npm-template-typescript

Let developers who publish libraries via npm share with the team or community quicker. Less time to set up utility tools to follow best practices, and more time on the core features of the package

This package template supports us

• Customize configuration: eslint, prettier, jest, typescript
• Git hook: ensure your code is qualified with lint when committing and test when pushing from your early stage on your local machine
• CI jobs: trigger on each PR or Push event to ensure jobs Lint -> Build -> Test are verified
• CD (publish) jobs: trigger when a new tag is pushed
  • Create a new release based on your commit messages like this
  • Publish the npm package to npmjs like this
  • Create | Update the Github page like this

Prerequisites

The following tools need to be installed:

• Git
• Node.js 18+

Capabilities and Frameworks

| Capability | Module | | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Dependence Framework | @tsconfig/node18 extend ts config node18+, typescript adds optional types to JavaScript that support tools for large-scale JavaScript applications | | Build Tools | tsup Bundle your TypeScript library with no config, powered by esbuild | | Coding Standard | eslint statically analyzes your code to quickly find and fix problems based on opt-in rules, prettier an opinionated code formatter to build and enforce a style guide on save, eslint-config-prettier to turns off all rules that are unnecessary or might conflict with Prettier. | | Testing Framework | Jest a delightful JavaScript Testing Framework with a focus on simplicity. | | Useful Links | npmtrends Compare package download counts over time, act run your GitHub Actions locally, Actionlint static checker for GitHub Actions workflow files, share-dev-environments quick setup by running some commands to align development environment among machines or developers |

How to use

Clone repository and rename it

git clone [email protected]:make-everything-simple/npm-template-typescript.git
# rename to desire name folder
mv npm-template-typescript $desire_name
cd $desire_name

Update necessary fields e.g. name, author, version, repository, etc in package.json file

we can manage our package.json via npm-pkg

npm pkg set <key>=<value> [<key>=<value> ...]
npm pkg get [<key> [<key> ...]]
npm pkg delete <key> [<key> ...]
npm pkg set [<array>[<index>].<key>=<value> ...]
npm pkg set [<array>[].<key>=<value> ...]
npm pkg fix

Install dependencies and build it

# reinitialize existing Git repository
git init
# install dependencies
npm install | yarn install
# run build
npm run build | yarn build

Implement code and write unit tests to verify your package's business logics

Verify or fix lint

# check lint's rules
npm run lint | yarn lint
# check lint's rules and try to fix
npm run lint:fix | yarn lint:fix
# format your code
npm run prettier:format | yarn prettier:format

Verify unit test

npm test | yarn test

Configure necessary credentials once you are ready for release

1. Generate a Granular Access Token on npmjs.com
   1. github package: TBU
2. Configure in your repository's secret variables
   1. Individual level
   2. Organization level to share across repositories on-demand

Collaboration

1. We use the git rebase strategy to keep tracking meaningful commit message. Help to enable rebase when pull $ git config --local pull.rebase true
2. Follow TypeScript Style Guide Google
3. Follow Best-Practices in coding:
   1. Clean code make team happy
   2. Return early make code safer and use resource Efficiency
   3. Truthy & Falsy make code shorter
   4. SOLID Principles make clean code
   5. DRY & KISS avoid redundancy and make your code as simple as possible
4. Make buildable commit and pull latest code from main branch frequently
5. Follow the Semantic Versioning once we are ready for release
6. Use readable commit message karma to let us use it in the release notes

     /‾‾‾‾‾‾‾‾
🔔  <  Ring! Please use semantic commit messages
     \________


<type>(<scope>): ([issue number]) <subject>
    │      │        |             │
    |      |        |             └─> subject in present tense. Not capitalized. No period at the end.
    |      |        |
    │      │        └─> Issue number (optional): Jira Ticket or Issue number
    │      │
    │      └─> Scope (optional): eg. Articles, Profile, Core
    │
    └─> Type: chore, docs, feat, fix, refactor, style, ci, perf, build, or test.