Skip to content

Latest commit

 

History

History
86 lines (61 loc) · 2.04 KB

README.md

File metadata and controls

86 lines (61 loc) · 2.04 KB
Raw

JSDoc Folder

Automatically collapses JSDoc comment blocks by default when opening JavaScript and TypeScript files.

Why This Extension?

JSDoc comments can take up significant vertical space in your code editor. Long documentation blocks often make it harder to navigate and understand the actual code structure. This extension solves that problem by automatically folding JSDoc comments while preserving their first line, giving you the best of both worlds:

Features

  • Automatically folds JSDoc comment blocks when opening files
  • Preserves the first line (/** */) for visibility
  • Supports JavaScript, TypeScript, JSX, and TSX files
  • Configurable through VS Code settings

Usage

JSDoc comments will be automatically folded when you open a file:

/** This line stays visible
 * These lines will be
 * automatically folded
 * when you open the file
 */
function example() {}

Configuration

You can configure the extension through VS Code settings:

  1. Open VS Code Settings (⌘ + , on macOS or Ctrl + , on Windows/Linux)
  2. Search for "JSDoc Folder"
  3. Find the following settings:
  • jsdocFolder.autoFold: Enable/disable automatic folding of JSDoc comments
    • true (default): Automatically fold JSDoc comments when opening files
    • false: Leave JSDoc comments unfolded

You can also directly edit settings.json:

Requirements

  • Visual Studio Code ^1.80.0
  • Node.js >= 14.x

Development

  1. Clone the repository:
git clone https://github.com/aydgn/fold-jsdoc.git
cd fold-jsdoc
  1. Install dependencies:
bun install
# or
npm install
  1. Open VS Code:
code .
  1. Press F5 to launch the Extension Development Host
    • This opens a new VS Code window with your extension loaded
    • Open any JavaScript/TypeScript file with JSDoc comments to test

Building and Testing

  1. Package the extension:
npm run package
  1. The above command will generate a .vsix file that you can install locally:
code --install-extension fold-jsdoc-X.X.X.vsix

License

MIT