npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@quintype/copyright-header

v1.3.4

Published

To manage copyright headers in source files

Downloads

177

Readme

Copyright Header

Add or update copyright headers on source code files by scanning directory patterns recursively.

Installation

Global:

npm i @quintype/copyright-header -g

As local devDependency:

npm i @quintype/copyright-header --save-dev

Usage Examples

List of file extensions supported:

copyright-header -ex

Add or update copyright headers:

copyright-header -i "test/files/**/*" -f test/header.js

Options

Usage: copyright-header [options]

Options:
-f, --license-file <file>         copyright license file
-i, --include-path <paths>        recursively insert header in all files found in path (allows multiple file patterns separated by space and within double quotes '"')
-e, --exclude-path <paths>        skip adding headers for files in the path (allows multiple file patterns separated by comma space and within double quotes '"')
-u, --include-git-untracked       include git untracked files, by default git untracked files will be skipped
-s, --git-stage-files             add file changes to git staging
-ex, --supported-file-extensions  list supported file extensions
-V, --version                     output the version number
-h, --help                        display help for command

Copyright license file

  • Copyright license information in this file will be added as header to the source code files.
  • It should be a javascript file (.js) and can have dynamic content using template string.
  • Example license file,
// ************************************************************************
// *  © [2015 - ${new Date().getFullYear()}] Quintype Technologies India Private Limited
// *  All Rights Reserved.
// *************************************************************************
  • Program will read the license info as-is including empty lines after the comment, modify comment syntax based on the target file and append/update it to the target file beginning.
  • For updating a copyright, existing comment in the file should have any of the following keywords, 'copyright', '(c)', '©'
  • Make sure to check exact number of new lines added after the comment using text editors like vim. If using visual editors like vscode, then add an additional new line to the number of one's intended.

List of supported languages/file extensions

c, cpp, js, jsx, ts, tsx, go, java, clj, py

Adding support for new language/file extensions

  • Currently, this is possible only with a library configuration change. No command line option available to extend language support.
  • Add an entry in the library source code file, copyright-header/src/config/index.ts under SUPPORTED_LANGUAGES, similar to the one below
 {
    name: 'Ruby',
    fileExtensions: ['rb'],
    commentSyntax: {
      singleLine: {
        start: ['#']
      }
    }
  }

Configuring as husky pre commit hook

  • Add the following under scripts in package.json file.

"copyright-header": "copyright-header -f copyright-header-template.js -i \"src/**/*" -s"

  • Above script command will add/update copyright header in copyright-header-template.js file to all source code files under src directory.

  • Add the following in husky pre commit hook config in package.json file,

"husky": {
    "hooks": {
      "pre-commit": "npm run copyright-header"
    }
  }