Gathering detailed insights and metrics for rollup-plugin-vuedoc
Gathering detailed insights and metrics for rollup-plugin-vuedoc
Rollup plugin to generate markdown documentation from Vue.js component source with @vuedoc/md.
Installations
npm install rollup-plugin-vuedocDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Node Version
12.18.3
NPM Version
6.14.6
Releases
5
Languages
1
JavaScript
JavaScript (100%)
Developer
h-ikeda
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
MIT License
2 Stars
27 Commits
1 Forks
2 Watchers
3 Branches
1 Contributors
Updated on Jan 27, 2021
Maintainers
1
Package Meta Information
Latest Version
0.4.0
Package Id
rollup-plugin-vuedoc@0.4.0
Unpacked Size
25.74 kB
Size
5.62 kB
File Count
16
NPM Version
6.14.6
Node Version
12.18.3
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
rollup-plugin-vuedoc
Rollup plugin to generate markdown documentation from Vue.js component source with @vuedoc/md.
Usage
- Install the plugin.
1npm i -D rollup-plugin-vuedoc - Edit the config file to use the plugin.
1// rollup.config.js 2 3import vuedoc from 'rollup-plugin-vuedoc'; 4 5export default { 6 input: 'path/to/entry-point.js', 7 ...generalConfigurations, 8 plugins: [ 9 vuedoc({ test: /\.vue$/, prefix: 'docs' }), 10 ...otherPlugins, 11 ], 12}; - Run rollup.
- Markdown files will be created in the asset path.
Options
test
Generate markdown files only if the module ID matches the test. Can be a string, RegExp, or an array of them.
prefix
Path prefix for generated markdown files. Files will be put at <asset path>/<prefix>/<module's relative path>
intro/outro
String to be prepended before or appended after generated markdown strings. Can be a string or a function. Function will be called with an argument object including id of the module.
1export default { 2 ...generalConfigs, 3 plugins: [ 4 vuedoc({ intro: ({ id }) => `id` }), 5 ...otherPlugins, 6 ], 7}; 8 9// Generates markdown files starting with module's ID string.
index
If true, generate indix markdowns containing a directory name string as the title at each directory under the prefix path. If function is given, returning string will be the content of the index. Functions are called with a directory path.
replace
Replaces substrings of generated markdown strings. test property and replacement
property of the replace object will be passed to String.prototype.replace()
function.
1export default { 2 ...generalConfigs, 3 plugins: [ 4 vuedoc({ replace: { test: /to be replaced/g, replacement: 'replaced' }), 5 ...otherPlugins, 6 ], 7}; 8 9// String.prototype.replace(/to be replaced/g, 'replaced') will be applied.
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
dependency not pinned by hash detected -- score normalized to 3
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/h-ikeda/rollup-plugin-vuedoc/publish.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/h-ikeda/rollup-plugin-vuedoc/publish.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/h-ikeda/rollup-plugin-vuedoc/publish.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/h-ikeda/rollup-plugin-vuedoc/publish.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/h-ikeda/rollup-plugin-vuedoc/test.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/h-ikeda/rollup-plugin-vuedoc/test.yml/master?enable=pin
- Info: 0 out of 6 GitHub-owned GitHubAction dependencies pinned
- Info: 3 out of 3 npmCommand dependencies pinned
Reason
Found 0/19 approved changesets -- score normalized to 0
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/publish.yml:1
- Warn: no topLevel permission defined: .github/workflows/test.yml:1
- Info: no jobLevel write permissions found
Reason
no effort to earn an OpenSSF best practices badge detected
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
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 16 are checked with a SAST tool
Reason
30 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-93q8-gq69-wqmw
- 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-43f8-2h32-f4cj
- Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
- Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
- Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
- Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
- 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-5fw9-fq32-wv5p
- Warn: Project is vulnerable to: GHSA-rp65-9cf3-cjxr
- Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
- Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
- Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
- Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
- Warn: Project is vulnerable to: GHSA-w5p7-h5w8-2hfq
- Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
- Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693
- Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
- Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
Score
3
/10
Last Scanned on 2025-07-14
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More