@ts-dev-tools/core

Welcome to @ts-dev-tools/core 💎

Common Typescript dev tools

---

What's included

📦 Package scripts

• test: Run tests with jest
• lint: Run linter with eslint
• prepare: Self install / update

⚡ Git hooks

pre-commit

• Run linter against staged git files with lint-staged
• Run prettier against changed files with pretty-quick

commit-msg

• Lint conventional commit message with commit-lint

pre-push

• Run linter
• Execute Typescript compiler with tsc
• Run tests

👕 Linter

• Install and configure eslint with recommended rules

• Configure Eslint to works with typescript

• Install and configure the following Eslint plugins:

  • eslint-plugin-import: ES2015+ (ES6+) import/export syntax
  • eslint-plugin-jest: Rules for Jest
  • eslint-plugin-node: Additional ESLint's rules for Node.js
  • eslint-plugin-promise: Enforce best practices for JavaScript promises.

💄 Prettier

• Install and configure Prettier
• Configure Prettier to works with Eslint
• Install and configure the following Prettier plugins:
  • prettier-plugin-import-sort: sort imports using import-sort for javascript and typescript files.

🧪 Tests

• Install and configure Jest
• Install and configure ts-jest to make Jest and Typescript work together

📖 Types

• @types/node
• @types/jest

---

Usage

1. Install

npm install --dev @ts-dev-tools/core

Or

yarn add --dev @ts-dev-tools/core

2. Enable ts-dev-tools

npx ts-dev-tools install

Or

yarn ts-dev-tools install

⚠️ If your package is not private and you're publishing it on a registry like npmjs.com, you need to disable postinstall script using pinst. Otherwise, postinstall will run when someone installs your package and result in an error.