npmpackage.info

Gathering detailed insights and metrics for vue-docgen-loader

Other packages similar to vue-docgen-loader

react-docgen-typescript-loader

3.7.2

Webpack loader to generate docgen information from TypeScript React components.

vue-docgen-api

4.79.2

Toolbox to extract information from Vue component files for documentation generation purposes.

vue-inbrowser-compiler-independent-utils

4.71.1

the part of vue-inbrowser-compiler-utils that contains no vue dependency

react-docgen-typescript

2.2.2

[![Build Status](https://github.com/styleguidist/react-docgen-typescript/actions/workflows/nodejs.yml/badge.svg)](https://github.com/styleguidist/react-docgen-typescript/actions/workflows/nodejs.yml)

Gathering detailed insights and metrics for vue-docgen-loader

vue-docgen-loader

Vue docgen loader for webpack

2.0.1

MIT

JavaScript

336.98 kB

59,048,894 3.9

Installations

npm install vue-docgen-loader

Pull Requests

Open

0

Total

9

Closed

0

Merged

9

Issues

Open

0

Total

8

Closed

8

Releases

v1.5.1

Published on 10 Apr 2022

View all 1 releases

Developer

pocka

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

>= 12

Typescript Support

No

Node Version

18.20.4

NPM Version

10.7.0 Statistics

13 Stars

63 Commits

4 Forks

3 Watching

1 Branches

4 Contributors

Updated on 29 Oct 2024

Bundle Size

1.28 MB

Minified

336.98 kB

Minified + Gzipped

Bundlephobia

Languages

JavaScript (100%)

Total Downloads

Cumulative downloads

Total Downloads

59,048,894

Last day

-9.5%

24,881

Compared to previous day

Last week

-1.3%

133,883

Compared to previous week

Last month

14.7%

560,149

Compared to previous month

Last year

-30%

10,593,386

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

vue-docgen-loader

This package allows parsing Vue component file with vue-docgen-api then injecting the result into the output file.

Getting Started

First, install the loader and vue-docgen-api.

1$ yarn add -D vue-docgen-loader vue-docgen-api
2# or npm
3# $ npm i -D vue-docgen-loader vue-docgen-api

Then add the loader to your webpack config file. Please make sure to run the loader at the last of the loader chain.

1import MyComponent from './my-component.vue'
2
3Vue.extend({
4  // You can use the components as usual
5  components: { MyComponent }
6})

1// webpack.config.js
2module.exports = {
3  module: {
4    rules: [
5      {
6        test: /\.vue$/,
7        use: 'vue-loader'
8      },
9      {
10        // You also can put this loader above, but I recommend to use
11        // a separeted rule with enforce: 'post' for maintainability
12        // and simplicity. For example, you can enable the loader only
13        // for development build.
14        test: /\.vue$/,
15        use: 'vue-docgen-loader',
16        enforce: 'post'
17      }
18    ]
19  },
20  plugins: [new VueLoaderPlugin()]
21}

If you want to apply this loader to non-SFC files like below, you also need to setup a rule for them. This works only with vue-docgen-api >= 4.0.0.

1// my-button.js
2import Vue from 'vue'
3
4export const MyButton = Vue.extend({
5  props: {
6    foo: {
7      type: String
8    }
9  },
10  template: '<button/>'
11})

1// other.js
2import MyButton from './my-button.js?component'

1// webpack.config.js
2module.exports = {
3  module: {
4    rules: [
5      // Please make sure to apply the loader only for Vue components: In this
6      // sample, only modules imported with ?component query will match.
7      //
8      // IMPORTANT!
9      // Do not use ?vue query if you're using vue-loader. It will sliently inject
10      // .js?vue rule into rules array and it breaks the module.
11      {
12        test: /\.js$/,
13        resourceQuery: /component/,
14        use: 'vue-docgen-loader',
15        enforce: 'post'
16      }
17    ]
18  }
19}

Options

You can pass options for vue-docgen-api through docgenOptions and specify the property name the loader inject docgen result at.

1{
2  test: /\.vue$/,
3    loader: 'vue-docgen-loader',
4    options: {
5      docgenOptions: {
6        // options for vue-docgen-api...
7      },
8      // Injected property name
9      injectAt: '__docgenInfo' // default
10    },
11    enforce: 'post'
12}

Contributing

Please read our contributing guidelines.

CONTRIBUTING

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

License

Determines if the project has defined a license.

5

Maintained

Determines if the project is "actively maintained".

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 0

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-alpha.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/pocka/vue-docgen-loader/publish-alpha.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-alpha.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/pocka/vue-docgen-loader/publish-alpha.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-beta.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/pocka/vue-docgen-loader/publish-beta.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-beta.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/pocka/vue-docgen-loader/publish-beta.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/pocka/vue-docgen-loader/publish.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/pocka/vue-docgen-loader/publish.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/pocka/vue-docgen-loader/test.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/pocka/vue-docgen-loader/test.yml/master?enable=pin
Warn: npmCommand not pinned by hash: .github/workflows/publish-alpha.yml:21
Warn: npmCommand not pinned by hash: .github/workflows/publish-beta.yml:21
Warn: npmCommand not pinned by hash: .github/workflows/publish.yml:23
Info: 0 out of 8 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 3 npmCommand dependencies pinned

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

Score

3.9

/10

Last Scanned on 2024-11-18

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

Other packages similar to vue-docgen-loader

Other packages similar to vue-docgen-loader

vue-docgen-loader

Installations

Pull Requests

0

9

0

9

Issues

0

8

8

Releases

Developer

pocka

Developer Guide

CommonJS

>= 12

No

18.20.4

10.7.0

Statistics

Bundle Size

1.28 MB

336.98 kB

Languages

Total Downloads

59,048,894

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

vue-docgen-loader

Getting Started

Options

Contributing

10

10

10

10

5

0

0

0

0

0

0

0

0

3.9

/10