{"id":22444575,"url":"https://github.com/aydgn/jsdoc-folder","last_synced_at":"2025-04-13T20:15:31.377Z","repository":{"id":266547441,"uuid":"896923296","full_name":"aydgn/jsdoc-folder","owner":"aydgn","description":"VSCode Extension that automatically collapses JSDoc comment blocks by default when opening JavaScript and TypeScript files.","archived":false,"fork":false,"pushed_at":"2024-12-07T16:37:30.000Z","size":28,"stargazers_count":6,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-27T10:47:44.694Z","etag":null,"topics":["javascript","jsdoc","jsdoc-plugin","jsdocs","typescript","vscode","vscode-extension"],"latest_commit_sha":null,"homepage":"https://marketplace.visualstudio.com/items/aydgn.jsdoc-folder/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aydgn.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-12-01T16:30:49.000Z","updated_at":"2025-01-27T07:44:27.000Z","dependencies_parsed_at":"2024-12-04T20:39:39.366Z","dependency_job_id":"d9c5c11c-db9f-4288-a474-f2fa86f8d675","html_url":"https://github.com/aydgn/jsdoc-folder","commit_stats":null,"previous_names":["aydgn/jsdoc-folder"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aydgn%2Fjsdoc-folder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aydgn%2Fjsdoc-folder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aydgn%2Fjsdoc-folder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aydgn%2Fjsdoc-folder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aydgn","download_url":"https://codeload.github.com/aydgn/jsdoc-folder/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248774966,"owners_count":21159534,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["javascript","jsdoc","jsdoc-plugin","jsdocs","typescript","vscode","vscode-extension"],"created_at":"2024-12-06T03:08:47.819Z","updated_at":"2025-04-13T20:15:31.341Z","avatar_url":"https://github.com/aydgn.png","language":"TypeScript","readme":"# JSDoc Folder\n\nAutomatically collapses JSDoc comment blocks by default when opening JavaScript and TypeScript files.\n\n## Why This Extension?\n\nJSDoc 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:\n\n## Features\n\n- Automatically folds JSDoc comment blocks when opening files\n- Preserves the first line `(/** */)` for visibility\n- Supports JavaScript, TypeScript, JSX, and TSX files\n- Configurable through VS Code settings\n\n## Usage\n\nJSDoc comments will be automatically folded when you open a file:\n\n```javascript\n/** This line stays visible\n * These lines will be\n * automatically folded\n * when you open the file\n */\nfunction example() {}\n```\n\n## Configuration\n\nYou can configure the extension through VS Code settings:\n\n1. Open VS Code Settings (`⌘ + ,` on macOS or `Ctrl + ,` on Windows/Linux)\n2. Search for \"`JSDoc Folder`\"\n3. Find the following settings:\n\n* `jsdocFolder.autoFold`: Enable/disable automatic folding of JSDoc comments\n  * `true` (default): Automatically fold JSDoc comments when opening files\n  * `false`: Leave JSDoc comments unfolded\n\nYou can also directly edit `settings.json`:\n\n## Requirements\n\n- Visual Studio Code ^1.80.0\n- Node.js \u003e= 14.x\n\n## Development\n\n1. Clone the repository:\n```bash\ngit clone https://github.com/aydgn/fold-jsdoc.git\ncd fold-jsdoc\n```\n\n2. Install dependencies:\n```bash\nbun install\n# or\nnpm install\n```\n\n3. Open VS Code:\n```bash\ncode .\n```\n\n4. Press `F5` to launch the Extension Development Host\n   - This opens a new VS Code window with your extension loaded\n   - Open any JavaScript/TypeScript file with JSDoc comments to test\n\n## Building and Testing\n\n1. Package the extension:\n```bash\nnpm run package\n```\n\n2. The above command will generate a `.vsix` file that you can install locally:\n```bash\ncode --install-extension fold-jsdoc-X.X.X.vsix\n```\n\n## License\n\n[MIT](LICENSE)","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faydgn%2Fjsdoc-folder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faydgn%2Fjsdoc-folder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faydgn%2Fjsdoc-folder/lists"}