Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dizmo/yeoman-generator-module
@dizmo/generator-module: a module generator for JavaScript, TypeScript and CoffeeScript
https://github.com/dizmo/yeoman-generator-module
coffeescript generator javascript module node typescript
Last synced: about 15 hours ago
JSON representation
@dizmo/generator-module: a module generator for JavaScript, TypeScript and CoffeeScript
- Host: GitHub
- URL: https://github.com/dizmo/yeoman-generator-module
- Owner: dizmo
- License: isc
- Created: 2018-07-17T19:04:00.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-06-16T09:52:43.000Z (5 months ago)
- Last Synced: 2024-08-08T16:31:42.328Z (3 months ago)
- Topics: coffeescript, generator, javascript, module, node, typescript
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/@dizmo/generator-module
- Size: 1.36 MB
- Stars: 0
- Watchers: 6
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGE_LOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://npmjs.org/package/@dizmo/generator-module)
[](https://travis-ci.com/dizmo/yeoman-generator-module)
# @dizmo/generator-module
> Generator for [Node.js] JavaScript, CoffeeScript and TypeScript modules
Generates [NPM] compatible module projects that can be published, installed and even upgraded. The supported development steps are cleaning, linting, building (including bundling) and testing (including coverage statistics).
## Prerequisites
* [Node.js] v14.15.5 LTS (or higher); for Linux distribution based packages (`deb` or `rpm`) see also [binary distributions](https://github.com/nodesource/distributions).
## Installation
```sh
npm install -g yo
```
```sh
npm install -g @dizmo/generator-module
```
## Help
```sh
yo @dizmo/module --help
```
## Generation
```sh
yo @dizmo/module [--git] [--typescript|--coffeescript]
```
## Upgrade
```sh
npm upgrade --global @dizmo/generator-module
```
```sh
yo @dizmo/module --upgrade --skip-install
```
```sh
npm install && npm audit fix
```
## Development
### Clean
```sh
npm run clean
```
### Build
```sh
npm run build
```
#### without linting and cleaning:
```sh
npm run -- build --no-lint --no-clean
```
#### with UMD bundling (incl. minimization):
```sh
npm run -- build --prepack
```
#### with UMD bundling (excl. minimization):
```sh
npm run -- build --prepack --no-minify
```
### Lint
```sh
npm run lint
```
#### with auto-fixing:
```sh
npm run -- lint --fix
```
### Test
```sh
npm run test
```
#### without linting, cleaning and (re-)building:
```sh
npm run -- test --no-lint --no-clean --no-build
```
### Cover
```sh
npm run cover
```
#### without linting, cleaning and (re-)building:
```sh
npm run -- cover --no-lint --no-clean --no-build
```
## Debugging
Connect `my-module` to another project:
```sh
[my-module] $ npm link # symlink global:my-module
```
```sh
[a-project] $ npm link my-module # symlink node-modules:my-module
```
```sh
[a-project] $ head webpack.config.js # ensure my-module in entry.main
```
```
entry: {
main: [..., 'my-module', './source/index.js']
}
```
Disconnect `my-module` from the project:
```sh
[a-project] $ npm unlink my-module # delete local symlink
```
```sh
[my-module] $ npm uninstall -g # delete global symlink
```
## Documentation
```sh
npm run docs
```
## Publication
```sh
npm publish
```
#### initially (if `public`):
```sh
npm publish --access=public
```
## Copyright
© [dizmo AG](http://dizmo.com/), Switzerland
[Node.js]: https://nodejs.org
[NPM]: https://www.npmjs.com