sriramrudraraju / npm-package-template

template for creating npm modules

NPM Package Template

Template for creating npm modules. Including react components.

Example using this template.

Using the template

clone or click use this template feature

• Tweak necessary values in package.json

npm install

Installs dependencies.

npm run test

runs unit test cases using jest (and enzyme for react components)

npm run coverage

gives unit tests coverage report.

npm run build

creates ./dist prod build folder.

npm link

For local testing. More info

npm publish

Publishes to npm. (have to login if needed using npm login)

Github actions for CI/CD

create .yml file for github actions in .github/workflows and paste the code

name: Publishing to npm

on:
  push:
    branches:
    - master

jobs:
  build:

    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v1
    - name: installing dependencies
      run: npm install
    - name: running unit tests
      run: npm run test
    - name: generating production build
      run: npm run build
    - uses: actions/setup-node@v1
      with:
        node-version: '10.x'
        registry-url: 'https://registry.npmjs.org'
    - run: npm publish
      env:
        NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}

• Above code was simple CI/CD for pushing to npm when some code is pushed to master branch
• ${{ secrets.NPM_AUTH_TOKEN }} was set using github secrets
• NPM_AUTH_TOKEN is obtained from npm

Storybook Integration

• code example with integrated storybook is on story-book branch

npm-package-template's Issues

scripts for cleaning and moving files

 "build": "yarn run clean && tsc",
 "postbuild": "ef-tspm && yarn run copy-files",
 "clean": "rimraf lib/",
 "prepare": "yarn run build",
 "copy-files": "copyfiles -u 1 src/**/*.js dist"

more info

add webpack support

Now

• only .ts and .tsx files being compiled (cause of typescript)

Future

• need set up to build minified files, etc