tsdoc
ESLint
Our great sponsors
tsdoc | ESLint | |
---|---|---|
15 | 380 | |
4,655 | 24,281 | |
1.1% | 1.2% | |
6.1 | 9.7 | |
19 days ago | 3 days ago | |
TypeScript | JavaScript | |
MIT License | MIT License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
tsdoc
-
Jsdoc Cheatsheet
For what it’s worth, there’s also TSDoc[1] which is TypeScript’s sorta-equivalent spiritual successor, and notably uses the same format as JSDoc. Inline type annotation is great—and I vastly prefer it to JSDoc as a type annotation mechanism—but supporting the breadth of documentation capability in an inline code position would probably be unwieldy no matter how you try to accommodate it.
1: https://tsdoc.org/
-
What am I Missing (or Could Benefit From Using) For My Stack?
Docs? TSdoc + TypeDoc or DocFX. Of particular interest, this can be used to generate JSON schema's, useful for REST / GraphQL
-
Complete rewrite of ESLint (GitHub discussion by the creator)
Nope, they look the same, at a glance, but they're not the same. JSDoc and TSDoc are different standards, developed by different teams.
- tsc doesn't convert jsdoc types into real typescript
-
How to properly document components
JSDoc is a terrible standard. I would rather go for TypeScript + TSDoc, then use TypDoc to generate the actual documentation based on TS typings. Alternatively, you can go for Vue Styleguidist. It's an excellent tool, but, opposite to TSDoc it's not a standard, it's just a tool.
-
Using @microsoft/tsdoc for documenting functions
I am trying to use the @microsoft/tsdoc package to generate documentation for a given file. I followed the demo that hey have provided https://github.com/microsoft/tsdoc/tree/main/api-demo and it works for the sample input they provided, shown below.
-
Is it better to use the JSDoc return type or TypeScript return type?
Maybe this is of interest? https://tsdoc.org/
- TSDoc – Documentation Your TypeScript in Code
-
Neogen - The annotation toolkit you never knew you needed
Awesome, thank you! Would you be willing to support TSDoc ?
- Do you use JSdocs with TypeScript?
ESLint
-
Shared Data-Layer Setup For Micro Frontend Application with Nx Workspace
ESLint: A pluggable and configurable linter tool for identifying and reporting on patterns in JavaScript.
-
To Review or Not to Review: The Debate on Mandatory Code Reviews
Automating code checks with static code analysis allows us to enforce code styling effectively. By integrating tools into our workflow, we can identify errors at an early stage, while coding instead of blocking us at the end. For instance, flake8 checks Python code for style and errors, eslint performs similar checks for JavaScript, and prettier automatically formats code to maintain consistency.
-
Biome.js : Prettier+ESLint killer ?
If you're a developer, you're surely familiar with Prettier and ESLint. With over 8 years of existence, they have established themselves as references in the JavaScript ecosystem.
-
Most basic code formatting
eslint is used to avoid code errors
-
How to use Lefthooks in your node project?
No lint errors: The committed code does not contain any lint errors (eslint).
-
Git Project Configuration With Husky and ESLint
Let’s walk through the steps for a one-time setup to configure husky pre-commit and pre-push hooks, ESLint with code styles conventions, prettier code formatter, and lint-staged. Husky automatically runs a script on each commit or push. This is useful for linting files to enforce code styles that keeps the entire code base following conventions.
-
What is an Abstract Syntax Tree in Programming?
GitHub | Website
-
Shared Tailwind Setup For Micro Frontend Application with Nx Workspace
ESLint: A pluggable and configurable linter tool for identifying and reporting on patterns in JavaScript.
-
6 Tools To Help Keep Your Dependencies And Code More Secure
ESLint
-
Six Factors That Raise The Risk Of Bugs In A Codebase
1. Lack of Static Code Analysis Static code analysis tools like TypeScript and ESLint play a crucial role in identifying and preventing bugs. TypeScript provides static typing, enhancing the robustness of the code. ESLint detects issues and enforces coding standards. The absence of these tools can significantly elevate the likelihood of bugs due to the lack of early detection and guidance provided during development.
What are some alternatives?
typedoc - Documentation generator for TypeScript projects.
XO - ❤️ JavaScript/TypeScript linter (ESLint wrapper) with great defaults
vscode-docthis - JSDoc generator extension for Visual Studio Code.
Standard - 🌟 JavaScript Style Guide, with linter & automatic code fixer
compodoc - :notebook_with_decorative_cover: The missing documentation tool for your Angular, Nest & Stencil application
prettier - Prettier is an opinionated code formatter.
redoc - 📘 OpenAPI/Swagger-generated API Reference Documentation
JSHint - JSHint is a tool that helps to detect errors and potential problems in your JavaScript code
vim-doge - (Do)cumentation (Ge)nerator for nearly 20 languages 📚 Generate proper code documentation with a single keypress. ⚡️🔥
JSLint - JSLint, The JavaScript Code Quality and Coverage Tool
tree-sitter-comment - Tree-sitter grammar for comment tags like TODO, FIXME(user).
Babel (Formerly 6to5) - 🐠 Babel is a compiler for writing next generation JavaScript.