# generator-nodecg

> Yeoman generator for NodeCG bundles

Latest version **2.2.1** (published 2023-06-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install generator-nodecg
pnpm add generator-nodecg
yarn add generator-nodecg
bun add generator-nodecg
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.2.1 |
| Published | 2023-06-20 |
| First published | 2021-03-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM |
| Dependencies | 12 |
| Unpacked size | 72.4 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 18 |
| Author | Alex Van Camp |
| Maintainers | hoishin |
| Keywords | yeoman-generator, nodecg, bundle |

## Links

- npm: https://www.npmjs.com/package/generator-nodecg
- Repository: https://github.com/nodecg/generator-nodecg
- Homepage: http://nodecg.dev
- Issues: https://github.com/nodecg/generator-nodecg/issues
- npm.io page: https://npm.io/package/generator-nodecg

## Dependencies (12)

- [chalk](https://npm.io/package/chalk.md) ^5.2.0
- [yosay](https://npm.io/package/yosay.md) ^2.0.2
- [mkdirp](https://npm.io/package/mkdirp.md) ^3.0.1
- [lodash-es](https://npm.io/package/lodash-es.md) ^4.17.21
- [git-config](https://npm.io/package/git-config.md) 0.0.7
- [deep-extend](https://npm.io/package/deep-extend.md) ^0.6.0
- [parse-author](https://npm.io/package/parse-author.md) ^2.0.0
- [generator-node](https://npm.io/package/generator-node.md) ^2.8.0
- [github-username](https://npm.io/package/github-username.md) ^7.0.0
- [yeoman-generator](https://npm.io/package/yeoman-generator.md) ^5.8.0
- [generator-license](https://npm.io/package/generator-license.md) ^5.5.0
- [yeoman-environment](https://npm.io/package/yeoman-environment.md) ^3.16.2

## Alternatives

- [raw-loader](https://npm.io/package/raw-loader.md) — 4.3M weekly downloads
- [plop](https://npm.io/package/plop.md) — 1.4M weekly downloads
- [webpack-deadcode-plugin](https://npm.io/package/webpack-deadcode-plugin.md) — 80.3K weekly downloads
- [@storybook/preact-vite](https://npm.io/package/@storybook/preact-vite.md) — 54.2K weekly downloads
- [vite-plugin-transform](https://npm.io/package/vite-plugin-transform.md) — 2.4K weekly downloads

## Recent versions

- 2.2.1 (latest) — 2023-06-20
- 2.2.0 — 2023-06-12
- 2.1.2 — 2023-06-08
- 2.1.1 — 2023-05-18
- 2.1.0 — 2023-05-15
- 2.0.1 — 2023-03-24
- 2.0.0 — 2023-03-24
- 1.2.0 — 2021-03-06

## README

# generator-nodecg

[![NPM version][npm-image]][npm-url]
[![Build Status][travis-image]][travis-url]
[![Test Coverage][coverage-image]][coverage-url]

> Yeoman generator for [NodeCG](http://nodecg.dev/) bundles

generator-nodecg can be used to quickly start a new bundle with the barebones boilerplate files that every bundle needs.
It can also be used to add a new panel, graphic, or extension in an existing bundle.

## Installation

First, install [Yeoman](http://yeoman.io) and generator-nodecg using [npm](https://www.npmjs.com/)
(we assume you have pre-installed [node.js](https://nodejs.org/)).

```bash
npm install -g yo@latest
npm install -g generator-nodecg@latest
```

Then generate your new bundle:

```bash
# Run this command inside the directory of your bundle.
# For example, nodecg/bundles/my-bundle.
yo nodecg
```

generator-nodecg also has specific sub-generators that can be used on existing bundles:

```bash
yo nodecg:panel
yo nodecg:graphic
yo nodecg:extension
```

## Special Thanks

Significant portions of this generator are based on [generator-node](https://github.com/yeoman/generator-node).
We thank the developers of [generator-node](https://github.com/yeoman/generator-node) and
[Yeoman](http://yeoman.io/) for their years of hard work.

## License

MIT © [Alex Van Camp](http://alexvan.camp)

[npm-image]: https://badge.fury.io/js/generator-nodecg.svg
[npm-url]: https://npmjs.org/package/generator-nodecg
[travis-image]: https://travis-ci.org/nodecg/generator-nodecg.svg?branch=master
[travis-url]: https://travis-ci.org/nodecg/generator-nodecg
[coverage-image]: https://codecov.io/gh/nodecg/generator-nodecg/branch/master/graph/badge.svg
[coverage-url]: https://codecov.io/gh/nodecg/generator-nodecg

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