Add stricter TypeScript type checking

[mbland]

Most of this message is copied from:

• Bump to v1.0.6, bump vitest, mv {js,ts}config.json jsdoc-cli-wrapper#21 mbland/jsdoc-cli-wrapper@e0d287d
• Add strict type checking via TypeScript rollup-plugin-handlebars-precompiler#7 mbland/rollup-plugin-handlebars-precompiler@eb5b9a8
• Check rollup types, add jsdoc-plugin-typescript rollup-plugin-handlebars-precompiler#8 mbland/rollup-plugin-handlebars-precompiler@8b36b2a

After doing more research, it appears tsconfig.json is more broadly supported by editors and IDEs than jsconfig.json. For example, IntelliJ IDEA/WebStorm won't recognize it unless added to Settings > Editor > File Types > TypeScript.

Related changes include:

• Fixed the problems with vitest.config.js and ci/vitest.config.js such that the // @ts-nocheck directive is no longer necessary. Used ...(configDefaults.coverage.exclude || []) to avoid type errors due to configDefaults.coverage.exclude potentially being undefined.

• Moved a bunch of compiler options from the pnpm typecheck script into tsconfig.json.

• Added the rimraf npm to make sure pnpm prepack generates a new types/ directory without stale content.

• Added @types/{jsdom,istanbul-lib-coverage} as production dependencies.

• Bumped vitest to 1.2.0.

• Set .eslintrc to disable the no-undefined-types rule by extending "plugin:jsdoc/recommended-typescript-flavor-error". This is because the Handlebars types in lib/parser.js weren't trivial to replicate, and TypeScript finds those types just fine. This was based on advice from:

  ...the config plugin:jsdoc/recommended-typescript-error should
  disable the jsdoc/no-undefined-types rule because TypeScript itself
  is responsible for reporting errors about invalid JSDoc types.

  • no-undefined-types: false positives for built-in interface types in typescript mode gajus/eslint-plugin-jsdoc#888 (comment)

  And:

  If you are not using TypeScript syntax (your source files are still
  .js files) but you are using the TypeScript flavor within JSDoc
  (i.e., the default "typescript" mode in eslint-plugin-jsdoc) and you
  are perhaps using allowJs and checkJs options of TypeScript's
  tsconfig.json), you may use:

  {
    "extends": ["plugin:jsdoc/recommended-typescript-flavor"]
  }

  ...or to report with failing errors instead of mere warnings:

  {
    "extends": ["plugin:jsdoc/recommended-typescript-flavor-error"]
  }

  • https://github.com/gajus/eslint-plugin-jsdoc#eslintrc

  More background:

  • https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-undefined-types.md
  • Way to feed no-undefined-types additional files or have it auto-detect them (and finding unused types within the same set of files); avoid defects of tampering with no-unused-vars gajus/eslint-plugin-jsdoc#99
  • no-undefined-types and TypeScript gajus/eslint-plugin-jsdoc#1098
  • Question: Import typedef from another file? jsdoc/jsdoc#1537

• At the same time, extending "recommended-typescript-flavor-error" required adding the // eslint-disable-next-line no-unused-vars directive before each set of imports from lib/types.js. (Or adding // eslint-disable-line no-unused-vars on the same line if possible.)

• Added 'jsdoc-plugin-typescript' to the build to handle the TypeScript import().Type directives. This ended up pulling in the 'es-abstract' module, which blew up the pnpm-lock.yaml file. If I get an itch, I'll implement my own plugin one day and replace it.

• Finally, it seems IntelliJ IDEA's JSDoc type checking is stronger than TypeScript and VSCode. Fixed a few JSDoc type parameters to eliminate warnings in IntelliJ as well.

[coveralls]

Pull Request Test Coverage Report for Build 7547992748

• 0 of 0 changed or added relevant lines in 0 files are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage increased (+0.003%) to 99.437%

---

Totals
Change from base Build 7466007350:	0.003%
Covered Lines:	476
Relevant Lines:	476

---

💛 - Coveralls