pretty-ts-errors
JSDoc
pretty-ts-errors | JSDoc | |
---|---|---|
13 | 70 | |
12,251 | 14,784 | |
- | 0.7% | |
6.3 | 9.3 | |
10 days ago | 4 days ago | |
TypeScript | JavaScript | |
MIT License | Apache License 2.0 |
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.
pretty-ts-errors
-
What is JSDoc and why you may not need typescript for your next project?
Besides the features TypeScript itself proposed, the most important thing it brought to the community was the ability to create cool features around this compiler that enhance the developer experience and productivity. Tools like tsserver, pretty ts errors, and many others are actively improving the ecosystem for both JavaScript and TypeScript writers.
-
Home made plugin - Better formatted TypeScript error messages
Being heavily inspired by VSCode plugin for prettifying TS error messages, I decided to try and create similar as Neovim plugin.
-
How to make type safe a function that receives a prisma.[modelName] ?
#1: VSCode extension that makes TypeScript errors prettier and human-readable | 28 comments #2: Those who know, know... | 63 comments #3: Announcing TypeScript 5.0 Beta | 24 comments
- How do I fix this Type error: No overload matches this call.
- Pretty TypeScript Errors VSCode Plugin
- [Neovim] Plugin assez erreurs comme celui-ci?
-
TS Formatted Errors
Is there anything similar to this project for neovim: https://github.com/yoavbls/pretty-ts-errors
- Pretty TypeScript Errors β Make TypeScript Errors Human-Readable in VSCode
-
VSCode extension that makes TypeScript errors prettier and human-readable
It is already reported though: https://github.com/yoavbls/pretty-ts-errors/issues/3
- Pretty errors plugin like this?
JSDoc
-
Figma's Journey to TypeScript
You may like JSDoc[1] if you just want some type-safety from the IDE without the compilation overhead.
Itβs done wonders when Iβve had to wrangle poorly commented legacy JavaScript codebases where most of the overhead is tracing what type the input parameters are.
Personally, Iβm impartial to TypeScript or JSDoc at this point. But Iβd rather have either over plain JavaScript.
[1] https://jsdoc.app/
-
Eloquent JavaScript 4th edition (2024)
I wholeheartedly agree. At most, I introduce JSDoc[1] to newer developers as standardising how parameters and whatnot are commented at least gets you better documentation and _some_ safety without adding any TS knowledge overhead.
[1] https://jsdoc.app/
-
Learn how to document JavaScript/TypeScript code using JSDoc & Typedoc
This is where JSDoc comes to save the day.
-
Add typing to your Javascript code (without Typescript, kinda) βπΌ
The best way to do this, of course, is with JSDoc. But something I always found awkward about jsdoc is defining the object types in the same file. So, after a lot of reading, I found a way to combine JSDoc with declaration type files from Typescript. Let me give you an example:
-
What is JSDoc and why you may not need typescript for your next project?
There is a lot of specific symbols presented on the JSDOC specification that can be found here: https://jsdoc.app
-
TypeScript Might Not Be Your God: Case Study of Migration from TS to JSDoc
JSDoc is a specification for the comment format in JavaScript. This specification allows developers to describe the structure of their code, data types, function parameters, and much more using special comments. These comments can then be transformed into documentation using appropriate tools.
-
Adding a search feature to my app
Working with new features, frameworks, and tools, the experience of reading documentation is a critical part of it. I have been lucky to work with projects that feature really easy to read documentation such as USWDS and Bun, but I've also had the misfortune to work with pretty terrible documentation like JSDoc. The JSDoc documentation lacks a search field which makes searching for specific items an ordeal and also does not cover many hidden use cases. It provides less than the bare minimum for what it needs to do - a lot of the time I am forced to rely on external user documentation elsewhere to use JSDoc effectively. That was why I was drawn to the search field in particular in Docusaurus.
-
JavaScript First, Then TypeScript
The Svelte team followed suit but motivated by the maintainer's developer experience as they migrated the project away from TypeScript in favor of plain JSDoc comments for type annotations instead.
-
No comments. Now what?
Even more relevant, tools like Javadoc, JSDoc, Doxygen, etc. read comments in a specific format to generate documentation. These comments do not affect readability. On the contrary, Javadocs are great for explaining how to use these entities. Combined with tools like my dear Doctest, we even get guarantees of accuracy and correctness!
-
The Complete 2023 Guide to Learning TypeScript - From Beginner to Advanced
Document types with JSDoc annotations
What are some alternatives?
format-ts-errors.nvim - Neovim plugin to format tsserver LSP errors
ESDoc - ESDoc - Good Documentation for JavaScript
pretty_hover - A small and customizable neovim plugin for pretty printing the hover information from LSP servers
documentation.js - :book: documentation for modern JavaScript
hover.nvim - Hover plugin framework for Neovim
Docusaurus - Easy to maintain open source documentation websites.
markmap-vscode - Integrate markmap into VSCode
apiDoc - RESTful web API Documentation Generator.
vscode-ibmi - π IBM i development extension for VS Code
YUIDoc - YUI Javascript Documentation Tool
diagnostic-window.nvim - Shows diagnostic messages in a separate window, which is particularly helpful for long message like those seen in typescript.
storybook - Storybook is a frontend workshop for building UI components and pages in isolation. Made for UI development, testing, and documentation.