mirror of https://github.com/thangisme/notes.git
99 lines
2.5 KiB
Markdown
99 lines
2.5 KiB
Markdown
|
SVG Tags
|
||
|
|
========
|
||
|
|
[![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Coverage][coveralls-image]][coveralls-url] [![Dependencies][dependencies-image]][dependencies-url]
|
||
|
|
|
||
|
|
> List of standard SVG tags.
|
||
|
|
|
||
|
|
List built from the [SVG 1.1 specification](http://www.w3.org/TR/SVG/eltindex.html).
|
||
|
|
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
``` bash
|
||
|
|
$ npm install svg-tags --save
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
The module is simply a JSON array, so use as you would a normal JavaScript array.
|
||
|
|
|
||
|
|
``` javascript
|
||
|
|
var tags = require( 'svg-tags' );
|
||
|
|
|
||
|
|
console.log( JSON.stringify( tags ) );
|
||
|
|
/**
|
||
|
|
* Returns:
|
||
|
|
* [ 'a', 'altGlyph', ... ]
|
||
|
|
*/
|
||
|
|
|
||
|
|
console.log( tags.indexOf( 'desc' ) );
|
||
|
|
// Returns [index]
|
||
|
|
```
|
||
|
|
|
||
|
|
## Examples
|
||
|
|
|
||
|
|
To run the example code from the top-level application directory,
|
||
|
|
|
||
|
|
``` bash
|
||
|
|
$ node ./examples/index.js
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
## Tests
|
||
|
|
|
||
|
|
### Unit
|
||
|
|
|
||
|
|
Unit tests use the [Mocha](http://visionmedia.github.io/mocha) test framework with [Chai](http://chaijs.com) assertions. To run the tests, execute the following command in the top-level application directory:
|
||
|
|
|
||
|
|
``` bash
|
||
|
|
$ make test
|
||
|
|
```
|
||
|
|
|
||
|
|
All new feature development should have corresponding unit tests to validate correct functionality.
|
||
|
|
|
||
|
|
|
||
|
|
### Test Coverage
|
||
|
|
|
||
|
|
This repository uses [Istanbul](https://github.com/gotwarlost/istanbul) as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:
|
||
|
|
|
||
|
|
``` bash
|
||
|
|
$ make test-cov
|
||
|
|
```
|
||
|
|
|
||
|
|
Istanbul creates a `./reports/coverage` directory. To access an HTML version of the report,
|
||
|
|
|
||
|
|
``` bash
|
||
|
|
$ open reports/coverage/lcov-report/index.html
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
[MIT license](http://opensource.org/licenses/MIT).
|
||
|
|
|
||
|
|
|
||
|
|
---
|
||
|
|
## Copyright
|
||
|
|
|
||
|
|
Copyright © 2014. Athan Reines.
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
[npm-image]: http://img.shields.io/npm/v/svg-tags.svg
|
||
|
|
[npm-url]: https://npmjs.org/package/svg-tags
|
||
|
|
|
||
|
|
[travis-image]: http://img.shields.io/travis/element-io/svg-tags/master.svg
|
||
|
|
[travis-url]: https://travis-ci.org/element-io/svg-tags
|
||
|
|
|
||
|
|
[coveralls-image]: https://img.shields.io/coveralls/element-io/svg-tags/master.svg
|
||
|
|
[coveralls-url]: https://coveralls.io/r/element-io/svg-tags?branch=master
|
||
|
|
|
||
|
|
[dependencies-image]: http://img.shields.io/david/element-io/svg-tags.svg
|
||
|
|
[dependencies-url]: https://david-dm.org/element-io/svg-tags
|
||
|
|
|
||
|
|
[dev-dependencies-image]: http://img.shields.io/david/dev/element-io/svg-tags.svg
|
||
|
|
[dev-dependencies-url]: https://david-dm.org/dev/element-io/svg-tags
|
||
|
|
|
||
|
|
[github-issues-image]: http://img.shields.io/github/issues/element-io/svg-tags.svg
|
||
|
|
[github-issues-url]: https://github.com/element-io/svg-tags/issues
|