Skip to content

Quickly scaffolds a valid placeholder package that meets all npm publishing requirements, preparing it for future development.

Notifications You must be signed in to change notification settings

jakex7/create-name

Repository files navigation

create-name

Quickly scaffolds a valid placeholder package that meets all npm publishing requirements, preparing it for future development.

Usage

With yarn

yarn create name <name> [options]

With npm global install

npm install -g create-name
create-name <name> [options]

Options

  • --author, -a <author>: Package author
  • --description, --desc <description>: Package description (default: "Work in progress")
  • --dry-run, --dry, -d: Dry run without publishing
  • --license <license>: Package license (default: "MIT")
  • --private: Mark package as private
  • --repository <url>: Repository URL
  • --temp, -t: Create a package in temporary directory

Examples

Create a basic package:

yarn create name my-package

Create a package with custom description and author:

yarn create name my-package --description "My awesome package" --author "John Doe"

Create in temporary directory:

yarn create name my-package --temp

Contributing

Contributions are welcome! Please open an issue or submit a pull request.

License

MIT

About

Quickly scaffolds a valid placeholder package that meets all npm publishing requirements, preparing it for future development.

Topics

Resources

Stars

Watchers

Forks