skeleton-typescript-project

A skeleton project for typescript projects.

Setup

• Update package information:
  • Name
  • Version
  • Description
  • Main entry
  • Author
  • Keywords
  • Repository
  • Bugs
  • License
  • Homepage
• Update repository actions
  • Dependabot: automatic dependencies update
  • CI: tests and build validation
  • Commitlint: Lint commit messages
  • Dependabot auto merge: Enable auto-merge on dependabot's pull requests
    • For this action to work properly it is necessary to allow auto-merge on the repository settings
• Setup git hooks to enable commitizen on git commit:
  • ./setup-git-hooks.sh
• Review TypeScript configurations at tsconfig.json
• Review ESLint configurations at .eslintrc.js
• Review Prettier configurations at .prettierrc.json

Functionalities

• TypeScript
• Jest
• TypeScript ESLint
• Prettier
• Commitizen

Scripts

• build: Compile the typescript project into the build folder.
• build:clean: Remove the build folder
• test: Run jest tests
• test:coverage: Run jest tests with coverage report
• test:clean: Remove the tests coverage result
• lint: Lint codebase
• lint:fix: Lint codebase and fix problems
• prettier:check: Check if files in the src and tests folders are formatted according to the prettier configurations.
• prettier:write: Format files in the src and tests folders according to the prettier configurations.