{"id":49858977,"url":"https://github.com/fardad-dev/prettier-plugin-jsdoc","last_synced_at":"2026-05-14T21:01:21.916Z","repository":{"id":37009385,"uuid":"253229499","full_name":"fardad-dev/prettier-plugin-jsdoc","owner":"fardad-dev","description":"A Prettier plugin to format JSDoc comments.","archived":false,"fork":false,"pushed_at":"2026-05-09T17:01:02.000Z","size":1076,"stargazers_count":271,"open_issues_count":21,"forks_count":35,"subscribers_count":2,"default_branch":"master","last_synced_at":"2026-05-13T22:39:32.480Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","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/fardad-dev.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2020-04-05T12:28:22.000Z","updated_at":"2026-05-13T13:04:42.000Z","dependencies_parsed_at":"2023-12-12T12:26:25.728Z","dependency_job_id":"ce4c89d6-bcc0-42d3-8e72-cda7f1cd91d3","html_url":"https://github.com/fardad-dev/prettier-plugin-jsdoc","commit_stats":{"total_commits":378,"total_committers":19,"mean_commits":"19.894736842105264","dds":"0.16666666666666663","last_synced_commit":"60776a459d85e5a69ab1747dfb5e80d4c739763b"},"previous_names":["fardad-dev/prettier-plugin-jsdoc"],"tags_count":103,"template":false,"template_full_name":null,"purl":"pkg:github/fardad-dev/prettier-plugin-jsdoc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fardad-dev%2Fprettier-plugin-jsdoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fardad-dev%2Fprettier-plugin-jsdoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fardad-dev%2Fprettier-plugin-jsdoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fardad-dev%2Fprettier-plugin-jsdoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fardad-dev","download_url":"https://codeload.github.com/fardad-dev/prettier-plugin-jsdoc/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fardad-dev%2Fprettier-plugin-jsdoc/sbom","scorecard":{"id":469333,"data":{"date":"2025-08-11","repo":{"name":"github.com/hosseinmd/prettier-plugin-jsdoc","commit":"2c6d363f7fb0cdb0271d8ff7239238e79583cb8a"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"name":"Code-Review","score":2,"reason":"Found 8/30 approved changesets -- score normalized to 2","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Maintained","score":3,"reason":"4 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 3","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/test.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/hosseinmd/prettier-plugin-jsdoc/test.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/hosseinmd/prettier-plugin-jsdoc/test.yml/master?enable=pin","Warn: npmCommand not pinned by hash: .github/workflows/test.yml:27","Info:   0 out of   2 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   1 npmCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 8 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"12 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-19T13:24:46.700Z","repository_id":37009385,"created_at":"2025-08-19T13:24:46.700Z","updated_at":"2025-08-19T13:24:46.700Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33043249,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-13T13:14:54.681Z","status":"online","status_checked_at":"2026-05-14T02:00:06.663Z","response_time":57,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2026-05-14T21:01:20.826Z","updated_at":"2026-05-14T21:01:21.896Z","avatar_url":"https://github.com/fardad-dev.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![NPM](https://nodei.co/npm/prettier-plugin-jsdoc.png)](https://nodei.co/npm/prettier-plugin-jsdoc/)\n\n[![Installation size](https://packagephobia.now.sh/badge?p=prettier-plugin-jsdoc)](https://packagephobia.now.sh/result?p=prettier-plugin-jsdoc)\n\n# prettier-plugin-jsdoc\n\nPrettier plugin for formatting comment blocks and converting to a standard.\nMatch with Visual Studio Code and other IDEs that support JSDoc and comments as Markdown.\n\nMany good examples of how this plugin works are in the [`/tests`](/tests) directory.\nCompare tests and their [snapshots](/tests//__snapshots__).\n\nConfigured with best practices of JSDoc style guides.\n\n## Contents\n\n- [Installation](#installation)\n- [Configuration](#configuration)\n- [Ignore](#ignore)\n- [Examples](#examples)\n- [Options](#options)\n- [Supported Prettier versions](#supported-prettier-versions)\n- [Contributing](#contributing)\n- [Links](#links)\n- [Acknowledge](#acknowledge)\n\n## Installation\n\n1. [Install](https://prettier.io/docs/en/install.html) and [configure](https://prettier.io/docs/en/configuration) Prettier\n2. Install `prettier-plugin-jsdoc`:\n\n```sh\nnpm install prettier-plugin-jsdoc --save-dev\n```\n\n```sh\nyarn add prettier-plugin-jsdoc --dev\n```\n\n## Configuration\n\nAdd `prettier-plugin-jsdoc` to your `plugins` list.\n\n**Important:** When using multiple plugins, add `prettier-plugin-jsdoc` to the **end** of the plugins list.\n\n`.prettierrc`:\n\n```json\n{\n  \"plugins\": [\"prettier-plugin-jsdoc\"]\n}\n```\n\nWith other plugins:\n\n```json\n{\n  \"plugins\": [..., \"prettier-plugin-jsdoc\"]\n}\n```\n\n`prettier.config.js`:\n\n```js\nexport default {\n  plugins: [\"prettier-plugin-jsdoc\"],\n};\n```\n\nIf you want to ignore some types of files, use `overrides` with an empty `plugins`:\n\n```json\n{\n  \"plugins\": [\"prettier-plugin-jsdoc\"],\n  \"overrides\": [\n    {\n      \"files\": \"*.tsx\",\n      \"options\": {\n        \"plugins\": []\n      }\n    }\n  ]\n}\n```\n\n## Ignore\n\nTo prevent Prettier from formatting, use `/* */` or `//` instead of /\\*\\* \\*/, or see [Ignoring Code](https://prettier.io/docs/en/ignore#javascript).\n\n## Examples\n\n#### Single line\n\n```js\n/**\n * @param {  string   }    param0 description\n */\nfunction fun(param0) {}\n```\n\nFormats to:\n\n```js\n/** @param {string} param0 Description */\nfunction fun(param0) {}\n```\n\n#### React component\n\n```js\n/**\n * @type {React.FC\u003c{   message:string}   \u003e}\n */\nconst Component = memo(({ message }) =\u003e {\n  return \u003cp\u003e{message}\u003c/p\u003e;\n});\n```\n\nFormats to:\n\n```js\n/** @type {React.FC\u003c{message: string}\u003e} */\nconst Component = memo(({ message }) =\u003e {\n  return \u003cp\u003e{message}\u003c/p\u003e;\n});\n```\n\n#### TypeScript objects\n\n```js\n/**\n @typedef {\n    {\n        \"userId\": {\n        \"profileImageLink\": *,\n        \"isBusinessUser\": \"isResellerUser\"|\"isBoolean\"|  \"isSubUser\" |    \"isNot\",\n        \"shareCode\": number,\n        \"referredBy\": any,\n        },\n        id:number\n      }\n     } User\n     */\n```\n\nFormat to:\n\n```js\n/**\n * @typedef {{\n *   userId: {\n *     profileImageLink: any;\n *     isBusinessUser: \"isResellerUser\" | \"isBoolean\" | \"isSubUser\" | \"isNot\";\n *     shareCode: number;\n *     referredBy: any;\n *   };\n *   id: number;\n * }} User\n */\n```\n\n#### Example\n\nAdd code to `@examples` tag.\n\n```js\n/**\n * @examples\n *   var one= 5\n *   var two=10\n *\n *   if(one \u003e 2) { two += one }\n */\n```\n\nFormats to:\n\n```js\n/**\n * @example\n *   var one = 5;\n *   var two = 10;\n *\n *   if (one \u003e 2) {\n *     two += one;\n *   }\n */\n```\n\n#### Description\n\n`@description` is formatted as Markdown so that you can use any features of Markdown on that.\nLike code tags (` ```js `), header tags like `# Header`, or other Markdown features.\n\n## Options\n\n| Key                                 | Type                              | Default      | Description                                                                                                                                                             |\n| :---------------------------------- | :-------------------------------- | :----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `jsdocSpaces`                       | Number                            | 1            |\n| `jsdocDescriptionWithDot`           | Boolean                           | false        |\n| `jsdocDescriptionTag`               | Boolean                           | false        |\n| `jsdocVerticalAlignment`            | Boolean                           | false        |\n| `jsdocKeepUnParseAbleExampleIndent` | Boolean                           | false        |\n| `jsdocCommentLineStrategy`          | (\"singleLine\",\"multiline\",\"keep\") | \"singleLine\" |\n| `jsdocCapitalizeDescription`        | Boolean                           | true         |\n| `jsdocSeparateReturnsFromParam`     | Boolean                           | false        | Adds a space between last `@param` and `@returns`                                                                                                                       |\n| `jsdocSeparateTagGroups`            | Boolean                           | false        | Adds a space between tag groups                                                                                                                                         |\n| `jsdocPreferCodeFences`             | Boolean                           | false        | Always fence code blocks (surround them by triple backticks)                                                                                                            |\n| `jsdocEmptyCommentStrategy`         | (\"remove\",\"keep\")                 | \"remove\"     | How to handle empty JSDoc comment blocks                                                                                                                                |\n| `jsdocBracketSpacing`               | Boolean                           | false        | Whether to add spaces inside JSDoc type brackets. `{string}` (false) vs `{ string }` (true)                                                                             |\n| `tsdoc`                             | Boolean                           | false        | See [TSDoc](#tsdoc)                                                                                                                                                     |\n| `jsdocPrintWidth`                   | Number                            | undefined    | If you don't set the value to `jsdocPrintWidth`, `printWidth` will be used as `jsdocPrintWidth`                                                                         |\n| `jsdocLineWrappingStyle`            | String                            | \"greedy\"     | \"greedy\": lines wrap as soon as they reach `printWidth`. \"balance\": preserve existing line breaks if lines are shorter than `printWidth`, otherwise use greedy wrapping |\n| `jsdocTagsOrder`                    | String (object)                   | undefined    | See [Custom Tags Order](doc/CUSTOM_TAGS_ORDER.md)                                                                                                                       |\n\n### TSDoc\n\nWe hope to support the whole [TSDoc](https://tsdoc.org/).\nIf we missed something, please [create an issue](https://github.com/hosseinmd/prettier-plugin-jsdoc/issues/new).\n\nTo enable, add:\n\n```json\n{\n  \"tsdoc\": true\n}\n```\n\n## Supported Prettier versions\n\n| Plugin version | Prettier version |\n| -------------- | ---------------- |\n| 1.0.0+         | 3.0.0+           |\n| 0.4.2          | 2.x+             |\n\n## Contributing\n\n1. Fork and clone the repository\n2. [Install Yarn](https://yarnpkg.com/getting-started/install)\n3. Install project dependencies:\n\n   ```sh\n   yarn install\n   ```\n\n4. Make changes and make sure that tests pass:\n   ```js\n   yarn run test\n   ```\n5. Update or add tests to your changes if needed\n6. Create PR\n\n## Links\n\n- [Prettier](https://prettier.io)\n- [JSDoc](https://jsdoc.app)\n\n## Acknowledge\n\nThis project extended from the @gum3n worked project on GitLab.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffardad-dev%2Fprettier-plugin-jsdoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffardad-dev%2Fprettier-plugin-jsdoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffardad-dev%2Fprettier-plugin-jsdoc/lists"}