# vue-docgen-web-types

**Repository Path**: free_pan/vue-docgen-web-types

## Basic Information

- **Project Name**: vue-docgen-web-types
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-01-27
- **Last Updated**: 2023-02-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# vue-docgen-web-types

这个和 Jetbins 的`vue-docgen-web-types`区别是升级了一下`vue-docgen-api`的版本，使其更好的支持`vue3`

作用：用于解决自定全局 vue3 组件在 webstorm 中无法智能提示的问题

**注意：** 默认只会对 `src/components`目录下的 vue 文件生成`web-types`. 详见源代码`src/config.ts`

[npm 仓库](https://www.npmjs.com/package/@pzy915/vue-docgen-web-types)

[gitee 仓库](https://gitee.com/free_pan/vue-docgen-web-types)

安装: `npm i @pzy915/vue-docgen-web-types -D`

使用:

- 以下内容添加到 `package.json`

```json
"scripts": {
    "update-web-types": "vue-docgen-web-types"
},
"web-types": "./web-types.json",
```

- 运行 `npm run update-web-types` 命令。

This package provides `vue-docgen-web-types` command to generate [web-types](https://github.com/JetBrains/web-types)
JSON based on source components. It parses JSDoc using
[styleguidist](https://vue-styleguidist.github.io/docs/Documenting.html#code-comments) `vue-docgen-api` package.

You can launch builder in a watch mode by passing `--watch` and
you can pass a custom configuration file via `--config` parameter.
See [config.d.ts](https://github.com/JetBrains/web-types/blob/master/gen/vue-docgen-web-types/types/config.d.ts)
for detailed information on supported configuration file options.