JSDoc
vite
JSDoc | vite | |
---|---|---|
70 | 804 | |
14,832 | 65,479 | |
0.6% | 1.1% | |
9.3 | 9.8 | |
7 days ago | 5 days ago | |
JavaScript | TypeScript | |
Apache License 2.0 | 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.
JSDoc
-
How to document your JavaScript package
Thanks to JSDoc it's easy to write documentation that is coupled with your code and can be consumed by users in a variety of formats. When combined with a modern publishing flow like JSR, you can easily create comprehensive documentation for your package that not only fits within your workflow, but also integrates directly in the tools your users consume your package with. This blog post aims to cover best practices when writing JSDoc-style comments to get your users up and running as quickly as possible:
-
Deep Dive: Google Apps Script - Testing APIs and Automating Sheets
Note: For simplicity, I will omit the JavaScript documentation, but for a production grade code you may want to add the documentation (see jsdoc.app website for more).
-
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.
vite
- Migrando do CRA para Vite
-
Why and How to Migrate Your React App from CRA to Vite
In Vite, legacy browsers can be supported via the official @vitejs/plugin-legacy plugin, it also provides Browselist like configuration.
-
Switching to Vite from React-Scripts
I have a silly react project that I’m working on that I made using create-react-app. By default, these kinds of projects build and run using react-scripts which uses webpack under the hood for building projects. Vite is generally known to be faster than Webpack ⚡ so I was curious about how to swap them.
-
Converting couple thousands Js/Ts files that contains JSX content to jsx extension
Without a transpiler in the process, the jsx left as is: https://github.com/vitejs/vite/discussions/3448
-
Series - Converting Large Codebase Project to Vite
We wanted to change the bundler to vite for two main reasons:
-
How to Start & Setup a React project in 2024 (7 Different Ways Based on Use Cases)
You can see all create-vite templates for other libraries. You can also learn more about vite in its documentation website.
-
Svelte Series-2: How to install Svelte
After we have installed the Node environment, we can use Vite to install. Because the use of Vite has a higher version of Node.js requirements, so I recommend that you install a relatively new Node.js. currently I use the version for v18.15.0.
-
🇫🇷 Base d'une application RiotJS avec Vite
import { defineConfig } from 'vite' import riot from 'rollup-plugin-riot' export default defineConfig({ root : process.cwd() + '/client', plugins : [riot()], build: { minify : 'esbuild', /** https://vitejs.dev/config/build-options.html#build-minify */ target : 'esnext' /** https://vitejs.dev/config/build-options.html#build-target */ } })
-
Comparing Hattip vs. Express.js for modern app development
As of this writing, initializing a Hattip project requires some manual commands. However, keep in mind that a zero-config development environment based on Vite is in the works.
-
React TypeScript - Vite + React
import { defineConfig } from 'vite' import react from '@vitejs/plugin-react' // https://vitejs.dev/config/ export default defineConfig({ plugins: [react()], server: { port: 4200, } })
What are some alternatives?
ESDoc - ESDoc - Good Documentation for JavaScript
Next.js - The React Framework
documentation.js - :book: documentation for modern JavaScript
parcel - The zero configuration build tool for the web. 📦🚀
Docusaurus - Easy to maintain open source documentation websites.
esbuild - An extremely fast bundler for the web
apiDoc - RESTful web API Documentation Generator.
swc - Rust-based platform for the Web
YUIDoc - YUI Javascript Documentation Tool
astro - The web framework for content-driven websites. ⭐️ Star to support our work!
storybook - Storybook is a frontend workshop for building UI components and pages in isolation. Made for UI development, testing, and documentation.
Rollup - Next-generation ES module bundler