components helper
v2.2.0
Volar의 WebStorm 지원을 사용하면 더 이상이 라이브러리가 필요하지 않을 수 있습니다.
유형 선언을 개선하여 Volar의 코드 프롬프트를 사용하는 것이 좋습니다.
이 라이브러리가 여전히 필요한 경우 계속 사용할 수 있지만이 라이브러리에는 더 이상 새로운 기능 업데이트가 없습니다.
VUE 구성 요소 라이브러리에 코드 프롬프트 파일을 제공하기위한 문서를 기반으로
참조 문서 형식 참조 테스트 파일
changelog
yarn add components-helper -D
# or
npm i components-helper --save-dev const { main } = require ( 'components-helper' )
main ( {
// Options
} )예
그런 다음 package.json에서
{
"scripts": {
+ "build:helper": "node helper/file.js"
},
+ "vetur": {
+ "tags": "config outDir/tags.json",
+ "attributes": "config outDir/attributes.json"
+ },
+ "web-types": "config outDir/web-types.json"
}truestring | string[]항목 디렉토리를 지정합니다. 빠른 글로브
예를 들어:
docs/*.md 문서의 모든 파일과 일치합니다docs/(a|b).md 파일 a.md 및 b.md 와 일치합니다docs/!(a|b).md a.md 및 b.md 를 제외한 파일과 일치합니다object빠른 글로브 구성
truestring출력 디렉토리를 지정하십시오. 예를 들어,`lib``
truestring구성 요소 라이브러리의 이름.
truestring구성 요소 라이브러리의 버전.
number | stringreturn-value json 텍스트에 계약, 공백 및 라인 브레이크 문자를 추가하여 읽기 쉽게 읽을 수 있습니다.
string/소송, 슬롯 서브 타그, 유형에 대한 분리기
(title: string, fileName: string, path: string) => stringhyphenate(title || fileName)구성 요소의 이름을 다시 작성합니다
예를 들어 (title) => 'prefix-' + title.replace(/B([AZ])/g, '-$1').toLowerCase()
(fileName: string, header?: string, path: string) => string | undefind구성 요소의 문서 URL을 다시 작성합니다
(value: string, key: string, row: string[], title: string) => string | undefined 구성 요소의 속성을 다시 작성합니다
(description?: string, defaultValue?: string, docUrl?: string) => string${description}, default: ${defaultValue}.nn[Docs](${docUrl})Vetur의 설명을 다시 작성합니다
(title: string, fileName: string, path: string) => Source웹 유형의 소스를 다시 작성합니다. (구성 요소 라이브러리에서 내보내기 이름)
(type: string) => undefined | string | BaseContribution일부 공통 유형 만 내부적으로 처리되며 나머지는 기본적으로 구성 요소 라이브러리에서 내보내집니다. 문서가 타사 라이브러리에서 유형을 참조하는 경우이 기능을 통해 관련 동작을 무시하도록 선택할 수 있습니다.
stringtags.jsonVetur의 태그 이름
stringattributes.jsonVetur의 속성의 이름
stringweb-types.jsonWebStorm의 웹 유형의 이름
string ( 이것은 일반 문자열이며 케이스를 무시합니다. )props소품 테이블의 제목. 헤더의 다른 문자열은 하위 구성 요소로 식별됩니다.
stringName 소품 테이블에서 Name 의 헤더 이름
stringDescription 소품 테이블에서 Description 의 헤더 이름
stringType 소품 테이블 Type 의 헤더 이름
stringOptions 소품 테이블의 Options 의 헤더 이름
stringDefault 소품 테이블의 Default 의 헤더 이름
string ( 이것은 일반 문자열이며 케이스를 무시합니다. )events이벤트 테이블의 제목. 헤더의 다른 문자열은 하위 구성 요소로 식별됩니다.
stringName 이벤트 테이블에서 Name 의 헤더 이름
stringDescription 이벤트 테이블에서 Description 의 헤더 이름
string ( 이것은 일반 문자열이며 케이스를 무시합니다. )slots슬롯 테이블의 제목. 헤더의 다른 문자열은 하위 구성 요소로 식별됩니다.
stringName 슬롯 테이블에서 Name 의 헤더 이름
stringDescription 슬롯 테이블에서 Description 의 헤더 이름
stringType 슬롯 테이블 Type 의 헤더 이름
stringSubtags 슬롯 테이블에서 Subtags 의 헤더 이름
string ( 이것은 일반 문자열이며 케이스를 무시합니다. )directives지침 표의 제목. 헤더의 다른 문자열은 하위 구성 요소로 식별됩니다.
stringName 지침 테이블에서 Name 의 헤더 이름
stringDescription 지시문 표에서 Description 의 헤더 이름
stringType 지침 테이블에서 Type 의 헤더 이름
RegExp | string ( 이것은 일반 문자열입니다. )/#+s+(.*)n+([^(#|n)]*)/g + s+(.*) n+(..................n)*)/g문서의 제목 및 설명 정보와 일치합니다
RegExp | string ( 이것은 일반 문자열입니다. )/#+s+(.*)n+(|?.+|.+)n|?s*:?-+:?s*|.+((n|?.+|.+)+)/g s+(.*) n+ (|? .+ |.+) n |? s* :?-+ :? | .+( ( n |? .+ |.+)/g제목 및 테이블 헤더와 일치하고 테이블에는 문서의 정보가 포함되어 있습니다.
RegExp | string ( 이것은 일반 문자열입니다. )//((w|-)+).w+$/ /(( wo|-) +) . whflo$/경로에서 파일 이름과 일치합니다
문서의 첫 번째 형식 정보와 일치합니다
/#+ s+( .* ) n+( [^(#|n)]* )/
titledescription그리고
title예를 들어 다른 형식과 일치합니다.
/#+ s+( .* ) n+> s* ( [^(#|n)]* )/g
titledescription문서의 형식 정보와 일치합니다
/#+ s+( .* ) n+( |?.+|.+ ) n |? (n|?.+|.+)+
title| header || column || column |그리고
sub-component title| header || column || column |기본적으로 모든 테이블과 일치하고 TablePeerGexp를 통해 최적화하십시오.
/#+ s+( .*s*Props|.*s*Events|.*s*Slots|.*s*Directives ) n+( |?.+|.+ ) (n|?.+|.+)+
Props / Events / Slots / Directives| header || column || column |그리고
sub-component Props| header || column || column | 이 문서에 기본 제목 또는 Props Events Slots 및 Directives 이 포함되어 있지 않은 경우이 구성 요소는 생성되지 않습니다.
MIT
