Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/savvy-css/generator-savvy-css
Yeoman generator for scaffolding out a Savvy module or utility
https://github.com/savvy-css/generator-savvy-css
css css-framework functional-css postcss savvy-css
Last synced: 14 days ago
JSON representation
Yeoman generator for scaffolding out a Savvy module or utility
- Host: GitHub
- URL: https://github.com/savvy-css/generator-savvy-css
- Owner: savvy-css
- License: mit
- Created: 2017-04-01T09:06:16.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-07-27T15:13:11.000Z (over 7 years ago)
- Last Synced: 2024-04-23T10:44:42.292Z (10 months ago)
- Topics: css, css-framework, functional-css, postcss, savvy-css
- Language: JavaScript
- Size: 121 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# generator-savvy-css
[![NPM version][npm-image]][npm-url]
[![Build Status][circle-image]][circle-url]
[![Dependency Status][daviddm-image]][daviddm-url]
> Generator for scaffolding out a Savvy CSS module..
## Installation
First, install [Yeoman](http://yeoman.io) and this generator using either [npm](https://www.npmjs.com/) (we assume you have pre-installed [node.js](https://nodejs.org/))...
```bash
npm install -g yo
npm install -g @savvy-css/generator-savvy-css
```
... or [yarn](https://yarnpkg.com/en/).
```bash
yarn global add yo
yarn global add @savvy-css/generator-savvy-css
```
## Usage
Run the `yo` command to generate your new project:
```bash
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](https://github.com/savvy-css/savvy/blob/master/doc/architecture/design-principles.md).
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](https://www.npmjs.com/org/savvy-css) using [`np`](https://github.com/sindresorhus/np).
Right now, instead of packaging `np` with each project, it's recommended to use your own
global installation:
```shell
yarn global add np
```
or
```shell
npm install -g np
```
#### 🔑 Important Note
The [Savvy CSS organization](https://github.com/savvy-css) 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](./CHANGELOG.md) and push the project to Github:
```shell
git init
git remote add origin
git add --all
git commit -m 'released v0.0.0'
git push --set-upstream origin master
```
Then create and push a tag to Github:
```shell
git tag v0.0.0
git push origin master --tags
```
Finally, publish:
```shell
npm publish --access public
```
## License
MIT © 2017 [Brian Sipple](https://github.com/BrianSipple)
[npm-image]: https://img.shields.io/npm/v/@savvy-css/generator-savvy-css.svg
[npm-url]: https://www.npmjs.com/package/@savvy-css/generator-savvy-css
[circle-image]: https://circleci.com/gh/savvy-css/generator-savvy-css/tree/master.svg?style=svg&circle-token={{CIRCLE_TOKEN}}
[circle-url]: https://circleci.com/gh/savvy-css/generator-savvy-css/tree/master
[daviddm-image]: https://david-dm.org/savvy-css/generator-savvy-css.svg?theme=shields.io
[daviddm-url]: https://david-dm.org/savvy-css/generator-savvy-css