{"id":16590414,"url":"https://github.com/kocal/jsdoc-vuejs","last_synced_at":"2025-10-07T23:58:52.270Z","repository":{"id":37850905,"uuid":"99959429","full_name":"Kocal/jsdoc-vuejs","owner":"Kocal","description":"📖 A JSDoc plugin for documenting .vue files. ","archived":false,"fork":false,"pushed_at":"2025-07-21T14:45:24.000Z","size":2524,"stargazers_count":237,"open_issues_count":29,"forks_count":41,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-10-07T11:19:51.980Z","etag":null,"topics":["jsdoc","jsdoc-plugin","vue-files","vuejs"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/Kocal.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":"Kocal","custom":"paypal.me/HAlliaume"}},"created_at":"2017-08-10T19:47:21.000Z","updated_at":"2025-07-21T13:34:57.000Z","dependencies_parsed_at":"2023-02-01T08:01:12.264Z","dependency_job_id":null,"html_url":"https://github.com/Kocal/jsdoc-vuejs","commit_stats":null,"previous_names":[],"tags_count":41,"template":false,"template_full_name":null,"purl":"pkg:github/Kocal/jsdoc-vuejs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kocal%2Fjsdoc-vuejs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kocal%2Fjsdoc-vuejs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kocal%2Fjsdoc-vuejs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kocal%2Fjsdoc-vuejs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Kocal","download_url":"https://codeload.github.com/Kocal/jsdoc-vuejs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kocal%2Fjsdoc-vuejs/sbom","scorecard":{"id":79590,"data":{"date":"2025-08-11","repo":{"name":"github.com/Kocal/jsdoc-vuejs","commit":"e73bd4f74bfd9bf6f52d7a75579d416a44f73688"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"name":"Code-Review","score":2,"reason":"Found 1/4 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":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"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":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/ci.yml:1","Warn: no topLevel permission defined: .github/workflows/release.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":"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":"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/ci.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/Kocal/jsdoc-vuejs/ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/Kocal/jsdoc-vuejs/ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:39: update your workflow using https://app.stepsecurity.io/secureworkflow/Kocal/jsdoc-vuejs/ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/Kocal/jsdoc-vuejs/release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/Kocal/jsdoc-vuejs/release.yml/master?enable=pin","Info:   0 out of   5 GitHub-owned GitHubAction 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":"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":"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":"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":"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":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"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":"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":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 28 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":"70 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-p28h-cc7q-c4fg","Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw","Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9","Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm","Warn: Project is vulnerable to: GHSA-6vfc-qv3f-vr6c","Warn: Project is vulnerable to: GHSA-5v2h-r2cx-5xgj","Warn: Project is vulnerable to: GHSA-rrrm-qjm4-v8hf","Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-8hfj-j24r-96c4","Warn: Project is vulnerable to: GHSA-wc69-rhjr-hc9g","Warn: Project is vulnerable to: GHSA-rp65-9cf3-cjxr","Warn: Project is vulnerable to: GHSA-566m-qj78-rww5","Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j","Warn: Project is vulnerable to: GHSA-rjqq-98f6-6j3r","Warn: Project is vulnerable to: GHSA-mjxr-4v3x-q3m4","Warn: Project is vulnerable to: GHSA-cgfm-xwp7-2cvr","Warn: Project is vulnerable to: GHSA-rm97-x556-q36h","Warn: Project is vulnerable to: GHSA-mxhp-79qh-mcx6","Warn: Project is vulnerable to: GHSA-cf4h-3jhx-xvhq","Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6","Warn: Project is vulnerable to: GHSA-h5c3-5r3r-rr8q","Warn: Project is vulnerable to: GHSA-rmvr-2pp2-xj38","Warn: Project is vulnerable to: GHSA-xx4v-prfh-6cgc","Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw","Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw","Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25","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-gxpj-cx7g-858c","Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq","Warn: Project is vulnerable to: GHSA-phwq-j96m-2c2q","Warn: Project is vulnerable to: GHSA-ghr5-ch3p-vcr6","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97","Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j","Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22","Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp","Warn: Project is vulnerable to: GHSA-896r-f27r-55mw","Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h","Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq","Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488","Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-qrpm-p2h7-hrv2","Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55","Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g","Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p","Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9","Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp","Warn: Project is vulnerable to: GHSA-x2pg-mjhr-2m5x","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-44c6-4v22-4mhx","Warn: Project is vulnerable to: GHSA-4x5v-gmq8-25ch","Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9","Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw","Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc","Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh","Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p","Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36","Warn: Project is vulnerable to: GHSA-52f5-9888-hmc6","Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v","Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3","Warn: Project is vulnerable to: GHSA-38fc-wpqx-33j7","Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7","Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q"],"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-15T05:31:25.431Z","repository_id":37850905,"created_at":"2025-08-15T05:31:25.431Z","updated_at":"2025-08-15T05:31:25.431Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278866932,"owners_count":26059671,"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","status":"online","status_checked_at":"2025-10-07T02:00:06.786Z","response_time":59,"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":["jsdoc","jsdoc-plugin","vue-files","vuejs"],"created_at":"2024-10-11T23:12:53.073Z","updated_at":"2025-10-07T23:58:52.212Z","avatar_url":"https://github.com/Kocal.png","language":"JavaScript","funding_links":["https://github.com/sponsors/Kocal","paypal.me/HAlliaume"],"categories":[],"sub_categories":[],"readme":"JSDoc for VueJS\n===============\n\n[![npm version](https://badge.fury.io/js/jsdoc-vuejs.svg)](https://badge.fury.io/js/jsdoc-vuejs)\n[![Build Status (Travis)](https://travis-ci.org/Kocal/jsdoc-vuejs.svg?branch=master)](https://travis-ci.org/Kocal/jsdoc-vuejs)\n[![Build Status (AppVeyor)](https://ci.appveyor.com/api/projects/status/a36pui6w1qhqq582?svg=true)](https://ci.appveyor.com/project/Kocal/jsdoc-vuejs)\n[![codecov](https://codecov.io/gh/Kocal/jsdoc-vuejs/branch/master/graph/badge.svg)](https://codecov.io/gh/Kocal/jsdoc-vuejs)\n[![Codacy Badge](https://api.codacy.com/project/badge/Grade/850b7601f2bf4e8787a6aadbafa8afef)](https://www.codacy.com/app/kocal/jsdoc-vuejs?utm_source=github.com\u0026amp;utm_medium=referral\u0026amp;utm_content=Kocal/jsdoc-vuejs\u0026amp;utm_campaign=Badge_Grade)\n\nA JSDoc plugin for listing props, data, computed data, and methods from `.vue` files.\n\n:warning: This branch is for Vue 3. If you still use Vue 2, please see [`3.x` branch](https://github.com/Kocal/jsdoc-vuejs/tree/3.x).\n\n---\n\n## Requirements\n\n- Node 10+\n- Vue 3\n\n## Installation\n\n```bash\n$ npm install --save-dev jsdoc jsdoc-vuejs\n```\n\nYou also need to install `@vue/compiler-sfc` that match your Vue version:\n\n```bash\n$ npm install --save-dev @vue/compiler-sfc\n```\n\n## Usage\n\nYour should update your JSDoc configuration to enable JSDoc-VueJS:\n\n```json\n{\n  \"plugins\": [\n    \"node_modules/jsdoc-vuejs\"\n  ],\n  \"source\": {\n    \"includePattern\": \"\\\\.(vue|js)$\"\n  }\n}\n```\n\nUpdate your .vue files with one of the following tags:\n\n- `@vue-prop`\n- `@vue-data`\n- `@vue-computed`\n- `@vue-event`\n\nAll of those tags work the same way than [`@param` tag](http://usejsdoc.org/tags-param.html).\n\n```vue\n\u003ctemplate\u003e\n  \u003cdiv\u003eHello world!\u003c/div\u003e\n\u003c/template\u003e\n\n\u003cscript\u003e\n  /**\n   * @vue-prop {Number} initialCounter - Initial counter's value\n   * @vue-prop {Number} [step=1] - Step\n   * @vue-data {Number} counter - Current counter's value\n   * @vue-computed {String} message\n   * @vue-event {Number} increment - Emit counter's value after increment\n   * @vue-event {Number} decrement - Emit counter's value after decrement\n   */\n  export default {\n    props: {\n      initialCounter: {\n        type: Number,\n        required: true,\n      },\n      step: {\n        type: Number,\n        default: 1,\n      },\n    },\n    data () {\n      return {\n        counter: 0,\n      }\n    },\n    computed: {\n      message() {\n        return `Current value is ${this.counter}`;\n      }\n    },\n    methods: {\n      increment() {\n        this.counter += 1;\n        this.$emit('increment', this.counter);\n      },\n      decrement() {\n        this.counter -= 1;\n        this.$emit('decrement', this.counter);\n      }\n    }\n  }\n\u003c/script\u003e\n```\n\n## Supported templates\n\nThe rendering engine has been rewritten in v2, it can supports every JSDoc templates that exists.\n\nActually, it supports 4 templates:\n- Default\n- [Docstrap](https://github.com/docstrap/docstrap)\n- [Minami](https://github.com/nijikokun/minami)\n- [Tui](https://github.com/nhnent/tui.jsdoc-template)\n\nIf you use a template that is not supported, it will use the default one as a fallback.\n\nFeel free to open an issue/pull request if your template is not supported!\n\n\u003cdetails\u003e\n\u003csummary\u003eDefault\u003c/summary\u003e\n\n![](./screenshots/templates/default.png)\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003eDocstrap\u003c/summary\u003e\n\n![](./screenshots/templates/docstrap.png)\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003eMinami\u003c/summary\u003e\n\n![](./screenshots/templates/minami.png)\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003eTui\u003c/summary\u003e\n\n![](./screenshots/templates/tui.png)\n\n\u003c/details\u003e\n\n## Testing\n\n### Install Dependencies\n\n```bash\n$ git clone https://github.com/Kocal/jsdoc-vuejs\n$ cd jsdoc-vuejs\n$ yarn install\n\n# For testing the example docs\n$ cd example\n$ yarn install\n```\n\n#### Generate documentations\n\n```bash\n$ cd example\n\n# Generate docs for every renderer\n$ yarn docs:all\n\n# or one by one\n$ yarn docs # default jsdoc template\n$ yarn docs:docstrap\n$ yarn docs:minami\n$ yarn docs:tui\n```\n\n### Unit\n\n```bash\n$ yarn test\n```\n\n### E2E\n\nBefore running integration tests with [Cypress](https://cypress.io), \nyou should generate documentation with all renderers:\n\n```bash\n$ cd example\n$ yarn docs:all\n```\n\nAnd then run Cypress:\n\n```bash\n$ cd ..\n$ yarn cypress run\n```\n\n## License\n\nMIT.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkocal%2Fjsdoc-vuejs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkocal%2Fjsdoc-vuejs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkocal%2Fjsdoc-vuejs/lists"}