@savvy-css/generator-savvy-css

generator-savvy-css

Generator for scaffolding out a Savvy CSS module..

Installation

First, install Yeoman and this generator using either npm (we assume you have pre-installed node.js)...

npm install -g yo
npm install -g @savvy-css/generator-savvy-css

... or yarn.

yarn global add yo
yarn global add @savvy-css/generator-savvy-css

Usage

Run the yo command to generate your new project:

yo @savvy-css/generator-savvy-css

From there, the generator is setup to configure a Savvy CSS module within one of Savvy's categories of concerns.

Simply select your concern (for example, "utility"), the subject of your module within the context of that concern (for example, "spacing"), and from there, after a few more straightforward prompts, the generator will know how to scaffold your project!

Deployment

Each project designed to be published on NPM using np.

Right now, instead of packaging np with each project, it's recommended to use your own global installation:

yarn global add np

or

npm install -g np

🔑 Important Note

The Savvy CSS organization currently lacks the funding for private GitHub repositories 😛.

This means that before packages can be published under the @savvy-css namespace using np, an initial publish will need to be done manually with the --access publish flag being passed.

Please do this with the v0.0.0 files after they are generated. First, update the date in CHANGELOG.md and push the project to Github:

git init
git remote add origin <repo_url>
git add --all
git commit -m 'released v0.0.0'
git push --set-upstream origin master

Then create and push a tag to Github:

git tag v0.0.0
git push origin master --tags

Finally, publish:

npm publish --access public

License

MIT © 2017 Brian Sipple