Skip to content

A template for JSDOC typechecking with Typescript + docs + lint + format + coverage + test

Notifications You must be signed in to change notification settings

thelinuxlich/template_jsdoc_ts

Repository files navigation

This repository showcases how you can have typechecking in JS files using Typescript and also generates documentation, inline testing, coverage and pre-commit hooks typechecking, linting and running the test suite + conventional-commit messages

Steps:

  • npm install
  • npm run docs
  • npm run test
  • npm run coverage
  • npm run type-coverage
  • npm run lint
  • npm run format

You can also optionally build the project with npm run build if you are developing a frontend or just want to remove the import.meta.vitest code. You might want to customize vitest.config.js to your project then.

About

A template for JSDOC typechecking with Typescript + docs + lint + format + coverage + test

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published