thelinuxlich / template_jsdoc_ts

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

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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


Languages

Language:HTML 60.6%Language:JavaScript 36.0%Language:CSS 2.0%Language:Shell 1.0%Language:TypeScript 0.4%