0.0.8 • Published 6 years ago
mashishmewada v0.0.8
generate npm package
This is cli to create boiler plate for npm package project.
Getting Started
Installation
npm install -g mashishmewada
Usage
$ mashishmewada
| Options | Default | Description |
|---|---|---|
| project name | create-npm-package | npm package name or project name |
| semacntic releease | false or No | add semantic denpendencies |
| travis setup | false or No | config travis setup .travis.yml |
| install dependencies | false or No | install project dependencies after creating project |
Semantic Release
npm install -g semantic-release-cli
cd your-module
semantic-release-cli setupTravis CI Setup
Project Structure
| File/Folder | Descriptions |
|---|---|
| project/index.js | entry file while creating npm module. |
| src/lib/index.js | main file that you want to publish in npm. |
| src/lib/index.spec.js | test file for above file. |
| styles/ | folder for styles if you are creating UI npm module. |
| test/index.js | for testing build files after build. |
| .travis.yml | for Travis CI |
Commands
Run project ( will start project with watch-bootstrap and watch-custom ) webpack.dev.config.js
npm startRun Test ( will run test for src/lib/index.spec.js )
npm run testBuild ( will bundle the src/lib/index.js to /build folder ) webpack.prod.config.js
npm run buildTest Build ( will test the build module /build/index.js )
npm run test-build
Create Simple NPM package
cd your-module
Install Dependencies
npm installl
Add Git Link
package.json
"repository": {
"type": "git",
"url": "git_repository_link"
}npm publish - Using Semanctic Release
npm install -g commitizen
npm run commit
git pushnpm publish - without Semantic Release LInk
npm build
npm login
npm publish