jpelaa / create-copyright-header

CLI - to add copyright and license header to all files in the project

Create-copyright-header

This is CLI - to add copyright and license header to all files in the project

## Prerequisites

CLI require Node 8.9 or higher, together with NPM 5.5.1 or higher.

Quick Overview

npx create-copyright-header --generate

If you've previously installed create-copyright-header globally via npm install -g create-copyright-header, we recommend you uninstall the package using npm uninstall -g create-copyright-header or yarn global remove create-copyright-header to ensure that npx always uses the latest version.

Installation

All that's needed to install create-copyright-header is to use npm to install it globally. For Linux sudo may be required.

npm install -g create-copyright-header

Introduction

create-copyright-header - commandline generate copyright header

Usage: npx create-copyright-header --generate create-copyright-header is a tool for generating copyright & license header, applying to given the directories and selected filetypes and updating at beginning of the files.

we take input from user for directories they want to change, file type they want to update. For a listing of options, use create-copyright-header --help.

Demo

Example:

? Please select the directories which you want to add copyright header (Press <space> to select, <a> to toggle all, <i>
to invert selection)
>( ) .git
 ( ) .github
 ( ) bin
 ( ) lib
 ( ) static

 ? Please select the file type below are supported file types (Press <space> to select, <a> to toggle all, <i> to invert
selection)
>( ) JavaScript
 ( ) HTML
 ( ) CSS
 ( ) Kotlin
 ( ) Java
 ( ) JSP
 ( ) PHP
 ( ) Python
 ( ) .NET

 ? Enter the copyright header content Press <enter> to launch your preferred editor.
 /*
* Copyright (c) 2012 - 2014 {Company Org}.
* All rights reserved.
*/

Thank you for ur response. we are working on file updates
lib checking...
[|||||||||||||||||||||||||||||||||------------------------------------------------------------------] 34%
lib\filewrite.js is updated
lib checking...
[||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||---------------------------------] 67%
lib\initializer.js is updated
lib checking...
[|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||] 100%
lib\utils.js is updated
static checking...
[|||||||||||||||||||||||||||||||||------------------------------------------------------------------] 34%
static\fileTypes.js is updated
static checking...
[||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||---------------------------------] 67%
static\folderExcludeList.js is updated
static checking...
[|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||] 100%
static\licenceCopyrightSamples.js is updated
updated all files Successfully please check

create-copyright-header's Issues

Generate config file in the project folder

• add new cli command for generating config file.
• get all input for config from user.
• generate config file with user inputs.

Contents get prepand even the content already exists in file

Change inquirer to enquirer package for user interaction

• To reduce size we prefer to go with the enquirer. Enquirer is a lightweight package compare to an inquirer.
• we should check enquirer providing all options which we have in our CLI tool.

Change chalk to ansi-colors package for color purpose

write copyright header file based on config inputs

• change --generate command name to --write for appropriate meaning.
• add logic to get config values and write copyright header

Ignore .git folder in directory list to select

• you can choose the directories want to overwrite there we are listing all directories .
• By Default, node_modules, codecoverage will not be in the list.
• we need to .git folder also

Remove prompt-editor package

provide help in command

Create help content and add it as options command arguments.

Fails on Mac with no helpful error message

Running on a MacBook, I get the following error:

? Enter the copyright header content › Waiting for editor...node:internal/process/promises:289
            triggerUncaughtException(err, true /* fromPromise */);
            ^

[UnhandledPromiseRejection: This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). The promise rejected with the reason "1".] {
  code: 'ERR_UNHANDLED_REJECTION'
}

Not that helpful to me. May be of use to the developers. No clue as to why it was unable to open an editor, or how I should set a default one!

write copyright/license header in git hooks

• create copyright config with all user inputs values in the project root directory.
• new CLI command to write copyright/license header in git hooks with global patterns (reference: prettier CLI ).
• add documentation in the readme.
• test this approach with sample projects.

explore bundle the package for node project

Change Progress bar to spinner while processing file

While overwriting file it is async call we shouldn't put progress bar while loading . we should use spinner for async calls.

Remove unused packages

• pkg-dir
• minimist