Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vdustr/doc-tab
Edit the doc comments in a new tab.
https://github.com/vdustr/doc-tab
comment documentation eslint javascript jsdoc markdown md prettier tsdoc typescript visual-studio-code vscode vscode-extension
Last synced: 2 months ago
JSON representation
Edit the doc comments in a new tab.
- Host: GitHub
- URL: https://github.com/vdustr/doc-tab
- Owner: VdustR
- License: mit
- Created: 2023-10-10T05:03:29.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-10T08:46:56.000Z (over 1 year ago)
- Last Synced: 2024-10-14T16:38:07.176Z (4 months ago)
- Topics: comment, documentation, eslint, javascript, jsdoc, markdown, md, prettier, tsdoc, typescript, visual-studio-code, vscode, vscode-extension
- Language: TypeScript
- Homepage: https://marketplace.visualstudio.com/items?itemName=VdustR.doc-tab
- Size: 126 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Doc Tab
Edit the doc comments in a new tab.
"Doc Tab" is a Visual Studio Code extension that allows you to edit the doc comments in a new tab.
## The Problem
Editors like VSCode support markdown preview for JSDoc / TSDoc, but it's often challenging to edit, format, and indent it within the comment block. This extension is designed to assist in editing doc comments in a new tab, providing the benefits of specific language features such as Markdown's syntax highlighting, intelligence, linting, and formatting.
## Usage
1. Choose or position the cursor within the documentation comment block.
2. Access the command palette:
- `Ctrl+Shift+P` on Windows/Linux
- `Cmd+Shift+P` on macOS
3. Enter `Doc Tab: Edit Comment In New Tab` and hit `Enter`.
4. Modify the documentation comment in the new tab.
5. Close the tab without saving to discard any alterations.
6. The changes will be applied to the documentation comment block. 🎉🎉
## Recommended Workflow
1. Format the code (using eslint, prettier, etc.).
2. Edit the documentation comments in a new tab. It's advisable to [preview](https://code.visualstudio.com/docs/languages/markdown#_markdown-preview) while editing.
3. Format the code in the new tab.
4. Close the tab without saving.
5. Format the code once again.
6. Reformat the documentation comments (using [Rewrap](https://marketplace.visualstudio.com/items?itemName=stkb.rewrap)).
[📽️ Youtube Demo](https://youtu.be/mC6cOQaAY-A)
## Recommended Extensions for Combined Use
- [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
- [eslint-stylistic](https://github.com/eslint-stylistic/eslint-stylistic)
- [Rewrap](https://marketplace.visualstudio.com/items?itemName=stkb.rewrap)
## License
[VdustR](https://github.com/VdustR) © [MIT](https://github.com/VdustR/doc-tab/LICENSE)