1.16.1 • Published 1 year ago

@bndynet/typescript-lib-starter v1.16.1

Weekly downloads
1
License
MIT
Repository
github
Last release
1 year ago

typescript-lib-starter

Release npm Coverage Status semver Code Styles semantic-release: angular

This starter project will standardize coding and publishing for your library, and implements following features:

  • :school_satchel: Include all packages for coding, linting, testing and building
  • :art: Compile sass to css using node-sass, autoprefixer and postcss
  • :inbox_tray: Build library to UMD and CommonJS modules
  • :blue_book: Generate API documentation of your TypeScript files automatically
  • :100: Check your commit message when git commit ...
  • :cl: Default CI scripts for GitHub Action, includes release and publish automatically
  • :bookmark: Generate CHANGELOG.md according to your commits in CI publishing process
  • :test_tube: Publish your unit tests report to coveralls.io by CI
  • :earth_asia: Publish API documentation, converage, demo and changelog to your gh-pages branch as your project site by CI
  • :package: Release to NPM and GitHub Package automatically by CI

Start your library

  1. Clone this repo:

    git clone https://github.com/bndynet/typescript-lib-starter.git <your-location> --depth 1

  2. Initialize your library:

    npm i && npm run init and type your package informations

  3. Now, you can code your library and bellow commands to start your work:

    npm start
    npm run lint
    npm run build
    npm run docs
    npm run test
    npm run test:watch
    npm run precommit
  4. Commit your changes and push them to your REPO.

Commit Message Guidelines

All commit message MUST follow https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit

Format as:

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

Note: The <type> can be found in ./commitlint.config.js file.

GitHub Action

Add NPM_TOKEN in your repo -> Settings -> Secrets

If you enabled GitHub Actions, the action will publish your package to GitHub Package Registry automatically.

1.16.1

1 year ago

1.16.0

1 year ago

1.15.4

2 years ago

1.15.0

2 years ago

1.15.3

2 years ago

1.15.2

2 years ago

1.15.1

2 years ago

1.14.1

2 years ago

1.14.0

2 years ago

1.12.1

2 years ago

1.10.3

2 years ago

1.12.0

2 years ago

1.10.2

2 years ago

1.14.5

2 years ago

1.14.4

2 years ago

1.14.3

2 years ago

1.14.2

2 years ago

1.8.2

2 years ago

1.6.4

2 years ago

1.8.1

2 years ago

1.6.3

2 years ago

1.8.0

2 years ago

1.6.2

2 years ago

1.14.6

2 years ago

1.6.1

2 years ago

1.6.0

2 years ago

1.11.0

2 years ago

1.13.2

2 years ago

1.13.0

2 years ago

1.13.4

2 years ago

1.13.3

2 years ago

1.9.0

2 years ago

1.7.1

2 years ago

1.7.0

2 years ago

1.8.9

2 years ago

1.8.10

2 years ago

1.8.8

2 years ago

1.8.11

2 years ago

1.8.7

2 years ago

1.8.6

2 years ago

1.8.5

2 years ago

1.8.4

2 years ago

1.6.6

2 years ago

1.8.3

2 years ago

1.6.5

2 years ago

1.10.1

2 years ago

1.5.0

5 years ago

1.4.0

5 years ago

1.3.0

5 years ago

1.2.3

5 years ago

1.2.2

5 years ago

1.2.1

5 years ago

1.2.0

5 years ago

1.1.9

5 years ago

1.1.8

5 years ago

1.1.7

5 years ago

1.1.6

5 years ago