jsheader/README.md

Generates headers for files

# jsheader
Generates and replaces headers for files in bulk.


**Linux and MacOS only**

Installing

```
npm install -g jsheader
```


Using

1- Create a config file with the following settings:

```
{
  // String. Mandatory.
  // This field contains the header you want in your files
  header: "/**\n * JSHeader\n *\n * @license Apache-2.0\n */\n\n",

  // String. Optional.
  // This field contains the directory of your project. If not specified,
  // will use the directory where you placed this script
  directory: "~/Desktop/jsheader",

  // Array<String>. Optional.
  // The array must contain stringified regexes (without the //)
  // Will be used to exclude paths that match the regex
  exclude: ["node_modules"], 

  // String. Optional.
  // Contains a stringified regex
  // Will be used to detect old headers. If matched, the script will replace the
  // old header with the new one.
  // Default: /^\/(.|\n)+?@license(.|\n)+?\*\/[\n]*/ (matches JSDoc with @license) 
  headerTest: "/^\\/(.|\\n)+?@license(.|\\n)+?\*\\/[\\n]*/",

  // Array<String>. Optional.
  // Extensions of the files to modify
  // Default: ['js', 'jsx']
  // Used in the command `find <directory> -name "*.<extension>"`
  extension: ['js']
}
```

2- Launch the program and pass the location of the config file

```
jsheader ~/Desktop/jsheader.config
```

3- Review the information provided (files to write, new header, etc) and confirm.