0.0.1 • Published 4 years ago

sm-flex-ns v0.0.1

Weekly downloads
-
License
ISC
Repository
-
Last release
4 years ago

Build Status

generate npm package

This is cli to create boiler plate for npm package project.

Getting Started

Installation

npm install -g flex-ns-service

Usage

$ flex-ns-service

create

OptionsDefaultDescription
project namecreate-npm-packagenpm package name or project name
semacntic releeasefalse or Noadd semantic denpendencies
travis setupfalse or Noconfig travis setup .travis.yml
install dependenciesfalse or Noinstall project dependencies after creating project

Semantic Release

npm install -g semantic-release-cli
cd your-module
semantic-release-cli setup

Travis CI Setup

Project Structure

project

File/FolderDescriptions
project/index.jsentry file while creating npm module.
src/lib/index.jsmain file that you want to publish in npm.
src/lib/index.spec.jstest file for above file.
styles/folder for styles if you are creating UI npm module.
test/index.jsfor testing build files after build.
.travis.ymlfor Travis CI

Commands

  • Run project ( will start project with watch-bootstrap and watch-custom ) webpack.dev.config.js npm start

  • Run Test ( will run test for src/lib/index.spec.js ) npm run test

  • Build ( will bundle the src/lib/index.js to /build folder ) webpack.prod.config.js npm run build

  • Test 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 push

npm publish - without Semantic Release LInk

npm build
npm login
npm publish