A skeleton project for typescript projects.
- 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
build
: Compile the typescript project into thebuild
folder.build:clean
: Remove the build foldertest
: Run jest teststest:coverage
: Run jest tests with coverage reporttest:clean
: Remove the tests coverage resultlint
: Lint codebaselint:fix
: Lint codebase and fix problemsprettier:check
: Check if files in thesrc
andtests
folders are formatted according to the prettier configurations.prettier:write
: Format files in thesrc
andtests
folders according to the prettier configurations.