blackteay/vant
1
0
Fork 0
mirror of https://gitee.com/vant-contrib/vant.git synced 2025-04-06 03:57:59 +08:00
Code Issues Projects Releases Wiki Activity

feat(markdown-vetur): 支持生成 attributes.json 的 options 属性 (#8545)

Browse Source 
* feat(markdown-vetur): 支持生成 attributes.json 的 options 属性

* fix(markdown-vetur): 没有可选值不添加 options 属性
This commit is contained in:
Ttou 2021-04-16 17:18:01 +08:00 committed by GitHub
parent 805916b6e0
commit 74e2b10b74
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 21 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
packages/vant-markdown-vetur/src/formatter.ts
View File

@ -1,6 +1,6 @@
/* eslint-disable no-continue */
import { Articals } from './parser';
import { formatType, removeVersion, toKebabCase } from './utils';
import { formatOptions, formatType, removeVersion, toKebabCase } from './utils';
import { VueTag } from './type';
function formatComponentName(name: string, tagPrefix: string) {
@ -64,11 +64,12 @@ export function formatter(
const tag = findTag(vueTags, name);
table.body.forEach((line) => {
const [name, desc, type, defaultVal] = line;
const [name, desc, type, defaultVal, options] = line;
tag.attributes!.push({
name: removeVersion(name),
default: defaultVal,
description: desc,
options: formatOptions(options),
value: {
type: formatType(type),
kind: 'expression',

2
packages/vant-markdown-vetur/src/type.ts
View File

@ -20,6 +20,7 @@ export type VueAttribute = {
name: string;
default: string;
description: string;
options: string[]
value: {
kind: 'expression';
type: string;
@ -44,6 +45,7 @@ export type VeturTags = Record<string, VeturTag>;
export type VeturAttribute = {
type: string;
description: string;
options?: string[];
};
export type VeturAttributes = Record<string, VeturAttribute>;

6
packages/vant-markdown-vetur/src/utils.ts
View File

@ -20,3 +20,9 @@ export function formatType(type: string) {
export function normalizePath(path: string): string {
return path.replace(/\\/g, '/');
}
// `default` `primary` -> ['default', 'primary']
export function formatOptions(options?: string) {
if (!options) return []
return options.replace(/`/g, '').split(' ')
}

14
packages/vant-markdown-vetur/src/vetur.ts
View File

@ -1,4 +1,4 @@
import { VueTag, VeturTags, VeturAttributes } from './type';
import { VueTag, VeturTags, VeturAttributes, VeturAttribute } from './type';
export function genVeturTags(tags: VueTag[]) {
const veturTags: VeturTags = {};
@ -18,10 +18,16 @@ export function genVeturAttributes(tags: VueTag[]) {
tags.forEach(tag => {
if (tag.attributes) {
tag.attributes.forEach(attr => {
veturAttributes[`${tag.name}/${attr.name}`] = {
let attribute: VeturAttribute = {
type: attr.value.type,
description: `${attr.description}, 默认值: ${attr.default}`,
};
description: `${attr.description}, 默认值: ${attr.default}`
}
if (attr.options.length > 0) {
attribute.options = attr.options
}
veturAttributes[`${tag.name}/${attr.name}`] = attribute;
});
}
});