https://github.com/bndynet/typescript-lib-starter

:rocket:A starter project includes all necessary dependencies and scripts for coding and publishing your typescript library
https://github.com/bndynet/typescript-lib-starter

automated-publishing coveralls github-actions jest nodejs npm travis-ci typedoc typescript-library umd

Last synced: 3 months ago
JSON representation

:rocket:A starter project includes all necessary dependencies and scripts for coding and publishing your typescript library

• Host: GitHub
• URL: https://github.com/bndynet/typescript-lib-starter
• Owner: bndynet
• Created: 2019-01-24T11:33:19.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-02-21T07:42:56.000Z (12 months ago)
• Last Synced: 2024-04-22T19:44:39.992Z (10 months ago)
• Topics: automated-publishing, coveralls, github-actions, jest, nodejs, npm, travis-ci, typedoc, typescript-library, umd
• Language: JavaScript
• Homepage: https://bndynet.github.io/typescript-lib-starter
• Size: 7.81 MB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# typescript-lib-starter

![Release](https://img.shields.io/github/actions/workflow/status/bndynet/typescript-lib-starter/release.yml?style=flat-square)

[![npm](https://img.shields.io/npm/v/@bndynet/typescript-lib-starter?style=flat-square)](https://www.npmjs.com/package/@bndynet/typescript-lib-starter)

[![Coverage Status](https://img.shields.io/coverallsCoverage/github/bndynet/typescript-lib-starter?branch=master&style=flat-square)](https://coveralls.io/github/bndynet/typescript-lib-starter?branch=master)

[![semver](https://img.shields.io/badge/semver-2.0.0-blue?style=flat-square)](https://semver.org/)

[![Code Styles](https://img.shields.io/badge/Code_Style-Prettier-ff69b4?style=flat-square)](https://github.com/prettier/prettier)

![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release&style=flat-square)

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](https://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  --depth 1`

1. Initialize your library:

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

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

    ```bash

    npm start

    npm run lint

    npm run build

    npm run docs

    npm run test

    npm run test:watch

    npm run precommit

    ```

1. 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:

```

(): 

```

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.**