npm

Need private packages and team management tools?Check out npm Orgs. »

frets-styles-generator

1.2.0 • Public • Published

frets-styles-generator

Genreates a typescript class from a given input css file. The typescript

Uses postcss under the hood.

Installation

npm install frets-styles-generator --save-dev

And here is more recommended starter packages with common postcss pluugins, basecss library, and support for @import.

npm install postcss-cli postcss-import postcss-preset-enc purgecss purge-css-from-frets cssnano basscss basscss-addons basscss-basic -D

Usage

npx frets-styles-generator

The first argument you pass to the program will be the directory to scan for CSS files. It defaults to "./src" if you leave the argument out. Each CSS file that is found will be run through postcss (utilizing the postcss-import plugin by default) and then turned into a .ts file like [orginialFilename-styles.ts] based on the template specified. The default template is for maquette hyperscript functions.

Optionally pass this argument -t '[path to custom template.js file]' to specify a custom template.

Used in conjunction with FRETS and/or another hyperscript implementation. This particular template is specifically for the Maquette hyperscript implementation. Meaning it outputs a ts file that expects maquette to be available for import, so you will need 'maquette' in your project as a dependency.

Other Options

Includes an optional watch flag -w.

Includes an options flag -o which will overwrite the original css file using the postcss-import plugin.

Setting the -p or --purge flag will allow the use of purgecss.

Purging unused CSS

The generation of the typescript class suffers from the same inefficiency as atomic CSS. It includes a bunch of members that you may not be currently using in your actual source code. The atomic CSS people have found that using purgecss will greatly reduce file size by scanning your source code files for classnames that are used and only including those selectors in the final css outoput.

We can use the same technology for two purposes in FRETS. First, we configure postcss to scan our src/**/.ts files with the custom extractor purgecss-from-frets and when we use PostCSS to compile browser-ready css we will get only the selectors that are neccessary!

Here's my sample postcss config.

const postcssPresetEnv = require('postcss-preset-env');
var atImport = require("postcss-import");
var purgecss = require("@fullhuman/postcss-purgecss");
 
var purgeFromFrets = require("purgecss-from-frets");
 
module.exports = {
  plugins: [
    atImport(),
    postcssPresetEnv({
      stage: 1,
      browsers: 'last 2 versions'
    }),
    purgecss({
      content: ['./src/components/**/*.ts'],
      extractors: [
        { extractor: purgeFromFrets, extensions: ["ts"] }
      ],
      whitelist: ['html', 'body', 'input', 'button', 'select'],
      whitelistPatterns: [/icon/, /green/],
      rejected: true
    })
    // cssnano({
    //   preset: 'default',
    // })
  ],
  input: 'src/base.css',
  dir: 'dist'
}

Now to solve the other half of the problem. Normally when frets-styles-generator analyzes your source css file it purposefully removes the purgecss plugin so that you have access to the entire set of class names from your css file when writing typscript code.

But, during your build script you can actually re-generate the *-styles.ts files with the -p flag to allow purgecss to remove unused selectors from your typescript class too! This will significantly decrease the size of your *-styles.ts files before they get compiled into final javascript bundles by webpack.

Here's a sample build script from my package.json.

"build:prod""frets-styles-generator src/base.css src/base-styles.ts -p && cross-env NODE_ENV=production webpack -p && npm run css && npm run css:minify",

I find it especially useful for rapid prototyping if you point it at BaseCSS or tachyons because then you have a chainable typescript method for every "atomic" css class.

Custom Templates

See the current maquette template for an example.

It should be possible to build templates for using the preact, react, or vue hyperscript functions.

install

npm i frets-styles-generator

Downloadsweekly downloads

27

version

1.2.0

license

MIT

homepage

gitlab.com

repository

Gitgitlab

last publish

collaborators

  • avatar
Report a vulnerability