Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
copyrightizen
Advanced tools
Changelog
Readme
this module is a tool to append/update copyright/license notice in target source files, based on scope management.
For installation, run
npm install copyrightizen -g
to run copyrightizen against some file with glob patterns, run
copyrightizen --paths src/*.ts
to run copyrightizen with config file, just run
copyrightizen [--config custom.config.js]
thanks to cosmiconfig, Copyrightizen support a bunch of config variants:
copyrightizen
property in package.json
.copyrightizenrc
file in JSON or YAML format.copyrightizenrc.json
file.copyrightizenrc.yaml
, .copyrightizenrc.yml
, or .copyrightizenrc.js
filecopyrightizen.config.js
file exporting a JS objectA sample content of the config should look like this:
//.copyrightizenrc
{
"licenseText": "Copyright (c) Humans on Mars",
"updateStrategy": "update",
"scopes": [
{
"name": "scopeA",
"paths": ["*.ts*"],
"licenseText": "Copyright (c) Humans on Moon",
"updateStrategy": "update",
},
]
}
NOTE: For the detail constraints of the supported configurations, see the JSON schema.
NOTE: Configuration uses globby for glob matching, it support glob features what globby supports
From lowest to highest
the order of scopes within config file matters.
The global scope (aka default config) has the lowest priority. The later a scope is defined in the scopes list, the higher priority it has.
Options:
--version Show version number [boolean]
--config Use the specific configuration file [string]
--detect-rule regexp expression to detect copyright [string]
--paths a list of glob string to match desired files [array]
--license-text the license/copyright notice [string]
--license-template-url the address for license template file [string]
--update-strategy the update strategy when existing copyright is
detected in matched source file
[choices: \\"update\\", \\"skip\\"]
--follow-gitignore exclude the files listed as excluded in .gitignore
[boolean]
-h, --help Show help [boolean]
Examples:
cli.js --config crn.spec.json
cli.js --detect-rule /@license/i
cli.js --license-text \\"@license whatever you want\\"
cli.js --license-template-url config/license.tpl
FAQs
A tool generates designated copyright notice to target files with scope support like Intellij IDEs.
The npm package copyrightizen receives a total of 16 weekly downloads. As such, copyrightizen popularity was classified as not popular.
We found that copyrightizen demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.