sendlo / jquery-next-id

jQuery collection plugin that will assign the next ID in sequence if an ID property does not already exist.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

@ebay/jquery-next-id

Build Status Coverage Status

jQuery collection plugin that will assign the next ID in sequence if an ID property does not already exist.

$(collection).nextId([prefix]);

Experimental

This plugin is still in an experimental state, until it reaches v1.0.0 you must consider all minor releases as breaking changes. Patch releases may introduce new features, but will be backwards compatible.

Please use the tilde range specifier in your package.json to pin to a fixed major and minor version.

Install

npm install @ebay/jquery-next-id --save

The NPM package also includes a minified version of the plugin.

Defaults

$.fn.nextId.defaults = {
    prefix : 'nid',
    separator : '-'
};

Example

Input:

<div /><div />

Execute:

$('div').nextId('my-prefix');

Output:

<div id="my-prefix-0" /><div id="my-prefix-1" />

Development

Run npm start for test driven development. All tests are located in test.js.

Execute npm run to view all available CLI scripts:

  • npm start test driven development: watches code and re-tests after any change
  • npm test runs tests & generates reports (see reports section below)
  • npm run lint lints code and reports to jshint.txt
  • npm run minify builds minified version of code
  • npm run build cleans, lints, tests and minifies (called on npm prepublish hook)
  • npm run clean deletes all generated test reports and coverage files

Reports

Each test run will generate the following reports:

  • /test_reports/coverage contains Istanbul code coverage report
  • /test_reports/html contains HTML test report
  • /test_reports/junit contains JUnit test report

CI Build

https://travis-ci.org/ianmcburnie/jquery-next-id

Code Coverage

https://coveralls.io/github/ianmcburnie/jquery-next-id?branch=master

About

jQuery collection plugin that will assign the next ID in sequence if an ID property does not already exist.


Languages

Language:JavaScript 100.0%