https://github.com/caseyWebb/generator-npm-init

:link: npm init for yeoman
https://github.com/caseyWebb/generator-npm-init

npm yeoman yeoman-generator

Last synced: 3 months ago
JSON representation

:link: npm init for yeoman

• Host: GitHub
• URL: https://github.com/caseyWebb/generator-npm-init
• Owner: caseyWebb
• License: mit
• Archived: true
• Created: 2016-01-08T01:07:22.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2024-02-11T14:39:09.000Z (12 months ago)
• Last Synced: 2024-09-21T23:44:41.928Z (4 months ago)
• Topics: npm, yeoman, yeoman-generator
• Language: JavaScript
• Homepage:
• Size: 2.55 MB
• Stars: 22
• Watchers: 3
• Forks: 3
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# generator-npm-init

[![Version][npm-version-shield]][npm]

[![Build Status][build-status-shield]][build-status]

[![Coverage States][codecov-shield]][codecov]

[![Downloads][npm-stats-shield]][npm-stats]

Yeoman generator implementation of `npm init`. Useful for composition.

```javascript

this.composeWith(require.resolve('generator-npm-init/app') /*, options*/)

```

### Options

```javascript

{

  // skip prompts

  'skip-name': false,

  'skip-description': false,

  'skip-version': false,

  'skip-main': false,

  'skip-test': false,

  'skip-repo': false,

  'skip-keywords': false,

  'skip-author': false,

  'skip-license': false,

  // supply alternative defaults

  name: '<%= destFolderName %>',

  version: '1.0.0',

  description: '',

  main: 'index.js',

  test: 'echo "Error: no test specified" && exit 1',

  repo: '',

  keywords: [],

  author: '',

  license: 'ISC',

  // configure run script defaults

  scripts: {

    start: 'node dist/index.js',

    build: 'webpack -p',

    watch: 'webpack-dev-server'

  }

}

```

[build-status]: https://github.com/caseyWebb/generator-npm-init/actions/workflows/nodejs.yml

[build-status-shield]: https://img.shields.io/github/workflow/status/caseyWebb/generator-npm-init/Node%20CI/master

[codecov]: https://codecov.io/gh/caseyWebb/generator-npm-init

[codecov-shield]: https://img.shields.io/codecov/c/github/caseyWebb/generator-npm-init.svg

[npm]: https://www.npmjs.com/package/generator-npm-init

[npm-version-shield]: https://img.shields.io/npm/v/generator-npm-init.svg

[npm-stats]: http://npm-stat.com/charts.html?package=generator-npm-init&author=&from=&to=

[npm-stats-shield]: https://img.shields.io/npm/dt/generator-npm-init.svg?maxAge=2592000