# new-node-module

> Mini-boilerplate for generating new node modules

Latest version **2.0.0** (published 2021-04-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install new-node-module
pnpm add new-node-module
yarn add new-node-module
bun add new-node-module
```

Provides the command `new-node-module`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2021-04-21 |
| First published | 2017-10-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 7.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 6 |
| Author | Michele Pangrazzi |
| Maintainers | mpangrazzi |
| Keywords | module, node, boilerplate |

## Links

- npm: https://www.npmjs.com/package/new-node-module
- Repository: https://github.com/mpangrazzi/new-mode-module
- Homepage: https://github.com/mpangrazzi/new-mode-module#readme
- Issues: https://github.com/mpangrazzi/new-mode-module/issues
- npm.io page: https://npm.io/package/new-node-module

## Dependencies (3)

- [debug](https://npm.io/package/debug.md) ^4.3.1
- [yargs](https://npm.io/package/yargs.md) ^16.2.0
- [shelljs](https://npm.io/package/shelljs.md) ^0.8.4

## Alternatives

- [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads
- [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads
- [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads
- [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads
- [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads

## Recent versions

- 2.0.0 (latest) — 2021-04-21
- 1.0.2 — 2017-10-19
- 1.0.1 — 2017-10-19

## README

new-node-module(1)
===

A CLI tool which generates a minimal boilerplate for creating new [Node.js](https://nodejs.org/en/) modules.

It's implemented with [shelljs](https://github.com/shelljs/shelljs) instead of bash. Why? Just for fun.

## Install

With [npm](https://www.npmjs.com):

```bash
$ npm install -g new-node-module
```

## Usage

```bash
# Simple module
$ new-node-module --name

# Scoped module
$ new-node-module --scope '@yourscope' --name 'test'
```

## Debug

To see what's going on under the hood, run:

```bash
$ DEBUG=new-node-module new-node-module --scope '@yourscope' --name 'test'
```

## LICENSE

Copyright 2017 Michele Pangrazzi <xmikex83@gmail.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

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