{"id":22486473,"url":"https://github.com/Kocal/jsdoc-vuejs","last_synced_at":"2025-08-02T19:31:58.965Z","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":"2023-01-03T16:47:40.000Z","size":4783,"stargazers_count":235,"open_issues_count":57,"forks_count":40,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-10-12T23:12:56.376Z","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":"2024-09-18T03:23: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,"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","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228078606,"owners_count":17865959,"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":["jsdoc","jsdoc-plugin","vue-files","vuejs"],"created_at":"2024-12-06T17:14:40.026Z","updated_at":"2024-12-06T17:15:51.643Z","avatar_url":"https://github.com/Kocal.png","language":"JavaScript","funding_links":["https://github.com/sponsors/Kocal","paypal.me/HAlliaume"],"categories":["JavaScript"],"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"}