create
An npm create package for creating JavaScript projects.
Usage
An npm create package for creating JavaScript projects. Use npm init to create a new project.
npm init @programmerrajThen install the dependencies.
Features
Automatic author field
If the project contains a GitHub git remote, the author will be fetched, and the name, email, and GitHub url of the author will be set.
Public / private packages
One of the first prompts asks if the package will be published. Then the private field is set for private packages.
Checks for existing packages with the same name
If you try to make an npm package using a name which already exists on npm, you will be prompted to pick a different name.
Automatic homepage
The GitHub repo link is used as the homepage, if it exists.
Automatic repository field
This even includes the `repository directory.
Automatic license field
Checks for a LICENSE file and uses the name of that license.
Sets up code lint
Currently, standard code style can be used. This sets up all the dev dependencies needed for eslint with standard.
Generates GitHub Actions workflow
A GitHub workflow that checks the code style and runs tests can be added.
Creates README.md
Adds the name of the package, as well as badges to the README.
Creates starter code files
Just use the CLI, and you'll be ready to start coding. No need to create a index.js file. The package does it for you.
Easily support CommonJS and ESModules
Using Babel or TypeScript, the file structure, exports, and build scripts will be created by the CLI.
Easily use TypeScript
Use typescript with one key press. The compiling and tsconfig.json will be setup.
Add tests
This package sets up Mocha or Jest, and even adds types to your devDependencies if you're using TypeScript.
Use with any package installer
This CLI does not run npm i itself. This is so you can use whatever package installer you use. Whether you use Npm, Pnpm, Yarn, or something else, you just need to install the dependencies in package.json after running the CLI.
Generate docs with Typedoc
For projects using TypeScript, there is an option to add typedoc to devDependencies and add a script for building docs. You can also use GitHub Actions to build the documentation to GitHub Pages.
Easily maintain and publish packages
One of the main tasks when creating and maintaining npm packages is releasing new versions and publishing it to npm.
Using GitHub Actions, Release It, Detect Increment, and Label Manager, contributors can and maintainers can spend valuable time doing the real work - writing and reviewing code. Incrementing the version and publishing to npm will be done automatically.