# package-json-from-template

> Generate a package.json file from a template

Latest version **0.0.3** (published 2017-12-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install package-json-from-template
pnpm add package-json-from-template
yarn add package-json-from-template
bun add package-json-from-template
```

Provides the command `pack-gen`.

## 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.3 |
| Published | 2017-12-03 |
| First published | 2017-12-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4 |
| Dependencies | 5 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Andrea SonnY |
| Maintainers | andreasonny83 |
| Keywords | package, package-json, generator, package-json-generator |

## Links

- npm: https://www.npmjs.com/package/package-json-from-template
- Repository: https://github.com/andreasonny83/package-json-from-template
- Homepage: https://github.com/andreasonny83/package-json-from-template#readme
- Issues: https://github.com/andreasonny83/package-json-from-template/issues
- npm.io page: https://npm.io/package/package-json-from-template

## Dependencies (5)

- [meow](https://npm.io/package/meow.md) ^4.0.0
- [chalk](https://npm.io/package/chalk.md) ^2.3.0
- [read-pkg](https://npm.io/package/read-pkg.md) ^3.0.0
- [write-pkg](https://npm.io/package/write-pkg.md) ^3.1.0
- [replace-string](https://npm.io/package/replace-string.md) ^1.1.0

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 0.0.3 (latest) — 2017-12-03
- 0.0.2 — 2017-12-03
- 0.0.1 — 2017-12-03

## README

# Package.json From Template [![Build Status](https://travis-ci.org/andreasonny83/package-json-from-template.svg?branch=master)](https://travis-ci.org/andreasonny83/package-json-from-template)

> Generate a package.json file from a template

## Why

- You might find this project useful if you need to generate a node module with different dependencies which uses a different package.json configuration from your repository configuration
- It saves you time
- It's DRY

## When to use it

Sometimes you create a repository that generates a packaged version of your
project and you want that to have it own `package.json` file but the same
name and version inherited from your original project.

## Install

If you want to install package-json-from-template globally,
use the follow command from your terminal:

```
$ npm install -g package-json-from-template
```

Otherwise just add PackageJsonFromTemplate to your project with:

```
$ npm install --save-dev package-json-from-template
```

If you prefer using Yarn:

```
$ yarn add --dev package-json-from-template
```

## Usage

```txt
  $ Usage: pack-gen [path] [options] -- [diff args]

  Options
    -t, --template=<filename>   The template file to be used for generating the new package.json file. [default: <path>/package.tpl.json]

    -s, --source=<filename>     The location of your `package.json` file. [default: the root project directory will be used]

  [path]  The working directory in where generating package.json file

  Examples
  Generate a new package.json file inside the ./package folder
  $ pack-gen package

  Generate a new package.json using the base package.json file located under the src directory
  $ pack-gen package --source=src/package.json

  Generate a new package.json file inside the ./package folder using a my-template.json file as a template
  $ pack-gen package --template=my-template.json
```

## Example

Now, assuming that your project generate a distribution version
of your node module inside a `dist` folder, add a `pack-gen` script
to generate a `package.json` file inside that directory to
call after your build task is completed.

```json
"scripts": {
  "pack-gen": "pack-gen ./dist",
}
```

Note that your `dist` folder will need to contain a
`package.tpl.json` file to use as a template.
If you wish to use a template file sitting elsewhere, you can use
the `template` flag and specify a different path like this:

```json
"scripts": {
  "pack-gen": "pack-gen ./dist --template=/templates/my-package.teplate.json",
}
```

## Contributing

1.  Fork it!
1.  Create your feature branch: `git checkout -b my-new-feature`
1.  Add your changes: `git add .`
1.  Commit your changes: `git commit -am 'Add some feature'`
1.  Push to the branch: `git push origin my-new-feature`
1.  Submit a pull request :sunglasses:

## License

[MIT License](https://andreasonny.mit-license.org/2017) © SonnY

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