travel/admin/node_modules/extract-from-css/README.md

104 lines
3.3 KiB
Markdown

[![npm](https://img.shields.io/npm/v/extract-from-css.svg)](https://npmjs.org/package/extract-from-css)
[![npm](https://img.shields.io/npm/l/extract-from-css.svg)](https://npmjs.org/package/extract-from-css)
[![Build Status](https://travis-ci.org/rubennorte/extract-from-css.svg?branch=master)](https://travis-ci.org/rubennorte/extract-from-css)
[![Coverage Status](https://coveralls.io/repos/rubennorte/extract-from-css/badge.svg)](https://coveralls.io/r/rubennorte/extract-from-css)
[![Code Climate](https://codeclimate.com/github/rubennorte/extract-from-css/badges/gpa.svg)](https://codeclimate.com/github/rubennorte/extract-from-css)
[![Dependency Status](https://david-dm.org/rubennorte/extract-from-css.svg?theme=shields.io&style=flat)](https://david-dm.org/rubennorte/extract-from-css)
[![devDependency Status](https://david-dm.org/rubennorte/extract-from-css/dev-status.svg?theme=shields.io&style=flat)](https://david-dm.org/rubennorte/extract-from-css#info=devDependencies)
# Extract from CSS
Extract information from CSS code.
For now, it extracts class names and ids.
## Installation
Dependencies:
* node >= 0.10
* npm >= 1.3.7 (package usage)
* npm >= 2.0.0 (package development)
```bash
npm install extract-from-css
```
## Usage
```javascript
var extract = require('extract-from-css');
var code = '.list-item { background: red; } \
/* comment */ \
#main-header { background: black; } \
.list-item-title:hover { font-weight: bold; } ';
extract(['ids', 'classes'], code);
// {
// ids: [ 'main-header' ],
// classes: [ 'list-item', 'list-item-title' ]
// }
extract.extractClasses(code);
// [ 'list-item', 'list-item-title' ]
extract.extractIds(code);
// [ 'main-header' ]
```
Works with nested rules (inside media queries, supports...), complex selectors and escaped characters and unicode symbols (♠, ♥, ★...) in class names and ids. See tests.
## Tests
To run the tests with Jasmine:
```bash
npm install
npm test
```
To run the benchmark:
```bash
npm run benchmark
```
To check the code:
```bash
npm run lint
```
## Contributing
1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Check the build: `npm run build`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D
## License
The MIT License (MIT)
Copyright (c) 2014 Rubén Norte
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.