Skip to content

Latest commit

 

History

History
98 lines (73 loc) · 5 KB

README.md

File metadata and controls

98 lines (73 loc) · 5 KB

Awesome JSDoc Awesome

A list of awesome JSDoc (GitHub) plugins, resources, etc.

Contents

Formatting

Learning

Documentation

  • typedoc - Create documentation using the TypeScript flavor of JSDoc (including documentation of plain JavaScript)
  • typedoc-plugin-missing-exports - Ensure typedoc gets referenced, non-exported items documented in addition to exported items.

Articles

Linting

Markdown

Parsing and Stringifying

  • comment-parser - JSDoc-like parsing and stringifying (to be semantically aware of jsdoc's tags, you will need to supply a custom parser like in eslint-plugin-jsdoc).
  • @es-joy/jsdoccomment - Allows JSDoc-aware tag semantics on top of comment-parser. Also has a number of utilities, e.g., converting parser AST to ESLint AST and VisitorKeys.
  • @es-joy/jsdoc-eslint-parser - A proof-of-concept ESLint parser integrating @babel/eslint-parser, comment-parser (via @es-joy/jsdoccomment), and jsdocttypeparser.

Type parsing

Schema usage

Type checking

  • typescript - Check plain JavaScript with TypeScript by using allowJs and checkJs in tsconfig.json.
  • bycontract - Validate structures with jsdoc expressions.
  • eslint-plugin-typelint - Allows JSON Schema (or Redux reducer) to be pointed to by jsdoc types with usage type-checked.
  • tern - Checking type usage against jsdoc. (Also interesting for notion of implicit typing--might there be a static but implicitly typed, ESLint-enforced subset of JavaScript (like asm.js) which can compile to more performant code without need to pollute code with types everywhere?.)

Visualizations