# jsheader

> Generates headers for files

Latest version **0.0.2** (published 2017-03-16) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install jsheader
pnpm add jsheader
yarn add jsheader
bun add jsheader
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2017-03-16 |
| First published | 2017-03-16 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Henrique Salvadori Coelho |
| Maintainers | hscasn |
| Keywords | header, bulk, generator, author, license, file, files |

## Links

- npm: https://www.npmjs.com/package/jsheader
- Repository: https://github.com/hscasn/jsheader
- Homepage: https://github.com/hscasn/jsheader#readme
- Issues: https://github.com/hscasn/jsheader/issues
- npm.io page: https://npm.io/package/jsheader

## Alternatives

- [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads
- [path-starts-with](https://npm.io/package/path-starts-with.md) — 35.9K weekly downloads
- [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads
- [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads
- [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads

## Recent versions

- 0.0.2 (latest) — 2017-03-16
- 0.0.1 — 2017-03-16

## README

# 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.

---
_Source: https://npm.io/package/jsheader · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._