https://github.com/boneskull/create-yo

Use any Yeoman generator with "npm init"
https://github.com/boneskull/create-yo

create init npm npx scaffold yeoman

Last synced: 3 months ago
JSON representation

Use any Yeoman generator with "npm init"

• Host: GitHub
• URL: https://github.com/boneskull/create-yo
• Owner: boneskull
• License: other
• Created: 2018-11-01T07:18:05.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-12-30T17:47:29.000Z (about 2 years ago)
• Last Synced: 2024-10-10T01:58:37.122Z (4 months ago)
• Topics: create, init, npm, npx, scaffold, yeoman
• Language: JavaScript
• Homepage:
• Size: 444 KB
• Stars: 45
• Watchers: 3
• Forks: 4
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# create-yo

> Use any Yeoman generator with "npm init"

As of npm v6.1.0, you can [use a custom package](https://github.com/npm/npm/pull/20403) with `npm init` to scaffold a project.

## Table of Contents

- [Install](#install)

- [Usage](#usage)

- [Maintainers](#maintainers)

- [License](#license)

## Install

You _could_ install this, but you shouldn't have to. Use `npm` to install globally if you wish.

### Requirements

- Node.js v10.0.0+

- npm v6.1.0+

## Usage

```shell

$ npm init yo [:subgenerator]

```

All Yeoman generator packages start with `generator-`; this prefix is _optional_ **unless you are using a scoped package**. In other words, `npm init yo license` will work just as well as `npm init yo generator-license`, but to use generator `@butts/generator-butts`, you must specify the complete package name with `npm init yo @butts/generator-butts`.

See [a list of generators here](http://yeoman.io/generators/).

## Notes

This package does little other than monkey with arguments and invoke `npx` programmatically.

## Contribution

Please use [Conventional Commit conventions](https://www.conventionalcommits.org). Commit messages are checked via Git hook using [commitlint](https://npm.im/@commitlint/cli).

## Maintainers

[@boneskull](https://github.com/boneskull)

## License

Copyright © 2019 Christopher Hiller. Licensed Apache-2.0