Update a copyright statement with the current year. Also makes minor corrections.
Install with npm:
$ npm install --save update-copyright
Pass a string with a copyright statement to update, and it will be parsed and updated.
var copyright = ;;//=> 'Copyright (c) 2015-2016, Jon Schlinkert.';//=> 'Copyright (c) 2012, 2015-2016, Jon Schlinkert.'
The current year is updated/appended to existing years. The rest of the information will stay the same unless new information is passed.
If you're too lazy to pass anything at all, that's okay! You get a free copyright statement with the current year, using data from package.json!
;//=> 'Copyright (c) 2016, Jon Schlinkert.'
Optionally fills in author
If the author is missing it will be filled in with the author from package.json.
;//=> 'Copyright (c) 2014-2015, Jon Schlinkert.'
It will use the author from package.json if a misspelling seems obvious (according to its Levenshtein distance):
;//=> 'Copyright (c) 2014, 2016, Jon Schlinkert.'
See the tests for more examples.
A template is used to create the new copyright statement, and the options object is merged with the context that is passed to the template.
- The (context) object is populated with data from the parsed (old) copyright statement
- The object is then updated with the current year, author from package.json, and any other data you pass on the options.
This is what the context object looks like. To override anything on the context just pass the property and value on the options:
year: '2015'prefix: 'Copyright'symbol: '(c)'template: '<%= prefix %><%= symbol ? (" " + symbol + " ") : "" %><%= years %>, <%= authors %>.'statement: 'Copyright (c) 2015, Jon Schlinkert'dateRange: '2014'latest: '2014'author: 'Jon Schlinkert'
Pass any custom data (as shown above) on the options:
;//=> 'Copyright (c) 2015-2016, Foo Bar.'
- copyright-regex: Regex for matching and parsing copyright statements. | homepage
- parse-copyright: Parse copyright statement(s) into an array of copyright objects. | homepage
- update-year: Update or add the current year to a range of years in a string. | homepage
- update: Be scalable! Update is a new, open source developer framework and CLI for automating updates… more | homepage
- year: Simple utility to get the current year with 2 or 4 digits. | homepage
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
To generate the readme, run the following command:
$ npm install -g verbose/verb#dev verb-generate-readme && verb
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
$ npm install && npm test
This file was generated by verb-generate-readme, v0.6.0, on June 26, 2017.