Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dpellier/bem-comment
Automatically comment your BEM compliant SASS files to add class name comments
https://github.com/dpellier/bem-comment
Last synced: 4 months ago
JSON representation
Automatically comment your BEM compliant SASS files to add class name comments
- Host: GitHub
- URL: https://github.com/dpellier/bem-comment
- Owner: dpellier
- License: mit
- Created: 2014-11-04T15:25:03.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2014-11-05T09:25:57.000Z (about 10 years ago)
- Last Synced: 2024-06-22T21:08:28.096Z (6 months ago)
- Language: JavaScript
- Size: 89.8 KB
- Stars: 3
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE-MIT
Awesome Lists containing this project
README
Bem-comment
=========
A node module that read through some SASS files that follow BEM syntax to automatically add full name class comment above each classes.
Make the file much more readable to know the final classes generated.
## Installation
```shell
npm install bem-content --save
```
## Usage
```shell
node bem-content ...
```
## Example
```css
/* before */
.button {
&__cancel {
....
}
&--active {
....
}
}
```
```css
/* after */
// button
.button {
// button__cancel
&__cancel {
....
}
// button--active
&--active {
....
}
}
```
## Tests
```shell
npm test
```
## Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style.
Add unit tests for any new or changed functionality. Lint and test your code.
## Release History
* 0.1.0 Initial release