{"id":19086018,"url":"https://github.com/shershen08/vue-styleguide-generator","last_synced_at":"2025-09-12T18:44:54.775Z","repository":{"id":143926765,"uuid":"79750220","full_name":"shershen08/vue-styleguide-generator","owner":"shershen08","description":"React inspired style guide generator for Vue.js","archived":false,"fork":false,"pushed_at":"2017-09-26T19:37:26.000Z","size":179,"stargazers_count":121,"open_issues_count":4,"forks_count":15,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-08-20T20:51:33.647Z","etag":null,"topics":["parser","style-guide","styleguide","vuejs","vuejs2"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/shershen08.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2017-01-22T22:26:40.000Z","updated_at":"2025-08-17T20:57:01.000Z","dependencies_parsed_at":"2023-09-06T22:02:13.956Z","dependency_job_id":null,"html_url":"https://github.com/shershen08/vue-styleguide-generator","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/shershen08/vue-styleguide-generator","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shershen08%2Fvue-styleguide-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shershen08%2Fvue-styleguide-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shershen08%2Fvue-styleguide-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shershen08%2Fvue-styleguide-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/shershen08","download_url":"https://codeload.github.com/shershen08/vue-styleguide-generator/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shershen08%2Fvue-styleguide-generator/sbom","scorecard":{"id":817942,"data":{"date":"2025-08-11","repo":{"name":"github.com/shershen08/vue-styleguide-generator","commit":"253db8fb302d6259a2b5c5fc8efe62dbbfd7dec7"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.6,"checks":[{"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":"Code-Review","score":0,"reason":"Found 2/27 approved changesets -- score normalized to 0","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":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"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":"Dangerous-Workflow","score":-1,"reason":"no workflows found","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":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"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":"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":"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":"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":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"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":"License","score":0,"reason":"license file not detected","details":["Warn: project does not have a license file"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"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 5 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"}}]},"last_synced_at":"2025-08-23T14:39:23.449Z","repository_id":143926765,"created_at":"2025-08-23T14:39:23.449Z","updated_at":"2025-08-23T14:39:23.449Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273034868,"owners_count":25034486,"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-08-31T02:00:09.071Z","response_time":79,"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":["parser","style-guide","styleguide","vuejs","vuejs2"],"created_at":"2024-11-09T02:58:05.253Z","updated_at":"2025-08-31T20:32:59.323Z","avatar_url":"https://github.com/shershen08.png","language":"JavaScript","funding_links":[],"categories":["Awesome Vue.js [![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/sindresorhus/awesome)","叫研发工具组","Components \u0026 Libraries","Dev Tools","Dev Tools [🔝](#readme)"],"sub_categories":["Development Tools","文档","Dev Tools","Docs"],"readme":"🙀 **[20/09/2017] Project discontinued** 🙀 \n\nFor purpose of having a demo of your Vuejs components please take a look at following projects that do really great job and are really handy for you dev workflow with Vuejs: [storybook for vuejs](https://github.com/storybooks/storybook) and [vue-styleguidist](https://github.com/vue-styleguidist/vue-styleguidist).\n\n# Vue js components styleguide generator 📚\n\n![dependencies status](https://david-dm.org/shershen08/vue-styleguide-generator/status.svg)\n\n\u003e Initially started after reading [this vue.js feature request](https://github.com/vuejs/vue-requests/issues/17).\nNow only basic proof of concept is available which can load folder with .vue files, parse it and extract basic props of it.\n\nTarget is to have some tool with at least some of the [React version](https://github.com/styleguidist/react-styleguidist) capabilities.\n\nIdea is to have what [vue-play](https://github.com/vue-play/vue-play) does but in automated way - with one task run, plus READMEs, etc.\n\n**Generate single html file containing all components listed with details and search out from your .vue project files.**\n\n### Questions \u0026 bugs\n\n - General questions please ping me on twitter [@legkoletat](https://twitter.com/legkoletat).\n - Bugs and inconsistencies please create [an issue](https://github.com/shershen08/vue-styleguide-generator/issues) . Please concider to adding more information on what is the codebase you're running the generator against, what errors (with code, if applicable) you got. To keep issues list clean and relevant issues with no feedback/details/activity will be closed within 3 days.\n\n\n## 1. Examples\n\n### Running on large components collections\n\n - Run with [Keen-UI](https://github.com/JosephusPaye/Keen-UI) repo produces the following [**DEMO html-file**](https://shershen08.github.io/vue-plugins-demo-static/Keen-UI-demo.html). \n - Run with [vuikit](https://github.com/vuikit/vuikit) repo produces the following [**DEMO html-file**](https://shershen08.github.io/vue-plugins-demo-static/vuikit-demo-index.html). \n\n### Output UI demo\n ![resulting output](https://raw.githubusercontent.com/shershen08/vue-styleguide-generator/master/demo-output.jpg)\n\n\n## 2. Setup\n\n  1. ```npm install vue-styleguide-generator --save-dev```\n\n  2. add to you package.json in script section - for example like this ```\"build-components\": \"node ./node_modules/vue-styleguide-generator/\"``` and then run ```npm run build-components``` from the root folder of the project.\n\n  🏃 You can also manually (or using Gulp/Grunt) run ```node ./node_modules/vue-styleguide-generator/```\n\n## 3. Usage\n\n✅ Works only for Vue 2.x projects.\n\n#### CLI options\n\n| Name | Type | Description | Default |\n| ---: | ---- |  ------ |------------ |\n| --src  | String|Source dir, will be recursively scanned|src|\n| --dest | String|Destination output dir, file index.html will be placed there| components-preview|\n| --exclude| RegExp|File mask to exclude certain type of files|/^\\./|\n| --locale|String|Output locale language|en|\n| --verbose| String|Output all details while processing| false|\n| --all| String|Do not ignore any components| false|\n| --o| String|Open browser preview after generating| false|\n\n E.g.: ```node ./node_modules/vue-styleguide-generator/ --src components --dest preview``` will read components from PROJECT_ROOT/components folder and provide a html page into PROJECT_ROOT/preview folder\n\n To see all parser error run with DEBUG: ```DEBUG=app node ./node_modules/vue-styleguide-generator/```\n\n#### How the components are iterated\n\n If you want to see more information about the component - add a .md file in the same directory.\n While retrieving the files the following assumptions are made:\n  - if there are files with the **same name** in one folder (e.g. ```/scr/partials/TabBar.vue``` and ```/scr/partials/TabBar.md```) it's assumed to be one component;\n  - if there are **only two** files in the folder and one is .vue and another is .md (e.g. ```/scr/TabBar/codez.vue``` and ```/scr/partials/readers.md```)  it's assumed to be one component;\n  - If there are \u003e1 .vue files in the folder and .md file that does not have the same name as one of the .vue files - this .md file is ignored\n  - Components with no props, no computed and no methods defined are considered to be a simple wrappers and not outputed\n\n\n  Found a bug or have a proposal - please [create an issue](https://github.com/shershen08/vue-styleguide-generator/issueshttps://github.com/shershen08/vue-styleguide-generator/issues) or tweet me [@legkoletat](https://twitter.com/legkoletat)!\n\n### Todos\n\n- improve parsing technique and/or configuration to deal with variety of components organisation approaches\n- \u003cs\u003esyntax highlighting\u003c/s\u003e\n- align parsing and display with [vue-js-component-style-guide](https://medium.com/tldr-tech/vue-js-component-style-guide-711988d5e94e)\n- core: move the demo-page to use Vue so that components can be generated from its declaration\n- ui: output extra component parameters (computable, data)\n- \u003cs\u003evarious use cases testing\u003c/s\u003e, added vuikit and Keen-UI links\n\n#### Contributions are welcome 👍!\n\nEspecially on following:\n - [translations](https://github.com/shershen08/vue-styleguide-generator/tree/master/i18n)\n - extra features\n - implementing SSR\n\n### Bugs and problems\n-  window object [may not be patched fully](https://github.com/shershen08/vue-styleguide-generator/blob/master/src/processor.js#L29) so some component's code execution may fail\n- 'vue-template-compiler' must be the same as the version of 'vue' you're using in your codebase. Now set to 2.1.10. may have to manually put to other version that's used in your project.'\n\n### Changelog\n\n **0.9.11**\n \n Now as from 0.9.11 also your `.js` files referenced from `.vue` files are supported.\n\n **0.9.15**\n \n Added `-o` option to open the browser.\n Refactoring the template. Added pt-br translation by [israelss](https://github.com/israelss).\n\n **0.9.18**\n \n UI improvements (UX of the search block, 'Copy' component code).\n\n\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshershen08%2Fvue-styleguide-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshershen08%2Fvue-styleguide-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshershen08%2Fvue-styleguide-generator/lists"}