\n\n\n\n### [ComponentRegistrationInfo](#-vuedx-analyze-ComponentRegistrationInfo-interface)\n\n\n\n```ts\ninterface ComponentRegistrationInfo {\n aliases: string[];\n name: string;\n source: ImportSource;\n}\n```\n\n\n
\n\n\n\n### [EmitInfo](#-vuedx-analyze-EmitInfo-interface)\n\n\n\n```ts\ninterface EmitInfo extends Taggable, Addressable {\n description: string;\n isDynamic: boolean;\n isInferred: boolean;\n name: string;\n references: SourceRange[];\n type: TypeInfo[];\n}\n```\n\n\n
\n\n\n\n### [IdentifierSource](#-vuedx-analyze-IdentifierSource-interface)\n\n\n\n```ts\ninterface IdentifierSource extends Addressable {\n name: string;\n}\n```\n\n\n
\n\n\n\n### [ImportSource](#-vuedx-analyze-ImportSource-interface)\n\n\n\n```ts\ninterface ImportSource {\n exportName?: string;\n localName: string;\n moduleName: string;\n}\n```\n\n\n
\n\n\n\n### [ImportSourceWithLocation](#-vuedx-analyze-ImportSourceWithLocation-interface)\n\n\n\n```ts\ninterface ImportSourceWithLocation extends ImportSource, Addressable {\n}\n```\n\n\n
\n\n\n\n### [LocalComponentRegistrationInfo](#-vuedx-analyze-LocalComponentRegistrationInfo-interface)\n\n\n\n```ts\ninterface LocalComponentRegistrationInfo extends ComponentRegistrationInfo, Addressable {\n kind: 'script' | 'scriptSetup';\n source: ImportSourceWithLocation;\n}\n```\n\n\n
\n\n\n\n### [Plugin](#-vuedx-analyze-Plugin-2-interface)\n\n\n\n```ts\ninterface Plugin {\n babel?: AbstractScriptAnalyzerFn | AbstractAnalyzerHandler;\n blocks?: Partial<{\n script: BlockAnalyzer
\n\n\n\n### [PropInfo](#-vuedx-analyze-PropInfo-interface)\n\n\n\n```ts\ninterface PropInfo extends Taggable, Addressable {\n defaultValue: ValueInfo | null;\n description: string;\n name: string;\n required: boolean;\n type: TypeInfo[];\n}\n```\n\n\n
\n\n\n\n### [ScriptSetupInfo](#-vuedx-analyze-ScriptSetupInfo-interface)\n\n\n\n```ts\ninterface ScriptSetupInfo {\n defineEmit?: Addressable;\n defineProps?: Addressable;\n}\n```\n\n\n
\n\n\n\n### [SetupInfo](#-vuedx-analyze-SetupInfo-interface)\n\n\n\n```ts\ninterface SetupInfo extends Addressable {\n context?: {\n identifiers: Partial<{\n attrs: string;\n slots: string;\n emit: string;\n }>;\n rest?: string;\n } & Addressable;\n props?: {\n identifiers: string[];\n rest?: string;\n } & Addressable;\n return?: Addressable;\n}\n```\n\n\n
\n\n\n\n### [SourceRange](#-vuedx-analyze-SourceRange-interface)\n\n\n\n```ts\ninterface SourceRange {\n end: SourceLocation;\n source: string;\n start: SourceLocation;\n}\n```\n\n\n
\n\n\n\n### [SyntaxError](#-vuedx-analyze-SyntaxError-2-interface)\n\n\n\n```ts\ninterface SyntaxError {\n loc: SourceLocation;\n message: string;\n}\n```\n\n\n
\n\n","readmeFilename":"readme.md","_id":"@vuedx/analyze@0.3.1-insiders-1607631204.0","_nodeVersion":"14.14.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-Q42bi8sNWSYrcUMsA8aDJwgR0ctARLkVxfjZ/bReMjkAII22NwLhnU1zEsRBF63i+GeUEoZSZ3DS6Mh/bpr0sQ==","shasum":"5998fff64254edc3f88abc29cd6cf1c23100f974","tarball":"https://registry.npmjs.org/@vuedx/analyze/-/analyze-0.3.1-insiders-1607631204.0.tgz","fileCount":9,"unpackedSize":433413,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJf0oF7CRA9TVsSAnZWagAAetIP/ihR0I2/r+UHINe2450y\nvcP/5qEkmyG3b8Ivg1wyq+wsOA6sdZnDz5siGWRoJsexuGSKDaVy4+l4LVBG\nrDi3/Hwnb6Be+b8RIEs5Zwj37XUHR7eOU6JAyRavQvNbbDOfMX73jQiR2wVS\nL8OP3k+cWA4KDUzgdh5NMvXoPemCiIPzgDpqPMqnIBs+Ar5aPalmrdNsLQLK\nh1qbpfweybCedbjqqjxcbUPovZrUWE0aLxD0/3AXoXTGXTrRAVOR4FTKus4d\n++Rs3xczjBZOjykNOcsWiXN4QqkuAno/h21L97D6CzJEjz8hVS2A5mtCkjml\nRMPKrnbcJkYa+wXfmd2I0XSk+O+03vIWRfjU2x7iPpmM2BX12/F9Y3I2gbhk\nWmRZzFV3bo5FWgHOoJ6852cYSn+xIqGeBfzOMo173y2KCRkpGbwOl08kVuT0\nRfuvcCmOg1uC3fuedBavF6Q2fHPRBMTMTh5HFleJoXU05iV1MC8jOMqM5P4n\nEI0RHAkvNdqJjb98IrlmVEz7PO6XMsIs3svDIUEgc0phx4uhxZL8fFpZDPXH\ndxuhqZYvP7TOdgDHFN8xVc3CF6y7pQM9gH7cb0eKXmQpkiGgJje9o0i2glfB\nC0MRdVXDO1PJdHjEG603rFXSXYNo2fGKK6eQ7JtrivNVzvp9519t6tSob7s6\nXxMo\r\n=pQLn\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIBHAJwFW4hVmHGMdW+WgI5fr+jsM3mzd1bdsEEhY1jweAiEAko8SlygTTtZwAd/+EwY6h/L1RAl19KGXmRGAuADTOQA="}]},"_npmUser":{"name":"znck","email":"rahulkdn@gmail.com"},"directories":{},"maintainers":[{"name":"znck","email":"rahulkdn@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/analyze_0.3.1-insiders-1607631204.0_1607631227062_0.848304291846824"},"_hasShrinkwrap":false},"0.3.1-insiders-1607632537.0":{"name":"@vuedx/analyze","version":"0.3.1-insiders-1607632537.0","description":"Extracts public API information from Vue component.","main":"dist/index.cjs.js","module":"dist/index.esm.js","types":"dist/index.d.ts","bin":{"vuedx-analyze":"bin/analyze.js"},"keywords":["vue","sfc","sfc api extractor","static analyzer","sfc analyzer","sfc static analyzer","docgen","documentation"],"repository":{"type":"git","url":"git+https://github.com/znck/vue-developer-experience.git"},"author":{"name":"Rahul Kadyan","email":"rahulkdn@gmail.com","url":"https://znck.me/"},"funding":{"type":"individual","url":"https://github.com/sponsors/znck"},"license":"MIT","bugs":{"url":"https://github.com/znck/vue-developer-experience/issues"},"homepage":"https://github.com/znck/vue-developer-experience#readme","dependencies":{"@babel/code-frame":"^7.10.4","@babel/generator":"^7.12.1","@babel/parser":"^7.12.3","@babel/template":"^7.12.7","@babel/traverse":"7.12.1","@babel/types":"7.12.1","@types/micromatch":"^4.0.1","@vuedx/compiler-sfc":"0.3.1-insiders-1607632537.0","@vuedx/compiler-tsx":"0.3.1-insiders-1607632537.0","@vuedx/projectconfig":"0.3.3-insiders-1607632537.0","@vuedx/template-ast-types":"0.3.1-insiders-1607632537.0","cli-highlight":"^2.1.4","commander":"^6.1.0","fast-glob":"^3.2.4","hash-sum":"^2.0.0","micromatch":"^4.0.2"},"devDependencies":{"@types/babel__traverse":"^7.0.15","@vuedx/shared":"0.0.1-insiders-1607632537.0","typescript":"^4.0.3"},"readme":"# Analyze\n\nA tool to statically analyze Vue single file components.\n\n## Support\n\nThis package is part of [VueDX project](https://github.com/znck/vue-developer-experience), maintained by [Rahul Kadyan](https://github.com/znck). You can [💖 sponsor him](https://github.com/sponsors/znck) for continued development of this package and other VueDX tools.\n\n## Usage\n\n\n\n## API\n\n\n\n\n### [ConfiguredVueProject](#-vuedx-analyze-ConfiguredVueProject-class)\n\n\n\n
More info
\n\n**Signature:**\n```ts\ndeclare class ConfiguredVueProject extends VueProject {\n constructor(rootDir: string, packageFile: string | undefined, packageJSON: Partial\n\n\n\n#### [setFileNames](#-vuedx-analyze-ConfiguredVueProject-setFileNames-member-1-)\n\n\n\n**Signature:**\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n\n### [InferredVueProject](#-vuedx-analyze-InferredVueProject-class)\n\n\n\n
More info
\n\n**Signature:**\n```ts\ndeclare class InferredVueProject extends VueProject {\n kind: \"inferred\";\n protected refresh(): void;\n}\n```\n\n**Members:**\n\n\n\n\n#### [refresh](#-vuedx-analyze-InferredVueProject-refresh-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected refresh(): void;\n```\n\n\n\n
\n\n\n\n\n### [VueProject](#-vuedx-analyze-VueProject-class)\n\n\n\n
More info
\n\n**Signature:**\n```ts\ndeclare abstract class VueProject {\n protected _config: Readonly\n\n\n\n#### [markDirty](#-vuedx-analyze-VueProject-markDirty-member-1-)\n\n\n\n**Signature:**\n```ts\nmarkDirty(): void;\n```\n\n\n
\n\n\n\n#### [refresh](#-vuedx-analyze-VueProject-refresh-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected abstract refresh(): void;\n```\n\n\n
\n\n\n\n#### [reloadIfNeeded](#-vuedx-analyze-VueProject-reloadIfNeeded-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected reloadIfNeeded(): void;\n```\n\n\n
\n\n\n\n#### [setConfig](#-vuedx-analyze-VueProject-setConfig-member-1-)\n\n\n\n**Signature:**\n```ts\nsetConfig(config: ProjectConfig): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| config |
ProjectConfig | - |\n\n\n\n\n\n#### [setFileNames](#-vuedx-analyze-VueProject-setFileNames-member-1-)\n\n\n\n**Signature:**\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n\n### [createAnalyzer](#-vuedx-analyze-createAnalyzer-function-1-)\n\n\n\n
\n): Analyzer;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| plugins |
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createAnalyzer(plugins: Plugin[], options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createFullAnalyzer](#-vuedx-analyze-createFullAnalyzer-function-1-)\n\n\n\n
\n): ReturnType;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| plugins |
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createFullAnalyzer(plugins?: Plugin[], options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createSourceRange](#-vuedx-analyze-createSourceRange-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createSourceRange(context: Context | ScriptAnalyzerContext, node: Node): SourceRange;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| context |Context | ScriptAnalyzerContext | - |\n| node | Node | - |\n\n\n\n\n\n### [transformToFunction](#-vuedx-analyze-transformToFunction-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function transformToFunction(content: string, options?: FunctionTransformOptions): string;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| content |string | - |\n| options | FunctionTransformOptions | - |\n\n\n\n## Types\n\n\n\n\n### [Analyzer](#-vuedx-analyze-Analyzer-interface)\n\n\n\n```ts\ninterface Analyzer {\n analyze: (content: string, fileName?: string) => ComponentInfo;\n analyzeScript: (content: string, fileName?: string, mode?: 'script' | 'scriptSetup') => ComponentInfo;\n analyzeTemplate: (content: string, fileName?: string) => ComponentInfo;\n}\n```\n\n\n
\n\n\n\n### [ComponentInfo](#-vuedx-analyze-ComponentInfo-interface)\n\n\n\n```ts\ninterface ComponentInfo {\n components: LocalComponentRegistrationInfo[];\n emits: EmitInfo[];\n errors: SyntaxError[];\n fnSetupOption?: SetupInfo;\n identifierSource: Record
\n\n\n\n### [ComponentRegistrationInfo](#-vuedx-analyze-ComponentRegistrationInfo-interface)\n\n\n\n```ts\ninterface ComponentRegistrationInfo {\n aliases: string[];\n name: string;\n source: ImportSource;\n}\n```\n\n\n
\n\n\n\n### [EmitInfo](#-vuedx-analyze-EmitInfo-interface)\n\n\n\n```ts\ninterface EmitInfo extends Taggable, Addressable {\n description: string;\n isDynamic: boolean;\n isInferred: boolean;\n name: string;\n references: SourceRange[];\n type: TypeInfo[];\n}\n```\n\n\n
\n\n\n\n### [IdentifierSource](#-vuedx-analyze-IdentifierSource-interface)\n\n\n\n```ts\ninterface IdentifierSource extends Addressable {\n name: string;\n}\n```\n\n\n
\n\n\n\n### [ImportSource](#-vuedx-analyze-ImportSource-interface)\n\n\n\n```ts\ninterface ImportSource {\n exportName?: string;\n localName: string;\n moduleName: string;\n}\n```\n\n\n
\n\n\n\n### [ImportSourceWithLocation](#-vuedx-analyze-ImportSourceWithLocation-interface)\n\n\n\n```ts\ninterface ImportSourceWithLocation extends ImportSource, Addressable {\n}\n```\n\n\n
\n\n\n\n### [LocalComponentRegistrationInfo](#-vuedx-analyze-LocalComponentRegistrationInfo-interface)\n\n\n\n```ts\ninterface LocalComponentRegistrationInfo extends ComponentRegistrationInfo, Addressable {\n kind: 'script' | 'scriptSetup';\n source: ImportSourceWithLocation;\n}\n```\n\n\n
\n\n\n\n### [Plugin](#-vuedx-analyze-Plugin-2-interface)\n\n\n\n```ts\ninterface Plugin {\n babel?: AbstractScriptAnalyzerFn | AbstractAnalyzerHandler;\n blocks?: Partial<{\n script: BlockAnalyzer
\n\n\n\n### [PropInfo](#-vuedx-analyze-PropInfo-interface)\n\n\n\n```ts\ninterface PropInfo extends Taggable, Addressable {\n defaultValue: ValueInfo | null;\n description: string;\n name: string;\n required: boolean;\n type: TypeInfo[];\n}\n```\n\n\n
\n\n\n\n### [ScriptSetupInfo](#-vuedx-analyze-ScriptSetupInfo-interface)\n\n\n\n```ts\ninterface ScriptSetupInfo {\n defineEmit?: Addressable;\n defineProps?: Addressable;\n}\n```\n\n\n
\n\n\n\n### [SetupInfo](#-vuedx-analyze-SetupInfo-interface)\n\n\n\n```ts\ninterface SetupInfo extends Addressable {\n context?: {\n identifiers: Partial<{\n attrs: string;\n slots: string;\n emit: string;\n }>;\n rest?: string;\n } & Addressable;\n props?: {\n identifiers: string[];\n rest?: string;\n } & Addressable;\n return?: Addressable;\n}\n```\n\n\n
\n\n\n\n### [SourceRange](#-vuedx-analyze-SourceRange-interface)\n\n\n\n```ts\ninterface SourceRange {\n end: SourceLocation;\n source: string;\n start: SourceLocation;\n}\n```\n\n\n
\n\n\n\n### [SyntaxError](#-vuedx-analyze-SyntaxError-2-interface)\n\n\n\n```ts\ninterface SyntaxError {\n loc: SourceLocation;\n message: string;\n}\n```\n\n\n
\n\n","readmeFilename":"readme.md","_id":"@vuedx/analyze@0.3.1-insiders-1607632537.0","_nodeVersion":"14.14.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-P0LwPEx7R6YR1W9O5jFy1VxmX88jBVDTn7jYj8Lg+nPBv8ZYrghKYtPYkVQPBAGzVDwSqSZ11AJuRkfRfHmxWg==","shasum":"b36deb7d0e6b1b4d5d49b311219071dd1ac6d863","tarball":"https://registry.npmjs.org/@vuedx/analyze/-/analyze-0.3.1-insiders-1607632537.0.tgz","fileCount":9,"unpackedSize":433413,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJf0oaxCRA9TVsSAnZWagAA9pcP/2K9mHZuzokBC/xIdCTG\nszUsPkeZ1NfvFl4LJ2EX656QSqT1z8FxedzHEFlp1M8JmLrAkCV7+GBcmLSZ\nyYK4isOa2pNwsTucLTfMg2m0W4pQr6/meoy416JXqRMIlY+KJD1riv/1+O+4\nFNU9LobQKTPegxv8vFQue0uBLgYBN2mZYgHpLn7WA9Vy0Yovi1As8rZJY0mM\ncNXwauU9nUEz9zEG1mNzQJs5f84ia/aFnWsbeAtdI2Io4Qv5JiZuo10u+sUq\nI06wGwdury1mJB8pXQLeAXQSFi91bqZHPYL0XtHMXLQhOJ/Yh8AXhRfZCTGJ\neIzDzKfn1P0JfoauWn2RhHKliPmCNHqEZ2v5n96WmCE4fd39ESKOxg6Wi9NN\nuLnO85rjA+1KkCPhZzzl6eHu/eKd1FLTWE496ECNm9GqBIHWD+NcUxWwvznE\ndc32NLL4zmrU0yhThCbBaW7uIna4Ax4Jw5AV9fkWeRKvb5x2j0XEVXzh248g\ngvjCWxNDFXITOGtVokk4U/wri74fcDM5pmDTrE8cciSSL7uJS5P2NAPTDHe/\niRyqPKJJhixlhhcQdFHgfWPWoGgxdabeJEWqvJBH1u8gxgpkRW2/tfHI1Jj8\nzcLybP/bqMsjMZT6zaNuDlmc87xK8KY8JtI6wLOxRf9+G8uZnrSKGEwGeDBM\n1wy7\r\n=m17K\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCr77O8oK+DwKx0aBVZKHAEIRsS7WuVapEvXGwte8wUPQIhAMFFJvfIeIWfPqXfFdFQ00gPOU7vV6RPuEIwlMlHyA7m"}]},"_npmUser":{"name":"znck","email":"rahulkdn@gmail.com"},"directories":{},"maintainers":[{"name":"znck","email":"rahulkdn@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/analyze_0.3.1-insiders-1607632537.0_1607632560733_0.5611903351379157"},"_hasShrinkwrap":false},"0.3.1-insiders-1608185511.0":{"name":"@vuedx/analyze","version":"0.3.1-insiders-1608185511.0","description":"Extracts public API information from Vue component.","main":"dist/index.cjs.js","module":"dist/index.esm.js","types":"dist/index.d.ts","bin":{"vuedx-analyze":"bin/analyze.js"},"keywords":["vue","sfc","sfc api extractor","static analyzer","sfc analyzer","sfc static analyzer","docgen","documentation"],"repository":{"type":"git","url":"git+https://github.com/znck/vue-developer-experience.git"},"author":{"name":"Rahul Kadyan","email":"rahulkdn@gmail.com","url":"https://znck.me/"},"funding":{"type":"individual","url":"https://github.com/sponsors/znck"},"license":"MIT","bugs":{"url":"https://github.com/znck/vue-developer-experience/issues"},"homepage":"https://github.com/znck/vue-developer-experience#readme","dependencies":{"@babel/code-frame":"^7.10.4","@babel/generator":"^7.12.1","@babel/parser":"^7.12.3","@babel/template":"^7.12.7","@babel/traverse":"7.12.1","@babel/types":"7.12.1","@types/micromatch":"^4.0.1","@vuedx/compiler-sfc":"0.3.1-insiders-1608185511.0","@vuedx/compiler-tsx":"0.3.1-insiders-1608185511.0","@vuedx/projectconfig":"0.3.3-insiders-1608185511.0","@vuedx/template-ast-types":"0.3.1-insiders-1608185511.0","cli-highlight":"^2.1.4","commander":"^6.1.0","fast-glob":"^3.2.4","hash-sum":"^2.0.0","micromatch":"^4.0.2"},"devDependencies":{"@types/babel__traverse":"^7.0.15","@vuedx/shared":"0.0.1-insiders-1608185511.0","typescript":"^4.0.3"},"readme":"
\n ![](\"./logo.png\")
\n
\n\n## Support\n\nThis package is part of [VueDX project](https://github.com/znck/vue-developer-experience), maintained by [Rahul Kadyan](https://github.com/znck). You can [💖 sponsor him](https://github.com/sponsors/znck) for continued development of this package and other VueDX tools.\n\n## Usage\n\n\n\n\n## API\n\n\n\n### [ConfiguredVueProject](#-vuedx-analyze-ConfiguredVueProject-class)\n\n\n Analyze
\nA tool to statically analyze Vue single file components.
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare class ConfiguredVueProject extends VueProject {\n constructor(\n rootDir: string,\n packageFile: string | undefined,\n packageJSON: Partial\n\n\n\n#### [setFileNames](#-vuedx-analyze-ConfiguredVueProject-setFileNames-member-1-)\n\n**Signature:**\n\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --------- | --------------------- | ----------- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n### [InferredVueProject](#-vuedx-analyze-InferredVueProject-class)\n\n
More info
\n\n**Signature:**\n\n```ts\ndeclare class InferredVueProject extends VueProject {\n kind: 'inferred'\n protected refresh(): void\n}\n```\n\n**Members:**\n\n\n\n#### [refresh](#-vuedx-analyze-InferredVueProject-refresh-member-1-)\n\n**Signature:**\n\n```ts\nprotected refresh(): void;\n```\n\n\n
\n\n\n\n### [VueProject](#-vuedx-analyze-VueProject-class)\n\n
More info
\n\n**Signature:**\n\n```ts\ndeclare abstract class VueProject {\n protected _config: Readonly\n\n\n\n#### [markDirty](#-vuedx-analyze-VueProject-markDirty-member-1-)\n\n**Signature:**\n\n```ts\nmarkDirty(): void;\n```\n\n
\n\n\n\n#### [refresh](#-vuedx-analyze-VueProject-refresh-member-1-)\n\n**Signature:**\n\n```ts\nprotected abstract refresh(): void;\n```\n\n
\n\n\n\n#### [reloadIfNeeded](#-vuedx-analyze-VueProject-reloadIfNeeded-member-1-)\n\n**Signature:**\n\n```ts\nprotected reloadIfNeeded(): void;\n```\n\n
\n\n\n\n#### [setConfig](#-vuedx-analyze-VueProject-setConfig-member-1-)\n\n**Signature:**\n\n```ts\nsetConfig(config: ProjectConfig): void;\n```\n\n| Parameter | Type | Description |\n| --------- | --------------------------------------------------------------------------------------- | ----------- |\n| config |
ProjectConfig | - |\n\n\n\n\n\n#### [setFileNames](#-vuedx-analyze-VueProject-setFileNames-member-1-)\n\n**Signature:**\n\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --------- | --------------------- | ----------- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n### [createAnalyzer](#-vuedx-analyze-createAnalyzer-function-1-)\n\n
\n,\n): Analyzer\n```\n\n| Parameter | Type | Description |\n| --------- | ---------------------------------------------------------------------------------------------------------------------- | ----------- |\n| plugins |
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare function createAnalyzer(\n plugins: Plugin[],\n options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createFullAnalyzer](#-vuedx-analyze-createFullAnalyzer-function-1-)\n\n
\n,\n): ReturnType\n```\n\n| Parameter | Type | Description |\n| --------- | ---------------------------------------------------------------------------------------------------------------------- | ----------- |\n| plugins |
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare function createFullAnalyzer(\n plugins?: Plugin[],\n options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createSourceRange](#-vuedx-analyze-createSourceRange-function-1-)\n\n
\n
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare function createSourceRange(\n context: Context | ScriptAnalyzerContext,\n node: Node,\n): SourceRange\n```\n\n| Parameter | Type | Description |\n| --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |\n| context |Context | ScriptAnalyzerContext | - |\n| node | Node | - |\n\n\n\n\n\n### [transformToFunction](#-vuedx-analyze-transformToFunction-function-1-)\n\n
\n
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare function transformToFunction(\n content: string,\n options?: FunctionTransformOptions,\n): string\n```\n\n| Parameter | Type | Description |\n| --------- | ------------------------------------------------------------------------------------------------------- | ----------- |\n| content |string | - |\n| options | FunctionTransformOptions | - |\n\n\n\n## Types\n\n\n\n### [Analyzer](#-vuedx-analyze-Analyzer-interface)\n\n```ts\ninterface Analyzer {\n analyze: (content: string, fileName?: string) => ComponentInfo\n analyzeScript: (\n content: string,\n fileName?: string,\n mode?: 'script' | 'scriptSetup',\n ) => ComponentInfo\n analyzeTemplate: (content: string, fileName?: string) => ComponentInfo\n}\n```\n\n
\n\n\n\n### [ComponentInfo](#-vuedx-analyze-ComponentInfo-interface)\n\n```ts\ninterface ComponentInfo {\n components: LocalComponentRegistrationInfo[]\n emits: EmitInfo[]\n errors: SyntaxError[]\n fnSetupOption?: SetupInfo\n identifierSource: Record
\n\n\n\n### [ComponentRegistrationInfo](#-vuedx-analyze-ComponentRegistrationInfo-interface)\n\n```ts\ninterface ComponentRegistrationInfo {\n aliases: string[]\n name: string\n source: ImportSource\n}\n```\n\n
\n\n\n\n### [EmitInfo](#-vuedx-analyze-EmitInfo-interface)\n\n```ts\ninterface EmitInfo extends Taggable, Addressable {\n description: string\n isDynamic: boolean\n isInferred: boolean\n name: string\n references: SourceRange[]\n type: TypeInfo[]\n}\n```\n\n
\n\n\n\n### [IdentifierSource](#-vuedx-analyze-IdentifierSource-interface)\n\n```ts\ninterface IdentifierSource extends Addressable {\n name: string\n}\n```\n\n
\n\n\n\n### [ImportSource](#-vuedx-analyze-ImportSource-interface)\n\n```ts\ninterface ImportSource {\n exportName?: string\n localName: string\n moduleName: string\n}\n```\n\n
\n\n\n\n### [ImportSourceWithLocation](#-vuedx-analyze-ImportSourceWithLocation-interface)\n\n```ts\ninterface ImportSourceWithLocation extends ImportSource, Addressable {}\n```\n\n
\n\n\n\n### [LocalComponentRegistrationInfo](#-vuedx-analyze-LocalComponentRegistrationInfo-interface)\n\n```ts\ninterface LocalComponentRegistrationInfo\n extends ComponentRegistrationInfo,\n Addressable {\n kind: 'script' | 'scriptSetup'\n source: ImportSourceWithLocation\n}\n```\n\n
\n\n\n\n### [Plugin](#-vuedx-analyze-Plugin-2-interface)\n\n```ts\ninterface Plugin {\n babel?: AbstractScriptAnalyzerFn | AbstractAnalyzerHandler\n blocks?: Partial<{\n script: BlockAnalyzer
\n\n\n\n### [PropInfo](#-vuedx-analyze-PropInfo-interface)\n\n```ts\ninterface PropInfo extends Taggable, Addressable {\n defaultValue: ValueInfo | null\n description: string\n name: string\n required: boolean\n type: TypeInfo[]\n}\n```\n\n
\n\n\n\n### [ScriptSetupInfo](#-vuedx-analyze-ScriptSetupInfo-interface)\n\n```ts\ninterface ScriptSetupInfo {\n defineEmit?: Addressable\n defineProps?: Addressable\n}\n```\n\n
\n\n\n\n### [SetupInfo](#-vuedx-analyze-SetupInfo-interface)\n\n```ts\ninterface SetupInfo extends Addressable {\n context?: {\n identifiers: Partial<{\n attrs: string\n slots: string\n emit: string\n }>\n rest?: string\n } & Addressable\n props?: {\n identifiers: string[]\n rest?: string\n } & Addressable\n return?: Addressable\n}\n```\n\n
\n\n\n\n### [SourceRange](#-vuedx-analyze-SourceRange-interface)\n\n```ts\ninterface SourceRange {\n end: SourceLocation\n source: string\n start: SourceLocation\n}\n```\n\n
\n\n\n\n### [SyntaxError](#-vuedx-analyze-SyntaxError-2-interface)\n\n```ts\ninterface SyntaxError {\n loc: SourceLocation\n message: string\n}\n```\n\n
\n\n","readmeFilename":"readme.md","_id":"@vuedx/analyze@0.3.1-insiders-1608185511.0","_nodeVersion":"14.14.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-Z3px3eLY4hWeYMXAVy3NQ4w33lKHjYvCFUYNiCeVsBoIcbxAzilM23pEsMoFFk+NKT7PfPaQjL9LsLglXBhVSw==","shasum":"30af55662745a3b89c830a022e55a00ab6f7eeb4","tarball":"https://registry.npmjs.org/@vuedx/analyze/-/analyze-0.3.1-insiders-1608185511.0.tgz","fileCount":9,"unpackedSize":435364,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJf2va+CRA9TVsSAnZWagAAfGcP/2STZk0YQ24CmXNnXGHg\nJ56tmJcn3aCTGsR6OVLtetX648+YnTZY6FQs2yKx6YvE7yHMzDAMQf8os7kT\nhYjlNBOfhrivGOlteVyc87HIxWmnWyxofPP9SnPI/44o0qjOm8+woKSRcRux\nBApK4bXWoTFfhD7x8qjl1mjQU9Pe4fqpHDhbVDUn/x8i0c6RwLVErb3CRfcL\nuLSsre2D4p8dxRvL1/t36U+tJfP8IeXoqOCVjFGZ11WSt64wPo0SkA+m68Wd\nR9oKT0n0/3a9ar+U29unlA5bTQm7uxYAnKroF/MTm259wz1xnnbku4RHJ2gJ\nbUVi4jQd88KLBZ1K/iUcCzemXAAlcAD8E2ZJw/d5C8Zh4x6+9BZm8I5RdB9H\nR/CFC6u5HUs8WQS1ME0dRt8kB03wxGYCKPrkq+ebx22nSu4Gy0GJNyqXUHON\nJj+IUDFmx8/psQStbGzaUO/3RdFSHUE5Lmcw6UbCsx12U5Y04URXpnCAgFxD\np36o+JGwix/4z76eXON/7Bd2alb68Z8a/hpAdyl7me6yZciJ3TP0ONkHLG1X\nt1NCgO+98LUjauEL81Wx0FR55DxzJYkZEbhlMM9fVLwafZzWNOQv3C3jJc1V\nmK6pG1hIsUKX4taZl8rTy7CspYzy5rcZ9aAtxW5xTTqCoF/emxBOQUz6vptF\nQRGv\r\n=XzOo\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCbLEjSWiUKp0inQSSAq0iDmtN8PJtbJZ9LX8+cI8wquQIgWLW3IVTA9kUpLWZel+tZ8chhLfIZvpgfGmoKiLeQEyI="}]},"_npmUser":{"name":"znck","email":"rahulkdn@gmail.com"},"directories":{},"maintainers":[{"name":"znck","email":"rahulkdn@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/analyze_0.3.1-insiders-1608185511.0_1608185533896_0.9583789517931232"},"_hasShrinkwrap":false},"0.3.1-insiders-1608281809.0":{"name":"@vuedx/analyze","version":"0.3.1-insiders-1608281809.0","description":"Extracts public API information from Vue component.","main":"dist/index.cjs.js","module":"dist/index.esm.js","types":"dist/index.d.ts","bin":{"vuedx-analyze":"bin/analyze.js"},"keywords":["vue","sfc","sfc api extractor","static analyzer","sfc analyzer","sfc static analyzer","docgen","documentation"],"repository":{"type":"git","url":"git+https://github.com/znck/vue-developer-experience.git"},"author":{"name":"Rahul Kadyan","email":"rahulkdn@gmail.com","url":"https://znck.me/"},"funding":{"type":"individual","url":"https://github.com/sponsors/znck"},"license":"MIT","bugs":{"url":"https://github.com/znck/vue-developer-experience/issues"},"homepage":"https://github.com/znck/vue-developer-experience#readme","dependencies":{"@babel/code-frame":"^7.10.4","@babel/generator":"^7.12.1","@babel/parser":"^7.12.3","@babel/template":"^7.12.7","@babel/traverse":"7.12.1","@babel/types":"7.12.1","@types/micromatch":"^4.0.1","@vuedx/compiler-sfc":"0.3.1-insiders-1608281809.0","@vuedx/compiler-tsx":"0.3.1-insiders-1608281809.0","@vuedx/projectconfig":"0.3.3-insiders-1608281809.0","@vuedx/template-ast-types":"0.3.1-insiders-1608281809.0","cli-highlight":"^2.1.4","commander":"^6.1.0","fast-glob":"^3.2.4","hash-sum":"^2.0.0","micromatch":"^4.0.2"},"devDependencies":{"@types/babel__traverse":"^7.0.15","@vuedx/shared":"0.0.1-insiders-1608281809.0","typescript":"^4.0.3"},"readme":"
\n \n
\n\n## Support\n\nThis package is part of [VueDX project](https://github.com/znck/vue-developer-experience), maintained by [Rahul Kadyan](https://github.com/znck). You can [💖 sponsor him](https://github.com/sponsors/znck) for continued development of this package and other VueDX tools.\n\n## Usage\n\n\n\n\n## API\n\n\n\n### [ConfiguredVueProject](#-vuedx-analyze-ConfiguredVueProject-class)\n\n\n Analyze
\nA tool to statically analyze Vue single file components.
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare class ConfiguredVueProject extends VueProject {\n constructor(\n rootDir: string,\n packageFile: string | undefined,\n packageJSON: Partial\n\n\n\n#### [setFileNames](#-vuedx-analyze-ConfiguredVueProject-setFileNames-member-1-)\n\n**Signature:**\n\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --------- | --------------------- | ----------- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n### [InferredVueProject](#-vuedx-analyze-InferredVueProject-class)\n\n
More info
\n\n**Signature:**\n\n```ts\ndeclare class InferredVueProject extends VueProject {\n kind: 'inferred'\n protected refresh(): void\n}\n```\n\n**Members:**\n\n\n\n#### [refresh](#-vuedx-analyze-InferredVueProject-refresh-member-1-)\n\n**Signature:**\n\n```ts\nprotected refresh(): void;\n```\n\n\n
\n\n\n\n### [VueProject](#-vuedx-analyze-VueProject-class)\n\n
More info
\n\n**Signature:**\n\n```ts\ndeclare abstract class VueProject {\n protected _config: Readonly\n\n\n\n#### [markDirty](#-vuedx-analyze-VueProject-markDirty-member-1-)\n\n**Signature:**\n\n```ts\nmarkDirty(): void;\n```\n\n
\n\n\n\n#### [refresh](#-vuedx-analyze-VueProject-refresh-member-1-)\n\n**Signature:**\n\n```ts\nprotected abstract refresh(): void;\n```\n\n
\n\n\n\n#### [reloadIfNeeded](#-vuedx-analyze-VueProject-reloadIfNeeded-member-1-)\n\n**Signature:**\n\n```ts\nprotected reloadIfNeeded(): void;\n```\n\n
\n\n\n\n#### [setConfig](#-vuedx-analyze-VueProject-setConfig-member-1-)\n\n**Signature:**\n\n```ts\nsetConfig(config: ProjectConfig): void;\n```\n\n| Parameter | Type | Description |\n| --------- | --------------------------------------------------------------------------------------- | ----------- |\n| config |
ProjectConfig | - |\n\n\n\n\n\n#### [setFileNames](#-vuedx-analyze-VueProject-setFileNames-member-1-)\n\n**Signature:**\n\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --------- | --------------------- | ----------- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n### [createAnalyzer](#-vuedx-analyze-createAnalyzer-function-1-)\n\n
\n,\n): Analyzer\n```\n\n| Parameter | Type | Description |\n| --------- | ---------------------------------------------------------------------------------------------------------------------- | ----------- |\n| plugins |
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare function createAnalyzer(\n plugins: Plugin[],\n options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createFullAnalyzer](#-vuedx-analyze-createFullAnalyzer-function-1-)\n\n
\n,\n): ReturnType\n```\n\n| Parameter | Type | Description |\n| --------- | ---------------------------------------------------------------------------------------------------------------------- | ----------- |\n| plugins |
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare function createFullAnalyzer(\n plugins?: Plugin[],\n options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createSourceRange](#-vuedx-analyze-createSourceRange-function-1-)\n\n
\n
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare function createSourceRange(\n context: Context | ScriptAnalyzerContext,\n node: Node,\n): SourceRange\n```\n\n| Parameter | Type | Description |\n| --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |\n| context |Context | ScriptAnalyzerContext | - |\n| node | Node | - |\n\n\n\n\n\n### [transformToFunction](#-vuedx-analyze-transformToFunction-function-1-)\n\n
\n
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare function transformToFunction(\n content: string,\n options?: FunctionTransformOptions,\n): string\n```\n\n| Parameter | Type | Description |\n| --------- | ------------------------------------------------------------------------------------------------------- | ----------- |\n| content |string | - |\n| options | FunctionTransformOptions | - |\n\n\n\n## Types\n\n\n\n### [Analyzer](#-vuedx-analyze-Analyzer-interface)\n\n```ts\ninterface Analyzer {\n analyze: (content: string, fileName?: string) => ComponentInfo\n analyzeScript: (\n content: string,\n fileName?: string,\n mode?: 'script' | 'scriptSetup',\n ) => ComponentInfo\n analyzeTemplate: (content: string, fileName?: string) => ComponentInfo\n}\n```\n\n
\n\n\n\n### [ComponentInfo](#-vuedx-analyze-ComponentInfo-interface)\n\n```ts\ninterface ComponentInfo {\n components: LocalComponentRegistrationInfo[]\n emits: EmitInfo[]\n errors: SyntaxError[]\n fnSetupOption?: SetupInfo\n identifierSource: Record
\n\n\n\n### [ComponentRegistrationInfo](#-vuedx-analyze-ComponentRegistrationInfo-interface)\n\n```ts\ninterface ComponentRegistrationInfo {\n aliases: string[]\n name: string\n source: ImportSource\n}\n```\n\n
\n\n\n\n### [EmitInfo](#-vuedx-analyze-EmitInfo-interface)\n\n```ts\ninterface EmitInfo extends Taggable, Addressable {\n description: string\n isDynamic: boolean\n isInferred: boolean\n name: string\n references: SourceRange[]\n type: TypeInfo[]\n}\n```\n\n
\n\n\n\n### [IdentifierSource](#-vuedx-analyze-IdentifierSource-interface)\n\n```ts\ninterface IdentifierSource extends Addressable {\n name: string\n}\n```\n\n
\n\n\n\n### [ImportSource](#-vuedx-analyze-ImportSource-interface)\n\n```ts\ninterface ImportSource {\n exportName?: string\n localName: string\n moduleName: string\n}\n```\n\n
\n\n\n\n### [ImportSourceWithLocation](#-vuedx-analyze-ImportSourceWithLocation-interface)\n\n```ts\ninterface ImportSourceWithLocation extends ImportSource, Addressable {}\n```\n\n
\n\n\n\n### [LocalComponentRegistrationInfo](#-vuedx-analyze-LocalComponentRegistrationInfo-interface)\n\n```ts\ninterface LocalComponentRegistrationInfo\n extends ComponentRegistrationInfo,\n Addressable {\n kind: 'script' | 'scriptSetup'\n source: ImportSourceWithLocation\n}\n```\n\n
\n\n\n\n### [Plugin](#-vuedx-analyze-Plugin-2-interface)\n\n```ts\ninterface Plugin {\n babel?: AbstractScriptAnalyzerFn | AbstractAnalyzerHandler\n blocks?: Partial<{\n script: BlockAnalyzer
\n\n\n\n### [PropInfo](#-vuedx-analyze-PropInfo-interface)\n\n```ts\ninterface PropInfo extends Taggable, Addressable {\n defaultValue: ValueInfo | null\n description: string\n name: string\n required: boolean\n type: TypeInfo[]\n}\n```\n\n
\n\n\n\n### [ScriptSetupInfo](#-vuedx-analyze-ScriptSetupInfo-interface)\n\n```ts\ninterface ScriptSetupInfo {\n defineEmit?: Addressable\n defineProps?: Addressable\n}\n```\n\n
\n\n\n\n### [SetupInfo](#-vuedx-analyze-SetupInfo-interface)\n\n```ts\ninterface SetupInfo extends Addressable {\n context?: {\n identifiers: Partial<{\n attrs: string\n slots: string\n emit: string\n }>\n rest?: string\n } & Addressable\n props?: {\n identifiers: string[]\n rest?: string\n } & Addressable\n return?: Addressable\n}\n```\n\n
\n\n\n\n### [SourceRange](#-vuedx-analyze-SourceRange-interface)\n\n```ts\ninterface SourceRange {\n end: SourceLocation\n source: string\n start: SourceLocation\n}\n```\n\n
\n\n\n\n### [SyntaxError](#-vuedx-analyze-SyntaxError-2-interface)\n\n```ts\ninterface SyntaxError {\n loc: SourceLocation\n message: string\n}\n```\n\n
\n\n","readmeFilename":"readme.md","_id":"@vuedx/analyze@0.3.1-insiders-1608281809.0","_nodeVersion":"14.14.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-kAfNe6i0+/YdilKtl3eG/MjMa4Q3GAaZGh+74fL+LrIdCkD3r3mneLg5ETTeTuZ6oNUaM6FN06D0JKY+aUuTRQ==","shasum":"a24ed97fec41811089754e420b391ba5aaa55b19","tarball":"https://registry.npmjs.org/@vuedx/analyze/-/analyze-0.3.1-insiders-1608281809.0.tgz","fileCount":9,"unpackedSize":435364,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJf3G7nCRA9TVsSAnZWagAAjvwP/Avamfbmx6qyBYw1mMkJ\nHoTfhsaZ1cACaYy31k37i0EUr2YoX/tX4jGGs8uTkvq2CAjAiycAPo4IxW31\nvESE6DhW9xbF0Dq3gMAQ8FK+gH52jugO9MS5DKsmBWcJLZ8Oa0e7IZ4YctPE\njARYilmCrf4klSeOJ5pIG9OZvfyRx8cSGDMdU1gpw5zeuxGhAUyb/QnXlPwz\nfA+H0AXKKpEYxCUmDdnUKZWUbM6pozna6fqeWuP/tgMBgBTMXNasZYJUWbMj\nFKPFfIJKTux8CX01RbZOjtUg4h42Vd/MzCnFJvItxXbQ/NXLdDBdO2Yk4QnP\nY8yuQKPtlDK4obJWJtGhw0muDNYFRyg0C18gouH7cf9jRB6oI6EuIoCWKdDR\na5tHXdwzz3PMLcSaHo6eTPKEH5+fXS589FlfUhQ1CSUb0VZhyHXFvpK0QpL6\nzjFJkmOyY31CVKeQG7Ht4BtnxGFnzd4owiq8NrOZd/fZ2c/j3YUMwTBw59Im\nogCeDgcMpSP2V3vSrJSTGa9uwEkEadsJzFrlI5/c+aVlbGuex5UrGqHad1pP\n9Og4NjPobRaV7hepk03clen7QL7s5jf3wq7lsxa51MX/74MJtqVZPvr+YhV2\nZObYU1RIySOiuxBKZaUpYDOVaxH4KpjdCvjRHvZ5Sg5KaithnewO0bPNr4RW\nJNJn\r\n=0HuU\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCID2dLvnIhULYtnij2t24o9eMGQ6FWG2+vs+nwHSRzEf8AiEAhYJ+s2OEOpe72K7JUQUy1wfNZXFYRO3unnbo+ezgmF8="}]},"_npmUser":{"name":"znck","email":"rahulkdn@gmail.com"},"directories":{},"maintainers":[{"name":"znck","email":"rahulkdn@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/analyze_0.3.1-insiders-1608281809.0_1608281830984_0.5838182826866858"},"_hasShrinkwrap":false},"0.3.1-insiders-1608285835.0":{"name":"@vuedx/analyze","version":"0.3.1-insiders-1608285835.0","description":"Extracts public API information from Vue component.","main":"dist/index.cjs.js","module":"dist/index.esm.js","types":"dist/index.d.ts","bin":{"vuedx-analyze":"bin/analyze.js"},"keywords":["vue","sfc","sfc api extractor","static analyzer","sfc analyzer","sfc static analyzer","docgen","documentation"],"repository":{"type":"git","url":"git+https://github.com/znck/vue-developer-experience.git"},"author":{"name":"Rahul Kadyan","email":"rahulkdn@gmail.com","url":"https://znck.me/"},"funding":{"type":"individual","url":"https://github.com/sponsors/znck"},"license":"MIT","bugs":{"url":"https://github.com/znck/vue-developer-experience/issues"},"homepage":"https://github.com/znck/vue-developer-experience#readme","dependencies":{"@babel/code-frame":"^7.10.4","@babel/generator":"^7.12.1","@babel/parser":"^7.12.3","@babel/template":"^7.12.7","@babel/traverse":"7.12.1","@babel/types":"7.12.1","@types/micromatch":"^4.0.1","@vuedx/compiler-sfc":"0.3.1-insiders-1608285835.0","@vuedx/compiler-tsx":"0.3.1-insiders-1608285835.0","@vuedx/projectconfig":"0.3.3-insiders-1608285835.0","@vuedx/template-ast-types":"0.3.1-insiders-1608285835.0","cli-highlight":"^2.1.4","commander":"^6.1.0","fast-glob":"^3.2.4","hash-sum":"^2.0.0","micromatch":"^4.0.2"},"devDependencies":{"@types/babel__traverse":"^7.0.15","@vuedx/shared":"0.0.1-insiders-1608285835.0","typescript":"^4.0.3"},"readme":"
\n \n
\n\n## Support\n\nThis package is part of [VueDX project](https://github.com/znck/vue-developer-experience), maintained by [Rahul Kadyan](https://github.com/znck). You can [💖 sponsor him](https://github.com/sponsors/znck) for continued development of this package and other VueDX tools.\n\n## Usage\n\n\n\n\n## API\n\n\n\n### [ConfiguredVueProject](#-vuedx-analyze-ConfiguredVueProject-class)\n\n\n Analyze
\nA tool to statically analyze Vue single file components.
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare class ConfiguredVueProject extends VueProject {\n constructor(\n rootDir: string,\n packageFile: string | undefined,\n packageJSON: Partial\n\n\n\n#### [setFileNames](#-vuedx-analyze-ConfiguredVueProject-setFileNames-member-1-)\n\n**Signature:**\n\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --------- | --------------------- | ----------- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n### [InferredVueProject](#-vuedx-analyze-InferredVueProject-class)\n\n
More info
\n\n**Signature:**\n\n```ts\ndeclare class InferredVueProject extends VueProject {\n kind: 'inferred'\n protected refresh(): void\n}\n```\n\n**Members:**\n\n\n\n#### [refresh](#-vuedx-analyze-InferredVueProject-refresh-member-1-)\n\n**Signature:**\n\n```ts\nprotected refresh(): void;\n```\n\n\n
\n\n\n\n### [VueProject](#-vuedx-analyze-VueProject-class)\n\n
More info
\n\n**Signature:**\n\n```ts\ndeclare abstract class VueProject {\n protected _config: Readonly\n\n\n\n#### [markDirty](#-vuedx-analyze-VueProject-markDirty-member-1-)\n\n**Signature:**\n\n```ts\nmarkDirty(): void;\n```\n\n
\n\n\n\n#### [refresh](#-vuedx-analyze-VueProject-refresh-member-1-)\n\n**Signature:**\n\n```ts\nprotected abstract refresh(): void;\n```\n\n
\n\n\n\n#### [reloadIfNeeded](#-vuedx-analyze-VueProject-reloadIfNeeded-member-1-)\n\n**Signature:**\n\n```ts\nprotected reloadIfNeeded(): void;\n```\n\n
\n\n\n\n#### [setConfig](#-vuedx-analyze-VueProject-setConfig-member-1-)\n\n**Signature:**\n\n```ts\nsetConfig(config: ProjectConfig): void;\n```\n\n| Parameter | Type | Description |\n| --------- | --------------------------------------------------------------------------------------- | ----------- |\n| config |
ProjectConfig | - |\n\n\n\n\n\n#### [setFileNames](#-vuedx-analyze-VueProject-setFileNames-member-1-)\n\n**Signature:**\n\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --------- | --------------------- | ----------- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n### [createAnalyzer](#-vuedx-analyze-createAnalyzer-function-1-)\n\n
\n,\n): Analyzer\n```\n\n| Parameter | Type | Description |\n| --------- | ---------------------------------------------------------------------------------------------------------------------- | ----------- |\n| plugins |
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare function createAnalyzer(\n plugins: Plugin[],\n options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createFullAnalyzer](#-vuedx-analyze-createFullAnalyzer-function-1-)\n\n
\n,\n): ReturnType\n```\n\n| Parameter | Type | Description |\n| --------- | ---------------------------------------------------------------------------------------------------------------------- | ----------- |\n| plugins |
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare function createFullAnalyzer(\n plugins?: Plugin[],\n options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createSourceRange](#-vuedx-analyze-createSourceRange-function-1-)\n\n
\n
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare function createSourceRange(\n context: Context | ScriptAnalyzerContext,\n node: Node,\n): SourceRange\n```\n\n| Parameter | Type | Description |\n| --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |\n| context |Context | ScriptAnalyzerContext | - |\n| node | Node | - |\n\n\n\n\n\n### [transformToFunction](#-vuedx-analyze-transformToFunction-function-1-)\n\n
\n
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare function transformToFunction(\n content: string,\n options?: FunctionTransformOptions,\n): string\n```\n\n| Parameter | Type | Description |\n| --------- | ------------------------------------------------------------------------------------------------------- | ----------- |\n| content |string | - |\n| options | FunctionTransformOptions | - |\n\n\n\n## Types\n\n\n\n### [Analyzer](#-vuedx-analyze-Analyzer-interface)\n\n```ts\ninterface Analyzer {\n analyze: (content: string, fileName?: string) => ComponentInfo\n analyzeScript: (\n content: string,\n fileName?: string,\n mode?: 'script' | 'scriptSetup',\n ) => ComponentInfo\n analyzeTemplate: (content: string, fileName?: string) => ComponentInfo\n}\n```\n\n
\n\n\n\n### [ComponentInfo](#-vuedx-analyze-ComponentInfo-interface)\n\n```ts\ninterface ComponentInfo {\n components: LocalComponentRegistrationInfo[]\n emits: EmitInfo[]\n errors: SyntaxError[]\n fnSetupOption?: SetupInfo\n identifierSource: Record
\n\n\n\n### [ComponentRegistrationInfo](#-vuedx-analyze-ComponentRegistrationInfo-interface)\n\n```ts\ninterface ComponentRegistrationInfo {\n aliases: string[]\n name: string\n source: ImportSource\n}\n```\n\n
\n\n\n\n### [EmitInfo](#-vuedx-analyze-EmitInfo-interface)\n\n```ts\ninterface EmitInfo extends Taggable, Addressable {\n description: string\n isDynamic: boolean\n isInferred: boolean\n name: string\n references: SourceRange[]\n type: TypeInfo[]\n}\n```\n\n
\n\n\n\n### [IdentifierSource](#-vuedx-analyze-IdentifierSource-interface)\n\n```ts\ninterface IdentifierSource extends Addressable {\n name: string\n}\n```\n\n
\n\n\n\n### [ImportSource](#-vuedx-analyze-ImportSource-interface)\n\n```ts\ninterface ImportSource {\n exportName?: string\n localName: string\n moduleName: string\n}\n```\n\n
\n\n\n\n### [ImportSourceWithLocation](#-vuedx-analyze-ImportSourceWithLocation-interface)\n\n```ts\ninterface ImportSourceWithLocation extends ImportSource, Addressable {}\n```\n\n
\n\n\n\n### [LocalComponentRegistrationInfo](#-vuedx-analyze-LocalComponentRegistrationInfo-interface)\n\n```ts\ninterface LocalComponentRegistrationInfo\n extends ComponentRegistrationInfo,\n Addressable {\n kind: 'script' | 'scriptSetup'\n source: ImportSourceWithLocation\n}\n```\n\n
\n\n\n\n### [Plugin](#-vuedx-analyze-Plugin-2-interface)\n\n```ts\ninterface Plugin {\n babel?: AbstractScriptAnalyzerFn | AbstractAnalyzerHandler\n blocks?: Partial<{\n script: BlockAnalyzer
\n\n\n\n### [PropInfo](#-vuedx-analyze-PropInfo-interface)\n\n```ts\ninterface PropInfo extends Taggable, Addressable {\n defaultValue: ValueInfo | null\n description: string\n name: string\n required: boolean\n type: TypeInfo[]\n}\n```\n\n
\n\n\n\n### [ScriptSetupInfo](#-vuedx-analyze-ScriptSetupInfo-interface)\n\n```ts\ninterface ScriptSetupInfo {\n defineEmit?: Addressable\n defineProps?: Addressable\n}\n```\n\n
\n\n\n\n### [SetupInfo](#-vuedx-analyze-SetupInfo-interface)\n\n```ts\ninterface SetupInfo extends Addressable {\n context?: {\n identifiers: Partial<{\n attrs: string\n slots: string\n emit: string\n }>\n rest?: string\n } & Addressable\n props?: {\n identifiers: string[]\n rest?: string\n } & Addressable\n return?: Addressable\n}\n```\n\n
\n\n\n\n### [SourceRange](#-vuedx-analyze-SourceRange-interface)\n\n```ts\ninterface SourceRange {\n end: SourceLocation\n source: string\n start: SourceLocation\n}\n```\n\n
\n\n\n\n### [SyntaxError](#-vuedx-analyze-SyntaxError-2-interface)\n\n```ts\ninterface SyntaxError {\n loc: SourceLocation\n message: string\n}\n```\n\n
\n\n","readmeFilename":"readme.md","_id":"@vuedx/analyze@0.3.1-insiders-1608285835.0","_nodeVersion":"14.14.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-wXmRu2nH7FHjYvUUuOAmc4Y4gYaXsnoM1iMgNmZ/lM5DeoZ/0LuJYgZVijWNv8DnsWgfCMPMjdyP+ksJ8+am0A==","shasum":"0473199551282724667687f1c83c6b3d14d1ccf9","tarball":"https://registry.npmjs.org/@vuedx/analyze/-/analyze-0.3.1-insiders-1608285835.0.tgz","fileCount":9,"unpackedSize":436592,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJf3H6jCRA9TVsSAnZWagAAdAMP/jdhhHL1AxnQKai6gm4d\nRZOCInRBD0nj0GiLGFiuK3NEBJT7abm7A8MN/Zjbhn4GlP4ygRqnz0UVOnnd\nK26Rgab1WE6J+QaNKejeAnpGWG/lPZSgx6035HRPUeryTqeNpmpjYH81N4gW\n13lLA+dqMwwrXLO/afUvj+BTGt6BPCJo29BPghPcdTS8G9j+h3QcEp285Spb\naMpiVAfKMzXUXONmaIVZAptqVJGrITJfm256b+w9mkT1QaeSKSloz8B5OZ06\nZ8ZT6D7KnRscWh8k1b8yZzfkr9zuHaZDmDJmVfhw0RhVqycIxW/Sq7Y4E6an\njKQQ5KVhYN1LQu65toAJIbZ0xCUIaiHzIGuRArBJO4rGm32pJBi5hlJBy8WR\notoxC6guCPcO7/YR8e+mqtMrZri7HXeUhhe0bhvVhAD7iUWaOzmeDIBbuhsv\nY5zMka2vyhE82PijD5jl+vMOzGYowniOE3z9ZaMSsEnLOdtIF1Yrp4bekIQ1\nvnzyWhwZGwcR9ZFZgwcmlVNKSg7M6R3OEExXQNLPZAssqPhENF/VTSHpcDgE\nbHli4IxhO97DeMPMPUs0E/kKW7XXrTCKEVZfVINZC+BZDGrGIdkgta1yPw2+\nw+ZqEDUrkxxDQFuHkxDcRZY9tEwG8QGzM7aAWyvNg7ZjpiUJCkVHBj2H7d4y\nVpOz\r\n=wRfG\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIBYp0FY+OBb3gl+MWQA6f+o83VPeIpNS0hKvaiJz7GIUAiBg/h0YNi56DvN9GW2hof1tkq48fiAC2TmNoMmW9n0Etw=="}]},"_npmUser":{"name":"znck","email":"rahulkdn@gmail.com"},"directories":{},"maintainers":[{"name":"znck","email":"rahulkdn@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/analyze_0.3.1-insiders-1608285835.0_1608285858871_0.007442886314257491"},"_hasShrinkwrap":false},"0.3.1-insiders-1608294809.0":{"name":"@vuedx/analyze","version":"0.3.1-insiders-1608294809.0","description":"Extracts public API information from Vue component.","main":"dist/index.cjs.js","module":"dist/index.esm.js","types":"dist/index.d.ts","bin":{"vuedx-analyze":"bin/analyze.js"},"keywords":["vue","sfc","sfc api extractor","static analyzer","sfc analyzer","sfc static analyzer","docgen","documentation"],"repository":{"type":"git","url":"git+https://github.com/znck/vue-developer-experience.git"},"author":{"name":"Rahul Kadyan","email":"rahulkdn@gmail.com","url":"https://znck.me/"},"funding":{"type":"individual","url":"https://github.com/sponsors/znck"},"license":"MIT","bugs":{"url":"https://github.com/znck/vue-developer-experience/issues"},"homepage":"https://github.com/znck/vue-developer-experience#readme","dependencies":{"@babel/code-frame":"^7.10.4","@babel/generator":"^7.12.1","@babel/parser":"^7.12.3","@babel/template":"^7.12.7","@babel/traverse":"7.12.1","@babel/types":"7.12.1","@types/micromatch":"^4.0.1","@vuedx/compiler-sfc":"0.3.1-insiders-1608294809.0","@vuedx/compiler-tsx":"0.3.1-insiders-1608294809.0","@vuedx/projectconfig":"0.3.3-insiders-1608294809.0","@vuedx/template-ast-types":"0.3.1-insiders-1608294809.0","cli-highlight":"^2.1.4","commander":"^6.1.0","fast-glob":"^3.2.4","hash-sum":"^2.0.0","micromatch":"^4.0.2"},"devDependencies":{"@types/babel__traverse":"^7.0.15","@types/node":"^14.14.14","@vuedx/shared":"0.0.1-insiders-1608294809.0","typescript":"^4.0.3"},"readme":"
\n \n
\n\n## Support\n\nThis package is part of [VueDX project](https://github.com/znck/vue-developer-experience), maintained by [Rahul Kadyan](https://github.com/znck). You can [💖 sponsor him](https://github.com/sponsors/znck) for continued development of this package and other VueDX tools.\n\n## Usage\n\n\n\n\n## API\n\n\n\n### [ConfiguredVueProject](#-vuedx-analyze-ConfiguredVueProject-class)\n\n\n Analyze
\nA tool to statically analyze Vue single file components.
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare class ConfiguredVueProject extends VueProject {\n constructor(\n rootDir: string,\n packageFile: string | undefined,\n packageJSON: Partial\n\n\n\n#### [setFileNames](#-vuedx-analyze-ConfiguredVueProject-setFileNames-member-1-)\n\n**Signature:**\n\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --------- | --------------------- | ----------- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n### [InferredVueProject](#-vuedx-analyze-InferredVueProject-class)\n\n
More info
\n\n**Signature:**\n\n```ts\ndeclare class InferredVueProject extends VueProject {\n kind: 'inferred'\n protected refresh(): void\n}\n```\n\n**Members:**\n\n\n\n#### [refresh](#-vuedx-analyze-InferredVueProject-refresh-member-1-)\n\n**Signature:**\n\n```ts\nprotected refresh(): void;\n```\n\n\n
\n\n\n\n### [VueProject](#-vuedx-analyze-VueProject-class)\n\n
More info
\n\n**Signature:**\n\n```ts\ndeclare abstract class VueProject {\n protected _config: Readonly\n\n\n\n#### [markDirty](#-vuedx-analyze-VueProject-markDirty-member-1-)\n\n**Signature:**\n\n```ts\nmarkDirty(): void;\n```\n\n
\n\n\n\n#### [refresh](#-vuedx-analyze-VueProject-refresh-member-1-)\n\n**Signature:**\n\n```ts\nprotected abstract refresh(): void;\n```\n\n
\n\n\n\n#### [reloadIfNeeded](#-vuedx-analyze-VueProject-reloadIfNeeded-member-1-)\n\n**Signature:**\n\n```ts\nprotected reloadIfNeeded(): void;\n```\n\n
\n\n\n\n#### [setConfig](#-vuedx-analyze-VueProject-setConfig-member-1-)\n\n**Signature:**\n\n```ts\nsetConfig(config: ProjectConfig): void;\n```\n\n| Parameter | Type | Description |\n| --------- | --------------------------------------------------------------------------------------- | ----------- |\n| config |
ProjectConfig | - |\n\n\n\n\n\n#### [setFileNames](#-vuedx-analyze-VueProject-setFileNames-member-1-)\n\n**Signature:**\n\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --------- | --------------------- | ----------- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n### [createAnalyzer](#-vuedx-analyze-createAnalyzer-function-1-)\n\n
\n,\n): Analyzer\n```\n\n| Parameter | Type | Description |\n| --------- | ---------------------------------------------------------------------------------------------------------------------- | ----------- |\n| plugins |
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare function createAnalyzer(\n plugins: Plugin[],\n options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createFullAnalyzer](#-vuedx-analyze-createFullAnalyzer-function-1-)\n\n
\n,\n): ReturnType\n```\n\n| Parameter | Type | Description |\n| --------- | ---------------------------------------------------------------------------------------------------------------------- | ----------- |\n| plugins |
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare function createFullAnalyzer(\n plugins?: Plugin[],\n options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createSourceRange](#-vuedx-analyze-createSourceRange-function-1-)\n\n
\n
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare function createSourceRange(\n context: Context | ScriptAnalyzerContext,\n node: Node,\n): SourceRange\n```\n\n| Parameter | Type | Description |\n| --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |\n| context |Context | ScriptAnalyzerContext | - |\n| node | Node | - |\n\n\n\n\n\n### [transformToFunction](#-vuedx-analyze-transformToFunction-function-1-)\n\n
\n
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare function transformToFunction(\n content: string,\n options?: FunctionTransformOptions,\n): string\n```\n\n| Parameter | Type | Description |\n| --------- | ------------------------------------------------------------------------------------------------------- | ----------- |\n| content |string | - |\n| options | FunctionTransformOptions | - |\n\n\n\n## Types\n\n\n\n### [Analyzer](#-vuedx-analyze-Analyzer-interface)\n\n```ts\ninterface Analyzer {\n analyze: (content: string, fileName?: string) => ComponentInfo\n analyzeScript: (\n content: string,\n fileName?: string,\n mode?: 'script' | 'scriptSetup',\n ) => ComponentInfo\n analyzeTemplate: (content: string, fileName?: string) => ComponentInfo\n}\n```\n\n
\n\n\n\n### [ComponentInfo](#-vuedx-analyze-ComponentInfo-interface)\n\n```ts\ninterface ComponentInfo {\n components: LocalComponentRegistrationInfo[]\n emits: EmitInfo[]\n errors: SyntaxError[]\n fnSetupOption?: SetupInfo\n identifierSource: Record
\n\n\n\n### [ComponentRegistrationInfo](#-vuedx-analyze-ComponentRegistrationInfo-interface)\n\n```ts\ninterface ComponentRegistrationInfo {\n aliases: string[]\n name: string\n source: ImportSource\n}\n```\n\n
\n\n\n\n### [EmitInfo](#-vuedx-analyze-EmitInfo-interface)\n\n```ts\ninterface EmitInfo extends Taggable, Addressable {\n description: string\n isDynamic: boolean\n isInferred: boolean\n name: string\n references: SourceRange[]\n type: TypeInfo[]\n}\n```\n\n
\n\n\n\n### [IdentifierSource](#-vuedx-analyze-IdentifierSource-interface)\n\n```ts\ninterface IdentifierSource extends Addressable {\n name: string\n}\n```\n\n
\n\n\n\n### [ImportSource](#-vuedx-analyze-ImportSource-interface)\n\n```ts\ninterface ImportSource {\n exportName?: string\n localName: string\n moduleName: string\n}\n```\n\n
\n\n\n\n### [ImportSourceWithLocation](#-vuedx-analyze-ImportSourceWithLocation-interface)\n\n```ts\ninterface ImportSourceWithLocation extends ImportSource, Addressable {}\n```\n\n
\n\n\n\n### [LocalComponentRegistrationInfo](#-vuedx-analyze-LocalComponentRegistrationInfo-interface)\n\n```ts\ninterface LocalComponentRegistrationInfo\n extends ComponentRegistrationInfo,\n Addressable {\n kind: 'script' | 'scriptSetup'\n source: ImportSourceWithLocation\n}\n```\n\n
\n\n\n\n### [Plugin](#-vuedx-analyze-Plugin-2-interface)\n\n```ts\ninterface Plugin {\n babel?: AbstractScriptAnalyzerFn | AbstractAnalyzerHandler\n blocks?: Partial<{\n script: BlockAnalyzer
\n\n\n\n### [PropInfo](#-vuedx-analyze-PropInfo-interface)\n\n```ts\ninterface PropInfo extends Taggable, Addressable {\n defaultValue: ValueInfo | null\n description: string\n name: string\n required: boolean\n type: TypeInfo[]\n}\n```\n\n
\n\n\n\n### [ScriptSetupInfo](#-vuedx-analyze-ScriptSetupInfo-interface)\n\n```ts\ninterface ScriptSetupInfo {\n defineEmit?: Addressable\n defineProps?: Addressable\n}\n```\n\n
\n\n\n\n### [SetupInfo](#-vuedx-analyze-SetupInfo-interface)\n\n```ts\ninterface SetupInfo extends Addressable {\n context?: {\n identifiers: Partial<{\n attrs: string\n slots: string\n emit: string\n }>\n rest?: string\n } & Addressable\n props?: {\n identifiers: string[]\n rest?: string\n } & Addressable\n return?: Addressable\n}\n```\n\n
\n\n\n\n### [SourceRange](#-vuedx-analyze-SourceRange-interface)\n\n```ts\ninterface SourceRange {\n end: SourceLocation\n source: string\n start: SourceLocation\n}\n```\n\n
\n\n\n\n### [SyntaxError](#-vuedx-analyze-SyntaxError-2-interface)\n\n```ts\ninterface SyntaxError {\n loc: SourceLocation\n message: string\n}\n```\n\n
\n\n","readmeFilename":"readme.md","_id":"@vuedx/analyze@0.3.1-insiders-1608294809.0","_nodeVersion":"14.14.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-m37sLhZ9QB91IzPMx9GBANk90QgEcjbNYjdlSRco1k9CI/I3dRytgX9Cf3tUSu3APFXkwBZwo/yryAnYAZU34g==","shasum":"cbe54f8bbff11349e97f3aece6dab8b4ec67d92d","tarball":"https://registry.npmjs.org/@vuedx/analyze/-/analyze-0.3.1-insiders-1608294809.0.tgz","fileCount":9,"unpackedSize":474862,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJf3KGvCRA9TVsSAnZWagAAytkP/AuzqLv7IdReqQpzCe91\nV2AnPvUOp/eTA9J4T+jt2L/IzT2qJxETLeh3w4Vr8cxQgle+z5ca9FMejuoo\nW8WdgVGLG9tkecD+Su4mL6I7WjyJcIn6TyJ5bJ2h57LHKn81VKs/ic6cBmWK\nqcRV9zFVQInJ9ZoTwsITJn6/W7u4F7jQH/nbJ5uz6qu7Zd9SykIZsiGoQT3h\nj/jwfc5mvk6ZD6h5daprMoo7/6bSywQJjIuNafA28jvbx1Xq39Cy11t0kYl8\nHUQD8gve3sIKbY/6cVKkSmYrqs87+gMb4vWf12XU0Ts/9H3/TpAVU+B6leoM\nbtPm3zDODgPCBobhEaZDSCB46V5vBHwdL9RGliFNiMZ9hao0BEhrt+xtNMvX\nKjr8IUzv7OwbmTC5JS55CUIYr+nx4ZReIAUnP+Ucf4EvKuxAGESg+QwZI61y\nNwyuhdWvOR/8TGRPANy/JCDG1btBSrfH05VvRSCCUSck8bz81BH8oMSZQthX\n2f/rpANBuiWglt7oCi89uzzF/gcDW6JkmzHiYFWCcrDGAkxyI2kIVkVT7vz6\ntGoqJPGmCe0sy+5qBesVq7phWyRISD7xTpk2wMPMxaH2pnOt8NUriVoBipFl\nvLp3qZmfyS1Wap9xr6Qm+FJQEglFIJAZGrkfa6FxzXDf6C61u/pvpWzxdL3q\n8OZH\r\n=y87i\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCFwChCirsVjZqp2jYPJf39MmmKVA1RRtxEGdJ9F5C5XQIhAM9/n5zZvAOk5sZzBQWy9Mxp1lekoWXOX0BEEGKvQ+a2"}]},"_npmUser":{"name":"znck","email":"rahulkdn@gmail.com"},"directories":{},"maintainers":[{"name":"znck","email":"rahulkdn@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/analyze_0.3.1-insiders-1608294809.0_1608294830545_0.39262370858708073"},"_hasShrinkwrap":false},"0.3.1-insiders-1608632613.0":{"name":"@vuedx/analyze","version":"0.3.1-insiders-1608632613.0","description":"Extracts public API information from Vue component.","main":"dist/index.cjs.js","module":"dist/index.esm.js","types":"dist/index.d.ts","bin":{"vuedx-analyze":"bin/analyze.js"},"keywords":["vue","sfc","sfc api extractor","static analyzer","sfc analyzer","sfc static analyzer","docgen","documentation"],"repository":{"type":"git","url":"git+https://github.com/znck/vue-developer-experience.git"},"author":{"name":"Rahul Kadyan","email":"rahulkdn@gmail.com","url":"https://znck.me/"},"funding":{"type":"individual","url":"https://github.com/sponsors/znck"},"license":"MIT","bugs":{"url":"https://github.com/znck/vue-developer-experience/issues"},"homepage":"https://github.com/znck/vue-developer-experience#readme","dependencies":{"@babel/code-frame":"^7.10.4","@babel/generator":"^7.12.1","@babel/parser":"^7.12.3","@babel/template":"^7.12.7","@babel/traverse":"7.12.1","@babel/types":"7.12.1","@types/micromatch":"^4.0.1","@vuedx/compiler-sfc":"0.3.1-insiders-1608632613.0","@vuedx/compiler-tsx":"0.3.1-insiders-1608632613.0","@vuedx/projectconfig":"0.3.3-insiders-1608632613.0","@vuedx/template-ast-types":"0.3.1-insiders-1608632613.0","cli-highlight":"^2.1.4","commander":"^6.1.0","fast-glob":"^3.2.4","hash-sum":"^2.0.0","micromatch":"^4.0.2"},"devDependencies":{"@types/babel__traverse":"^7.0.15","@types/node":"^14.14.14","@vuedx/shared":"0.0.1-insiders-1608632613.0","typescript":"^4.0.3"},"readme":"
\n \n
\n\n## Support\n\nThis package is part of [VueDX project](https://github.com/znck/vue-developer-experience), maintained by [Rahul Kadyan](https://github.com/znck). You can [💖 sponsor him](https://github.com/sponsors/znck) for continued development of this package and other VueDX tools.\n\n## Usage\n\n\n\n\n## API\n\n\n\n### [ConfiguredVueProject](#-vuedx-analyze-ConfiguredVueProject-class)\n\n\n Analyze
\nA tool to statically analyze Vue single file components.
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare class ConfiguredVueProject extends VueProject {\n constructor(\n rootDir: string,\n packageFile: string | undefined,\n packageJSON: Partial\n\n\n\n#### [setFileNames](#-vuedx-analyze-ConfiguredVueProject-setFileNames-member-1-)\n\n**Signature:**\n\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --------- | --------------------- | ----------- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n### [InferredVueProject](#-vuedx-analyze-InferredVueProject-class)\n\n
More info
\n\n**Signature:**\n\n```ts\ndeclare class InferredVueProject extends VueProject {\n kind: 'inferred'\n protected refresh(): void\n}\n```\n\n**Members:**\n\n\n\n#### [refresh](#-vuedx-analyze-InferredVueProject-refresh-member-1-)\n\n**Signature:**\n\n```ts\nprotected refresh(): void;\n```\n\n\n
\n\n\n\n### [VueProject](#-vuedx-analyze-VueProject-class)\n\n
More info
\n\n**Signature:**\n\n```ts\ndeclare abstract class VueProject {\n protected _config: Readonly\n\n\n\n#### [markDirty](#-vuedx-analyze-VueProject-markDirty-member-1-)\n\n**Signature:**\n\n```ts\nmarkDirty(): void;\n```\n\n
\n\n\n\n#### [refresh](#-vuedx-analyze-VueProject-refresh-member-1-)\n\n**Signature:**\n\n```ts\nprotected abstract refresh(): void;\n```\n\n
\n\n\n\n#### [reloadIfNeeded](#-vuedx-analyze-VueProject-reloadIfNeeded-member-1-)\n\n**Signature:**\n\n```ts\nprotected reloadIfNeeded(): void;\n```\n\n
\n\n\n\n#### [setConfig](#-vuedx-analyze-VueProject-setConfig-member-1-)\n\n**Signature:**\n\n```ts\nsetConfig(config: ProjectConfig): void;\n```\n\n| Parameter | Type | Description |\n| --------- | --------------------------------------------------------------------------------------- | ----------- |\n| config |
ProjectConfig | - |\n\n\n\n\n\n#### [setFileNames](#-vuedx-analyze-VueProject-setFileNames-member-1-)\n\n**Signature:**\n\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --------- | --------------------- | ----------- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n### [createAnalyzer](#-vuedx-analyze-createAnalyzer-function-1-)\n\n
\n,\n): Analyzer\n```\n\n| Parameter | Type | Description |\n| --------- | ---------------------------------------------------------------------------------------------------------------------- | ----------- |\n| plugins |
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare function createAnalyzer(\n plugins: Plugin[],\n options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createFullAnalyzer](#-vuedx-analyze-createFullAnalyzer-function-1-)\n\n
\n,\n): ReturnType\n```\n\n| Parameter | Type | Description |\n| --------- | ---------------------------------------------------------------------------------------------------------------------- | ----------- |\n| plugins |
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare function createFullAnalyzer(\n plugins?: Plugin[],\n options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createSourceRange](#-vuedx-analyze-createSourceRange-function-1-)\n\n
\n
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare function createSourceRange(\n context: Context | ScriptAnalyzerContext,\n node: Node,\n): SourceRange\n```\n\n| Parameter | Type | Description |\n| --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |\n| context |Context | ScriptAnalyzerContext | - |\n| node | Node | - |\n\n\n\n\n\n### [transformToFunction](#-vuedx-analyze-transformToFunction-function-1-)\n\n
\n
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare function transformToFunction(\n content: string,\n options?: FunctionTransformOptions,\n): string\n```\n\n| Parameter | Type | Description |\n| --------- | ------------------------------------------------------------------------------------------------------- | ----------- |\n| content |string | - |\n| options | FunctionTransformOptions | - |\n\n\n\n## Types\n\n\n\n### [Analyzer](#-vuedx-analyze-Analyzer-interface)\n\n```ts\ninterface Analyzer {\n analyze: (content: string, fileName?: string) => ComponentInfo\n analyzeScript: (\n content: string,\n fileName?: string,\n mode?: 'script' | 'scriptSetup',\n ) => ComponentInfo\n analyzeTemplate: (content: string, fileName?: string) => ComponentInfo\n}\n```\n\n
\n\n\n\n### [ComponentInfo](#-vuedx-analyze-ComponentInfo-interface)\n\n```ts\ninterface ComponentInfo {\n components: LocalComponentRegistrationInfo[]\n emits: EmitInfo[]\n errors: SyntaxError[]\n fnSetupOption?: SetupInfo\n identifierSource: Record
\n\n\n\n### [ComponentRegistrationInfo](#-vuedx-analyze-ComponentRegistrationInfo-interface)\n\n```ts\ninterface ComponentRegistrationInfo {\n aliases: string[]\n name: string\n source: ImportSource\n}\n```\n\n
\n\n\n\n### [EmitInfo](#-vuedx-analyze-EmitInfo-interface)\n\n```ts\ninterface EmitInfo extends Taggable, Addressable {\n description: string\n isDynamic: boolean\n isInferred: boolean\n name: string\n references: SourceRange[]\n type: TypeInfo[]\n}\n```\n\n
\n\n\n\n### [IdentifierSource](#-vuedx-analyze-IdentifierSource-interface)\n\n```ts\ninterface IdentifierSource extends Addressable {\n name: string\n}\n```\n\n
\n\n\n\n### [ImportSource](#-vuedx-analyze-ImportSource-interface)\n\n```ts\ninterface ImportSource {\n exportName?: string\n localName: string\n moduleName: string\n}\n```\n\n
\n\n\n\n### [ImportSourceWithLocation](#-vuedx-analyze-ImportSourceWithLocation-interface)\n\n```ts\ninterface ImportSourceWithLocation extends ImportSource, Addressable {}\n```\n\n
\n\n\n\n### [LocalComponentRegistrationInfo](#-vuedx-analyze-LocalComponentRegistrationInfo-interface)\n\n```ts\ninterface LocalComponentRegistrationInfo\n extends ComponentRegistrationInfo,\n Addressable {\n kind: 'script' | 'scriptSetup'\n source: ImportSourceWithLocation\n}\n```\n\n
\n\n\n\n### [Plugin](#-vuedx-analyze-Plugin-2-interface)\n\n```ts\ninterface Plugin {\n babel?: AbstractScriptAnalyzerFn | AbstractAnalyzerHandler\n blocks?: Partial<{\n script: BlockAnalyzer
\n\n\n\n### [PropInfo](#-vuedx-analyze-PropInfo-interface)\n\n```ts\ninterface PropInfo extends Taggable, Addressable {\n defaultValue: ValueInfo | null\n description: string\n name: string\n required: boolean\n type: TypeInfo[]\n}\n```\n\n
\n\n\n\n### [ScriptSetupInfo](#-vuedx-analyze-ScriptSetupInfo-interface)\n\n```ts\ninterface ScriptSetupInfo {\n defineEmit?: Addressable\n defineProps?: Addressable\n}\n```\n\n
\n\n\n\n### [SetupInfo](#-vuedx-analyze-SetupInfo-interface)\n\n```ts\ninterface SetupInfo extends Addressable {\n context?: {\n identifiers: Partial<{\n attrs: string\n slots: string\n emit: string\n }>\n rest?: string\n } & Addressable\n props?: {\n identifiers: string[]\n rest?: string\n } & Addressable\n return?: Addressable\n}\n```\n\n
\n\n\n\n### [SourceRange](#-vuedx-analyze-SourceRange-interface)\n\n```ts\ninterface SourceRange {\n end: SourceLocation\n source: string\n start: SourceLocation\n}\n```\n\n
\n\n\n\n### [SyntaxError](#-vuedx-analyze-SyntaxError-2-interface)\n\n```ts\ninterface SyntaxError {\n loc: SourceLocation\n message: string\n}\n```\n\n
\n\n","readmeFilename":"readme.md","_id":"@vuedx/analyze@0.3.1-insiders-1608632613.0","_nodeVersion":"14.14.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-D0okGTV7xXfigATtA1EJmvlxszAat7vz+00a1GwaLefAuBShd7oMv2PZt8rqFIV4f2NITjSqJYr0uhM6NGbJ3g==","shasum":"8b371b922c381533d56286d9aeabdd35b7b60947","tarball":"https://registry.npmjs.org/@vuedx/analyze/-/analyze-0.3.1-insiders-1608632613.0.tgz","fileCount":9,"unpackedSize":474862,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJf4ck8CRA9TVsSAnZWagAA+W4P/06AedG6RCb/vv5+B3Dj\nE4R1g4Z2R/DdrylNubpQtGsq9at1w6C8BrafJgMZi5ebxfxPQ/7Bm1t9n/ge\nKRrvTJZUpMwt35JeNYE+VtDCXej0/h0gPVAsvCcUJGQgCJovTFON6QLy8iqk\nDkjMASp7xMzbgFKtrUDyRnquKTkGGSW/p8ZtUxbjsFuY/qbQq9vax3/6GQJH\nAInLZ+nTByHJ7lHAOSc9iW5Nj2RUOsKFQr6pCMQgRgEEyMwYBU0ezNrFuIyU\ndshFZEH6joxKXQ1w+02wKXAkdc1od1wns7M2tCNSboNBqtT9Zo2NKteHy8RA\nQl1Ajc4P7HHJ7vVOplugPXVw67P/EWkdGuzCru0d5F0Z/s7LnINv2Scn6MHw\n4LlvEgH0x+2M9LFgbTARyuep3JQc0ehxReRKTNaP8V2sZ0yEMdJ6zSfoffob\ntgvQV24gBcD44fb6XMIRtPbWhoQukEAP/dd5YKJM/Z8H9XdYD7ucrRa1Gt6P\nFt6nGRB0pQ7g2w7zHzFxiKLy1T4S3hqzBH4pVXlz06GLoacg6pDtv5E90cpw\nd3PezDiwV4BtUHqlwPk+Mlm4KVrQnGCMhgTpco+81oH0wjRZwu3aSsTiTUnp\ncoNqSUTHVrxBEw0KydGfZBC6S0WWY0bPBMxBlVcR4+UlOkx7GJEq+Pcejg53\nsDMI\r\n=cWBf\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIHL9j7DDvu6EzsF3XKko0n1QxDV2kJz8S0K4IctxZBVrAiEAly9jWZ4EgSdmPuS+HRqS4i36Gu9iKBbSDqlGk2SYrgI="}]},"_npmUser":{"name":"znck","email":"rahulkdn@gmail.com"},"directories":{},"maintainers":[{"name":"znck","email":"rahulkdn@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/analyze_0.3.1-insiders-1608632613.0_1608632635709_0.06831881097975279"},"_hasShrinkwrap":false},"0.3.1-insiders-1608642006.0":{"name":"@vuedx/analyze","version":"0.3.1-insiders-1608642006.0","description":"Extracts public API information from Vue component.","main":"dist/index.cjs.js","module":"dist/index.esm.js","types":"dist/index.d.ts","bin":{"vuedx-analyze":"bin/analyze.js"},"keywords":["vue","sfc","sfc api extractor","static analyzer","sfc analyzer","sfc static analyzer","docgen","documentation"],"repository":{"type":"git","url":"git+https://github.com/znck/vue-developer-experience.git"},"author":{"name":"Rahul Kadyan","email":"rahulkdn@gmail.com","url":"https://znck.me/"},"funding":{"type":"individual","url":"https://github.com/sponsors/znck"},"license":"MIT","bugs":{"url":"https://github.com/znck/vue-developer-experience/issues"},"homepage":"https://github.com/znck/vue-developer-experience#readme","dependencies":{"@babel/code-frame":"^7.10.4","@babel/generator":"^7.12.1","@babel/parser":"^7.12.3","@babel/template":"^7.12.7","@babel/traverse":"7.12.1","@babel/types":"7.12.1","@types/micromatch":"^4.0.1","@vuedx/compiler-sfc":"0.3.1-insiders-1608642006.0","@vuedx/compiler-tsx":"0.3.1-insiders-1608642006.0","@vuedx/projectconfig":"0.3.3-insiders-1608642006.0","@vuedx/template-ast-types":"0.3.1-insiders-1608642006.0","cli-highlight":"^2.1.4","commander":"^6.1.0","fast-glob":"^3.2.4","hash-sum":"^2.0.0","micromatch":"^4.0.2"},"devDependencies":{"@types/babel__traverse":"^7.0.15","@types/node":"^14.14.14","@vuedx/shared":"0.0.1-insiders-1608642006.0","typescript":"^4.0.3"},"readme":"
\n \n
\n\n## Support\n\nThis package is part of [VueDX project](https://github.com/znck/vue-developer-experience), maintained by [Rahul Kadyan](https://github.com/znck). You can [💖 sponsor him](https://github.com/sponsors/znck) for continued development of this package and other VueDX tools.\n\n## Usage\n\n\n\n\n## API\n\n\n\n### [ConfiguredVueProject](#-vuedx-analyze-ConfiguredVueProject-class)\n\n\n Analyze
\nA tool to statically analyze Vue single file components.
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare class ConfiguredVueProject extends VueProject {\n constructor(\n rootDir: string,\n packageFile: string | undefined,\n packageJSON: Partial\n\n\n\n#### [setFileNames](#-vuedx-analyze-ConfiguredVueProject-setFileNames-member-1-)\n\n**Signature:**\n\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --------- | --------------------- | ----------- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n### [InferredVueProject](#-vuedx-analyze-InferredVueProject-class)\n\n
More info
\n\n**Signature:**\n\n```ts\ndeclare class InferredVueProject extends VueProject {\n kind: 'inferred'\n protected refresh(): void\n}\n```\n\n**Members:**\n\n\n\n#### [refresh](#-vuedx-analyze-InferredVueProject-refresh-member-1-)\n\n**Signature:**\n\n```ts\nprotected refresh(): void;\n```\n\n\n
\n\n\n\n### [VueProject](#-vuedx-analyze-VueProject-class)\n\n
More info
\n\n**Signature:**\n\n```ts\ndeclare abstract class VueProject {\n protected _config: Readonly\n\n\n\n#### [markDirty](#-vuedx-analyze-VueProject-markDirty-member-1-)\n\n**Signature:**\n\n```ts\nmarkDirty(): void;\n```\n\n
\n\n\n\n#### [refresh](#-vuedx-analyze-VueProject-refresh-member-1-)\n\n**Signature:**\n\n```ts\nprotected abstract refresh(): void;\n```\n\n
\n\n\n\n#### [reloadIfNeeded](#-vuedx-analyze-VueProject-reloadIfNeeded-member-1-)\n\n**Signature:**\n\n```ts\nprotected reloadIfNeeded(): void;\n```\n\n
\n\n\n\n#### [setConfig](#-vuedx-analyze-VueProject-setConfig-member-1-)\n\n**Signature:**\n\n```ts\nsetConfig(config: ProjectConfig): void;\n```\n\n| Parameter | Type | Description |\n| --------- | --------------------------------------------------------------------------------------- | ----------- |\n| config |
ProjectConfig | - |\n\n\n\n\n\n#### [setFileNames](#-vuedx-analyze-VueProject-setFileNames-member-1-)\n\n**Signature:**\n\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --------- | --------------------- | ----------- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n### [createAnalyzer](#-vuedx-analyze-createAnalyzer-function-1-)\n\n
\n,\n): Analyzer\n```\n\n| Parameter | Type | Description |\n| --------- | ---------------------------------------------------------------------------------------------------------------------- | ----------- |\n| plugins |
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare function createAnalyzer(\n plugins: Plugin[],\n options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createFullAnalyzer](#-vuedx-analyze-createFullAnalyzer-function-1-)\n\n
\n,\n): ReturnType\n```\n\n| Parameter | Type | Description |\n| --------- | ---------------------------------------------------------------------------------------------------------------------- | ----------- |\n| plugins |
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare function createFullAnalyzer(\n plugins?: Plugin[],\n options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createSourceRange](#-vuedx-analyze-createSourceRange-function-1-)\n\n
\n
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare function createSourceRange(\n context: Context | ScriptAnalyzerContext,\n node: Node,\n): SourceRange\n```\n\n| Parameter | Type | Description |\n| --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |\n| context |Context | ScriptAnalyzerContext | - |\n| node | Node | - |\n\n\n\n\n\n### [transformToFunction](#-vuedx-analyze-transformToFunction-function-1-)\n\n
\n
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare function transformToFunction(\n content: string,\n options?: FunctionTransformOptions,\n): string\n```\n\n| Parameter | Type | Description |\n| --------- | ------------------------------------------------------------------------------------------------------- | ----------- |\n| content |string | - |\n| options | FunctionTransformOptions | - |\n\n\n\n## Types\n\n\n\n### [Analyzer](#-vuedx-analyze-Analyzer-interface)\n\n```ts\ninterface Analyzer {\n analyze: (content: string, fileName?: string) => ComponentInfo\n analyzeScript: (\n content: string,\n fileName?: string,\n mode?: 'script' | 'scriptSetup',\n ) => ComponentInfo\n analyzeTemplate: (content: string, fileName?: string) => ComponentInfo\n}\n```\n\n
\n\n\n\n### [ComponentInfo](#-vuedx-analyze-ComponentInfo-interface)\n\n```ts\ninterface ComponentInfo {\n components: LocalComponentRegistrationInfo[]\n emits: EmitInfo[]\n errors: SyntaxError[]\n fnSetupOption?: SetupInfo\n identifierSource: Record
\n\n\n\n### [ComponentRegistrationInfo](#-vuedx-analyze-ComponentRegistrationInfo-interface)\n\n```ts\ninterface ComponentRegistrationInfo {\n aliases: string[]\n name: string\n source: ImportSource\n}\n```\n\n
\n\n\n\n### [EmitInfo](#-vuedx-analyze-EmitInfo-interface)\n\n```ts\ninterface EmitInfo extends Taggable, Addressable {\n description: string\n isDynamic: boolean\n isInferred: boolean\n name: string\n references: SourceRange[]\n type: TypeInfo[]\n}\n```\n\n
\n\n\n\n### [IdentifierSource](#-vuedx-analyze-IdentifierSource-interface)\n\n```ts\ninterface IdentifierSource extends Addressable {\n name: string\n}\n```\n\n
\n\n\n\n### [ImportSource](#-vuedx-analyze-ImportSource-interface)\n\n```ts\ninterface ImportSource {\n exportName?: string\n localName: string\n moduleName: string\n}\n```\n\n
\n\n\n\n### [ImportSourceWithLocation](#-vuedx-analyze-ImportSourceWithLocation-interface)\n\n```ts\ninterface ImportSourceWithLocation extends ImportSource, Addressable {}\n```\n\n
\n\n\n\n### [LocalComponentRegistrationInfo](#-vuedx-analyze-LocalComponentRegistrationInfo-interface)\n\n```ts\ninterface LocalComponentRegistrationInfo\n extends ComponentRegistrationInfo,\n Addressable {\n kind: 'script' | 'scriptSetup'\n source: ImportSourceWithLocation\n}\n```\n\n
\n\n\n\n### [Plugin](#-vuedx-analyze-Plugin-2-interface)\n\n```ts\ninterface Plugin {\n babel?: AbstractScriptAnalyzerFn | AbstractAnalyzerHandler\n blocks?: Partial<{\n script: BlockAnalyzer
\n\n\n\n### [PropInfo](#-vuedx-analyze-PropInfo-interface)\n\n```ts\ninterface PropInfo extends Taggable, Addressable {\n defaultValue: ValueInfo | null\n description: string\n name: string\n required: boolean\n type: TypeInfo[]\n}\n```\n\n
\n\n\n\n### [ScriptSetupInfo](#-vuedx-analyze-ScriptSetupInfo-interface)\n\n```ts\ninterface ScriptSetupInfo {\n defineEmit?: Addressable\n defineProps?: Addressable\n}\n```\n\n
\n\n\n\n### [SetupInfo](#-vuedx-analyze-SetupInfo-interface)\n\n```ts\ninterface SetupInfo extends Addressable {\n context?: {\n identifiers: Partial<{\n attrs: string\n slots: string\n emit: string\n }>\n rest?: string\n } & Addressable\n props?: {\n identifiers: string[]\n rest?: string\n } & Addressable\n return?: Addressable\n}\n```\n\n
\n\n\n\n### [SourceRange](#-vuedx-analyze-SourceRange-interface)\n\n```ts\ninterface SourceRange {\n end: SourceLocation\n source: string\n start: SourceLocation\n}\n```\n\n
\n\n\n\n### [SyntaxError](#-vuedx-analyze-SyntaxError-2-interface)\n\n```ts\ninterface SyntaxError {\n loc: SourceLocation\n message: string\n}\n```\n\n
\n\n","readmeFilename":"readme.md","_id":"@vuedx/analyze@0.3.1-insiders-1608642006.0","_nodeVersion":"14.14.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-GODyWSznbxUinma9gIf9QJBA6/NCf/vCgNyDO3Jx0F/WDWg4cJLA69JMzJYnVpWDelBsrUzKsC+DK7P86SVH8Q==","shasum":"ba56dab44cd0310ac1217c8bf44a5106f460c5fe","tarball":"https://registry.npmjs.org/@vuedx/analyze/-/analyze-0.3.1-insiders-1608642006.0.tgz","fileCount":9,"unpackedSize":475686,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJf4e3rCRA9TVsSAnZWagAAweUQAIle7+eou9IxXMjyT/s8\nWuz0KWyrlH7MeLEuqiLlpH62YLTfZ41zc8pCVI4fkRp8oKGgmDpWORwU4AXE\ngqiman5ZBu8/mAgXUH38a41Od28jmHZTeOOnlCZDDxQ3GVkzhafTWpwK5Xnh\nVC45odsYNoA5+0NJqyD3pXrMO2gWLS/F4xGmW/kAWM2JnlYv01GtXHXYli7l\n77f9dZ0ARMwSQda4K3uo3GmYAqM6AaL18RPm3UAPf/Go3Eyi9obeKac1b6Hk\ndclNl/Iob2QIK6xMW8RKpx1w/FlnG0PeoP6vvdYgy/N91w2xSU1zo49hqZFf\nWOQo0wjGviQPoncNk/UXr8/UOAmiQM4PYaGuyolVQ/oI0Wx3BuywqvobBxCx\nwsj3ogFAhJW8CYkch0YUUurkIcVG4ObFDRTAuxQibrfwmyRRVFFZnS+qaMBx\n/YkkAn1TIDLOyhGAlGV3V2UII5+htzw9ILOIwSS7xy3bY0AzI2LaXEo4PAT7\nCILlFkxhn3R5NwBN9lh8wh71t6tXfa8mGFDoSQXzk3rb3JRklgdnfg2Wedfg\nRbTksda72GqHHsd81LZRMQpTz1N4d/yDImc0lWmtik04LGZGKaeTffxNx12G\nzZbbBmlhox0xu/nlcjS7rh0+smyd02mb51HOoBPKvnpfYwNqcilLc/dE0wzG\nPSP8\r\n=aEmH\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIA80ts8bC1uNXY7jqEo+zvYKOPOMRptWc0WAOLn6nOS/AiEAuttbznHw781vO1JRrPIEdcbcjdIomLVmrU3ThwFUh88="}]},"_npmUser":{"name":"znck","email":"rahulkdn@gmail.com"},"directories":{},"maintainers":[{"name":"znck","email":"rahulkdn@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/analyze_0.3.1-insiders-1608642006.0_1608642026834_0.1132303550425453"},"_hasShrinkwrap":false},"0.3.1-insiders-1608679071.0":{"name":"@vuedx/analyze","version":"0.3.1-insiders-1608679071.0","description":"Extracts public API information from Vue component.","main":"dist/index.cjs.js","module":"dist/index.esm.js","types":"dist/index.d.ts","bin":{"vuedx-analyze":"bin/analyze.js"},"keywords":["vue","sfc","sfc api extractor","static analyzer","sfc analyzer","sfc static analyzer","docgen","documentation"],"repository":{"type":"git","url":"git+https://github.com/znck/vue-developer-experience.git"},"author":{"name":"Rahul Kadyan","email":"rahulkdn@gmail.com","url":"https://znck.me/"},"funding":{"type":"individual","url":"https://github.com/sponsors/znck"},"license":"MIT","bugs":{"url":"https://github.com/znck/vue-developer-experience/issues"},"homepage":"https://github.com/znck/vue-developer-experience#readme","dependencies":{"@babel/code-frame":"^7.10.4","@babel/generator":"^7.12.1","@babel/parser":"^7.12.3","@babel/template":"^7.12.7","@babel/traverse":"7.12.1","@babel/types":"7.12.1","@types/micromatch":"^4.0.1","@vuedx/compiler-sfc":"0.3.1-insiders-1608679071.0","@vuedx/compiler-tsx":"0.3.1-insiders-1608679071.0","@vuedx/projectconfig":"0.3.3-insiders-1608679071.0","@vuedx/template-ast-types":"0.3.1-insiders-1608679071.0","cli-highlight":"^2.1.4","commander":"^6.1.0","fast-glob":"^3.2.4","hash-sum":"^2.0.0","micromatch":"^4.0.2"},"devDependencies":{"@types/babel__traverse":"^7.0.15","@types/node":"^14.14.14","@vuedx/shared":"0.0.1-insiders-1608679071.0","typescript":"^4.0.3"},"readme":"
\n \n
\n\n## Support\n\nThis package is part of [VueDX project](https://github.com/znck/vue-developer-experience), maintained by [Rahul Kadyan](https://github.com/znck). You can [💖 sponsor him](https://github.com/sponsors/znck) for continued development of this package and other VueDX tools.\n\n## Usage\n\n\n\n\n## API\n\n\n\n### [ConfiguredVueProject](#-vuedx-analyze-ConfiguredVueProject-class)\n\n\n Analyze
\nA tool to statically analyze Vue single file components.
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare class ConfiguredVueProject extends VueProject {\n constructor(\n rootDir: string,\n packageFile: string | undefined,\n packageJSON: Partial\n\n\n\n#### [setFileNames](#-vuedx-analyze-ConfiguredVueProject-setFileNames-member-1-)\n\n**Signature:**\n\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --------- | --------------------- | ----------- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n### [InferredVueProject](#-vuedx-analyze-InferredVueProject-class)\n\n
More info
\n\n**Signature:**\n\n```ts\ndeclare class InferredVueProject extends VueProject {\n kind: 'inferred'\n protected refresh(): void\n}\n```\n\n**Members:**\n\n\n\n#### [refresh](#-vuedx-analyze-InferredVueProject-refresh-member-1-)\n\n**Signature:**\n\n```ts\nprotected refresh(): void;\n```\n\n\n
\n\n\n\n### [VueProject](#-vuedx-analyze-VueProject-class)\n\n
More info
\n\n**Signature:**\n\n```ts\ndeclare abstract class VueProject {\n protected _config: Readonly\n\n\n\n#### [markDirty](#-vuedx-analyze-VueProject-markDirty-member-1-)\n\n**Signature:**\n\n```ts\nmarkDirty(): void;\n```\n\n
\n\n\n\n#### [refresh](#-vuedx-analyze-VueProject-refresh-member-1-)\n\n**Signature:**\n\n```ts\nprotected abstract refresh(): void;\n```\n\n
\n\n\n\n#### [reloadIfNeeded](#-vuedx-analyze-VueProject-reloadIfNeeded-member-1-)\n\n**Signature:**\n\n```ts\nprotected reloadIfNeeded(): void;\n```\n\n
\n\n\n\n#### [setConfig](#-vuedx-analyze-VueProject-setConfig-member-1-)\n\n**Signature:**\n\n```ts\nsetConfig(config: ProjectConfig): void;\n```\n\n| Parameter | Type | Description |\n| --------- | --------------------------------------------------------------------------------------- | ----------- |\n| config |
ProjectConfig | - |\n\n\n\n\n\n#### [setFileNames](#-vuedx-analyze-VueProject-setFileNames-member-1-)\n\n**Signature:**\n\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --------- | --------------------- | ----------- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n### [createAnalyzer](#-vuedx-analyze-createAnalyzer-function-1-)\n\n
\n,\n): Analyzer\n```\n\n| Parameter | Type | Description |\n| --------- | ---------------------------------------------------------------------------------------------------------------------- | ----------- |\n| plugins |
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare function createAnalyzer(\n plugins: Plugin[],\n options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createFullAnalyzer](#-vuedx-analyze-createFullAnalyzer-function-1-)\n\n
\n,\n): ReturnType\n```\n\n| Parameter | Type | Description |\n| --------- | ---------------------------------------------------------------------------------------------------------------------- | ----------- |\n| plugins |
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare function createFullAnalyzer(\n plugins?: Plugin[],\n options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createSourceRange](#-vuedx-analyze-createSourceRange-function-1-)\n\n
\n
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare function createSourceRange(\n context: Context | ScriptAnalyzerContext,\n node: Node,\n): SourceRange\n```\n\n| Parameter | Type | Description |\n| --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |\n| context |Context | ScriptAnalyzerContext | - |\n| node | Node | - |\n\n\n\n\n\n### [transformToFunction](#-vuedx-analyze-transformToFunction-function-1-)\n\n
\n
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare function transformToFunction(\n content: string,\n options?: FunctionTransformOptions,\n): string\n```\n\n| Parameter | Type | Description |\n| --------- | ------------------------------------------------------------------------------------------------------- | ----------- |\n| content |string | - |\n| options | FunctionTransformOptions | - |\n\n\n\n## Types\n\n\n\n### [Analyzer](#-vuedx-analyze-Analyzer-interface)\n\n```ts\ninterface Analyzer {\n analyze: (content: string, fileName?: string) => ComponentInfo\n analyzeScript: (\n content: string,\n fileName?: string,\n mode?: 'script' | 'scriptSetup',\n ) => ComponentInfo\n analyzeTemplate: (content: string, fileName?: string) => ComponentInfo\n}\n```\n\n
\n\n\n\n### [ComponentInfo](#-vuedx-analyze-ComponentInfo-interface)\n\n```ts\ninterface ComponentInfo {\n components: LocalComponentRegistrationInfo[]\n emits: EmitInfo[]\n errors: SyntaxError[]\n fnSetupOption?: SetupInfo\n identifierSource: Record
\n\n\n\n### [ComponentRegistrationInfo](#-vuedx-analyze-ComponentRegistrationInfo-interface)\n\n```ts\ninterface ComponentRegistrationInfo {\n aliases: string[]\n name: string\n source: ImportSource\n}\n```\n\n
\n\n\n\n### [EmitInfo](#-vuedx-analyze-EmitInfo-interface)\n\n```ts\ninterface EmitInfo extends Taggable, Addressable {\n description: string\n isDynamic: boolean\n isInferred: boolean\n name: string\n references: SourceRange[]\n type: TypeInfo[]\n}\n```\n\n
\n\n\n\n### [IdentifierSource](#-vuedx-analyze-IdentifierSource-interface)\n\n```ts\ninterface IdentifierSource extends Addressable {\n name: string\n}\n```\n\n
\n\n\n\n### [ImportSource](#-vuedx-analyze-ImportSource-interface)\n\n```ts\ninterface ImportSource {\n exportName?: string\n localName: string\n moduleName: string\n}\n```\n\n
\n\n\n\n### [ImportSourceWithLocation](#-vuedx-analyze-ImportSourceWithLocation-interface)\n\n```ts\ninterface ImportSourceWithLocation extends ImportSource, Addressable {}\n```\n\n
\n\n\n\n### [LocalComponentRegistrationInfo](#-vuedx-analyze-LocalComponentRegistrationInfo-interface)\n\n```ts\ninterface LocalComponentRegistrationInfo\n extends ComponentRegistrationInfo,\n Addressable {\n kind: 'script' | 'scriptSetup'\n source: ImportSourceWithLocation\n}\n```\n\n
\n\n\n\n### [Plugin](#-vuedx-analyze-Plugin-2-interface)\n\n```ts\ninterface Plugin {\n babel?: AbstractScriptAnalyzerFn | AbstractAnalyzerHandler\n blocks?: Partial<{\n script: BlockAnalyzer
\n\n\n\n### [PropInfo](#-vuedx-analyze-PropInfo-interface)\n\n```ts\ninterface PropInfo extends Taggable, Addressable {\n defaultValue: ValueInfo | null\n description: string\n name: string\n required: boolean\n type: TypeInfo[]\n}\n```\n\n
\n\n\n\n### [ScriptSetupInfo](#-vuedx-analyze-ScriptSetupInfo-interface)\n\n```ts\ninterface ScriptSetupInfo {\n defineEmit?: Addressable\n defineProps?: Addressable\n}\n```\n\n
\n\n\n\n### [SetupInfo](#-vuedx-analyze-SetupInfo-interface)\n\n```ts\ninterface SetupInfo extends Addressable {\n context?: {\n identifiers: Partial<{\n attrs: string\n slots: string\n emit: string\n }>\n rest?: string\n } & Addressable\n props?: {\n identifiers: string[]\n rest?: string\n } & Addressable\n return?: Addressable\n}\n```\n\n
\n\n\n\n### [SourceRange](#-vuedx-analyze-SourceRange-interface)\n\n```ts\ninterface SourceRange {\n end: SourceLocation\n source: string\n start: SourceLocation\n}\n```\n\n
\n\n\n\n### [SyntaxError](#-vuedx-analyze-SyntaxError-2-interface)\n\n```ts\ninterface SyntaxError {\n loc: SourceLocation\n message: string\n}\n```\n\n
\n\n","readmeFilename":"readme.md","_id":"@vuedx/analyze@0.3.1-insiders-1608679071.0","_nodeVersion":"14.14.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-q76R5zU3uTZIUJUaz3gawlM7FaVoVljqchcNhSY2mbI9j6YajuWKEZQqtr/piYt1xI4Ag43cn61RvXhzLir+2g==","shasum":"d706ed3b0c67c7dd1421ad713e44aff73e2aa01b","tarball":"https://registry.npmjs.org/@vuedx/analyze/-/analyze-0.3.1-insiders-1608679071.0.tgz","fileCount":9,"unpackedSize":475686,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJf4n62CRA9TVsSAnZWagAAy4QP/A9gikMpWEFozsQL6lTG\nxNjZlMK+fg8YToOIROdFoGHIbWIRmwO3GuWTTL3rOpccaEq0lWX7P2oxHaYO\nfrF9N5VPLWJyxJ2xzYyUgGfh5w0Ts/EXNbIhCuLBEUhJ9arDFIocWqFgd9qp\nKabT12NzLue1ONBeZ1pUzIAu/7BofaI2FcO6XlH9o5f7ALOSxfr3riowQvN2\nAiiDzIFWGc15VT/SAREPK96xocCoMqg+Hg+5/t2+AnFjwxFLtf8RG/WknHtD\nojUmH1relthBrtBwLSqdN3Rv4NQYkNrtRiy50diuuciDGuoHgEfhl4w9PTTf\naPzJ4U4UV5aMeLZYSgTqWLslI9U627i4MefVH3fxHF+pUfYCqbsOkjUf6XAr\nHXRhVT5/iKgkZy9qhqAXMoc387ZZxNhRQIrXYCEmSgyg+DBxiyj3xfXoDmg6\nR/OLRtk429X2ZvwY/axW8PfV+ujM5UaDnp8anJflo/4zV54FeeRIJQED/FaK\ncjoUG69w9h5wh9+b2RJMdgMtMNJwEVaeaDWWL9MtQMusDzehcOD6XwwYc12O\neMmAabmlt0AJO+Om8Lm7F4cQ1I/wUGvN2DEwJPLXOrish7vwJXnHZHrkVRwS\n+SBP0ZIN53Za1OsBBlNWDHRVvjOhckQmYCVrFFI3eMBydBHz1AGv9xQT3C5c\neE+N\r\n=XCKG\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIEu4UpW5mOYsuFR253nH/7TCCxDzPUQ2rMQNQX07O1exAiB2mX0IUwUIuBgaBDddShbX+tpv5tqdYseNKpNd+NMAsg=="}]},"_npmUser":{"name":"znck","email":"rahulkdn@gmail.com"},"directories":{},"maintainers":[{"name":"znck","email":"rahulkdn@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/analyze_0.3.1-insiders-1608679071.0_1608679093654_0.6673764037969552"},"_hasShrinkwrap":false},"0.3.1-insiders-1608679989.0":{"name":"@vuedx/analyze","version":"0.3.1-insiders-1608679989.0","description":"Extracts public API information from Vue component.","main":"dist/index.cjs.js","module":"dist/index.esm.js","types":"dist/index.d.ts","bin":{"vuedx-analyze":"bin/analyze.js"},"keywords":["vue","sfc","sfc api extractor","static analyzer","sfc analyzer","sfc static analyzer","docgen","documentation"],"repository":{"type":"git","url":"git+https://github.com/znck/vue-developer-experience.git"},"author":{"name":"Rahul Kadyan","email":"rahulkdn@gmail.com","url":"https://znck.me/"},"funding":{"type":"individual","url":"https://github.com/sponsors/znck"},"license":"MIT","bugs":{"url":"https://github.com/znck/vue-developer-experience/issues"},"homepage":"https://github.com/znck/vue-developer-experience#readme","dependencies":{"@babel/code-frame":"^7.10.4","@babel/generator":"^7.12.1","@babel/parser":"^7.12.3","@babel/template":"^7.12.7","@babel/traverse":"7.12.1","@babel/types":"7.12.1","@types/micromatch":"^4.0.1","@vuedx/compiler-sfc":"0.3.1-insiders-1608679989.0","@vuedx/compiler-tsx":"0.3.1-insiders-1608679989.0","@vuedx/projectconfig":"0.3.3-insiders-1608679989.0","@vuedx/template-ast-types":"0.3.1-insiders-1608679989.0","cli-highlight":"^2.1.4","commander":"^6.1.0","fast-glob":"^3.2.4","hash-sum":"^2.0.0","micromatch":"^4.0.2"},"devDependencies":{"@types/babel__traverse":"^7.0.15","@types/node":"^14.14.14","@vuedx/shared":"0.0.1-insiders-1608679989.0","typescript":"^4.0.3"},"readme":"
\n \n
\n\n## Support\n\nThis package is part of [VueDX project](https://github.com/znck/vue-developer-experience), maintained by [Rahul Kadyan](https://github.com/znck). You can [💖 sponsor him](https://github.com/sponsors/znck) for continued development of this package and other VueDX tools.\n\n## Usage\n\n\n\n\n## API\n\n\n\n### [ConfiguredVueProject](#-vuedx-analyze-ConfiguredVueProject-class)\n\n\n Analyze
\nA tool to statically analyze Vue single file components.
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare class ConfiguredVueProject extends VueProject {\n constructor(\n rootDir: string,\n packageFile: string | undefined,\n packageJSON: Partial\n\n\n\n#### [setFileNames](#-vuedx-analyze-ConfiguredVueProject-setFileNames-member-1-)\n\n**Signature:**\n\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --------- | --------------------- | ----------- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n### [InferredVueProject](#-vuedx-analyze-InferredVueProject-class)\n\n
More info
\n\n**Signature:**\n\n```ts\ndeclare class InferredVueProject extends VueProject {\n kind: 'inferred'\n protected refresh(): void\n}\n```\n\n**Members:**\n\n\n\n#### [refresh](#-vuedx-analyze-InferredVueProject-refresh-member-1-)\n\n**Signature:**\n\n```ts\nprotected refresh(): void;\n```\n\n\n
\n\n\n\n### [VueProject](#-vuedx-analyze-VueProject-class)\n\n
More info
\n\n**Signature:**\n\n```ts\ndeclare abstract class VueProject {\n protected _config: Readonly\n\n\n\n#### [markDirty](#-vuedx-analyze-VueProject-markDirty-member-1-)\n\n**Signature:**\n\n```ts\nmarkDirty(): void;\n```\n\n
\n\n\n\n#### [refresh](#-vuedx-analyze-VueProject-refresh-member-1-)\n\n**Signature:**\n\n```ts\nprotected abstract refresh(): void;\n```\n\n
\n\n\n\n#### [reloadIfNeeded](#-vuedx-analyze-VueProject-reloadIfNeeded-member-1-)\n\n**Signature:**\n\n```ts\nprotected reloadIfNeeded(): void;\n```\n\n
\n\n\n\n#### [setConfig](#-vuedx-analyze-VueProject-setConfig-member-1-)\n\n**Signature:**\n\n```ts\nsetConfig(config: ProjectConfig): void;\n```\n\n| Parameter | Type | Description |\n| --------- | --------------------------------------------------------------------------------------- | ----------- |\n| config |
ProjectConfig | - |\n\n\n\n\n\n#### [setFileNames](#-vuedx-analyze-VueProject-setFileNames-member-1-)\n\n**Signature:**\n\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --------- | --------------------- | ----------- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n### [createAnalyzer](#-vuedx-analyze-createAnalyzer-function-1-)\n\n
\n,\n): Analyzer\n```\n\n| Parameter | Type | Description |\n| --------- | ---------------------------------------------------------------------------------------------------------------------- | ----------- |\n| plugins |
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare function createAnalyzer(\n plugins: Plugin[],\n options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createFullAnalyzer](#-vuedx-analyze-createFullAnalyzer-function-1-)\n\n
\n,\n): ReturnType\n```\n\n| Parameter | Type | Description |\n| --------- | ---------------------------------------------------------------------------------------------------------------------- | ----------- |\n| plugins |
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare function createFullAnalyzer(\n plugins?: Plugin[],\n options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createSourceRange](#-vuedx-analyze-createSourceRange-function-1-)\n\n
\n
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare function createSourceRange(\n context: Context | ScriptAnalyzerContext,\n node: Node,\n): SourceRange\n```\n\n| Parameter | Type | Description |\n| --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |\n| context |Context | ScriptAnalyzerContext | - |\n| node | Node | - |\n\n\n\n\n\n### [transformToFunction](#-vuedx-analyze-transformToFunction-function-1-)\n\n
\n
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare function transformToFunction(\n content: string,\n options?: FunctionTransformOptions,\n): string\n```\n\n| Parameter | Type | Description |\n| --------- | ------------------------------------------------------------------------------------------------------- | ----------- |\n| content |string | - |\n| options | FunctionTransformOptions | - |\n\n\n\n## Types\n\n\n\n### [Analyzer](#-vuedx-analyze-Analyzer-interface)\n\n```ts\ninterface Analyzer {\n analyze: (content: string, fileName?: string) => ComponentInfo\n analyzeScript: (\n content: string,\n fileName?: string,\n mode?: 'script' | 'scriptSetup',\n ) => ComponentInfo\n analyzeTemplate: (content: string, fileName?: string) => ComponentInfo\n}\n```\n\n
\n\n\n\n### [ComponentInfo](#-vuedx-analyze-ComponentInfo-interface)\n\n```ts\ninterface ComponentInfo {\n components: LocalComponentRegistrationInfo[]\n emits: EmitInfo[]\n errors: SyntaxError[]\n fnSetupOption?: SetupInfo\n identifierSource: Record
\n\n\n\n### [ComponentRegistrationInfo](#-vuedx-analyze-ComponentRegistrationInfo-interface)\n\n```ts\ninterface ComponentRegistrationInfo {\n aliases: string[]\n name: string\n source: ImportSource\n}\n```\n\n
\n\n\n\n### [EmitInfo](#-vuedx-analyze-EmitInfo-interface)\n\n```ts\ninterface EmitInfo extends Taggable, Addressable {\n description: string\n isDynamic: boolean\n isInferred: boolean\n name: string\n references: SourceRange[]\n type: TypeInfo[]\n}\n```\n\n
\n\n\n\n### [IdentifierSource](#-vuedx-analyze-IdentifierSource-interface)\n\n```ts\ninterface IdentifierSource extends Addressable {\n name: string\n}\n```\n\n
\n\n\n\n### [ImportSource](#-vuedx-analyze-ImportSource-interface)\n\n```ts\ninterface ImportSource {\n exportName?: string\n localName: string\n moduleName: string\n}\n```\n\n
\n\n\n\n### [ImportSourceWithLocation](#-vuedx-analyze-ImportSourceWithLocation-interface)\n\n```ts\ninterface ImportSourceWithLocation extends ImportSource, Addressable {}\n```\n\n
\n\n\n\n### [LocalComponentRegistrationInfo](#-vuedx-analyze-LocalComponentRegistrationInfo-interface)\n\n```ts\ninterface LocalComponentRegistrationInfo\n extends ComponentRegistrationInfo,\n Addressable {\n kind: 'script' | 'scriptSetup'\n source: ImportSourceWithLocation\n}\n```\n\n
\n\n\n\n### [Plugin](#-vuedx-analyze-Plugin-2-interface)\n\n```ts\ninterface Plugin {\n babel?: AbstractScriptAnalyzerFn | AbstractAnalyzerHandler\n blocks?: Partial<{\n script: BlockAnalyzer
\n\n\n\n### [PropInfo](#-vuedx-analyze-PropInfo-interface)\n\n```ts\ninterface PropInfo extends Taggable, Addressable {\n defaultValue: ValueInfo | null\n description: string\n name: string\n required: boolean\n type: TypeInfo[]\n}\n```\n\n
\n\n\n\n### [ScriptSetupInfo](#-vuedx-analyze-ScriptSetupInfo-interface)\n\n```ts\ninterface ScriptSetupInfo {\n defineEmit?: Addressable\n defineProps?: Addressable\n}\n```\n\n
\n\n\n\n### [SetupInfo](#-vuedx-analyze-SetupInfo-interface)\n\n```ts\ninterface SetupInfo extends Addressable {\n context?: {\n identifiers: Partial<{\n attrs: string\n slots: string\n emit: string\n }>\n rest?: string\n } & Addressable\n props?: {\n identifiers: string[]\n rest?: string\n } & Addressable\n return?: Addressable\n}\n```\n\n
\n\n\n\n### [SourceRange](#-vuedx-analyze-SourceRange-interface)\n\n```ts\ninterface SourceRange {\n end: SourceLocation\n source: string\n start: SourceLocation\n}\n```\n\n
\n\n\n\n### [SyntaxError](#-vuedx-analyze-SyntaxError-2-interface)\n\n```ts\ninterface SyntaxError {\n loc: SourceLocation\n message: string\n}\n```\n\n
\n\n","readmeFilename":"readme.md","_id":"@vuedx/analyze@0.3.1-insiders-1608679989.0","_nodeVersion":"14.14.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-B8cMzdo9EGg0UbnIIVTY1w+23oV515R7ohDQut9U9+g8d7zUmaBSGDw2HOXMFMEfYc3cPTcJGA7iltYpakSDvg==","shasum":"a2571b800393f69a95bbf2447bb53365b93b0527","tarball":"https://registry.npmjs.org/@vuedx/analyze/-/analyze-0.3.1-insiders-1608679989.0.tgz","fileCount":9,"unpackedSize":475686,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJf4oJPCRA9TVsSAnZWagAAIqkP/AhF+iXYkvJ/ahsrVzbf\nNOoW+U6azC5TEW3HxMOxJQf1vtJ8nqeY/mSAgmWvZcX2L+U3WIZdd6FkoiFu\nP3DL8odAubuqrtrbE5+J9Xeyt9D9/kAJyGHm3XR+t2t2FGpfBlBeLBYiXVr1\nf7/sUuged+qnECYgZYIFn44xO1sNCTkhVfykJwbbdk+JX5701IRkDy37zURP\nQBGJmVPO0KfNLIDDT+Ugf07+JlqA1vhAQDC6Mm1B9s9qfqZBpmsvwKYER+mW\nBBcFOlQ1cfLQiWhcR9l+R2cdCXZ0eVd/C8iN8BJ4nXIXAP42y5IpPc4uew8D\nIlwNySJFoe1VTplfe2dUKreKWNb+tPRu0J8D9tvXP+R49zoAj/W5K/EumCtM\nNAVF5Tclqof4oWIlSMxwee+vmnBvqc3fsNlOxzIBQtSH78wSDIuHvdxGsF9C\ngMkUA1eywSVDAS7awI5/qvu3j0jjsFtgZrFaEN6OO63IvGRXRhxZTXf8lCFy\nl78d596hNayvyY3cMa58haa04CxbA3aTRybEGs9Y98ub7PZAgrimtJrr0EKd\n5+s+l/2bXaUeHb6ukcAIlvGkCl8CYrAljWUrxiDWfjEVEWxb62MRD+qTnKRw\nfSiPQA2GMKA4L/lgBsXtj0iXnS4BASImFphLi3ORoMouvYm/fJjJCzxqsWeb\nXcLP\r\n=5mAS\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIGWf0lsUPCaCTMBHg/uBQHuKRhbZ6lDWgombQAbRjKDCAiEA5svY4dgCNgmgI3mIZsodNJYHfBjcbcW5vuJ3r194HDU="}]},"_npmUser":{"name":"znck","email":"rahulkdn@gmail.com"},"directories":{},"maintainers":[{"name":"znck","email":"rahulkdn@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/analyze_0.3.1-insiders-1608679989.0_1608680015367_0.43882594988886003"},"_hasShrinkwrap":false},"0.3.1-insiders-1608682132.0":{"name":"@vuedx/analyze","version":"0.3.1-insiders-1608682132.0","description":"Extracts public API information from Vue component.","main":"dist/index.cjs.js","module":"dist/index.esm.js","types":"dist/index.d.ts","bin":{"vuedx-analyze":"bin/analyze.js"},"keywords":["vue","sfc","sfc api extractor","static analyzer","sfc analyzer","sfc static analyzer","docgen","documentation"],"repository":{"type":"git","url":"git+https://github.com/znck/vue-developer-experience.git"},"author":{"name":"Rahul Kadyan","email":"rahulkdn@gmail.com","url":"https://znck.me/"},"funding":{"type":"individual","url":"https://github.com/sponsors/znck"},"license":"MIT","bugs":{"url":"https://github.com/znck/vue-developer-experience/issues"},"homepage":"https://github.com/znck/vue-developer-experience#readme","dependencies":{"@babel/code-frame":"^7.10.4","@babel/generator":"^7.12.1","@babel/parser":"^7.12.3","@babel/template":"^7.12.7","@babel/traverse":"7.12.1","@babel/types":"7.12.1","@types/micromatch":"^4.0.1","@vuedx/compiler-sfc":"0.3.1-insiders-1608682132.0","@vuedx/compiler-tsx":"0.3.1-insiders-1608682132.0","@vuedx/projectconfig":"0.3.3-insiders-1608682132.0","@vuedx/template-ast-types":"0.3.1-insiders-1608682132.0","cli-highlight":"^2.1.4","commander":"^6.1.0","fast-glob":"^3.2.4","hash-sum":"^2.0.0","micromatch":"^4.0.2"},"devDependencies":{"@types/babel__traverse":"^7.0.15","@types/node":"^14.14.14","@vuedx/shared":"0.0.1-insiders-1608682132.0","typescript":"^4.0.3"},"readme":"
\n \n
\n\n## Support\n\nThis package is part of [VueDX project](https://github.com/znck/vue-developer-experience), maintained by [Rahul Kadyan](https://github.com/znck). You can [💖 sponsor him](https://github.com/sponsors/znck) for continued development of this package and other VueDX tools.\n\n## Usage\n\n\n\n\n## API\n\n\n\n### [ConfiguredVueProject](#-vuedx-analyze-ConfiguredVueProject-class)\n\n\n Analyze
\nA tool to statically analyze Vue single file components.
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare class ConfiguredVueProject extends VueProject {\n constructor(\n rootDir: string,\n packageFile: string | undefined,\n packageJSON: Partial\n\n\n\n#### [setFileNames](#-vuedx-analyze-ConfiguredVueProject-setFileNames-member-1-)\n\n**Signature:**\n\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --------- | --------------------- | ----------- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n### [InferredVueProject](#-vuedx-analyze-InferredVueProject-class)\n\n
More info
\n\n**Signature:**\n\n```ts\ndeclare class InferredVueProject extends VueProject {\n kind: 'inferred'\n protected refresh(): void\n}\n```\n\n**Members:**\n\n\n\n#### [refresh](#-vuedx-analyze-InferredVueProject-refresh-member-1-)\n\n**Signature:**\n\n```ts\nprotected refresh(): void;\n```\n\n\n
\n\n\n\n### [VueProject](#-vuedx-analyze-VueProject-class)\n\n
More info
\n\n**Signature:**\n\n```ts\ndeclare abstract class VueProject {\n protected _config: Readonly\n\n\n\n#### [markDirty](#-vuedx-analyze-VueProject-markDirty-member-1-)\n\n**Signature:**\n\n```ts\nmarkDirty(): void;\n```\n\n
\n\n\n\n#### [refresh](#-vuedx-analyze-VueProject-refresh-member-1-)\n\n**Signature:**\n\n```ts\nprotected abstract refresh(): void;\n```\n\n
\n\n\n\n#### [reloadIfNeeded](#-vuedx-analyze-VueProject-reloadIfNeeded-member-1-)\n\n**Signature:**\n\n```ts\nprotected reloadIfNeeded(): void;\n```\n\n
\n\n\n\n#### [setConfig](#-vuedx-analyze-VueProject-setConfig-member-1-)\n\n**Signature:**\n\n```ts\nsetConfig(config: ProjectConfig): void;\n```\n\n| Parameter | Type | Description |\n| --------- | --------------------------------------------------------------------------------------- | ----------- |\n| config |
ProjectConfig | - |\n\n\n\n\n\n#### [setFileNames](#-vuedx-analyze-VueProject-setFileNames-member-1-)\n\n**Signature:**\n\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --------- | --------------------- | ----------- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n### [createAnalyzer](#-vuedx-analyze-createAnalyzer-function-1-)\n\n
\n,\n): Analyzer\n```\n\n| Parameter | Type | Description |\n| --------- | ---------------------------------------------------------------------------------------------------------------------- | ----------- |\n| plugins |
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare function createAnalyzer(\n plugins: Plugin[],\n options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createFullAnalyzer](#-vuedx-analyze-createFullAnalyzer-function-1-)\n\n
\n,\n): ReturnType\n```\n\n| Parameter | Type | Description |\n| --------- | ---------------------------------------------------------------------------------------------------------------------- | ----------- |\n| plugins |
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare function createFullAnalyzer(\n plugins?: Plugin[],\n options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createSourceRange](#-vuedx-analyze-createSourceRange-function-1-)\n\n
\n
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare function createSourceRange(\n context: Context | ScriptAnalyzerContext,\n node: Node,\n): SourceRange\n```\n\n| Parameter | Type | Description |\n| --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |\n| context |Context | ScriptAnalyzerContext | - |\n| node | Node | - |\n\n\n\n\n\n### [transformToFunction](#-vuedx-analyze-transformToFunction-function-1-)\n\n
\n
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare function transformToFunction(\n content: string,\n options?: FunctionTransformOptions,\n): string\n```\n\n| Parameter | Type | Description |\n| --------- | ------------------------------------------------------------------------------------------------------- | ----------- |\n| content |string | - |\n| options | FunctionTransformOptions | - |\n\n\n\n## Types\n\n\n\n### [Analyzer](#-vuedx-analyze-Analyzer-interface)\n\n```ts\ninterface Analyzer {\n analyze: (content: string, fileName?: string) => ComponentInfo\n analyzeScript: (\n content: string,\n fileName?: string,\n mode?: 'script' | 'scriptSetup',\n ) => ComponentInfo\n analyzeTemplate: (content: string, fileName?: string) => ComponentInfo\n}\n```\n\n
\n\n\n\n### [ComponentInfo](#-vuedx-analyze-ComponentInfo-interface)\n\n```ts\ninterface ComponentInfo {\n components: LocalComponentRegistrationInfo[]\n emits: EmitInfo[]\n errors: SyntaxError[]\n fnSetupOption?: SetupInfo\n identifierSource: Record
\n\n\n\n### [ComponentRegistrationInfo](#-vuedx-analyze-ComponentRegistrationInfo-interface)\n\n```ts\ninterface ComponentRegistrationInfo {\n aliases: string[]\n name: string\n source: ImportSource\n}\n```\n\n
\n\n\n\n### [EmitInfo](#-vuedx-analyze-EmitInfo-interface)\n\n```ts\ninterface EmitInfo extends Taggable, Addressable {\n description: string\n isDynamic: boolean\n isInferred: boolean\n name: string\n references: SourceRange[]\n type: TypeInfo[]\n}\n```\n\n
\n\n\n\n### [IdentifierSource](#-vuedx-analyze-IdentifierSource-interface)\n\n```ts\ninterface IdentifierSource extends Addressable {\n name: string\n}\n```\n\n
\n\n\n\n### [ImportSource](#-vuedx-analyze-ImportSource-interface)\n\n```ts\ninterface ImportSource {\n exportName?: string\n localName: string\n moduleName: string\n}\n```\n\n
\n\n\n\n### [ImportSourceWithLocation](#-vuedx-analyze-ImportSourceWithLocation-interface)\n\n```ts\ninterface ImportSourceWithLocation extends ImportSource, Addressable {}\n```\n\n
\n\n\n\n### [LocalComponentRegistrationInfo](#-vuedx-analyze-LocalComponentRegistrationInfo-interface)\n\n```ts\ninterface LocalComponentRegistrationInfo\n extends ComponentRegistrationInfo,\n Addressable {\n kind: 'script' | 'scriptSetup'\n source: ImportSourceWithLocation\n}\n```\n\n
\n\n\n\n### [Plugin](#-vuedx-analyze-Plugin-2-interface)\n\n```ts\ninterface Plugin {\n babel?: AbstractScriptAnalyzerFn | AbstractAnalyzerHandler\n blocks?: Partial<{\n script: BlockAnalyzer
\n\n\n\n### [PropInfo](#-vuedx-analyze-PropInfo-interface)\n\n```ts\ninterface PropInfo extends Taggable, Addressable {\n defaultValue: ValueInfo | null\n description: string\n name: string\n required: boolean\n type: TypeInfo[]\n}\n```\n\n
\n\n\n\n### [ScriptSetupInfo](#-vuedx-analyze-ScriptSetupInfo-interface)\n\n```ts\ninterface ScriptSetupInfo {\n defineEmit?: Addressable\n defineProps?: Addressable\n}\n```\n\n
\n\n\n\n### [SetupInfo](#-vuedx-analyze-SetupInfo-interface)\n\n```ts\ninterface SetupInfo extends Addressable {\n context?: {\n identifiers: Partial<{\n attrs: string\n slots: string\n emit: string\n }>\n rest?: string\n } & Addressable\n props?: {\n identifiers: string[]\n rest?: string\n } & Addressable\n return?: Addressable\n}\n```\n\n
\n\n\n\n### [SourceRange](#-vuedx-analyze-SourceRange-interface)\n\n```ts\ninterface SourceRange {\n end: SourceLocation\n source: string\n start: SourceLocation\n}\n```\n\n
\n\n\n\n### [SyntaxError](#-vuedx-analyze-SyntaxError-2-interface)\n\n```ts\ninterface SyntaxError {\n loc: SourceLocation\n message: string\n}\n```\n\n
\n\n","readmeFilename":"readme.md","_id":"@vuedx/analyze@0.3.1-insiders-1608682132.0","_nodeVersion":"14.14.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-qNJTHxvnbhCeDdUXilSFxNURpVvfSEg3iw8vSZrZBxcAmqEJD8buLwSpcgdaXY3xYhyfWudP58Yk6juZM2+Pcg==","shasum":"93957933f6caa21a7635bd49b31f3f3ef1dbdd6c","tarball":"https://registry.npmjs.org/@vuedx/analyze/-/analyze-0.3.1-insiders-1608682132.0.tgz","fileCount":9,"unpackedSize":475686,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJf4oqsCRA9TVsSAnZWagAAslEP/1n3sXhqwpRlDB4tWT9j\nyPs/yYIhxg2z8z0OxZ8LgnIYGPP7dzzUAJavi0zwoKCIbqqmJzH/GNkhCUrq\nWvGRtUv67zR6ZPL33lfINtUOHk2E+JED0QmYD7ADklUJDiUoNUopOWw11ivS\n7PqzZHER3aP56elwdKsv0lxJuQ9F5VCb6o23+r5M2KHWGtiNC/6aQ0FjyO4N\nZ4uQi/w1mQfbeIAeHIS2/ezb550/FrvDl5QUmIh+OTmqS+hFyxReXmVhXuKJ\nfVsaLj+zqW+hp5caSuNSz6lRXSGqQDxBFUXmf4VW4ArLcI/om+tWSoWE0wTM\na1zkdj9dYtpWMc2sbOy3I3Di0vAna0AmsRtmzFIgdFEzP3WQBCBrBLWPiy2c\nRzjuOO6sjKhudKzvKVqiL+4fq874uPRou1rOMfqopbpUTL7Gs8TnN0AdbqdC\nwSWPxZbLtVQ6C/9K7evVbMiAVUG6SgWUPbGEQ+SRs10TOkKJjOlpC1ic2xcR\ndhUo/9Nee1UXXGoPmiqjX8JdyPrYSvvpfIHqpamEZcKsL94N7wqhl3b/ewjS\nTCNeZcdyOnzamFMVOGeCui/U2wnJ73NSQwa/Pup+BjTr8xyBpMXCIE3vGOa+\nIRx7Y0a2dQafPP9smD1gp/RvIpAoIfcoVXnNRxHOEikdTIiSZ/dexuIIiwvM\nAhib\r\n=AAUJ\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCQz412scnnsm/9f4yIOCC1jC5aN181I8FvdcwVZGUmpgIgVUckf5LgWG+UyBK7YQEyd8ToE39OYLoF9f0M6N6zt3w="}]},"_npmUser":{"name":"znck","email":"rahulkdn@gmail.com"},"directories":{},"maintainers":[{"name":"znck","email":"rahulkdn@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/analyze_0.3.1-insiders-1608682132.0_1608682156267_0.5786202402380958"},"_hasShrinkwrap":false},"0.3.1-insiders-1609032938.0":{"name":"@vuedx/analyze","version":"0.3.1-insiders-1609032938.0","description":"Extracts public API information from Vue component.","main":"dist/index.cjs.js","module":"dist/index.esm.js","types":"dist/index.d.ts","bin":{"vuedx-analyze":"bin/analyze.js"},"keywords":["vue","sfc","sfc api extractor","static analyzer","sfc analyzer","sfc static analyzer","docgen","documentation"],"repository":{"type":"git","url":"git+https://github.com/znck/vue-developer-experience.git"},"author":{"name":"Rahul Kadyan","email":"rahulkdn@gmail.com","url":"https://znck.me/"},"funding":{"type":"individual","url":"https://github.com/sponsors/znck"},"license":"MIT","bugs":{"url":"https://github.com/znck/vue-developer-experience/issues"},"homepage":"https://github.com/znck/vue-developer-experience#readme","dependencies":{"@babel/code-frame":"^7.10.4","@babel/generator":"^7.12.1","@babel/parser":"^7.12.3","@babel/template":"^7.12.7","@babel/traverse":"7.12.1","@babel/types":"7.12.1","@types/micromatch":"^4.0.1","@vuedx/compiler-sfc":"0.3.1-insiders-1609032938.0","@vuedx/compiler-tsx":"0.3.1-insiders-1609032938.0","@vuedx/projectconfig":"0.3.3-insiders-1609032938.0","@vuedx/template-ast-types":"0.3.1-insiders-1609032938.0","cli-highlight":"^2.1.4","commander":"^6.1.0","fast-glob":"^3.2.4","hash-sum":"^2.0.0","micromatch":"^4.0.2"},"devDependencies":{"@types/babel__traverse":"^7.0.15","@types/node":"^14.14.14","@vuedx/shared":"0.0.1-insiders-1609032938.0","typescript":"^4.0.3"},"readme":"
\n \n
\n\n## Support\n\nThis package is part of [VueDX project](https://github.com/znck/vue-developer-experience), maintained by [Rahul Kadyan](https://github.com/znck). You can [💖 sponsor him](https://github.com/sponsors/znck) for continued development of this package and other VueDX tools.\n\n## Usage\n\n\n\n\n## API\n\n\n\n### [ConfiguredVueProject](#-vuedx-analyze-ConfiguredVueProject-class)\n\n\n Analyze
\nA tool to statically analyze Vue single file components.
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare class ConfiguredVueProject extends VueProject {\n constructor(\n rootDir: string,\n packageFile: string | undefined,\n packageJSON: Partial\n\n\n\n#### [setFileNames](#-vuedx-analyze-ConfiguredVueProject-setFileNames-member-1-)\n\n**Signature:**\n\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --------- | --------------------- | ----------- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n### [InferredVueProject](#-vuedx-analyze-InferredVueProject-class)\n\n
More info
\n\n**Signature:**\n\n```ts\ndeclare class InferredVueProject extends VueProject {\n kind: 'inferred'\n protected refresh(): void\n}\n```\n\n**Members:**\n\n\n\n#### [refresh](#-vuedx-analyze-InferredVueProject-refresh-member-1-)\n\n**Signature:**\n\n```ts\nprotected refresh(): void;\n```\n\n\n
\n\n\n\n### [VueProject](#-vuedx-analyze-VueProject-class)\n\n
More info
\n\n**Signature:**\n\n```ts\ndeclare abstract class VueProject {\n protected _config: Readonly\n\n\n\n#### [markDirty](#-vuedx-analyze-VueProject-markDirty-member-1-)\n\n**Signature:**\n\n```ts\nmarkDirty(): void;\n```\n\n
\n\n\n\n#### [refresh](#-vuedx-analyze-VueProject-refresh-member-1-)\n\n**Signature:**\n\n```ts\nprotected abstract refresh(): void;\n```\n\n
\n\n\n\n#### [reloadIfNeeded](#-vuedx-analyze-VueProject-reloadIfNeeded-member-1-)\n\n**Signature:**\n\n```ts\nprotected reloadIfNeeded(): void;\n```\n\n
\n\n\n\n#### [setConfig](#-vuedx-analyze-VueProject-setConfig-member-1-)\n\n**Signature:**\n\n```ts\nsetConfig(config: ProjectConfig): void;\n```\n\n| Parameter | Type | Description |\n| --------- | --------------------------------------------------------------------------------------- | ----------- |\n| config |
ProjectConfig | - |\n\n\n\n\n\n#### [setFileNames](#-vuedx-analyze-VueProject-setFileNames-member-1-)\n\n**Signature:**\n\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --------- | --------------------- | ----------- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n### [createAnalyzer](#-vuedx-analyze-createAnalyzer-function-1-)\n\n
\n,\n): Analyzer\n```\n\n| Parameter | Type | Description |\n| --------- | ---------------------------------------------------------------------------------------------------------------------- | ----------- |\n| plugins |
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare function createAnalyzer(\n plugins: Plugin[],\n options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createFullAnalyzer](#-vuedx-analyze-createFullAnalyzer-function-1-)\n\n
\n,\n): ReturnType\n```\n\n| Parameter | Type | Description |\n| --------- | ---------------------------------------------------------------------------------------------------------------------- | ----------- |\n| plugins |
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare function createFullAnalyzer(\n plugins?: Plugin[],\n options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createSourceRange](#-vuedx-analyze-createSourceRange-function-1-)\n\n
\n
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare function createSourceRange(\n context: Context | ScriptAnalyzerContext,\n node: Node,\n): SourceRange\n```\n\n| Parameter | Type | Description |\n| --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |\n| context |Context | ScriptAnalyzerContext | - |\n| node | Node | - |\n\n\n\n\n\n### [transformToFunction](#-vuedx-analyze-transformToFunction-function-1-)\n\n
\n
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare function transformToFunction(\n content: string,\n options?: FunctionTransformOptions,\n): string\n```\n\n| Parameter | Type | Description |\n| --------- | ------------------------------------------------------------------------------------------------------- | ----------- |\n| content |string | - |\n| options | FunctionTransformOptions | - |\n\n\n\n## Types\n\n\n\n### [Analyzer](#-vuedx-analyze-Analyzer-interface)\n\n```ts\ninterface Analyzer {\n analyze: (content: string, fileName?: string) => ComponentInfo\n analyzeScript: (\n content: string,\n fileName?: string,\n mode?: 'script' | 'scriptSetup',\n ) => ComponentInfo\n analyzeTemplate: (content: string, fileName?: string) => ComponentInfo\n}\n```\n\n
\n\n\n\n### [ComponentInfo](#-vuedx-analyze-ComponentInfo-interface)\n\n```ts\ninterface ComponentInfo {\n components: LocalComponentRegistrationInfo[]\n emits: EmitInfo[]\n errors: SyntaxError[]\n fnSetupOption?: SetupInfo\n identifierSource: Record
\n\n\n\n### [ComponentRegistrationInfo](#-vuedx-analyze-ComponentRegistrationInfo-interface)\n\n```ts\ninterface ComponentRegistrationInfo {\n aliases: string[]\n name: string\n source: ImportSource\n}\n```\n\n
\n\n\n\n### [EmitInfo](#-vuedx-analyze-EmitInfo-interface)\n\n```ts\ninterface EmitInfo extends Taggable, Addressable {\n description: string\n isDynamic: boolean\n isInferred: boolean\n name: string\n references: SourceRange[]\n type: TypeInfo[]\n}\n```\n\n
\n\n\n\n### [IdentifierSource](#-vuedx-analyze-IdentifierSource-interface)\n\n```ts\ninterface IdentifierSource extends Addressable {\n name: string\n}\n```\n\n
\n\n\n\n### [ImportSource](#-vuedx-analyze-ImportSource-interface)\n\n```ts\ninterface ImportSource {\n exportName?: string\n localName: string\n moduleName: string\n}\n```\n\n
\n\n\n\n### [ImportSourceWithLocation](#-vuedx-analyze-ImportSourceWithLocation-interface)\n\n```ts\ninterface ImportSourceWithLocation extends ImportSource, Addressable {}\n```\n\n
\n\n\n\n### [LocalComponentRegistrationInfo](#-vuedx-analyze-LocalComponentRegistrationInfo-interface)\n\n```ts\ninterface LocalComponentRegistrationInfo\n extends ComponentRegistrationInfo,\n Addressable {\n kind: 'script' | 'scriptSetup'\n source: ImportSourceWithLocation\n}\n```\n\n
\n\n\n\n### [Plugin](#-vuedx-analyze-Plugin-2-interface)\n\n```ts\ninterface Plugin {\n babel?: AbstractScriptAnalyzerFn | AbstractAnalyzerHandler\n blocks?: Partial<{\n script: BlockAnalyzer
\n\n\n\n### [PropInfo](#-vuedx-analyze-PropInfo-interface)\n\n```ts\ninterface PropInfo extends Taggable, Addressable {\n defaultValue: ValueInfo | null\n description: string\n name: string\n required: boolean\n type: TypeInfo[]\n}\n```\n\n
\n\n\n\n### [ScriptSetupInfo](#-vuedx-analyze-ScriptSetupInfo-interface)\n\n```ts\ninterface ScriptSetupInfo {\n defineEmit?: Addressable\n defineProps?: Addressable\n}\n```\n\n
\n\n\n\n### [SetupInfo](#-vuedx-analyze-SetupInfo-interface)\n\n```ts\ninterface SetupInfo extends Addressable {\n context?: {\n identifiers: Partial<{\n attrs: string\n slots: string\n emit: string\n }>\n rest?: string\n } & Addressable\n props?: {\n identifiers: string[]\n rest?: string\n } & Addressable\n return?: Addressable\n}\n```\n\n
\n\n\n\n### [SourceRange](#-vuedx-analyze-SourceRange-interface)\n\n```ts\ninterface SourceRange {\n end: SourceLocation\n source: string\n start: SourceLocation\n}\n```\n\n
\n\n\n\n### [SyntaxError](#-vuedx-analyze-SyntaxError-2-interface)\n\n```ts\ninterface SyntaxError {\n loc: SourceLocation\n message: string\n}\n```\n\n
\n\n","readmeFilename":"readme.md","_id":"@vuedx/analyze@0.3.1-insiders-1609032938.0","_nodeVersion":"14.14.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-7Pm+4ZCwGnw0ihkL4X2IEcEWYVRD7Bxjj4cDv3yOE88schmQQxzHJRGceg9w1iLSIn6QJpsL3ENrX4fr4yr2+A==","shasum":"666cfe87d79c6af85859a4b8fb032e62cab034ef","tarball":"https://registry.npmjs.org/@vuedx/analyze/-/analyze-0.3.1-insiders-1609032938.0.tgz","fileCount":9,"unpackedSize":478970,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJf5+T/CRA9TVsSAnZWagAAgeAP/jTj7f5pcFWfY+KG54iH\nMs7NzKJno0uUJsKYA3NTccDba7aMGRf+zD+e9yJQVwOmfkdLnnlELk8k3fmH\nIK1zyph0JB44eJYUOUrrBH9fep9cUnKn/qlEmQe0FgTUSCbLTH0tuZTu8K9t\nyTXBdB6NNXavu9RLVsDXsTeIQOVFFrN5nvrq72hFNFjeEw2MLMQNaiTFsNDY\nnvVxco2EPY8WbuIcd/3TYVHUhbRpylAUJVPojkeJqG6if0ZNW5hgJYywpcc5\nVfiOXzTh2gCtBYeBn5uCrHXIYLPzjjzl965Vr+xdwMnufFhADYi+tTLUQSen\nI2r2qYlCs9Mk1mi1D+isw5d6SrFhqs74x/9Tt1idLnw+0YCvZqICmG5Ulb7h\nRJDWZZ4cOvKuANoqEGBbNaT7AX1jj6pFdZzt14ow8j7kazM6tjvQ95pXzBMx\nVIYlvksXzGCGbeFoZJ9zbIWYaFsN5egvtO/g8dHOossGNqLVL3Ua4mwgbKyL\nnHSQbnemt0MnhW58sCiQEq8efrFILdDlMIOEknGMUQcdYXXdgqOWOx9vFce4\nas6We1Nxej0uxqRnGIjgqrw5YCBcwBylNZsTySQNZoHmnPhd7eh/2CnRgely\n1uOfGxNk0LAtlvpJsI1eDG141zZIsLLuqio9NxrdT9ZnNKjlajw+APyNUFAu\nASAy\r\n=IwMF\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIDLan+B3dcdB1MPt4+d+TtdixR7amncw8EX45t3MDtdxAiEAkGekOkSBBHf7CxlVaS1BlkKC9mRatGn5mXURgmciW1o="}]},"_npmUser":{"name":"znck","email":"rahulkdn@gmail.com"},"directories":{},"maintainers":[{"name":"znck","email":"rahulkdn@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/analyze_0.3.1-insiders-1609032938.0_1609032959260_0.28616571127895707"},"_hasShrinkwrap":false},"0.3.1-insiders-1609034385.0":{"name":"@vuedx/analyze","version":"0.3.1-insiders-1609034385.0","description":"Extracts public API information from Vue component.","main":"dist/index.cjs.js","module":"dist/index.esm.js","types":"dist/index.d.ts","bin":{"vuedx-analyze":"bin/analyze.js"},"keywords":["vue","sfc","sfc api extractor","static analyzer","sfc analyzer","sfc static analyzer","docgen","documentation"],"repository":{"type":"git","url":"git+https://github.com/znck/vue-developer-experience.git"},"author":{"name":"Rahul Kadyan","email":"rahulkdn@gmail.com","url":"https://znck.me/"},"funding":{"type":"individual","url":"https://github.com/sponsors/znck"},"license":"MIT","bugs":{"url":"https://github.com/znck/vue-developer-experience/issues"},"homepage":"https://github.com/znck/vue-developer-experience#readme","dependencies":{"@babel/code-frame":"^7.10.4","@babel/generator":"^7.12.1","@babel/parser":"^7.12.3","@babel/template":"^7.12.7","@babel/traverse":"7.12.1","@babel/types":"7.12.1","@types/micromatch":"^4.0.1","@vuedx/compiler-sfc":"0.3.1-insiders-1609034385.0","@vuedx/compiler-tsx":"0.3.1-insiders-1609034385.0","@vuedx/projectconfig":"0.3.3-insiders-1609034385.0","@vuedx/template-ast-types":"0.3.1-insiders-1609034385.0","cli-highlight":"^2.1.4","commander":"^6.1.0","fast-glob":"^3.2.4","hash-sum":"^2.0.0","micromatch":"^4.0.2"},"devDependencies":{"@types/babel__traverse":"^7.0.15","@types/node":"^14.14.14","@vuedx/shared":"0.0.1-insiders-1609034385.0","typescript":"^4.0.3"},"readme":"
\n \n
\n\n## Support\n\nThis package is part of [VueDX project](https://github.com/znck/vue-developer-experience), maintained by [Rahul Kadyan](https://github.com/znck). You can [💖 sponsor him](https://github.com/sponsors/znck) for continued development of this package and other VueDX tools.\n\n## Usage\n\n\n\n\n## API\n\n\n\n### [ConfiguredVueProject](#-vuedx-analyze-ConfiguredVueProject-class)\n\n\n Analyze
\nA tool to statically analyze Vue single file components.
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare class ConfiguredVueProject extends VueProject {\n constructor(\n rootDir: string,\n packageFile: string | undefined,\n packageJSON: Partial\n\n\n\n#### [setFileNames](#-vuedx-analyze-ConfiguredVueProject-setFileNames-member-1-)\n\n**Signature:**\n\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --------- | --------------------- | ----------- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n### [InferredVueProject](#-vuedx-analyze-InferredVueProject-class)\n\n
More info
\n\n**Signature:**\n\n```ts\ndeclare class InferredVueProject extends VueProject {\n kind: 'inferred'\n protected refresh(): void\n}\n```\n\n**Members:**\n\n\n\n#### [refresh](#-vuedx-analyze-InferredVueProject-refresh-member-1-)\n\n**Signature:**\n\n```ts\nprotected refresh(): void;\n```\n\n\n
\n\n\n\n### [VueProject](#-vuedx-analyze-VueProject-class)\n\n
More info
\n\n**Signature:**\n\n```ts\ndeclare abstract class VueProject {\n protected _config: Readonly\n\n\n\n#### [markDirty](#-vuedx-analyze-VueProject-markDirty-member-1-)\n\n**Signature:**\n\n```ts\nmarkDirty(): void;\n```\n\n
\n\n\n\n#### [refresh](#-vuedx-analyze-VueProject-refresh-member-1-)\n\n**Signature:**\n\n```ts\nprotected abstract refresh(): void;\n```\n\n
\n\n\n\n#### [reloadIfNeeded](#-vuedx-analyze-VueProject-reloadIfNeeded-member-1-)\n\n**Signature:**\n\n```ts\nprotected reloadIfNeeded(): void;\n```\n\n
\n\n\n\n#### [setConfig](#-vuedx-analyze-VueProject-setConfig-member-1-)\n\n**Signature:**\n\n```ts\nsetConfig(config: ProjectConfig): void;\n```\n\n| Parameter | Type | Description |\n| --------- | --------------------------------------------------------------------------------------- | ----------- |\n| config |
ProjectConfig | - |\n\n\n\n\n\n#### [setFileNames](#-vuedx-analyze-VueProject-setFileNames-member-1-)\n\n**Signature:**\n\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --------- | --------------------- | ----------- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n### [createAnalyzer](#-vuedx-analyze-createAnalyzer-function-1-)\n\n
\n,\n): Analyzer\n```\n\n| Parameter | Type | Description |\n| --------- | ---------------------------------------------------------------------------------------------------------------------- | ----------- |\n| plugins |
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare function createAnalyzer(\n plugins: Plugin[],\n options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createFullAnalyzer](#-vuedx-analyze-createFullAnalyzer-function-1-)\n\n
\n,\n): ReturnType\n```\n\n| Parameter | Type | Description |\n| --------- | ---------------------------------------------------------------------------------------------------------------------- | ----------- |\n| plugins |
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare function createFullAnalyzer(\n plugins?: Plugin[],\n options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createSourceRange](#-vuedx-analyze-createSourceRange-function-1-)\n\n
\n
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare function createSourceRange(\n context: Context | ScriptAnalyzerContext,\n node: Node,\n): SourceRange\n```\n\n| Parameter | Type | Description |\n| --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |\n| context |Context | ScriptAnalyzerContext | - |\n| node | Node | - |\n\n\n\n\n\n### [transformToFunction](#-vuedx-analyze-transformToFunction-function-1-)\n\n
\n
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare function transformToFunction(\n content: string,\n options?: FunctionTransformOptions,\n): string\n```\n\n| Parameter | Type | Description |\n| --------- | ------------------------------------------------------------------------------------------------------- | ----------- |\n| content |string | - |\n| options | FunctionTransformOptions | - |\n\n\n\n## Types\n\n\n\n### [Analyzer](#-vuedx-analyze-Analyzer-interface)\n\n```ts\ninterface Analyzer {\n analyze: (content: string, fileName?: string) => ComponentInfo\n analyzeScript: (\n content: string,\n fileName?: string,\n mode?: 'script' | 'scriptSetup',\n ) => ComponentInfo\n analyzeTemplate: (content: string, fileName?: string) => ComponentInfo\n}\n```\n\n
\n\n\n\n### [ComponentInfo](#-vuedx-analyze-ComponentInfo-interface)\n\n```ts\ninterface ComponentInfo {\n components: LocalComponentRegistrationInfo[]\n emits: EmitInfo[]\n errors: SyntaxError[]\n fnSetupOption?: SetupInfo\n identifierSource: Record
\n\n\n\n### [ComponentRegistrationInfo](#-vuedx-analyze-ComponentRegistrationInfo-interface)\n\n```ts\ninterface ComponentRegistrationInfo {\n aliases: string[]\n name: string\n source: ImportSource\n}\n```\n\n
\n\n\n\n### [EmitInfo](#-vuedx-analyze-EmitInfo-interface)\n\n```ts\ninterface EmitInfo extends Taggable, Addressable {\n description: string\n isDynamic: boolean\n isInferred: boolean\n name: string\n references: SourceRange[]\n type: TypeInfo[]\n}\n```\n\n
\n\n\n\n### [IdentifierSource](#-vuedx-analyze-IdentifierSource-interface)\n\n```ts\ninterface IdentifierSource extends Addressable {\n name: string\n}\n```\n\n
\n\n\n\n### [ImportSource](#-vuedx-analyze-ImportSource-interface)\n\n```ts\ninterface ImportSource {\n exportName?: string\n localName: string\n moduleName: string\n}\n```\n\n
\n\n\n\n### [ImportSourceWithLocation](#-vuedx-analyze-ImportSourceWithLocation-interface)\n\n```ts\ninterface ImportSourceWithLocation extends ImportSource, Addressable {}\n```\n\n
\n\n\n\n### [LocalComponentRegistrationInfo](#-vuedx-analyze-LocalComponentRegistrationInfo-interface)\n\n```ts\ninterface LocalComponentRegistrationInfo\n extends ComponentRegistrationInfo,\n Addressable {\n kind: 'script' | 'scriptSetup'\n source: ImportSourceWithLocation\n}\n```\n\n
\n\n\n\n### [Plugin](#-vuedx-analyze-Plugin-2-interface)\n\n```ts\ninterface Plugin {\n babel?: AbstractScriptAnalyzerFn | AbstractAnalyzerHandler\n blocks?: Partial<{\n script: BlockAnalyzer
\n\n\n\n### [PropInfo](#-vuedx-analyze-PropInfo-interface)\n\n```ts\ninterface PropInfo extends Taggable, Addressable {\n defaultValue: ValueInfo | null\n description: string\n name: string\n required: boolean\n type: TypeInfo[]\n}\n```\n\n
\n\n\n\n### [ScriptSetupInfo](#-vuedx-analyze-ScriptSetupInfo-interface)\n\n```ts\ninterface ScriptSetupInfo {\n defineEmit?: Addressable\n defineProps?: Addressable\n}\n```\n\n
\n\n\n\n### [SetupInfo](#-vuedx-analyze-SetupInfo-interface)\n\n```ts\ninterface SetupInfo extends Addressable {\n context?: {\n identifiers: Partial<{\n attrs: string\n slots: string\n emit: string\n }>\n rest?: string\n } & Addressable\n props?: {\n identifiers: string[]\n rest?: string\n } & Addressable\n return?: Addressable\n}\n```\n\n
\n\n\n\n### [SourceRange](#-vuedx-analyze-SourceRange-interface)\n\n```ts\ninterface SourceRange {\n end: SourceLocation\n source: string\n start: SourceLocation\n}\n```\n\n
\n\n\n\n### [SyntaxError](#-vuedx-analyze-SyntaxError-2-interface)\n\n```ts\ninterface SyntaxError {\n loc: SourceLocation\n message: string\n}\n```\n\n
\n\n","readmeFilename":"readme.md","_id":"@vuedx/analyze@0.3.1-insiders-1609034385.0","_nodeVersion":"14.14.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-5YzyEtDsHmX6Uy/scUiw3vF3Ka2erYIfSfzhaYrlbMz5BsVlKPSpfpChpPpyDE+sI2cmXwFCDkZxaCDCtpa/IA==","shasum":"040a7346ae5ab3a8fd6226c891baaf6bf7a8a0f7","tarball":"https://registry.npmjs.org/@vuedx/analyze/-/analyze-0.3.1-insiders-1609034385.0.tgz","fileCount":9,"unpackedSize":478970,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJf5+qmCRA9TVsSAnZWagAAJR0QAJFUCXomkJrN1I6HKlVv\nEq6HU5wnp85y/iI9ja6kh1GjLmLEsa0inmvCxxZgEvmRebSjACGfjepYRRw0\n/2x7JTdRBIYjrgqL/LpVNWueNfahqlgV+VHynN2GNv1jaRdbw3UWAvy79JRG\ni29UtMfZVpF9SViUQNtVSPZI+zkxTWGgmPhVTRAWlbz1J+9ReQBumiJzrRdW\ncoybiXa3BFKU8nY6RWZPGBAwiBz6h4FczJHB8vN9t4R1Te0X3Gj09+ZqYGGy\n8AHwbyysiQGGUeliDg+EJGltelqhhFObYAeACuwoU0P7LgGpYJvB3757PWIZ\n6VGF24dM88YQbmf0T4sDdmDtGdyLLdFp9f228BIUX5Vkio7om14we9EU3z22\nsiE2s9SVajrwD9w9XkPiTErAbefqHUoRUpAh9ptyDOFPCZm1I7Po9nPUyqub\nxpRkXAYvfDdviTIHLhEkqrLv2v1Uhf85gyCw8VSVIQDEPpEn+rGjYKzgXWpw\nVZYu7eO+5vvyDYNdiYnI2ix6BxIx0V0R5p/rPVG0JVXZ2vZhSzGLkOzmmy+N\ngBKFOwmRdajkC5YGbbCX2RccuinE0gLeroEoVVz8XAeG93SgfCFqOL71WxXi\nZeNvTH4+zlpRzVUf0F9NPNXpSCv9BPuVRa6AhAPkuRd/fxyG1mORoIWuncYd\nbHoh\r\n=FjND\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCJDYjE/wrKgV9mL+Y2KbAkwn206u8XJO0OR1Hv869bQgIhAOlg7IWbSmTdp+vaO4F9XfYLlP7d1Dp43/DTI0guztgg"}]},"_npmUser":{"name":"znck","email":"rahulkdn@gmail.com"},"directories":{},"maintainers":[{"name":"znck","email":"rahulkdn@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/analyze_0.3.1-insiders-1609034385.0_1609034406276_0.5847146665533023"},"_hasShrinkwrap":false},"0.3.1-insiders-1609155664.0":{"name":"@vuedx/analyze","version":"0.3.1-insiders-1609155664.0","description":"Extracts public API information from Vue component.","main":"dist/index.cjs.js","module":"dist/index.esm.js","types":"dist/index.d.ts","bin":{"vuedx-analyze":"bin/analyze.js"},"keywords":["vue","sfc","sfc api extractor","static analyzer","sfc analyzer","sfc static analyzer","docgen","documentation"],"repository":{"type":"git","url":"git+https://github.com/znck/vue-developer-experience.git"},"author":{"name":"Rahul Kadyan","email":"rahulkdn@gmail.com","url":"https://znck.me/"},"funding":{"type":"individual","url":"https://github.com/sponsors/znck"},"license":"MIT","bugs":{"url":"https://github.com/znck/vue-developer-experience/issues"},"homepage":"https://github.com/znck/vue-developer-experience#readme","dependencies":{"@babel/code-frame":"^7.10.4","@babel/generator":"^7.12.1","@babel/parser":"^7.12.3","@babel/template":"^7.12.7","@babel/traverse":"7.12.1","@babel/types":"7.12.1","@types/micromatch":"^4.0.1","@vuedx/compiler-sfc":"0.3.1-insiders-1609155664.0","@vuedx/compiler-tsx":"0.3.1-insiders-1609155664.0","@vuedx/projectconfig":"0.3.3-insiders-1609155664.0","@vuedx/template-ast-types":"0.3.1-insiders-1609155664.0","cli-highlight":"^2.1.4","commander":"^6.1.0","fast-glob":"^3.2.4","hash-sum":"^2.0.0","micromatch":"^4.0.2"},"devDependencies":{"@types/babel__traverse":"^7.0.15","@types/node":"^14.14.14","@vuedx/shared":"0.0.1-insiders-1609155664.0","typescript":"^4.0.3"},"readme":"
\n \n
\n\n## Support\n\nThis package is part of [VueDX project](https://github.com/znck/vue-developer-experience), maintained by [Rahul Kadyan](https://github.com/znck). You can [💖 sponsor him](https://github.com/sponsors/znck) for continued development of this package and other VueDX tools.\n\n## Usage\n\n\n\n\n## API\n\n\n\n### [ConfiguredVueProject](#-vuedx-analyze-ConfiguredVueProject-class)\n\n\n Analyze
\nA tool to statically analyze Vue single file components.
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare class ConfiguredVueProject extends VueProject {\n constructor(\n rootDir: string,\n packageFile: string | undefined,\n packageJSON: Partial\n\n\n\n#### [setFileNames](#-vuedx-analyze-ConfiguredVueProject-setFileNames-member-1-)\n\n**Signature:**\n\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --------- | --------------------- | ----------- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n### [InferredVueProject](#-vuedx-analyze-InferredVueProject-class)\n\n
More info
\n\n**Signature:**\n\n```ts\ndeclare class InferredVueProject extends VueProject {\n kind: 'inferred'\n protected refresh(): void\n}\n```\n\n**Members:**\n\n\n\n#### [refresh](#-vuedx-analyze-InferredVueProject-refresh-member-1-)\n\n**Signature:**\n\n```ts\nprotected refresh(): void;\n```\n\n\n
\n\n\n\n### [VueProject](#-vuedx-analyze-VueProject-class)\n\n
More info
\n\n**Signature:**\n\n```ts\ndeclare abstract class VueProject {\n protected _config: Readonly\n\n\n\n#### [markDirty](#-vuedx-analyze-VueProject-markDirty-member-1-)\n\n**Signature:**\n\n```ts\nmarkDirty(): void;\n```\n\n
\n\n\n\n#### [refresh](#-vuedx-analyze-VueProject-refresh-member-1-)\n\n**Signature:**\n\n```ts\nprotected abstract refresh(): void;\n```\n\n
\n\n\n\n#### [reloadIfNeeded](#-vuedx-analyze-VueProject-reloadIfNeeded-member-1-)\n\n**Signature:**\n\n```ts\nprotected reloadIfNeeded(): void;\n```\n\n
\n\n\n\n#### [setConfig](#-vuedx-analyze-VueProject-setConfig-member-1-)\n\n**Signature:**\n\n```ts\nsetConfig(config: ProjectConfig): void;\n```\n\n| Parameter | Type | Description |\n| --------- | --------------------------------------------------------------------------------------- | ----------- |\n| config |
ProjectConfig | - |\n\n\n\n\n\n#### [setFileNames](#-vuedx-analyze-VueProject-setFileNames-member-1-)\n\n**Signature:**\n\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --------- | --------------------- | ----------- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n### [createAnalyzer](#-vuedx-analyze-createAnalyzer-function-1-)\n\n
\n,\n): Analyzer\n```\n\n| Parameter | Type | Description |\n| --------- | ---------------------------------------------------------------------------------------------------------------------- | ----------- |\n| plugins |
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare function createAnalyzer(\n plugins: Plugin[],\n options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createFullAnalyzer](#-vuedx-analyze-createFullAnalyzer-function-1-)\n\n
\n,\n): ReturnType\n```\n\n| Parameter | Type | Description |\n| --------- | ---------------------------------------------------------------------------------------------------------------------- | ----------- |\n| plugins |
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare function createFullAnalyzer(\n plugins?: Plugin[],\n options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createSourceRange](#-vuedx-analyze-createSourceRange-function-1-)\n\n
\n
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare function createSourceRange(\n context: Context | ScriptAnalyzerContext,\n node: Node,\n): SourceRange\n```\n\n| Parameter | Type | Description |\n| --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |\n| context |Context | ScriptAnalyzerContext | - |\n| node | Node | - |\n\n\n\n\n\n### [transformToFunction](#-vuedx-analyze-transformToFunction-function-1-)\n\n
\n
\nMore info
\n\n**Signature:**\n\n```ts\ndeclare function transformToFunction(\n content: string,\n options?: FunctionTransformOptions,\n): string\n```\n\n| Parameter | Type | Description |\n| --------- | ------------------------------------------------------------------------------------------------------- | ----------- |\n| content |string | - |\n| options | FunctionTransformOptions | - |\n\n\n\n## Types\n\n\n\n### [Analyzer](#-vuedx-analyze-Analyzer-interface)\n\n```ts\ninterface Analyzer {\n analyze: (content: string, fileName?: string) => ComponentInfo\n analyzeScript: (\n content: string,\n fileName?: string,\n mode?: 'script' | 'scriptSetup',\n ) => ComponentInfo\n analyzeTemplate: (content: string, fileName?: string) => ComponentInfo\n}\n```\n\n
\n\n\n\n### [ComponentInfo](#-vuedx-analyze-ComponentInfo-interface)\n\n```ts\ninterface ComponentInfo {\n components: LocalComponentRegistrationInfo[]\n emits: EmitInfo[]\n errors: SyntaxError[]\n fnSetupOption?: SetupInfo\n identifierSource: Record
\n\n\n\n### [ComponentRegistrationInfo](#-vuedx-analyze-ComponentRegistrationInfo-interface)\n\n```ts\ninterface ComponentRegistrationInfo {\n aliases: string[]\n name: string\n source: ImportSource\n}\n```\n\n
\n\n\n\n### [EmitInfo](#-vuedx-analyze-EmitInfo-interface)\n\n```ts\ninterface EmitInfo extends Taggable, Addressable {\n description: string\n isDynamic: boolean\n isInferred: boolean\n name: string\n references: SourceRange[]\n type: TypeInfo[]\n}\n```\n\n
\n\n\n\n### [IdentifierSource](#-vuedx-analyze-IdentifierSource-interface)\n\n```ts\ninterface IdentifierSource extends Addressable {\n name: string\n}\n```\n\n
\n\n\n\n### [ImportSource](#-vuedx-analyze-ImportSource-interface)\n\n```ts\ninterface ImportSource {\n exportName?: string\n localName: string\n moduleName: string\n}\n```\n\n
\n\n\n\n### [ImportSourceWithLocation](#-vuedx-analyze-ImportSourceWithLocation-interface)\n\n```ts\ninterface ImportSourceWithLocation extends ImportSource, Addressable {}\n```\n\n
\n\n\n\n### [LocalComponentRegistrationInfo](#-vuedx-analyze-LocalComponentRegistrationInfo-interface)\n\n```ts\ninterface LocalComponentRegistrationInfo\n extends ComponentRegistrationInfo,\n Addressable {\n kind: 'script' | 'scriptSetup'\n source: ImportSourceWithLocation\n}\n```\n\n
\n\n\n\n### [Plugin](#-vuedx-analyze-Plugin-2-interface)\n\n```ts\ninterface Plugin {\n babel?: AbstractScriptAnalyzerFn | AbstractAnalyzerHandler\n blocks?: Partial<{\n script: BlockAnalyzer
\n\n\n\n### [PropInfo](#-vuedx-analyze-PropInfo-interface)\n\n```ts\ninterface PropInfo extends Taggable, Addressable {\n defaultValue: ValueInfo | null\n description: string\n name: string\n required: boolean\n type: TypeInfo[]\n}\n```\n\n
\n\n\n\n### [ScriptSetupInfo](#-vuedx-analyze-ScriptSetupInfo-interface)\n\n```ts\ninterface ScriptSetupInfo {\n defineEmit?: Addressable\n defineProps?: Addressable\n}\n```\n\n
\n\n\n\n### [SetupInfo](#-vuedx-analyze-SetupInfo-interface)\n\n```ts\ninterface SetupInfo extends Addressable {\n context?: {\n identifiers: Partial<{\n attrs: string\n slots: string\n emit: string\n }>\n rest?: string\n } & Addressable\n props?: {\n identifiers: string[]\n rest?: string\n } & Addressable\n return?: Addressable\n}\n```\n\n
\n\n\n\n### [SourceRange](#-vuedx-analyze-SourceRange-interface)\n\n```ts\ninterface SourceRange {\n end: SourceLocation\n source: string\n start: SourceLocation\n}\n```\n\n
\n\n\n\n### [SyntaxError](#-vuedx-analyze-SyntaxError-2-interface)\n\n```ts\ninterface SyntaxError {\n loc: SourceLocation\n message: string\n}\n```\n\n
\n\n","readmeFilename":"readme.md","_id":"@vuedx/analyze@0.3.1-insiders-1609155664.0","_nodeVersion":"14.14.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-oDenjVjW7ktjLRJPSb6SrRaPBv0e1njphjFCf2uoSy+MLlxDUqe8f+zAt4ldbqxelugfyb2JGIiQQYfUUX8OUA==","shasum":"04bde97f816e11f24bd2256c43536b746e8fb316","tarball":"https://registry.npmjs.org/@vuedx/analyze/-/analyze-0.3.1-insiders-1609155664.0.tgz","fileCount":9,"unpackedSize":478970,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJf6cRkCRA9TVsSAnZWagAAw3YP/1IZ8OY/is3TrWXUvdTi\nWMQ2bxdIGZffL9jiGEr3k4HIa7Y9rMirUXCmlKMqj23ezCtBh9mP03mn5kDA\n92heLbJlASq3cnhna0RaE/ydfqNjpQ25j2tBqIzFLZozfWuh2zoWjErK3CfR\njBi93mNDxHeJLUF8ioong60R33JKoiFQF5tOIQS5Li+UDZrJF9a4rdX7klkE\nOIRWU8GKJNe/hDfNi0c+5QZUas/36X9QBFItGcMWaCLztr4sinFBOb4dsqFi\njTrTXZVIXMLovRXIjU8RLnAQSsKuBamiSx7F0Z5anTWoGBEUVDHFs9pcYc46\nLFPhJSm91wHBGDzc5tJ+2eIcwhwfzWWtT7bJmHn3VBbbgKHJaZQBZEmjeZ7O\nHUkQqHDtmh/UN4rUWHQ/nYytnPqkUadqSmO5FDddIGLE/VVh41hcR5LW44pU\n3L19rmZqa/rqzXQH+7eOz5rvElPSDusqolFXw+AgjAwB8MTvFMSB7rCkLIRM\nmnln4O18ON8cS3RNsu3QGONJNScHqNR98pMQvsPzf0HQG1Gbx3sWo4HBWRGi\navzEqjsfLhvx6Kh+RNtc3Tcn3FuVnBxAq9+9ykfWuWqZk0elmShMeXnpmRp4\nFSN4Ki2zBR8NmVB4Qsh8JGYi+DPwd84ZeUTj/dBEf6nm4nfmHxbQ5Ga43n+b\nVG7b\r\n=LJPU\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDudRoHu0vhPisXVWPn37l2bfGF/MdzBzS4UkXwCS0ZcQIgac7gpFpvY0yduSS/qa3NxslCmoMaWhhnDfhRmhaJ+To="}]},"_npmUser":{"name":"znck","email":"rahulkdn@gmail.com"},"directories":{},"maintainers":[{"name":"znck","email":"rahulkdn@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/analyze_0.3.1-insiders-1609155664.0_1609155684036_0.23501935983376976"},"_hasShrinkwrap":false},"0.4.1-insiders-1609180156.0":{"name":"@vuedx/analyze","version":"0.4.1-insiders-1609180156.0","description":"Extracts public API information from Vue component.","main":"dist/index.cjs.js","module":"dist/index.esm.js","types":"dist/index.d.ts","bin":{"vuedx-analyze":"bin/analyze.js"},"keywords":["vue","sfc","sfc api extractor","static analyzer","sfc analyzer","sfc static analyzer","docgen","documentation"],"repository":{"type":"git","url":"git+https://github.com/znck/vue-developer-experience.git"},"author":{"name":"Rahul Kadyan","email":"rahulkdn@gmail.com","url":"https://znck.me/"},"funding":{"type":"individual","url":"https://github.com/sponsors/znck"},"license":"MIT","bugs":{"url":"https://github.com/znck/vue-developer-experience/issues"},"homepage":"https://github.com/znck/vue-developer-experience#readme","dependencies":{"@babel/code-frame":"^7.10.4","@babel/generator":"^7.12.1","@babel/parser":"^7.12.3","@babel/template":"^7.12.7","@babel/traverse":"7.12.1","@babel/types":"7.12.1","@types/micromatch":"^4.0.1","@vuedx/compiler-sfc":"0.4.1-insiders-1609180156.0","@vuedx/compiler-tsx":"0.4.1-insiders-1609180156.0","@vuedx/projectconfig":"0.4.1-insiders-1609180156.0","@vuedx/template-ast-types":"0.4.1-insiders-1609180156.0","cli-highlight":"^2.1.4","commander":"^6.1.0","fast-glob":"^3.2.4","hash-sum":"^2.0.0","micromatch":"^4.0.2"},"devDependencies":{"@types/babel__traverse":"^7.0.15","@types/node":"^14.14.14","@vuedx/shared":"0.4.1-insiders-1609180156.0","typescript":"^4.0.3"},"readme":"
\n \n
\n\n## Support\n\nThis package is part of [VueDX project](https://github.com/znck/vue-developer-experience), maintained by [Rahul Kadyan](https://github.com/znck). You can [💖 sponsor him](https://github.com/sponsors/znck) for continued development of this package and other VueDX tools.\n\n## Usage\n\n\n\n\n## API\n\n\n\n\n### [ConfiguredVueProject](#-vuedx-analyze-ConfiguredVueProject-class)\n\n\n\n\n Analyze
\nA tool to statically analyze Vue single file components.
\nMore info
\n\n**Signature:**\n```ts\ndeclare class ConfiguredVueProject extends VueProject {\n constructor(rootDir: string, packageFile: string | undefined, packageJSON: Partial\n\n\n\n#### [setFileNames](#-vuedx-analyze-ConfiguredVueProject-setFileNames-member-1-)\n\n\n\n**Signature:**\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n\n### [InferredVueProject](#-vuedx-analyze-InferredVueProject-class)\n\n\n\n
More info
\n\n**Signature:**\n```ts\ndeclare class InferredVueProject extends VueProject {\n kind: \"inferred\";\n protected refresh(): void;\n}\n```\n\n**Members:**\n\n\n\n\n#### [refresh](#-vuedx-analyze-InferredVueProject-refresh-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected refresh(): void;\n```\n\n\n\n
\n\n\n\n\n### [VueProject](#-vuedx-analyze-VueProject-class)\n\n\n\n
More info
\n\n**Signature:**\n```ts\ndeclare abstract class VueProject {\n protected _config: Readonly\n\n\n\n#### [markDirty](#-vuedx-analyze-VueProject-markDirty-member-1-)\n\n\n\n**Signature:**\n```ts\nmarkDirty(): void;\n```\n\n\n
\n\n\n\n#### [refresh](#-vuedx-analyze-VueProject-refresh-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected abstract refresh(): void;\n```\n\n\n
\n\n\n\n#### [reloadIfNeeded](#-vuedx-analyze-VueProject-reloadIfNeeded-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected reloadIfNeeded(): void;\n```\n\n\n
\n\n\n\n#### [setConfig](#-vuedx-analyze-VueProject-setConfig-member-1-)\n\n\n\n**Signature:**\n```ts\nsetConfig(config: ProjectConfig): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| config |
ProjectConfig | - |\n\n\n\n\n\n#### [setFileNames](#-vuedx-analyze-VueProject-setFileNames-member-1-)\n\n\n\n**Signature:**\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n\n### [createAnalyzer](#-vuedx-analyze-createAnalyzer-function-1-)\n\n\n\n
\n): Analyzer;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| plugins |
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createAnalyzer(plugins: Plugin[], options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createFullAnalyzer](#-vuedx-analyze-createFullAnalyzer-function-1-)\n\n\n\n
\n): ReturnType;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| plugins |
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createFullAnalyzer(plugins?: Plugin[], options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createSourceRange](#-vuedx-analyze-createSourceRange-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createSourceRange(context: Context | ScriptAnalyzerContext, node: Node): SourceRange;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| context |Context | ScriptAnalyzerContext | - |\n| node | Node | - |\n\n\n\n\n\n### [toVeturData](#-vuedx-analyze-toVeturData-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function toVeturData(components: ComponentInfo[]): VeturData;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| components |ComponentInfo[] | - |\n\n\n\n\n\n### [toWebTypes](#-vuedx-analyze-toWebTypes-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function toWebTypes(name: string, version: string, components: ComponentInfo[]): WebTypes;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| name |string | - |\n| version | string | - |\n| components | ComponentInfo[] | - |\n\n\n\n\n\n### [transformToFunction](#-vuedx-analyze-transformToFunction-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function transformToFunction(content: string, options?: FunctionTransformOptions): string;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| content |string | - |\n| options | FunctionTransformOptions | - |\n\n\n\n## Types\n\n\n\n\n### [Analyzer](#-vuedx-analyze-Analyzer-interface)\n\n\n\n```ts\ninterface Analyzer {\n analyze(content: string, fileName?: string): ComponentInfo;\n analyzeScript(content: string, fileName?: string, mode?: 'script' | 'scriptSetup'): ComponentInfo;\n analyzeTemplate(content: string, fileName?: string): ComponentInfo;\n}\n```\n\n\n
\n\n\n\n### [ComponentInfo](#-vuedx-analyze-ComponentInfo-interface)\n\n\n\n```ts\ninterface ComponentInfo extends Taggable {\n aliases: string[];\n components: LocalComponentRegistrationInfo[];\n description: string;\n emits: EmitInfo[];\n errors: SyntaxError[];\n fileName: string;\n fnSetupOption?: SetupInfo;\n identifierSource: Record
\n\n\n\n### [ComponentRegistrationInfo](#-vuedx-analyze-ComponentRegistrationInfo-interface)\n\n\n\n```ts\ninterface ComponentRegistrationInfo {\n aliases: string[];\n name: string;\n source: ImportSource;\n}\n```\n\n\n
\n\n\n\n### [EmitInfo](#-vuedx-analyze-EmitInfo-interface)\n\n\n\n```ts\ninterface EmitInfo extends Taggable, Addressable {\n description: string;\n isDynamic: boolean;\n isInferred: boolean;\n name: string;\n references: SourceRange[];\n type: TypeInfo[];\n}\n```\n\n\n
\n\n\n\n### [IdentifierSource](#-vuedx-analyze-IdentifierSource-interface)\n\n\n\n```ts\ninterface IdentifierSource extends Addressable {\n name: string;\n}\n```\n\n\n
\n\n\n\n### [ImportSource](#-vuedx-analyze-ImportSource-interface)\n\n\n\n```ts\ninterface ImportSource {\n exportName?: string;\n localName: string;\n moduleName: string;\n}\n```\n\n\n
\n\n\n\n### [ImportSourceWithLocation](#-vuedx-analyze-ImportSourceWithLocation-interface)\n\n\n\n```ts\ninterface ImportSourceWithLocation extends ImportSource, Addressable {\n}\n```\n\n\n
\n\n\n\n### [LocalComponentRegistrationInfo](#-vuedx-analyze-LocalComponentRegistrationInfo-interface)\n\n\n\n```ts\ninterface LocalComponentRegistrationInfo extends ComponentRegistrationInfo, Addressable {\n kind: 'script' | 'scriptSetup';\n source: ImportSourceWithLocation;\n}\n```\n\n\n
\n\n\n\n### [Plugin](#-vuedx-analyze-Plugin-2-interface)\n\n\n\n```ts\ninterface Plugin {\n babel?: AbstractScriptAnalyzerFn | AbstractAnalyzerHandler;\n blocks?: Partial<{\n script: BlockAnalyzer
\n\n\n\n### [PropInfo](#-vuedx-analyze-PropInfo-interface)\n\n\n\n```ts\ninterface PropInfo extends Taggable, Addressable {\n defaultValue: ValueInfo | null;\n description: string;\n name: string;\n required: boolean;\n type: TypeInfo[];\n}\n```\n\n\n
\n\n\n\n### [ScriptSetupInfo](#-vuedx-analyze-ScriptSetupInfo-interface)\n\n\n\n```ts\ninterface ScriptSetupInfo {\n defineEmit?: Addressable;\n defineProps?: Addressable;\n}\n```\n\n\n
\n\n\n\n### [SetupInfo](#-vuedx-analyze-SetupInfo-interface)\n\n\n\n```ts\ninterface SetupInfo extends Addressable {\n context?: {\n identifiers: Partial<{\n attrs: string;\n slots: string;\n emit: string;\n }>;\n rest?: string;\n } & Addressable;\n props?: {\n identifiers: string[];\n rest?: string;\n } & Addressable;\n return?: Addressable;\n}\n```\n\n\n
\n\n\n\n### [SourceRange](#-vuedx-analyze-SourceRange-interface)\n\n\n\n```ts\ninterface SourceRange {\n end: SourceLocation;\n source: string;\n start: SourceLocation;\n}\n```\n\n\n
\n\n\n\n### [SyntaxError](#-vuedx-analyze-SyntaxError-2-interface)\n\n\n\n```ts\ninterface SyntaxError {\n loc: SourceLocation;\n message: string;\n}\n```\n\n\n
\n\n\n\n### [VeturData](#-vuedx-analyze-VeturData-interface)\n\n\n\n```ts\ninterface VeturData {\n attributes: Record
\n\n\n\n### [WebTypes](#-vuedx-analyze-WebTypes-interface)\n\n\n\n```ts\ninterface WebTypes {\n contributions: {\n 'types-syntax': 'typescript';\n 'description-markup': 'html' | 'markdown' | 'none';\n tags: Tag[];\n attributes: Attribute[];\n };\n framework: 'vue';\n name: string;\n version: string;\n}\n```\n\n\n
\n\n","readmeFilename":"readme.md","_id":"@vuedx/analyze@0.4.1-insiders-1609180156.0","_nodeVersion":"14.14.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-urbkPjOAz/ug8agLY2+7dHOtxdfO8AzJMB8eQ8xRpYuKMxEcUTc6cRe3c2fCQhRt9SbwDK/9uXdYpKMUbyyHxw==","shasum":"d5ee129668e45d86a7a24da305659c4fd58163cc","tarball":"https://registry.npmjs.org/@vuedx/analyze/-/analyze-0.4.1-insiders-1609180156.0.tgz","fileCount":9,"unpackedSize":479813,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJf6iQWCRA9TVsSAnZWagAAXmQP/jOrYdISmRSQ9MchVvAH\nbDl94yGr5KqBk8MmLziAW/dzlb/R13UH6goy1g+JMZ+zm5XAvu1yCvXiZ0V3\nhGy18fSSUAsm3A57J8NVyvHnWWI3KUy5KARcpYQkmLTDp5XkLPBEQYK+2EKV\n9n5hlaiu4GsFSq/2hEA4zKzZcVT6l1Pspe5ondTZ4VZQcVicdzq+6qCD5o9U\n56ScEsoYVo6obWhXuDX+toxBpDvw3TKvNl269GxulaTUr6mW8O11TZUf1coQ\nQ53VfaJ01s6tmHTXvvCTouo0k8lSGPAde6sbPxy9wHh/QM1u45rJhYvB7Jmr\nmjsZ2Bz7LS/D25siI/292HTlFcT2/D8CqNSPsJ+brg2B3pYZU0J25OjBXBdc\nUrwQr4fMarYnYPY8CTNBVOLPCav6AWQBYfxq3Ke3nQAnC+FgOTdCzdvZnh9L\n+eeQojRcyM9B3zGhconsECYB59lOmoQvtpokpyXRQxIuCkXJS7mMTsioYqkA\nRI6LAL5PSfgRUvMeT4sq0F6hYJFPunWCG5f1Teta1Nnsyj5ZVmDfwWljDDE2\n83Qwl98qwjdYqAlmz60XY2xiwPvlTMcYRX0q3rqBR7qF6yAXqtLoreIVAl7m\nmp828qDi6N/p790L7I880aRvLcFfnyuxiGCXr0GBl3tVCPHrhMStGVubPF8h\noakn\r\n=ZdjU\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCICvxzQqWwyDZLqU3TNsn57pepee2Epk0KoH3DQUMz9fxAiAVYrGLhYRzom0GrE0Xa9gdYH+zuOkpWwYV+3PUEBlFrg=="}]},"_npmUser":{"name":"znck","email":"rahulkdn@gmail.com"},"directories":{},"maintainers":[{"name":"znck","email":"rahulkdn@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/analyze_0.4.1-insiders-1609180156.0_1609180182154_0.8480694789827183"},"_hasShrinkwrap":false},"0.4.0":{"name":"@vuedx/analyze","version":"0.4.0","description":"Extracts public API information from Vue component.","main":"dist/index.cjs.js","module":"dist/index.esm.js","types":"dist/index.d.ts","bin":{"vuedx-analyze":"bin/analyze.js"},"keywords":["vue","sfc","sfc api extractor","static analyzer","sfc analyzer","sfc static analyzer","docgen","documentation"],"repository":{"type":"git","url":"git+https://github.com/znck/vue-developer-experience.git"},"author":{"name":"Rahul Kadyan","email":"rahulkdn@gmail.com","url":"https://znck.me/"},"funding":{"type":"individual","url":"https://github.com/sponsors/znck"},"license":"MIT","bugs":{"url":"https://github.com/znck/vue-developer-experience/issues"},"homepage":"https://github.com/znck/vue-developer-experience#readme","dependencies":{"@babel/code-frame":"^7.10.4","@babel/generator":"^7.12.1","@babel/parser":"^7.12.3","@babel/template":"^7.12.7","@babel/traverse":"7.12.1","@babel/types":"7.12.1","@types/micromatch":"^4.0.1","@vuedx/compiler-sfc":"0.4.0","@vuedx/compiler-tsx":"0.4.0","@vuedx/projectconfig":"0.4.0","@vuedx/template-ast-types":"0.4.0","cli-highlight":"^2.1.4","commander":"^6.1.0","fast-glob":"^3.2.4","hash-sum":"^2.0.0","micromatch":"^4.0.2"},"devDependencies":{"@types/babel__traverse":"^7.0.15","@types/node":"^14.14.14","@vuedx/shared":"0.4.0","typescript":"^4.0.3"},"_id":"@vuedx/analyze@0.4.0","_nodeVersion":"14.14.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-JHr5xjbzHNlAXY6pQER2SXzpnpDPINpfg9H1+eQo7e3dMwMdXj0f1nnJ9l3b3QCVR11jyr+xsWrqfuvNo2RJXg==","shasum":"a5ae608e8fedd0d9125e4ddb88b75a4a8165c991","tarball":"https://registry.npmjs.org/@vuedx/analyze/-/analyze-0.4.0.tgz","fileCount":9,"unpackedSize":479681,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJf6iQpCRA9TVsSAnZWagAA/xIP/3lul32ZkQvgkXTJOmt1\nSwpXGee5WE3RgzllEumP8WqGWdIh1ifYCdT4SJFmyzXp22FlaGl9QMBjgmYR\nco1fBVrLCzRMeBs1rACZFBboo/xKlOIKnbNJcPFvY1egu4MxswGuhTHqked6\ngboXto/OHMLLYUIDlRHuh8x6qRA0AdemVLz0v5ShKfYLvPwFAeCddtQxYqtn\nt/WIQPLi6jT5fd9DBP7V+ODef+Tx11RVb+DCoYXSyfU3ULXG7tDTn2XGFWya\nXECorWXHAvkX8ZGZFtGlCOQIXBQ2azpDqgkZWW5lo/kPC7bTu7+36f63lQ+N\nJPgnObODELS5H6DgqSHKFk5Dvwp+kr8wAvGobsDRHwIHpNRhyONcJmDUC0yH\nphX/QMRJWgCo9c9nFXdm6rMlNlHyXcL8VbZ8dfA3RUAqS8yuXKDhsNZNMj4D\naY1GZK/W97ENPOs+xMpwCPe+L4Vc/m1x5rCrqNTOEpvf2f917OzQYhyDSAXl\n77Ejx/nBxIRJlPtx8jxxZhyYj5jZ0CVnI2TWv2inswoQvWgJSPUxPOhpo/v4\nEXVDvlxzoo9tvqXcJlz4AawUSdHdVVYRaYWNmwVP32UKvJ0EmHIegqcSyxKO\nJoEgEXkWGJ5d8YsRJggv/ZumvTizO5X4EUXna1smN7wz3NL496EFlPT3D7yb\naVDM\r\n=+VQ1\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIEJZYV+B9j7ZBiQvV2v960zfIiqeRJJpJGD93vFzQoSVAiEA/S5vjflDNiB6V7Thu6q+IZF0FbXRngBSeyq3IPkhovc="}]},"_npmUser":{"name":"znck","email":"rahulkdn@gmail.com"},"directories":{},"maintainers":[{"name":"znck","email":"rahulkdn@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/analyze_0.4.0_1609180201233_0.23612462746549245"},"_hasShrinkwrap":false},"0.4.1-insiders-1609336775.0":{"name":"@vuedx/analyze","version":"0.4.1-insiders-1609336775.0","description":"Extracts public API information from Vue component.","main":"dist/index.cjs.js","module":"dist/index.esm.js","types":"dist/index.d.ts","bin":{"vuedx-analyze":"bin/analyze.js"},"keywords":["vue","sfc","sfc api extractor","static analyzer","sfc analyzer","sfc static analyzer","docgen","documentation"],"repository":{"type":"git","url":"git+https://github.com/znck/vue-developer-experience.git"},"author":{"name":"Rahul Kadyan","email":"rahulkdn@gmail.com","url":"https://znck.me/"},"funding":{"type":"individual","url":"https://github.com/sponsors/znck"},"license":"MIT","bugs":{"url":"https://github.com/znck/vue-developer-experience/issues"},"homepage":"https://github.com/znck/vue-developer-experience#readme","dependencies":{"@babel/code-frame":"^7.10.4","@babel/generator":"^7.12.1","@babel/parser":"^7.12.3","@babel/template":"^7.12.7","@babel/traverse":"7.12.1","@babel/types":"7.12.1","@types/micromatch":"^4.0.1","@vuedx/compiler-sfc":"0.4.1-insiders-1609336775.0","@vuedx/compiler-tsx":"0.4.1-insiders-1609336775.0","@vuedx/projectconfig":"0.4.1-insiders-1609336775.0","@vuedx/template-ast-types":"0.4.1-insiders-1609336775.0","cli-highlight":"^2.1.4","commander":"^6.1.0","fast-glob":"^3.2.4","hash-sum":"^2.0.0","micromatch":"^4.0.2"},"devDependencies":{"@types/babel__traverse":"^7.0.15","@types/node":"^14.14.14","@vuedx/shared":"0.4.1-insiders-1609336775.0","typescript":"^4.0.3"},"readme":"
\n \n
\n\n## Support\n\nThis package is part of [VueDX project](https://github.com/znck/vue-developer-experience), maintained by [Rahul Kadyan](https://github.com/znck). You can [💖 sponsor him](https://github.com/sponsors/znck) for continued development of this package and other VueDX tools.\n\n## Usage\n\n\n\n\n## API\n\n\n\n\n### [ConfiguredVueProject](#-vuedx-analyze-ConfiguredVueProject-class)\n\n\n\n\n Analyze
\nA tool to statically analyze Vue single file components.
\nMore info
\n\n**Signature:**\n```ts\ndeclare class ConfiguredVueProject extends VueProject {\n constructor(rootDir: string, packageFile: string | undefined, packageJSON: Partial\n\n\n\n#### [setFileNames](#-vuedx-analyze-ConfiguredVueProject-setFileNames-member-1-)\n\n\n\n**Signature:**\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n\n### [InferredVueProject](#-vuedx-analyze-InferredVueProject-class)\n\n\n\n
More info
\n\n**Signature:**\n```ts\ndeclare class InferredVueProject extends VueProject {\n kind: \"inferred\";\n protected refresh(): void;\n}\n```\n\n**Members:**\n\n\n\n\n#### [refresh](#-vuedx-analyze-InferredVueProject-refresh-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected refresh(): void;\n```\n\n\n\n
\n\n\n\n\n### [VueProject](#-vuedx-analyze-VueProject-class)\n\n\n\n
More info
\n\n**Signature:**\n```ts\ndeclare abstract class VueProject {\n protected _config: Readonly\n\n\n\n#### [markDirty](#-vuedx-analyze-VueProject-markDirty-member-1-)\n\n\n\n**Signature:**\n```ts\nmarkDirty(): void;\n```\n\n\n
\n\n\n\n#### [refresh](#-vuedx-analyze-VueProject-refresh-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected abstract refresh(): void;\n```\n\n\n
\n\n\n\n#### [reloadIfNeeded](#-vuedx-analyze-VueProject-reloadIfNeeded-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected reloadIfNeeded(): void;\n```\n\n\n
\n\n\n\n#### [setConfig](#-vuedx-analyze-VueProject-setConfig-member-1-)\n\n\n\n**Signature:**\n```ts\nsetConfig(config: ProjectConfig): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| config |
ProjectConfig | - |\n\n\n\n\n\n#### [setFileNames](#-vuedx-analyze-VueProject-setFileNames-member-1-)\n\n\n\n**Signature:**\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n\n### [createAnalyzer](#-vuedx-analyze-createAnalyzer-function-1-)\n\n\n\n
\n): Analyzer;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| plugins |
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createAnalyzer(plugins: Plugin[], options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createFullAnalyzer](#-vuedx-analyze-createFullAnalyzer-function-1-)\n\n\n\n
\n): ReturnType;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| plugins |
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createFullAnalyzer(plugins?: Plugin[], options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createSourceRange](#-vuedx-analyze-createSourceRange-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createSourceRange(context: Context | ScriptAnalyzerContext, node: Node): SourceRange;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| context |Context | ScriptAnalyzerContext | - |\n| node | Node | - |\n\n\n\n\n\n### [toVeturData](#-vuedx-analyze-toVeturData-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function toVeturData(components: ComponentInfo[]): VeturData;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| components |ComponentInfo[] | - |\n\n\n\n\n\n### [toWebTypes](#-vuedx-analyze-toWebTypes-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function toWebTypes(name: string, version: string, components: ComponentInfo[]): WebTypes;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| name |string | - |\n| version | string | - |\n| components | ComponentInfo[] | - |\n\n\n\n\n\n### [transformToFunction](#-vuedx-analyze-transformToFunction-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function transformToFunction(content: string, options?: FunctionTransformOptions): string;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| content |string | - |\n| options | FunctionTransformOptions | - |\n\n\n\n## Types\n\n\n\n\n### [Analyzer](#-vuedx-analyze-Analyzer-interface)\n\n\n\n```ts\ninterface Analyzer {\n analyze(content: string, fileName?: string): ComponentInfo;\n analyzeScript(content: string, fileName?: string, mode?: 'script' | 'scriptSetup'): ComponentInfo;\n analyzeTemplate(content: string, fileName?: string): ComponentInfo;\n}\n```\n\n\n
\n\n\n\n### [ComponentInfo](#-vuedx-analyze-ComponentInfo-interface)\n\n\n\n```ts\ninterface ComponentInfo extends Taggable {\n aliases: string[];\n components: LocalComponentRegistrationInfo[];\n description: string;\n emits: EmitInfo[];\n errors: SyntaxError[];\n fileName: string;\n fnSetupOption?: SetupInfo;\n identifierSource: Record
\n\n\n\n### [ComponentRegistrationInfo](#-vuedx-analyze-ComponentRegistrationInfo-interface)\n\n\n\n```ts\ninterface ComponentRegistrationInfo {\n aliases: string[];\n name: string;\n source: ImportSource;\n}\n```\n\n\n
\n\n\n\n### [EmitInfo](#-vuedx-analyze-EmitInfo-interface)\n\n\n\n```ts\ninterface EmitInfo extends Taggable, Addressable {\n description: string;\n isDynamic: boolean;\n isInferred: boolean;\n name: string;\n references: SourceRange[];\n type: TypeInfo[];\n}\n```\n\n\n
\n\n\n\n### [IdentifierSource](#-vuedx-analyze-IdentifierSource-interface)\n\n\n\n```ts\ninterface IdentifierSource extends Addressable {\n name: string;\n}\n```\n\n\n
\n\n\n\n### [ImportSource](#-vuedx-analyze-ImportSource-interface)\n\n\n\n```ts\ninterface ImportSource {\n exportName?: string;\n localName: string;\n moduleName: string;\n}\n```\n\n\n
\n\n\n\n### [ImportSourceWithLocation](#-vuedx-analyze-ImportSourceWithLocation-interface)\n\n\n\n```ts\ninterface ImportSourceWithLocation extends ImportSource, Addressable {\n}\n```\n\n\n
\n\n\n\n### [LocalComponentRegistrationInfo](#-vuedx-analyze-LocalComponentRegistrationInfo-interface)\n\n\n\n```ts\ninterface LocalComponentRegistrationInfo extends ComponentRegistrationInfo, Addressable {\n kind: 'script' | 'scriptSetup';\n source: ImportSourceWithLocation;\n}\n```\n\n\n
\n\n\n\n### [Plugin](#-vuedx-analyze-Plugin-2-interface)\n\n\n\n```ts\ninterface Plugin {\n babel?: AbstractScriptAnalyzerFn | AbstractAnalyzerHandler;\n blocks?: Partial<{\n script: BlockAnalyzer
\n\n\n\n### [PropInfo](#-vuedx-analyze-PropInfo-interface)\n\n\n\n```ts\ninterface PropInfo extends Taggable, Addressable {\n defaultValue: ValueInfo | null;\n description: string;\n name: string;\n required: boolean;\n type: TypeInfo[];\n}\n```\n\n\n
\n\n\n\n### [ScriptSetupInfo](#-vuedx-analyze-ScriptSetupInfo-interface)\n\n\n\n```ts\ninterface ScriptSetupInfo {\n defineEmit?: Addressable;\n defineProps?: Addressable;\n}\n```\n\n\n
\n\n\n\n### [SetupInfo](#-vuedx-analyze-SetupInfo-interface)\n\n\n\n```ts\ninterface SetupInfo extends Addressable {\n context?: {\n identifiers: Partial<{\n attrs: string;\n slots: string;\n emit: string;\n }>;\n rest?: string;\n } & Addressable;\n props?: {\n identifiers: string[];\n rest?: string;\n } & Addressable;\n return?: Addressable;\n}\n```\n\n\n
\n\n\n\n### [SourceRange](#-vuedx-analyze-SourceRange-interface)\n\n\n\n```ts\ninterface SourceRange {\n end: SourceLocation;\n source: string;\n start: SourceLocation;\n}\n```\n\n\n
\n\n\n\n### [SyntaxError](#-vuedx-analyze-SyntaxError-2-interface)\n\n\n\n```ts\ninterface SyntaxError {\n loc: SourceLocation;\n message: string;\n}\n```\n\n\n
\n\n\n\n### [VeturData](#-vuedx-analyze-VeturData-interface)\n\n\n\n```ts\ninterface VeturData {\n attributes: Record
\n\n\n\n### [WebTypes](#-vuedx-analyze-WebTypes-interface)\n\n\n\n```ts\ninterface WebTypes {\n contributions: {\n 'types-syntax': 'typescript';\n 'description-markup': 'html' | 'markdown' | 'none';\n tags: Tag[];\n attributes: Attribute[];\n };\n framework: 'vue';\n name: string;\n version: string;\n}\n```\n\n\n
\n\n","readmeFilename":"readme.md","_id":"@vuedx/analyze@0.4.1-insiders-1609336775.0","_nodeVersion":"14.14.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-czkkfheePubQKWlCG21mo2X7gaZXB9/PVyS8bpqH+8kr8MHrMe33joavAWcDHFUY+Jr6v3FX8n9IebOs8FFVzQ==","shasum":"9e282e090974b3736e8c65e80bcc4ccddac772d9","tarball":"https://registry.npmjs.org/@vuedx/analyze/-/analyze-0.4.1-insiders-1609336775.0.tgz","fileCount":9,"unpackedSize":479813,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJf7IfhCRA9TVsSAnZWagAA1JkQAJScADm4ouZ6UEfKPylT\nwaEeHj91FF0t8TFnoHOPGOyq9HvUMQWI1tBDDrEqGB/Of+IiJ6Tg158UnytY\nzi/XrLJjbFL0N2z0sbuuw6EjPUjvnbj6hpl1vu9sM4BuypnQGw9nWpbUTRJd\nIT1nQogHVbUrRoyQhSr9XD2t/cfHJR8VKl/jTPHWM060b8YY+yUghBglrLYI\noNW52KW6lRq9oTlBP07vOr9BbA0ShY04aAhxFycsA7XYwlfEqw/ljp0JFb7y\nUWu8HBkLDCE75fnG/Sr1XQvowWTWVkn256F0gdytyQWesspzX/1eLDvS9YXX\nqUV9gKmC5prUuY5sWA1qESNgJRXGmD4ckHuqvHgxwttIWcY521TuBFR8aan0\nLff+PrTHv2Uw1/pkH7hN7mmbHGxwJOJSeZ1YYUozAAUTNpuKBhh8/wdw7ken\nTYUbc7ui/Yzq2Rv2KTWBXq5YfpL4HmJafTotKbYVCmdKdUnKI18hSWntz+/a\nU2j9PyUwOrSQSzb7AYYRD7Et+Ljj1Buy3YLM7BtndcftVQOWKa40rb0Y1EBW\n4MOxpaYX3eFkN70ZCaIdXs34p+AEGyMoIGStrCwyec8rXe1ThFUDgxEkzHed\n+lMh1RA8FiAJKZg7+b9lgAEJWbNMmPGSX6eZs8kruwgD5rO4ohZec+/zbAKP\nNuzn\r\n=BQ+h\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDZbYvfaN3wrZozuTg1wmR76oD4wWARgECyUM7ewsFb7AIgZo6FQZU48WF9LR8Svtm7Eo37kIb72gxOYa0269qL7os="}]},"_npmUser":{"name":"znck","email":"rahulkdn@gmail.com"},"directories":{},"maintainers":[{"name":"znck","email":"rahulkdn@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/analyze_0.4.1-insiders-1609336775.0_1609336801017_0.4767634449324367"},"_hasShrinkwrap":false},"0.4.1":{"name":"@vuedx/analyze","version":"0.4.1","description":"Extracts public API information from Vue component.","main":"dist/index.cjs.js","module":"dist/index.esm.js","types":"dist/index.d.ts","bin":{"vuedx-analyze":"bin/analyze.js"},"keywords":["vue","sfc","sfc api extractor","static analyzer","sfc analyzer","sfc static analyzer","docgen","documentation"],"repository":{"type":"git","url":"git+https://github.com/znck/vue-developer-experience.git"},"author":{"name":"Rahul Kadyan","email":"rahulkdn@gmail.com","url":"https://znck.me/"},"funding":{"type":"individual","url":"https://github.com/sponsors/znck"},"license":"MIT","bugs":{"url":"https://github.com/znck/vue-developer-experience/issues"},"homepage":"https://github.com/znck/vue-developer-experience#readme","dependencies":{"@babel/code-frame":"^7.10.4","@babel/generator":"^7.12.1","@babel/parser":"^7.12.3","@babel/template":"^7.12.7","@babel/traverse":"7.12.1","@babel/types":"7.12.1","@types/micromatch":"^4.0.1","@vuedx/compiler-sfc":"0.4.1","@vuedx/compiler-tsx":"0.4.1","@vuedx/projectconfig":"0.4.1","@vuedx/template-ast-types":"0.4.1","cli-highlight":"^2.1.4","commander":"^6.1.0","fast-glob":"^3.2.4","hash-sum":"^2.0.0","micromatch":"^4.0.2"},"devDependencies":{"@types/babel__traverse":"^7.0.15","@types/node":"^14.14.14","@vuedx/shared":"0.4.1","typescript":"^4.0.3"},"_id":"@vuedx/analyze@0.4.1","_nodeVersion":"14.14.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-7FBFWboGCFDVtMnc+egZU0UpdKFfuyhRVjs+pycWvZ630eKsGK4zKRKmJBXqccctWO2FRRRuW4pXfi1SbJGY0w==","shasum":"9d5b888ee1b9a798794a44283100f8270bbb6e83","tarball":"https://registry.npmjs.org/@vuedx/analyze/-/analyze-0.4.1.tgz","fileCount":9,"unpackedSize":479681,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJf7IhBCRA9TVsSAnZWagAAcd0QAJi2GrTKs/X5DZpJqEzI\nJzcUMFHn+vdpjHIq47koCtIXZSEaWGgMGbtlbaVPd62wq1twqI+08YTc++ID\neDmED3dUua2Q6P3zBTfOShYEkMiuAxNQzRt0FIAl4l3a3twXDOOUK5JUgnN+\njC08plEVOQRo2BebV7Mx4+LwOhTpBib5sSykIyeB8nM4ilLFg5++tEHY+TK2\nfBy7wMjGFe9BaLdTc6iMLeqACoMBopQSh91H90GEDvLVc2GVbhkRKogeZHbv\n6ombAp9yEJbgA924CEhWl1NuSpX6tA8EOS/RXjASoPxBywDiN/OUXFUChSjf\nLQBUdOY+NcOB74+/TiEJJWiZ7S6EEbdHYiV7RcXvaFozLm0LsVugxo+GSEEi\n1E1XEnded+r41cNw1FS4N56VOlTqKFf0ytgDOhFMglP9MnfS/hZeXR5/yrrp\ntmEY40660APekoyscO8P0qD3u0EP15/gOq7XBI1ukGVRI7y40vojoH4M4CUP\n7592ZN5g2dnSSkMP8f6fRb5FfttW7HcRyqZsH5ECF+34yDCiNb9w8TG2o81W\narBx/k4qg05od23AEwsrA+OsBrp5obAGAYtagQ1fZtiARhplzw2OgpmycsUg\n0TnKCqwxn8dmTx1pY+kCKvUbWmTSNmV4OfZnKIg3aghs0+DZmSnGO0GAvPrY\n6Svj\r\n=XK3h\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQD1Ev6Ev9kTKeCRBMROt452q5k8cs+Ddno439XikEfO/gIgQNL3G/+BABHAdQBa9ZlUnRb5/7cRcQkw6Z9ijjBFGcw="}]},"_npmUser":{"name":"znck","email":"rahulkdn@gmail.com"},"directories":{},"maintainers":[{"name":"znck","email":"rahulkdn@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/analyze_0.4.1_1609336896543_0.9649392812754938"},"_hasShrinkwrap":false},"0.4.2-insiders-1609376449.0":{"name":"@vuedx/analyze","version":"0.4.2-insiders-1609376449.0","description":"Extracts public API information from Vue component.","main":"dist/index.cjs.js","module":"dist/index.esm.js","types":"dist/index.d.ts","bin":{"vuedx-analyze":"bin/analyze.js"},"keywords":["vue","sfc","sfc api extractor","static analyzer","sfc analyzer","sfc static analyzer","docgen","documentation"],"repository":{"type":"git","url":"git+https://github.com/znck/vue-developer-experience.git"},"author":{"name":"Rahul Kadyan","email":"rahulkdn@gmail.com","url":"https://znck.me/"},"funding":{"type":"individual","url":"https://github.com/sponsors/znck"},"license":"MIT","bugs":{"url":"https://github.com/znck/vue-developer-experience/issues"},"homepage":"https://github.com/znck/vue-developer-experience#readme","dependencies":{"@babel/code-frame":"^7.10.4","@babel/generator":"^7.12.1","@babel/parser":"^7.12.3","@babel/template":"^7.12.7","@babel/traverse":"7.12.1","@babel/types":"7.12.1","@types/micromatch":"^4.0.1","@vuedx/compiler-sfc":"0.4.2-insiders-1609376449.0","@vuedx/compiler-tsx":"0.4.2-insiders-1609376449.0","@vuedx/projectconfig":"0.4.2-insiders-1609376449.0","@vuedx/template-ast-types":"0.4.2-insiders-1609376449.0","cli-highlight":"^2.1.4","commander":"^6.1.0","fast-glob":"^3.2.4","hash-sum":"^2.0.0","micromatch":"^4.0.2"},"devDependencies":{"@types/babel__traverse":"^7.0.15","@types/node":"^14.14.14","@vuedx/shared":"0.4.2-insiders-1609376449.0","typescript":"^4.0.3"},"readme":"
\n \n
\n\n## Support\n\nThis package is part of [VueDX project](https://github.com/znck/vue-developer-experience), maintained by [Rahul Kadyan](https://github.com/znck). You can [💖 sponsor him](https://github.com/sponsors/znck) for continued development of this package and other VueDX tools.\n\n## Usage\n\n\n\n\n## API\n\n\n\n\n### [ConfiguredVueProject](#-vuedx-analyze-ConfiguredVueProject-class)\n\n\n\n\n Analyze
\nA tool to statically analyze Vue single file components.
\nMore info
\n\n**Signature:**\n```ts\ndeclare class ConfiguredVueProject extends VueProject {\n constructor(rootDir: string, packageFile: string | undefined, packageJSON: Partial\n\n\n\n#### [setFileNames](#-vuedx-analyze-ConfiguredVueProject-setFileNames-member-1-)\n\n\n\n**Signature:**\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n\n### [InferredVueProject](#-vuedx-analyze-InferredVueProject-class)\n\n\n\n
More info
\n\n**Signature:**\n```ts\ndeclare class InferredVueProject extends VueProject {\n kind: \"inferred\";\n protected refresh(): void;\n}\n```\n\n**Members:**\n\n\n\n\n#### [refresh](#-vuedx-analyze-InferredVueProject-refresh-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected refresh(): void;\n```\n\n\n\n
\n\n\n\n\n### [VueProject](#-vuedx-analyze-VueProject-class)\n\n\n\n
More info
\n\n**Signature:**\n```ts\ndeclare abstract class VueProject {\n protected _config: Readonly\n\n\n\n#### [markDirty](#-vuedx-analyze-VueProject-markDirty-member-1-)\n\n\n\n**Signature:**\n```ts\nmarkDirty(): void;\n```\n\n\n
\n\n\n\n#### [refresh](#-vuedx-analyze-VueProject-refresh-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected abstract refresh(): void;\n```\n\n\n
\n\n\n\n#### [reloadIfNeeded](#-vuedx-analyze-VueProject-reloadIfNeeded-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected reloadIfNeeded(): void;\n```\n\n\n
\n\n\n\n#### [setConfig](#-vuedx-analyze-VueProject-setConfig-member-1-)\n\n\n\n**Signature:**\n```ts\nsetConfig(config: ProjectConfig): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| config |
ProjectConfig | - |\n\n\n\n\n\n#### [setFileNames](#-vuedx-analyze-VueProject-setFileNames-member-1-)\n\n\n\n**Signature:**\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n\n### [createAnalyzer](#-vuedx-analyze-createAnalyzer-function-1-)\n\n\n\n
\n): Analyzer;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| plugins |
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createAnalyzer(plugins: Plugin[], options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createFullAnalyzer](#-vuedx-analyze-createFullAnalyzer-function-1-)\n\n\n\n
\n): ReturnType;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| plugins |
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createFullAnalyzer(plugins?: Plugin[], options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createSourceRange](#-vuedx-analyze-createSourceRange-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createSourceRange(context: Context | ScriptAnalyzerContext, node: Node): SourceRange;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| context |Context | ScriptAnalyzerContext | - |\n| node | Node | - |\n\n\n\n\n\n### [toVeturData](#-vuedx-analyze-toVeturData-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function toVeturData(components: ComponentInfo[]): VeturData;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| components |ComponentInfo[] | - |\n\n\n\n\n\n### [toWebTypes](#-vuedx-analyze-toWebTypes-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function toWebTypes(name: string, version: string, components: ComponentInfo[]): WebTypes;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| name |string | - |\n| version | string | - |\n| components | ComponentInfo[] | - |\n\n\n\n\n\n### [transformToFunction](#-vuedx-analyze-transformToFunction-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function transformToFunction(content: string, options?: FunctionTransformOptions): string;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| content |string | - |\n| options | FunctionTransformOptions | - |\n\n\n\n## Types\n\n\n\n\n### [Analyzer](#-vuedx-analyze-Analyzer-interface)\n\n\n\n```ts\ninterface Analyzer {\n analyze(content: string, fileName?: string): ComponentInfo;\n analyzeScript(content: string, fileName?: string, mode?: 'script' | 'scriptSetup'): ComponentInfo;\n analyzeTemplate(content: string, fileName?: string): ComponentInfo;\n}\n```\n\n\n
\n\n\n\n### [ComponentInfo](#-vuedx-analyze-ComponentInfo-interface)\n\n\n\n```ts\ninterface ComponentInfo extends Taggable {\n aliases: string[];\n components: LocalComponentRegistrationInfo[];\n description: string;\n emits: EmitInfo[];\n errors: SyntaxError[];\n fileName: string;\n fnSetupOption?: SetupInfo;\n identifierSource: Record
\n\n\n\n### [ComponentRegistrationInfo](#-vuedx-analyze-ComponentRegistrationInfo-interface)\n\n\n\n```ts\ninterface ComponentRegistrationInfo {\n aliases: string[];\n name: string;\n source: ImportSource;\n}\n```\n\n\n
\n\n\n\n### [EmitInfo](#-vuedx-analyze-EmitInfo-interface)\n\n\n\n```ts\ninterface EmitInfo extends Taggable, Addressable {\n description: string;\n isDynamic: boolean;\n isInferred: boolean;\n name: string;\n references: SourceRange[];\n type: TypeInfo[];\n}\n```\n\n\n
\n\n\n\n### [IdentifierSource](#-vuedx-analyze-IdentifierSource-interface)\n\n\n\n```ts\ninterface IdentifierSource extends Addressable {\n name: string;\n}\n```\n\n\n
\n\n\n\n### [ImportSource](#-vuedx-analyze-ImportSource-interface)\n\n\n\n```ts\ninterface ImportSource {\n exportName?: string;\n localName: string;\n moduleName: string;\n}\n```\n\n\n
\n\n\n\n### [ImportSourceWithLocation](#-vuedx-analyze-ImportSourceWithLocation-interface)\n\n\n\n```ts\ninterface ImportSourceWithLocation extends ImportSource, Addressable {\n}\n```\n\n\n
\n\n\n\n### [LocalComponentRegistrationInfo](#-vuedx-analyze-LocalComponentRegistrationInfo-interface)\n\n\n\n```ts\ninterface LocalComponentRegistrationInfo extends ComponentRegistrationInfo, Addressable {\n kind: 'script' | 'scriptSetup';\n source: ImportSourceWithLocation;\n}\n```\n\n\n
\n\n\n\n### [Plugin](#-vuedx-analyze-Plugin-2-interface)\n\n\n\n```ts\ninterface Plugin {\n babel?: AbstractScriptAnalyzerFn | AbstractAnalyzerHandler;\n blocks?: Partial<{\n script: BlockAnalyzer
\n\n\n\n### [PropInfo](#-vuedx-analyze-PropInfo-interface)\n\n\n\n```ts\ninterface PropInfo extends Taggable, Addressable {\n defaultValue: ValueInfo | null;\n description: string;\n name: string;\n required: boolean;\n type: TypeInfo[];\n}\n```\n\n\n
\n\n\n\n### [ScriptSetupInfo](#-vuedx-analyze-ScriptSetupInfo-interface)\n\n\n\n```ts\ninterface ScriptSetupInfo {\n defineEmit?: Addressable;\n defineProps?: Addressable;\n}\n```\n\n\n
\n\n\n\n### [SetupInfo](#-vuedx-analyze-SetupInfo-interface)\n\n\n\n```ts\ninterface SetupInfo extends Addressable {\n context?: {\n identifiers: Partial<{\n attrs: string;\n slots: string;\n emit: string;\n }>;\n rest?: string;\n } & Addressable;\n props?: {\n identifiers: string[];\n rest?: string;\n } & Addressable;\n return?: Addressable;\n}\n```\n\n\n
\n\n\n\n### [SourceRange](#-vuedx-analyze-SourceRange-interface)\n\n\n\n```ts\ninterface SourceRange {\n end: SourceLocation;\n source: string;\n start: SourceLocation;\n}\n```\n\n\n
\n\n\n\n### [SyntaxError](#-vuedx-analyze-SyntaxError-2-interface)\n\n\n\n```ts\ninterface SyntaxError {\n loc: SourceLocation;\n message: string;\n}\n```\n\n\n
\n\n\n\n### [VeturData](#-vuedx-analyze-VeturData-interface)\n\n\n\n```ts\ninterface VeturData {\n attributes: Record
\n\n\n\n### [WebTypes](#-vuedx-analyze-WebTypes-interface)\n\n\n\n```ts\ninterface WebTypes {\n contributions: {\n 'types-syntax': 'typescript';\n 'description-markup': 'html' | 'markdown' | 'none';\n tags: Tag[];\n attributes: Attribute[];\n };\n framework: 'vue';\n name: string;\n version: string;\n}\n```\n\n\n
\n\n","readmeFilename":"readme.md","_id":"@vuedx/analyze@0.4.2-insiders-1609376449.0","_nodeVersion":"14.14.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-cLjPaL1v9sM08etrxM2Y+bFTdc2pWz2UqPuntqpxaF42/kkHM7nqrFCsoZ3kkc345HdTu0sSDev3+eCotTlaVg==","shasum":"8d31e40f3f1aa37c751f492945c7c09c531a1b89","tarball":"https://registry.npmjs.org/@vuedx/analyze/-/analyze-0.4.2-insiders-1609376449.0.tgz","fileCount":9,"unpackedSize":479813,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJf7SLbCRA9TVsSAnZWagAA0NQP/0t0vxAlwRIS6JflWLh4\ns7yvF+WTm6NHb+H+4SVZ9j0PTLnhaQ3JLoWTS9LSjOCS3gtq76+1CsiCtbVg\nQDtjNaepa7E0IL0JK8+bNFmoA3mgDi8BbfnZNvRYlUASofdthCzmd9KOVg7q\n/ioHYaMb+SgSeTlJGjmIluPDHaDuBpaQ/9HhM2JDGZRMs7GkVy3VKskvrS4h\nmtLgmD6Z9q2VNR4VmHn6SxYILn+ag9qSqUwQJtA/UF99FKHhSdi8NzJWv4A1\nnA2rHyL7SPbRxbQP4K83VIb/yQQjSPPRJXSRKC2k5U4r2LRanbNLRqOBbUHP\nDNr9Ay94NP7/FQcKp1qf7uvlt1EBOleeTvSmQ4S2DKTqeGM2Hrc1LRmyrkOR\nWMDjX7Ynrerav7dnuxVDiN/Cmjws4eMNW971gcxHvTPE6i71oKZzniyPgbhI\nIhqHcPau0NkALPfmhGlBrcVsrxyc2f0mL9luK8kn2TgXHfEj/+iha/Qkt3Nq\nh9EweM3WfdtknIAbnUGXAA42F6Z7uKm0qOND+QYN5KipfAVHoHlobIYejLoG\n+BGvS3ax0uMiF0q3q2i8i3bedYUeeVN/ha0jRneteL/7N/lhn8cZ2yVYT0DS\npe1BT7yddYY3AD/fy1CYl3/PetULwILIaHCe6JiWglxftBu0+DWplsq7Uow0\nTAi9\r\n=HxzG\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIH31fzoCSj/R+mC76N4tiTqK81pBNpQWmsXvXl+rP+V+AiAw37YG15HJD62S6iUtSpqxb0tEVQmihEOjjdvjf71YZQ=="}]},"_npmUser":{"name":"znck","email":"rahulkdn@gmail.com"},"directories":{},"maintainers":[{"name":"znck","email":"rahulkdn@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/analyze_0.4.2-insiders-1609376449.0_1609376475130_0.7973344755737555"},"_hasShrinkwrap":false},"0.4.2-insiders-1609376781.0":{"name":"@vuedx/analyze","version":"0.4.2-insiders-1609376781.0","description":"Extracts public API information from Vue component.","main":"dist/index.cjs.js","module":"dist/index.esm.js","types":"dist/index.d.ts","bin":{"vuedx-analyze":"bin/analyze.js"},"keywords":["vue","sfc","sfc api extractor","static analyzer","sfc analyzer","sfc static analyzer","docgen","documentation"],"repository":{"type":"git","url":"git+https://github.com/znck/vue-developer-experience.git"},"author":{"name":"Rahul Kadyan","email":"rahulkdn@gmail.com","url":"https://znck.me/"},"funding":{"type":"individual","url":"https://github.com/sponsors/znck"},"license":"MIT","bugs":{"url":"https://github.com/znck/vue-developer-experience/issues"},"homepage":"https://github.com/znck/vue-developer-experience#readme","dependencies":{"@babel/code-frame":"^7.10.4","@babel/generator":"^7.12.1","@babel/parser":"^7.12.3","@babel/template":"^7.12.7","@babel/traverse":"7.12.1","@babel/types":"7.12.1","@types/micromatch":"^4.0.1","@vuedx/compiler-sfc":"0.4.2-insiders-1609376781.0","@vuedx/compiler-tsx":"0.4.2-insiders-1609376781.0","@vuedx/projectconfig":"0.4.2-insiders-1609376781.0","@vuedx/template-ast-types":"0.4.2-insiders-1609376781.0","cli-highlight":"^2.1.4","commander":"^6.1.0","fast-glob":"^3.2.4","hash-sum":"^2.0.0","micromatch":"^4.0.2"},"devDependencies":{"@types/babel__traverse":"^7.0.15","@types/node":"^14.14.14","@vuedx/shared":"0.4.2-insiders-1609376781.0","typescript":"^4.0.3"},"readme":"
\n \n
\n\n## Support\n\nThis package is part of [VueDX project](https://github.com/znck/vue-developer-experience), maintained by [Rahul Kadyan](https://github.com/znck). You can [💖 sponsor him](https://github.com/sponsors/znck) for continued development of this package and other VueDX tools.\n\n## Usage\n\n\n\n\n## API\n\n\n\n\n### [ConfiguredVueProject](#-vuedx-analyze-ConfiguredVueProject-class)\n\n\n\n\n Analyze
\nA tool to statically analyze Vue single file components.
\nMore info
\n\n**Signature:**\n```ts\ndeclare class ConfiguredVueProject extends VueProject {\n constructor(rootDir: string, packageFile: string | undefined, packageJSON: Partial\n\n\n\n#### [setFileNames](#-vuedx-analyze-ConfiguredVueProject-setFileNames-member-1-)\n\n\n\n**Signature:**\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n\n### [InferredVueProject](#-vuedx-analyze-InferredVueProject-class)\n\n\n\n
More info
\n\n**Signature:**\n```ts\ndeclare class InferredVueProject extends VueProject {\n kind: \"inferred\";\n protected refresh(): void;\n}\n```\n\n**Members:**\n\n\n\n\n#### [refresh](#-vuedx-analyze-InferredVueProject-refresh-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected refresh(): void;\n```\n\n\n\n
\n\n\n\n\n### [VueProject](#-vuedx-analyze-VueProject-class)\n\n\n\n
More info
\n\n**Signature:**\n```ts\ndeclare abstract class VueProject {\n protected _config: Readonly\n\n\n\n#### [markDirty](#-vuedx-analyze-VueProject-markDirty-member-1-)\n\n\n\n**Signature:**\n```ts\nmarkDirty(): void;\n```\n\n\n
\n\n\n\n#### [refresh](#-vuedx-analyze-VueProject-refresh-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected abstract refresh(): void;\n```\n\n\n
\n\n\n\n#### [reloadIfNeeded](#-vuedx-analyze-VueProject-reloadIfNeeded-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected reloadIfNeeded(): void;\n```\n\n\n
\n\n\n\n#### [setConfig](#-vuedx-analyze-VueProject-setConfig-member-1-)\n\n\n\n**Signature:**\n```ts\nsetConfig(config: ProjectConfig): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| config |
ProjectConfig | - |\n\n\n\n\n\n#### [setFileNames](#-vuedx-analyze-VueProject-setFileNames-member-1-)\n\n\n\n**Signature:**\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n\n### [createAnalyzer](#-vuedx-analyze-createAnalyzer-function-1-)\n\n\n\n
\n): Analyzer;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| plugins |
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createAnalyzer(plugins: Plugin[], options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createFullAnalyzer](#-vuedx-analyze-createFullAnalyzer-function-1-)\n\n\n\n
\n): ReturnType;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| plugins |
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createFullAnalyzer(plugins?: Plugin[], options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createSourceRange](#-vuedx-analyze-createSourceRange-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createSourceRange(context: Context | ScriptAnalyzerContext, node: Node): SourceRange;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| context |Context | ScriptAnalyzerContext | - |\n| node | Node | - |\n\n\n\n\n\n### [toVeturData](#-vuedx-analyze-toVeturData-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function toVeturData(components: ComponentInfo[]): VeturData;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| components |ComponentInfo[] | - |\n\n\n\n\n\n### [toWebTypes](#-vuedx-analyze-toWebTypes-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function toWebTypes(name: string, version: string, components: ComponentInfo[]): WebTypes;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| name |string | - |\n| version | string | - |\n| components | ComponentInfo[] | - |\n\n\n\n\n\n### [transformToFunction](#-vuedx-analyze-transformToFunction-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function transformToFunction(content: string, options?: FunctionTransformOptions): string;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| content |string | - |\n| options | FunctionTransformOptions | - |\n\n\n\n## Types\n\n\n\n\n### [Analyzer](#-vuedx-analyze-Analyzer-interface)\n\n\n\n```ts\ninterface Analyzer {\n analyze(content: string, fileName?: string): ComponentInfo;\n analyzeScript(content: string, fileName?: string, mode?: 'script' | 'scriptSetup'): ComponentInfo;\n analyzeTemplate(content: string, fileName?: string): ComponentInfo;\n}\n```\n\n\n
\n\n\n\n### [ComponentInfo](#-vuedx-analyze-ComponentInfo-interface)\n\n\n\n```ts\ninterface ComponentInfo extends Taggable {\n aliases: string[];\n components: LocalComponentRegistrationInfo[];\n description: string;\n emits: EmitInfo[];\n errors: SyntaxError[];\n fileName: string;\n fnSetupOption?: SetupInfo;\n identifierSource: Record
\n\n\n\n### [ComponentRegistrationInfo](#-vuedx-analyze-ComponentRegistrationInfo-interface)\n\n\n\n```ts\ninterface ComponentRegistrationInfo {\n aliases: string[];\n name: string;\n source: ImportSource;\n}\n```\n\n\n
\n\n\n\n### [EmitInfo](#-vuedx-analyze-EmitInfo-interface)\n\n\n\n```ts\ninterface EmitInfo extends Taggable, Addressable {\n description: string;\n isDynamic: boolean;\n isInferred: boolean;\n name: string;\n references: SourceRange[];\n type: TypeInfo[];\n}\n```\n\n\n
\n\n\n\n### [IdentifierSource](#-vuedx-analyze-IdentifierSource-interface)\n\n\n\n```ts\ninterface IdentifierSource extends Addressable {\n name: string;\n}\n```\n\n\n
\n\n\n\n### [ImportSource](#-vuedx-analyze-ImportSource-interface)\n\n\n\n```ts\ninterface ImportSource {\n exportName?: string;\n localName: string;\n moduleName: string;\n}\n```\n\n\n
\n\n\n\n### [ImportSourceWithLocation](#-vuedx-analyze-ImportSourceWithLocation-interface)\n\n\n\n```ts\ninterface ImportSourceWithLocation extends ImportSource, Addressable {\n}\n```\n\n\n
\n\n\n\n### [LocalComponentRegistrationInfo](#-vuedx-analyze-LocalComponentRegistrationInfo-interface)\n\n\n\n```ts\ninterface LocalComponentRegistrationInfo extends ComponentRegistrationInfo, Addressable {\n kind: 'script' | 'scriptSetup';\n source: ImportSourceWithLocation;\n}\n```\n\n\n
\n\n\n\n### [Plugin](#-vuedx-analyze-Plugin-2-interface)\n\n\n\n```ts\ninterface Plugin {\n babel?: AbstractScriptAnalyzerFn | AbstractAnalyzerHandler;\n blocks?: Partial<{\n script: BlockAnalyzer
\n\n\n\n### [PropInfo](#-vuedx-analyze-PropInfo-interface)\n\n\n\n```ts\ninterface PropInfo extends Taggable, Addressable {\n defaultValue: ValueInfo | null;\n description: string;\n name: string;\n required: boolean;\n type: TypeInfo[];\n}\n```\n\n\n
\n\n\n\n### [ScriptSetupInfo](#-vuedx-analyze-ScriptSetupInfo-interface)\n\n\n\n```ts\ninterface ScriptSetupInfo {\n defineEmit?: Addressable;\n defineProps?: Addressable;\n}\n```\n\n\n
\n\n\n\n### [SetupInfo](#-vuedx-analyze-SetupInfo-interface)\n\n\n\n```ts\ninterface SetupInfo extends Addressable {\n context?: {\n identifiers: Partial<{\n attrs: string;\n slots: string;\n emit: string;\n }>;\n rest?: string;\n } & Addressable;\n props?: {\n identifiers: string[];\n rest?: string;\n } & Addressable;\n return?: Addressable;\n}\n```\n\n\n
\n\n\n\n### [SourceRange](#-vuedx-analyze-SourceRange-interface)\n\n\n\n```ts\ninterface SourceRange {\n end: SourceLocation;\n source: string;\n start: SourceLocation;\n}\n```\n\n\n
\n\n\n\n### [SyntaxError](#-vuedx-analyze-SyntaxError-2-interface)\n\n\n\n```ts\ninterface SyntaxError {\n loc: SourceLocation;\n message: string;\n}\n```\n\n\n
\n\n\n\n### [VeturData](#-vuedx-analyze-VeturData-interface)\n\n\n\n```ts\ninterface VeturData {\n attributes: Record
\n\n\n\n### [WebTypes](#-vuedx-analyze-WebTypes-interface)\n\n\n\n```ts\ninterface WebTypes {\n contributions: {\n 'types-syntax': 'typescript';\n 'description-markup': 'html' | 'markdown' | 'none';\n tags: Tag[];\n attributes: Attribute[];\n };\n framework: 'vue';\n name: string;\n version: string;\n}\n```\n\n\n
\n\n","readmeFilename":"readme.md","_id":"@vuedx/analyze@0.4.2-insiders-1609376781.0","_nodeVersion":"14.14.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-Cr1X1barvMMevXc1w6mWUJa+zAkJIBlRRgxtOyPxAj4S/7TW2iKyzDrR8zNRpRTP0kgt5IkFGAtj4AfQe15l2Q==","shasum":"850a8f82f75d27e1fd2b359f3633907954b69edd","tarball":"https://registry.npmjs.org/@vuedx/analyze/-/analyze-0.4.2-insiders-1609376781.0.tgz","fileCount":9,"unpackedSize":479813,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJf7SQlCRA9TVsSAnZWagAA1vYP/3ON2DKWU/uhlJqoUiJT\nELdZicKssEWQv99l7GUPTMufyK9rC5PAKiqbi8zvZVLLQ7CV+smZ1gK7w1Dj\n0vxY9TAb56D8dCLrAlh6/ipWw4U3xpe1uHtlQVqef21MoDvg53ybCvbyO4pB\n6GkQ10qIpYqXXAwgjMwl4kfi8GLkAoTwFhXQ5HmJtzOEd+FK1ln3FXtPO0gB\nYQHkez5JC3HcS/fwFRfeM7lswu3eKlsTW5FIc90SupI1v9JwCOQEd4gMdqQ3\nV/sXtkA0EAzH9Vn8Gi5NTnAA3kNW5ZIO0SkiGWlhNRj5Q4NTwDM+7VaH5FRl\n3GRinxT6QuSrgpNdDFUyOb6AQsi//QgWch5FRPKqoqfNCKs1zq2w9WH67/pj\niDLfuRreJL8KP/+xSzjTuW/W3O094ayfdw3+D/gVZ7IwzywfHyaWrChCJcHL\nuoYRHUqQ4aHoESXJ+0CN5hliFv1V/AKOLOWOvNqVcUd0Zpm9g45Q0NQizgxV\n1pfo/TC1zboo5K4QG5PfqyB5VbOx58aqvz5Gd5RUZFB9b8/t4oWgx4vS4OmQ\nsXMdZ9qJLNP1Bf5mHe2w4K/YQd56tslQ4XgV6/4dC8J3pf47myTCMwitOTMl\nLPq7vSnxcF4eXGIGrjSFVxFE7w971noDGqYKdAuElqM9BlxVnfKu8RshQAcX\ny4Wl\r\n=geP/\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIA2pUvLfL8C8Co7Wn6WTMxnhNtFwA8hcV3gLIBnL/MC6AiBnLCNbwm1JPCZa9JBFu2kb6q4tPnJC/4L3t5Z0SZV/GQ=="}]},"_npmUser":{"name":"znck","email":"rahulkdn@gmail.com"},"directories":{},"maintainers":[{"name":"znck","email":"rahulkdn@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/analyze_0.4.2-insiders-1609376781.0_1609376804977_0.22753255881391343"},"_hasShrinkwrap":false},"0.4.2-insiders-1609385764.0":{"name":"@vuedx/analyze","version":"0.4.2-insiders-1609385764.0","description":"Extracts public API information from Vue component.","main":"dist/index.cjs.js","module":"dist/index.esm.js","types":"dist/index.d.ts","bin":{"vuedx-analyze":"bin/analyze.js"},"keywords":["vue","sfc","sfc api extractor","static analyzer","sfc analyzer","sfc static analyzer","docgen","documentation"],"repository":{"type":"git","url":"git+https://github.com/znck/vue-developer-experience.git"},"author":{"name":"Rahul Kadyan","email":"rahulkdn@gmail.com","url":"https://znck.me/"},"funding":{"type":"individual","url":"https://github.com/sponsors/znck"},"license":"MIT","bugs":{"url":"https://github.com/znck/vue-developer-experience/issues"},"homepage":"https://github.com/znck/vue-developer-experience#readme","dependencies":{"@babel/code-frame":"^7.10.4","@babel/generator":"^7.12.1","@babel/parser":"^7.12.3","@babel/template":"^7.12.7","@babel/traverse":"7.12.1","@babel/types":"7.12.1","@types/micromatch":"^4.0.1","@vuedx/compiler-sfc":"0.4.2-insiders-1609385764.0","@vuedx/compiler-tsx":"0.4.2-insiders-1609385764.0","@vuedx/projectconfig":"0.4.2-insiders-1609385764.0","@vuedx/template-ast-types":"0.4.2-insiders-1609385764.0","cli-highlight":"^2.1.4","commander":"^6.1.0","fast-glob":"^3.2.4","hash-sum":"^2.0.0","micromatch":"^4.0.2"},"devDependencies":{"@types/babel__traverse":"^7.0.15","@types/node":"^14.14.14","@vuedx/shared":"0.4.2-insiders-1609385764.0","typescript":"^4.0.3"},"readme":"
\n \n
\n\n## Support\n\nThis package is part of [VueDX project](https://github.com/znck/vue-developer-experience), maintained by [Rahul Kadyan](https://github.com/znck). You can [💖 sponsor him](https://github.com/sponsors/znck) for continued development of this package and other VueDX tools.\n\n## Usage\n\n\n\n\n## API\n\n\n\n\n### [ConfiguredVueProject](#-vuedx-analyze-ConfiguredVueProject-class)\n\n\n\n\n Analyze
\nA tool to statically analyze Vue single file components.
\nMore info
\n\n**Signature:**\n```ts\ndeclare class ConfiguredVueProject extends VueProject {\n constructor(rootDir: string, packageFile: string | undefined, packageJSON: Partial\n\n\n\n#### [setFileNames](#-vuedx-analyze-ConfiguredVueProject-setFileNames-member-1-)\n\n\n\n**Signature:**\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n\n### [InferredVueProject](#-vuedx-analyze-InferredVueProject-class)\n\n\n\n
More info
\n\n**Signature:**\n```ts\ndeclare class InferredVueProject extends VueProject {\n kind: \"inferred\";\n protected refresh(): void;\n}\n```\n\n**Members:**\n\n\n\n\n#### [refresh](#-vuedx-analyze-InferredVueProject-refresh-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected refresh(): void;\n```\n\n\n\n
\n\n\n\n\n### [VueProject](#-vuedx-analyze-VueProject-class)\n\n\n\n
More info
\n\n**Signature:**\n```ts\ndeclare abstract class VueProject {\n protected _config: Readonly\n\n\n\n#### [markDirty](#-vuedx-analyze-VueProject-markDirty-member-1-)\n\n\n\n**Signature:**\n```ts\nmarkDirty(): void;\n```\n\n\n
\n\n\n\n#### [refresh](#-vuedx-analyze-VueProject-refresh-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected abstract refresh(): void;\n```\n\n\n
\n\n\n\n#### [reloadIfNeeded](#-vuedx-analyze-VueProject-reloadIfNeeded-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected reloadIfNeeded(): void;\n```\n\n\n
\n\n\n\n#### [setConfig](#-vuedx-analyze-VueProject-setConfig-member-1-)\n\n\n\n**Signature:**\n```ts\nsetConfig(config: ProjectConfig): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| config |
ProjectConfig | - |\n\n\n\n\n\n#### [setFileNames](#-vuedx-analyze-VueProject-setFileNames-member-1-)\n\n\n\n**Signature:**\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n\n### [createAnalyzer](#-vuedx-analyze-createAnalyzer-function-1-)\n\n\n\n
\n): Analyzer;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| plugins |
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createAnalyzer(plugins: Plugin[], options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createFullAnalyzer](#-vuedx-analyze-createFullAnalyzer-function-1-)\n\n\n\n
\n): ReturnType;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| plugins |
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createFullAnalyzer(plugins?: Plugin[], options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createSourceRange](#-vuedx-analyze-createSourceRange-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createSourceRange(context: Context | ScriptAnalyzerContext, node: Node): SourceRange;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| context |Context | ScriptAnalyzerContext | - |\n| node | Node | - |\n\n\n\n\n\n### [toVeturData](#-vuedx-analyze-toVeturData-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function toVeturData(components: ComponentInfo[]): VeturData;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| components |ComponentInfo[] | - |\n\n\n\n\n\n### [toWebTypes](#-vuedx-analyze-toWebTypes-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function toWebTypes(name: string, version: string, components: ComponentInfo[]): WebTypes;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| name |string | - |\n| version | string | - |\n| components | ComponentInfo[] | - |\n\n\n\n\n\n### [transformToFunction](#-vuedx-analyze-transformToFunction-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function transformToFunction(content: string, options?: FunctionTransformOptions): string;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| content |string | - |\n| options | FunctionTransformOptions | - |\n\n\n\n## Types\n\n\n\n\n### [Analyzer](#-vuedx-analyze-Analyzer-interface)\n\n\n\n```ts\ninterface Analyzer {\n analyze(content: string, fileName?: string): ComponentInfo;\n analyzeScript(content: string, fileName?: string, mode?: 'script' | 'scriptSetup'): ComponentInfo;\n analyzeTemplate(content: string, fileName?: string): ComponentInfo;\n}\n```\n\n\n
\n\n\n\n### [ComponentInfo](#-vuedx-analyze-ComponentInfo-interface)\n\n\n\n```ts\ninterface ComponentInfo extends Taggable {\n aliases: string[];\n components: LocalComponentRegistrationInfo[];\n description: string;\n emits: EmitInfo[];\n errors: SyntaxError[];\n fileName: string;\n fnSetupOption?: SetupInfo;\n identifierSource: Record
\n\n\n\n### [ComponentRegistrationInfo](#-vuedx-analyze-ComponentRegistrationInfo-interface)\n\n\n\n```ts\ninterface ComponentRegistrationInfo {\n aliases: string[];\n name: string;\n source: ImportSource;\n}\n```\n\n\n
\n\n\n\n### [EmitInfo](#-vuedx-analyze-EmitInfo-interface)\n\n\n\n```ts\ninterface EmitInfo extends Taggable, Addressable {\n description: string;\n isDynamic: boolean;\n isInferred: boolean;\n name: string;\n references: SourceRange[];\n type: TypeInfo[];\n}\n```\n\n\n
\n\n\n\n### [IdentifierSource](#-vuedx-analyze-IdentifierSource-interface)\n\n\n\n```ts\ninterface IdentifierSource extends Addressable {\n name: string;\n}\n```\n\n\n
\n\n\n\n### [ImportSource](#-vuedx-analyze-ImportSource-interface)\n\n\n\n```ts\ninterface ImportSource {\n exportName?: string;\n localName: string;\n moduleName: string;\n}\n```\n\n\n
\n\n\n\n### [ImportSourceWithLocation](#-vuedx-analyze-ImportSourceWithLocation-interface)\n\n\n\n```ts\ninterface ImportSourceWithLocation extends ImportSource, Addressable {\n}\n```\n\n\n
\n\n\n\n### [LocalComponentRegistrationInfo](#-vuedx-analyze-LocalComponentRegistrationInfo-interface)\n\n\n\n```ts\ninterface LocalComponentRegistrationInfo extends ComponentRegistrationInfo, Addressable {\n kind: 'script' | 'scriptSetup';\n source: ImportSourceWithLocation;\n}\n```\n\n\n
\n\n\n\n### [Plugin](#-vuedx-analyze-Plugin-2-interface)\n\n\n\n```ts\ninterface Plugin {\n babel?: AbstractScriptAnalyzerFn | AbstractAnalyzerHandler;\n blocks?: Partial<{\n script: BlockAnalyzer
\n\n\n\n### [PropInfo](#-vuedx-analyze-PropInfo-interface)\n\n\n\n```ts\ninterface PropInfo extends Taggable, Addressable {\n defaultValue: ValueInfo | null;\n description: string;\n name: string;\n required: boolean;\n type: TypeInfo[];\n}\n```\n\n\n
\n\n\n\n### [ScriptSetupInfo](#-vuedx-analyze-ScriptSetupInfo-interface)\n\n\n\n```ts\ninterface ScriptSetupInfo {\n defineEmit?: Addressable;\n defineProps?: Addressable;\n}\n```\n\n\n
\n\n\n\n### [SetupInfo](#-vuedx-analyze-SetupInfo-interface)\n\n\n\n```ts\ninterface SetupInfo extends Addressable {\n context?: {\n identifiers: Partial<{\n attrs: string;\n slots: string;\n emit: string;\n }>;\n rest?: string;\n } & Addressable;\n props?: {\n identifiers: string[];\n rest?: string;\n } & Addressable;\n return?: Addressable;\n}\n```\n\n\n
\n\n\n\n### [SourceRange](#-vuedx-analyze-SourceRange-interface)\n\n\n\n```ts\ninterface SourceRange {\n end: SourceLocation;\n source: string;\n start: SourceLocation;\n}\n```\n\n\n
\n\n\n\n### [SyntaxError](#-vuedx-analyze-SyntaxError-2-interface)\n\n\n\n```ts\ninterface SyntaxError {\n loc: SourceLocation;\n message: string;\n}\n```\n\n\n
\n\n\n\n### [VeturData](#-vuedx-analyze-VeturData-interface)\n\n\n\n```ts\ninterface VeturData {\n attributes: Record
\n\n\n\n### [WebTypes](#-vuedx-analyze-WebTypes-interface)\n\n\n\n```ts\ninterface WebTypes {\n contributions: {\n 'types-syntax': 'typescript';\n 'description-markup': 'html' | 'markdown' | 'none';\n tags: Tag[];\n attributes: Attribute[];\n };\n framework: 'vue';\n name: string;\n version: string;\n}\n```\n\n\n
\n\n","readmeFilename":"readme.md","_id":"@vuedx/analyze@0.4.2-insiders-1609385764.0","_nodeVersion":"14.14.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-3YKMyQhXgi1gjlEDEv6RB7OIlLM0QThEvPpSGweFVvl2MYDWq9OyRUPqT63uV2iSphTfqJRoDeqmmn0cXNIpSQ==","shasum":"a9f85a7a4f4803ad028aca7adf78a2c9d61771ae","tarball":"https://registry.npmjs.org/@vuedx/analyze/-/analyze-0.4.2-insiders-1609385764.0.tgz","fileCount":9,"unpackedSize":479813,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJf7UdACRA9TVsSAnZWagAAUfEP/2WH/M7zpTsd/54Ws2Mr\niDS5MmpIsZtij672BsH9a3J5VcszrRL1PgxL34rzvvz7C4DGPjaaN8MBc9zc\ngfiqj6myfSeat2+8G9Sa5gqcWSHApKqkomNKbYNDYTjdtbEKvw7/9VUuErRY\nUMvnAUK9Rvkx0aq3jAKbZg573M8Ywbxq5zHAxKneETcoNY52efTnQJD1JMWn\nxPGdK0YpOBIS83aOJ09v13ETImEmDWU2g8AYSwpkxyshgIFVuauG+b471VVd\nvGzYFIAhaJjt/tqmkXTU+ifqtZrhjtaHgi3XgbZYIDS7pE1NsRhITiPfeJQz\nvTgbN9qxIfjvj6OZqURluGll6GLBNXP5FnAePFR3HkACh+Q6mAO9D/rP/a+4\n8XN22o+euZKGFaJiUC0FbBxGZjzPJt9YQ4XcMzV7/JsP/kkjY+xHRf8Y9frb\nCVYg7m8GEhcB2DNhvygSGZXkTSZolCZonGQdat3EEqi7y2H2DPMVbwN/r931\n46QSV4xKAoDLJ//wZbuO4Grty7DCef85TIr2cI35ka01fv/YH/IkKB69ULGS\notmQhUE7RgzbroE5DL1aJKoHkUSmgNKEhvyhtG4594pM1cSNR+fm9xF23nje\nXwqB54awhlL29zl5nQm67ieAgiuEE7TwVxYbGl4TeycAKPMy5p8v3thDUzr7\nhSFr\r\n=nFs7\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDPJWcnEI8m/u4ZAOtfvPP4Knjox30//kCycJYjo2quHQIhAL339LGyB4NENcvKTAp+wEUx7gp82CqRLpSD1mUSsJlB"}]},"_npmUser":{"name":"znck","email":"rahulkdn@gmail.com"},"directories":{},"maintainers":[{"name":"znck","email":"rahulkdn@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/analyze_0.4.2-insiders-1609385764.0_1609385791593_0.7768928493618266"},"_hasShrinkwrap":false},"0.4.2-insiders-1609436485.0":{"name":"@vuedx/analyze","version":"0.4.2-insiders-1609436485.0","description":"Extracts public API information from Vue component.","main":"dist/index.cjs.js","module":"dist/index.esm.js","types":"dist/index.d.ts","bin":{"vuedx-analyze":"bin/analyze.js"},"keywords":["vue","sfc","sfc api extractor","static analyzer","sfc analyzer","sfc static analyzer","docgen","documentation"],"repository":{"type":"git","url":"git+https://github.com/znck/vue-developer-experience.git"},"author":{"name":"Rahul Kadyan","email":"rahulkdn@gmail.com","url":"https://znck.me/"},"funding":{"type":"individual","url":"https://github.com/sponsors/znck"},"license":"MIT","bugs":{"url":"https://github.com/znck/vue-developer-experience/issues"},"homepage":"https://github.com/znck/vue-developer-experience#readme","dependencies":{"@babel/code-frame":"^7.10.4","@babel/generator":"^7.12.1","@babel/parser":"^7.12.3","@babel/template":"^7.12.7","@babel/traverse":"7.12.1","@babel/types":"7.12.1","@types/micromatch":"^4.0.1","@vuedx/compiler-sfc":"0.4.2-insiders-1609436485.0","@vuedx/compiler-tsx":"0.4.2-insiders-1609436485.0","@vuedx/projectconfig":"0.4.2-insiders-1609436485.0","@vuedx/template-ast-types":"0.4.2-insiders-1609436485.0","cli-highlight":"^2.1.4","commander":"^6.1.0","fast-glob":"^3.2.4","hash-sum":"^2.0.0","micromatch":"^4.0.2"},"devDependencies":{"@types/babel__traverse":"^7.0.15","@types/node":"^14.14.14","@vuedx/shared":"0.4.2-insiders-1609436485.0","typescript":"^4.0.3"},"readme":"
\n \n
\n\n## Support\n\nThis package is part of [VueDX project](https://github.com/znck/vue-developer-experience), maintained by [Rahul Kadyan](https://github.com/znck). You can [💖 sponsor him](https://github.com/sponsors/znck) for continued development of this package and other VueDX tools.\n\n## Usage\n\n\n\n\n## API\n\n\n\n\n### [ConfiguredVueProject](#-vuedx-analyze-ConfiguredVueProject-class)\n\n\n\n\n Analyze
\nA tool to statically analyze Vue single file components.
\nMore info
\n\n**Signature:**\n```ts\ndeclare class ConfiguredVueProject extends VueProject {\n constructor(rootDir: string, packageFile: string | undefined, packageJSON: Partial\n\n\n\n#### [setFileNames](#-vuedx-analyze-ConfiguredVueProject-setFileNames-member-1-)\n\n\n\n**Signature:**\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n\n### [InferredVueProject](#-vuedx-analyze-InferredVueProject-class)\n\n\n\n
More info
\n\n**Signature:**\n```ts\ndeclare class InferredVueProject extends VueProject {\n kind: \"inferred\";\n protected refresh(): void;\n}\n```\n\n**Members:**\n\n\n\n\n#### [refresh](#-vuedx-analyze-InferredVueProject-refresh-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected refresh(): void;\n```\n\n\n\n
\n\n\n\n\n### [VueProject](#-vuedx-analyze-VueProject-class)\n\n\n\n
More info
\n\n**Signature:**\n```ts\ndeclare abstract class VueProject {\n protected _config: Readonly\n\n\n\n#### [markDirty](#-vuedx-analyze-VueProject-markDirty-member-1-)\n\n\n\n**Signature:**\n```ts\nmarkDirty(): void;\n```\n\n\n
\n\n\n\n#### [refresh](#-vuedx-analyze-VueProject-refresh-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected abstract refresh(): void;\n```\n\n\n
\n\n\n\n#### [reloadIfNeeded](#-vuedx-analyze-VueProject-reloadIfNeeded-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected reloadIfNeeded(): void;\n```\n\n\n
\n\n\n\n#### [setConfig](#-vuedx-analyze-VueProject-setConfig-member-1-)\n\n\n\n**Signature:**\n```ts\nsetConfig(config: ProjectConfig): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| config |
ProjectConfig | - |\n\n\n\n\n\n#### [setFileNames](#-vuedx-analyze-VueProject-setFileNames-member-1-)\n\n\n\n**Signature:**\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n\n### [createAnalyzer](#-vuedx-analyze-createAnalyzer-function-1-)\n\n\n\n
\n): Analyzer;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| plugins |
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createAnalyzer(plugins: Plugin[], options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createFullAnalyzer](#-vuedx-analyze-createFullAnalyzer-function-1-)\n\n\n\n
\n): ReturnType;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| plugins |
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createFullAnalyzer(plugins?: Plugin[], options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createSourceRange](#-vuedx-analyze-createSourceRange-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createSourceRange(context: Context | ScriptAnalyzerContext, node: Node): SourceRange;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| context |Context | ScriptAnalyzerContext | - |\n| node | Node | - |\n\n\n\n\n\n### [toVeturData](#-vuedx-analyze-toVeturData-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function toVeturData(components: ComponentInfo[]): VeturData;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| components |ComponentInfo[] | - |\n\n\n\n\n\n### [toWebTypes](#-vuedx-analyze-toWebTypes-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function toWebTypes(name: string, version: string, components: ComponentInfo[]): WebTypes;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| name |string | - |\n| version | string | - |\n| components | ComponentInfo[] | - |\n\n\n\n\n\n### [transformToFunction](#-vuedx-analyze-transformToFunction-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function transformToFunction(content: string, options?: FunctionTransformOptions): string;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| content |string | - |\n| options | FunctionTransformOptions | - |\n\n\n\n## Types\n\n\n\n\n### [Analyzer](#-vuedx-analyze-Analyzer-interface)\n\n\n\n```ts\ninterface Analyzer {\n analyze(content: string, fileName?: string): ComponentInfo;\n analyzeScript(content: string, fileName?: string, mode?: 'script' | 'scriptSetup'): ComponentInfo;\n analyzeTemplate(content: string, fileName?: string): ComponentInfo;\n}\n```\n\n\n
\n\n\n\n### [ComponentInfo](#-vuedx-analyze-ComponentInfo-interface)\n\n\n\n```ts\ninterface ComponentInfo extends Taggable {\n aliases: string[];\n components: LocalComponentRegistrationInfo[];\n description: string;\n emits: EmitInfo[];\n errors: SyntaxError[];\n fileName: string;\n fnSetupOption?: SetupInfo;\n identifierSource: Record
\n\n\n\n### [ComponentRegistrationInfo](#-vuedx-analyze-ComponentRegistrationInfo-interface)\n\n\n\n```ts\ninterface ComponentRegistrationInfo {\n aliases: string[];\n name: string;\n source: ImportSource;\n}\n```\n\n\n
\n\n\n\n### [EmitInfo](#-vuedx-analyze-EmitInfo-interface)\n\n\n\n```ts\ninterface EmitInfo extends Taggable, Addressable {\n description: string;\n isDynamic: boolean;\n isInferred: boolean;\n name: string;\n references: SourceRange[];\n type: TypeInfo[];\n}\n```\n\n\n
\n\n\n\n### [IdentifierSource](#-vuedx-analyze-IdentifierSource-interface)\n\n\n\n```ts\ninterface IdentifierSource extends Addressable {\n name: string;\n}\n```\n\n\n
\n\n\n\n### [ImportSource](#-vuedx-analyze-ImportSource-interface)\n\n\n\n```ts\ninterface ImportSource {\n exportName?: string;\n localName: string;\n moduleName: string;\n}\n```\n\n\n
\n\n\n\n### [ImportSourceWithLocation](#-vuedx-analyze-ImportSourceWithLocation-interface)\n\n\n\n```ts\ninterface ImportSourceWithLocation extends ImportSource, Addressable {\n}\n```\n\n\n
\n\n\n\n### [LocalComponentRegistrationInfo](#-vuedx-analyze-LocalComponentRegistrationInfo-interface)\n\n\n\n```ts\ninterface LocalComponentRegistrationInfo extends ComponentRegistrationInfo, Addressable {\n kind: 'script' | 'scriptSetup';\n source: ImportSourceWithLocation;\n}\n```\n\n\n
\n\n\n\n### [Plugin](#-vuedx-analyze-Plugin-2-interface)\n\n\n\n```ts\ninterface Plugin {\n babel?: AbstractScriptAnalyzerFn | AbstractAnalyzerHandler;\n blocks?: Partial<{\n script: BlockAnalyzer
\n\n\n\n### [PropInfo](#-vuedx-analyze-PropInfo-interface)\n\n\n\n```ts\ninterface PropInfo extends Taggable, Addressable {\n defaultValue: ValueInfo | null;\n description: string;\n name: string;\n required: boolean;\n type: TypeInfo[];\n}\n```\n\n\n
\n\n\n\n### [ScriptSetupInfo](#-vuedx-analyze-ScriptSetupInfo-interface)\n\n\n\n```ts\ninterface ScriptSetupInfo {\n defineEmit?: Addressable;\n defineProps?: Addressable;\n}\n```\n\n\n
\n\n\n\n### [SetupInfo](#-vuedx-analyze-SetupInfo-interface)\n\n\n\n```ts\ninterface SetupInfo extends Addressable {\n context?: {\n identifiers: Partial<{\n attrs: string;\n slots: string;\n emit: string;\n }>;\n rest?: string;\n } & Addressable;\n props?: {\n identifiers: string[];\n rest?: string;\n } & Addressable;\n return?: Addressable;\n}\n```\n\n\n
\n\n\n\n### [SourceRange](#-vuedx-analyze-SourceRange-interface)\n\n\n\n```ts\ninterface SourceRange {\n end: SourceLocation;\n source: string;\n start: SourceLocation;\n}\n```\n\n\n
\n\n\n\n### [SyntaxError](#-vuedx-analyze-SyntaxError-2-interface)\n\n\n\n```ts\ninterface SyntaxError {\n loc: SourceLocation;\n message: string;\n}\n```\n\n\n
\n\n\n\n### [VeturData](#-vuedx-analyze-VeturData-interface)\n\n\n\n```ts\ninterface VeturData {\n attributes: Record
\n\n\n\n### [WebTypes](#-vuedx-analyze-WebTypes-interface)\n\n\n\n```ts\ninterface WebTypes {\n contributions: {\n 'types-syntax': 'typescript';\n 'description-markup': 'html' | 'markdown' | 'none';\n tags: Tag[];\n attributes: Attribute[];\n };\n framework: 'vue';\n name: string;\n version: string;\n}\n```\n\n\n
\n\n","readmeFilename":"readme.md","_id":"@vuedx/analyze@0.4.2-insiders-1609436485.0","_nodeVersion":"14.14.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-NPxi30ZCy47ZgGl/TthtCIDqd4kY/BYmNMzjaV+AGzvYWaPNUwzL4xp9051d5QNLCpCdN9Ld8r2812Jl6oG5Mg==","shasum":"b8c96eb890d3b6d9dc11cbbb837b2b41a4059b93","tarball":"https://registry.npmjs.org/@vuedx/analyze/-/analyze-0.4.2-insiders-1609436485.0.tgz","fileCount":9,"unpackedSize":479813,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJf7g1fCRA9TVsSAnZWagAAZ1EQAI3Gpc7SyDHhBFlUxB1F\n/e4QI0TBceLSasonPfzROaWI0as8D125ULbjebpw+TVyHHmrgixH+Gsvedn0\nCa9cGVXK7tnt7X/iy9xrSrCkLmWO8esB3Bu9MPI0+J5cjjfiQUpLwjdNl7LC\nT6uITuoMi5uE6A0c64zfuvLPN5ZXgMFyyxn9f+d44VZuS7JHGb74Kc/GBELJ\nRHWKogztAZXl2R01vGsBUzxbekXZ0buxGeY3WoMD1sgMWlg/CAT4Zax0wKGL\nVIcw30fArajms9cUKPW6ip1WfwycrnvaZwUBlYoFoOJdnx32F1a/ecoI1h+H\nmSRaVU04eDOb0vpnP4x4WAiElTliUrJGtrqFcdqYHD7MoLbqDPkxUPQTy7fp\nl2uAfEwbx2ufjM9ELG/ge4UTmKfuJ3X4zvYayiFZ/ijbCNThhPutwh/IlukL\nvAjL9EsvHbdmUPo2DJOXghkpQ+Mo580jjr0UbhbTPr6lT3qX7WVnC20Gg6ix\no1T00JUjhp37jS8NL8KMhNnIhJtso6hvR4w73ic6jhID+TDIezBs+XWV/CCg\n8Q2WUQHvbqI0XycMm3drQh5oQl59I0HkKlL7T3uENhYiyda0nOOnAdnYwSQc\n24AaCob0IlXgme9Ny90c3qVOQVSlUOe2KQH3HwbGhecIr0mVH6jki2swjqCP\nL+ff\r\n=b1Gz\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIEwBjWlXQXbO4iSEB7RL93DQemOULWoFfpVCwZ6rUKIeAiEAlApfHHtRSOiZM0dLsJwg4TyMzpS81C2Jupoe4qxhU38="}]},"_npmUser":{"name":"znck","email":"rahulkdn@gmail.com"},"directories":{},"maintainers":[{"name":"znck","email":"rahulkdn@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/analyze_0.4.2-insiders-1609436485.0_1609436511220_0.6816635844643366"},"_hasShrinkwrap":false},"0.4.2-insiders-1609479032.0":{"name":"@vuedx/analyze","version":"0.4.2-insiders-1609479032.0","description":"Extracts public API information from Vue component.","main":"dist/index.cjs.js","module":"dist/index.esm.js","types":"dist/index.d.ts","bin":{"vuedx-analyze":"bin/analyze.js"},"keywords":["vue","sfc","sfc api extractor","static analyzer","sfc analyzer","sfc static analyzer","docgen","documentation"],"repository":{"type":"git","url":"git+https://github.com/znck/vue-developer-experience.git"},"author":{"name":"Rahul Kadyan","email":"rahulkdn@gmail.com","url":"https://znck.me/"},"funding":{"type":"individual","url":"https://github.com/sponsors/znck"},"license":"MIT","bugs":{"url":"https://github.com/znck/vue-developer-experience/issues"},"homepage":"https://github.com/znck/vue-developer-experience#readme","dependencies":{"@babel/code-frame":"^7.10.4","@babel/generator":"^7.12.1","@babel/parser":"^7.12.3","@babel/template":"^7.12.7","@babel/traverse":"7.12.1","@babel/types":"7.12.1","@types/micromatch":"^4.0.1","@vuedx/compiler-sfc":"0.4.2-insiders-1609479032.0","@vuedx/compiler-tsx":"0.4.2-insiders-1609479032.0","@vuedx/projectconfig":"0.4.2-insiders-1609479032.0","@vuedx/template-ast-types":"0.4.2-insiders-1609479032.0","cli-highlight":"^2.1.4","commander":"^6.1.0","fast-glob":"^3.2.4","hash-sum":"^2.0.0","micromatch":"^4.0.2"},"devDependencies":{"@types/babel__traverse":"^7.0.15","@types/node":"^14.14.14","@vuedx/shared":"0.4.2-insiders-1609479032.0","typescript":"^4.0.3"},"readme":"
\n \n
\n\n## Support\n\nThis package is part of [VueDX project](https://github.com/znck/vue-developer-experience), maintained by [Rahul Kadyan](https://github.com/znck). You can [💖 sponsor him](https://github.com/sponsors/znck) for continued development of this package and other VueDX tools.\n\n## Usage\n\n\n\n\n## API\n\n\n\n\n### [ConfiguredVueProject](#-vuedx-analyze-ConfiguredVueProject-class)\n\n\n\n\n Analyze
\nA tool to statically analyze Vue single file components.
\nMore info
\n\n**Signature:**\n```ts\ndeclare class ConfiguredVueProject extends VueProject {\n constructor(rootDir: string, packageFile: string | undefined, packageJSON: Partial\n\n\n\n#### [setFileNames](#-vuedx-analyze-ConfiguredVueProject-setFileNames-member-1-)\n\n\n\n**Signature:**\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n\n### [InferredVueProject](#-vuedx-analyze-InferredVueProject-class)\n\n\n\n
More info
\n\n**Signature:**\n```ts\ndeclare class InferredVueProject extends VueProject {\n kind: \"inferred\";\n protected refresh(): void;\n}\n```\n\n**Members:**\n\n\n\n\n#### [refresh](#-vuedx-analyze-InferredVueProject-refresh-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected refresh(): void;\n```\n\n\n\n
\n\n\n\n\n### [VueProject](#-vuedx-analyze-VueProject-class)\n\n\n\n
More info
\n\n**Signature:**\n```ts\ndeclare abstract class VueProject {\n protected _config: Readonly\n\n\n\n#### [markDirty](#-vuedx-analyze-VueProject-markDirty-member-1-)\n\n\n\n**Signature:**\n```ts\nmarkDirty(): void;\n```\n\n\n
\n\n\n\n#### [refresh](#-vuedx-analyze-VueProject-refresh-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected abstract refresh(): void;\n```\n\n\n
\n\n\n\n#### [reloadIfNeeded](#-vuedx-analyze-VueProject-reloadIfNeeded-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected reloadIfNeeded(): void;\n```\n\n\n
\n\n\n\n#### [setConfig](#-vuedx-analyze-VueProject-setConfig-member-1-)\n\n\n\n**Signature:**\n```ts\nsetConfig(config: ProjectConfig): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| config |
ProjectConfig | - |\n\n\n\n\n\n#### [setFileNames](#-vuedx-analyze-VueProject-setFileNames-member-1-)\n\n\n\n**Signature:**\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n\n### [createAnalyzer](#-vuedx-analyze-createAnalyzer-function-1-)\n\n\n\n
\n): Analyzer;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| plugins |
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createAnalyzer(plugins: Plugin[], options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createFullAnalyzer](#-vuedx-analyze-createFullAnalyzer-function-1-)\n\n\n\n
\n): ReturnType;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| plugins |
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createFullAnalyzer(plugins?: Plugin[], options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createSourceRange](#-vuedx-analyze-createSourceRange-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createSourceRange(context: Context | ScriptAnalyzerContext, node: Node): SourceRange;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| context |Context | ScriptAnalyzerContext | - |\n| node | Node | - |\n\n\n\n\n\n### [toVeturData](#-vuedx-analyze-toVeturData-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function toVeturData(components: ComponentInfo[]): VeturData;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| components |ComponentInfo[] | - |\n\n\n\n\n\n### [toWebTypes](#-vuedx-analyze-toWebTypes-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function toWebTypes(name: string, version: string, components: ComponentInfo[]): WebTypes;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| name |string | - |\n| version | string | - |\n| components | ComponentInfo[] | - |\n\n\n\n\n\n### [transformToFunction](#-vuedx-analyze-transformToFunction-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function transformToFunction(content: string, options?: FunctionTransformOptions): string;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| content |string | - |\n| options | FunctionTransformOptions | - |\n\n\n\n## Types\n\n\n\n\n### [Analyzer](#-vuedx-analyze-Analyzer-interface)\n\n\n\n```ts\ninterface Analyzer {\n analyze(content: string, fileName?: string): ComponentInfo;\n analyzeScript(content: string, fileName?: string, mode?: 'script' | 'scriptSetup'): ComponentInfo;\n analyzeTemplate(content: string, fileName?: string): ComponentInfo;\n}\n```\n\n\n
\n\n\n\n### [ComponentInfo](#-vuedx-analyze-ComponentInfo-interface)\n\n\n\n```ts\ninterface ComponentInfo extends Taggable {\n aliases: string[];\n components: LocalComponentRegistrationInfo[];\n description: string;\n emits: EmitInfo[];\n errors: SyntaxError[];\n fileName: string;\n fnSetupOption?: SetupInfo;\n identifierSource: Record
\n\n\n\n### [ComponentRegistrationInfo](#-vuedx-analyze-ComponentRegistrationInfo-interface)\n\n\n\n```ts\ninterface ComponentRegistrationInfo {\n aliases: string[];\n name: string;\n source: ImportSource;\n}\n```\n\n\n
\n\n\n\n### [EmitInfo](#-vuedx-analyze-EmitInfo-interface)\n\n\n\n```ts\ninterface EmitInfo extends Taggable, Addressable {\n description: string;\n isDynamic: boolean;\n isInferred: boolean;\n name: string;\n references: SourceRange[];\n type: TypeInfo[];\n}\n```\n\n\n
\n\n\n\n### [IdentifierSource](#-vuedx-analyze-IdentifierSource-interface)\n\n\n\n```ts\ninterface IdentifierSource extends Addressable {\n name: string;\n}\n```\n\n\n
\n\n\n\n### [ImportSource](#-vuedx-analyze-ImportSource-interface)\n\n\n\n```ts\ninterface ImportSource {\n exportName?: string;\n localName: string;\n moduleName: string;\n}\n```\n\n\n
\n\n\n\n### [ImportSourceWithLocation](#-vuedx-analyze-ImportSourceWithLocation-interface)\n\n\n\n```ts\ninterface ImportSourceWithLocation extends ImportSource, Addressable {\n}\n```\n\n\n
\n\n\n\n### [LocalComponentRegistrationInfo](#-vuedx-analyze-LocalComponentRegistrationInfo-interface)\n\n\n\n```ts\ninterface LocalComponentRegistrationInfo extends ComponentRegistrationInfo, Addressable {\n kind: 'script' | 'scriptSetup';\n source: ImportSourceWithLocation;\n}\n```\n\n\n
\n\n\n\n### [Plugin](#-vuedx-analyze-Plugin-2-interface)\n\n\n\n```ts\ninterface Plugin {\n babel?: AbstractScriptAnalyzerFn | AbstractAnalyzerHandler;\n blocks?: Partial<{\n script: BlockAnalyzer
\n\n\n\n### [PropInfo](#-vuedx-analyze-PropInfo-interface)\n\n\n\n```ts\ninterface PropInfo extends Taggable, Addressable {\n defaultValue: ValueInfo | null;\n description: string;\n name: string;\n required: boolean;\n type: TypeInfo[];\n}\n```\n\n\n
\n\n\n\n### [ScriptSetupInfo](#-vuedx-analyze-ScriptSetupInfo-interface)\n\n\n\n```ts\ninterface ScriptSetupInfo {\n defineEmit?: Addressable;\n defineProps?: Addressable;\n}\n```\n\n\n
\n\n\n\n### [SetupInfo](#-vuedx-analyze-SetupInfo-interface)\n\n\n\n```ts\ninterface SetupInfo extends Addressable {\n context?: {\n identifiers: Partial<{\n attrs: string;\n slots: string;\n emit: string;\n }>;\n rest?: string;\n } & Addressable;\n props?: {\n identifiers: string[];\n rest?: string;\n } & Addressable;\n return?: Addressable;\n}\n```\n\n\n
\n\n\n\n### [SourceRange](#-vuedx-analyze-SourceRange-interface)\n\n\n\n```ts\ninterface SourceRange {\n end: SourceLocation;\n source: string;\n start: SourceLocation;\n}\n```\n\n\n
\n\n\n\n### [SyntaxError](#-vuedx-analyze-SyntaxError-2-interface)\n\n\n\n```ts\ninterface SyntaxError {\n loc: SourceLocation;\n message: string;\n}\n```\n\n\n
\n\n\n\n### [VeturData](#-vuedx-analyze-VeturData-interface)\n\n\n\n```ts\ninterface VeturData {\n attributes: Record
\n\n\n\n### [WebTypes](#-vuedx-analyze-WebTypes-interface)\n\n\n\n```ts\ninterface WebTypes {\n contributions: {\n 'types-syntax': 'typescript';\n 'description-markup': 'html' | 'markdown' | 'none';\n tags: Tag[];\n attributes: Attribute[];\n };\n framework: 'vue';\n name: string;\n version: string;\n}\n```\n\n\n
\n\n","readmeFilename":"readme.md","_id":"@vuedx/analyze@0.4.2-insiders-1609479032.0","_nodeVersion":"14.14.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-HM3ZxJale7EWEaepfOrnv33khng5S7uvpNyKV5I8YwQDZBzeBIU4FsfyS3xeU4snj+GQ5mKBDhxtTIFDMyTqdQ==","shasum":"c142ad0e85b28b63a3f6c9a5f5cbfbcb692c109c","tarball":"https://registry.npmjs.org/@vuedx/analyze/-/analyze-0.4.2-insiders-1609479032.0.tgz","fileCount":9,"unpackedSize":479813,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJf7rORCRA9TVsSAnZWagAAjcIQAKMj0HtNJP3UIfDzshYL\nrIpOAP5PFv7dmSZurrh5pLN5sOQclGCj4BqQGgbBi/oxcyLKxLzek3VZ8n4Q\nH0qtAF1m3Ss6mJn00n0FCdMsJXX+KL9s9ZtXEcerzujAqCaGcLk4rqDZ3h52\ndKVy9IDYQ4gp+A0SLm1sSdmR4KAzBy6MzbSPztDCLEM41iNvFE3EGuEy3E6F\nYm3uwlBJEbYgvuU1yrD4D7oXBSJo242glAIR53EkfcEkz6Sr2nQcO2MrfB89\nFFitBhyING5BLsyjaVod8JdbBMNFxkFUn+i/EZdjApgvpfxr7LLt53IEbNh9\nnGeITM9ffKt/F5WHJ1rJZxUu/BWeFZC7pITrhUbxrLI35AsZQT/7qUyKwEGx\n8d4t2iOj+3KTSJ0k+yTmuyT/hln8ucVVLGCV+dVuFAdNtlYKhZKDNrzHNjeO\nlDfjULxsT0wniuxtDES1cc+oQYiu+Ib3ZdX8sQUDyBdKgsmLvr6Ezdr6+EEt\nuvLkggC4Z0g9m0zj9/899LmzPXhGYHWWNSYnxbx8xc2/ucCIuuLLK9Bcy05I\nB4tA0/o2VZ3C4PDgIW2bhIhjM/FXAJoyRb54rKXOE2fL83aDJ1rO0LnItl9d\nKtbJspdFIyVoshY9lGwjfwIx4jjbxX/MfYBpbbE70wHKHFEfMTPUEhw05xO0\nBzcA\r\n=hh4A\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIAo370qr/jxepZsqRJD3+v9TDlYzM+pBGAs5pA9Tj3ScAiEA+Lxm0RhiYr4ns/WpfwTl8YDhpsVVnR53Srz8w1Nlyiw="}]},"_npmUser":{"name":"znck","email":"rahulkdn@gmail.com"},"directories":{},"maintainers":[{"name":"znck","email":"rahulkdn@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/analyze_0.4.2-insiders-1609479032.0_1609479057237_0.6504294169090761"},"_hasShrinkwrap":false},"0.4.2-insiders-1609960000.0":{"name":"@vuedx/analyze","version":"0.4.2-insiders-1609960000.0","description":"Extracts public API information from Vue component.","main":"dist/index.cjs.js","module":"dist/index.esm.js","types":"dist/index.d.ts","bin":{"vuedx-analyze":"bin/analyze.js"},"keywords":["vue","sfc","sfc api extractor","static analyzer","sfc analyzer","sfc static analyzer","docgen","documentation"],"repository":{"type":"git","url":"git+https://github.com/znck/vue-developer-experience.git"},"author":{"name":"Rahul Kadyan","email":"rahulkdn@gmail.com","url":"https://znck.me/"},"funding":{"type":"individual","url":"https://github.com/sponsors/znck"},"license":"MIT","bugs":{"url":"https://github.com/znck/vue-developer-experience/issues"},"homepage":"https://github.com/znck/vue-developer-experience#readme","dependencies":{"@babel/code-frame":"^7.10.4","@babel/generator":"^7.12.1","@babel/parser":"^7.12.3","@babel/template":"^7.12.7","@babel/traverse":"7.12.1","@babel/types":"7.12.1","@types/micromatch":"^4.0.1","@vuedx/compiler-sfc":"0.4.2-insiders-1609960000.0","@vuedx/compiler-tsx":"0.4.2-insiders-1609960000.0","@vuedx/projectconfig":"0.4.2-insiders-1609960000.0","@vuedx/template-ast-types":"0.4.2-insiders-1609960000.0","cli-highlight":"^2.1.4","commander":"^6.1.0","fast-glob":"^3.2.4","hash-sum":"^2.0.0","micromatch":"^4.0.2"},"devDependencies":{"@types/babel__traverse":"^7.0.15","@types/node":"^14.14.14","@vuedx/shared":"0.4.2-insiders-1609960000.0","typescript":"^4.0.3"},"readme":"
\n \n
\n\n## Support\n\nThis package is part of [VueDX project](https://github.com/znck/vue-developer-experience), maintained by [Rahul Kadyan](https://github.com/znck). You can [💖 sponsor him](https://github.com/sponsors/znck) for continued development of this package and other VueDX tools.\n\n## Usage\n\n\n\n\n## API\n\n\n\n\n### [ConfiguredVueProject](#-vuedx-analyze-ConfiguredVueProject-class)\n\n\n\n\n Analyze
\nA tool to statically analyze Vue single file components.
\nMore info
\n\n**Signature:**\n```ts\ndeclare class ConfiguredVueProject extends VueProject {\n constructor(rootDir: string, packageFile: string | undefined, packageJSON: Partial\n\n\n\n#### [setFileNames](#-vuedx-analyze-ConfiguredVueProject-setFileNames-member-1-)\n\n\n\n**Signature:**\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n\n### [InferredVueProject](#-vuedx-analyze-InferredVueProject-class)\n\n\n\n
More info
\n\n**Signature:**\n```ts\ndeclare class InferredVueProject extends VueProject {\n kind: \"inferred\";\n protected refresh(): void;\n}\n```\n\n**Members:**\n\n\n\n\n#### [refresh](#-vuedx-analyze-InferredVueProject-refresh-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected refresh(): void;\n```\n\n\n\n
\n\n\n\n\n### [VueProject](#-vuedx-analyze-VueProject-class)\n\n\n\n
More info
\n\n**Signature:**\n```ts\ndeclare abstract class VueProject {\n protected _config: Readonly\n\n\n\n#### [markDirty](#-vuedx-analyze-VueProject-markDirty-member-1-)\n\n\n\n**Signature:**\n```ts\nmarkDirty(): void;\n```\n\n\n
\n\n\n\n#### [refresh](#-vuedx-analyze-VueProject-refresh-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected abstract refresh(): void;\n```\n\n\n
\n\n\n\n#### [reloadIfNeeded](#-vuedx-analyze-VueProject-reloadIfNeeded-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected reloadIfNeeded(): void;\n```\n\n\n
\n\n\n\n#### [setConfig](#-vuedx-analyze-VueProject-setConfig-member-1-)\n\n\n\n**Signature:**\n```ts\nsetConfig(config: ProjectConfig): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| config |
ProjectConfig | - |\n\n\n\n\n\n#### [setFileNames](#-vuedx-analyze-VueProject-setFileNames-member-1-)\n\n\n\n**Signature:**\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n\n### [createAnalyzer](#-vuedx-analyze-createAnalyzer-function-1-)\n\n\n\n
\n): Analyzer;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| plugins |
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createAnalyzer(plugins: Plugin[], options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createFullAnalyzer](#-vuedx-analyze-createFullAnalyzer-function-1-)\n\n\n\n
\n): ReturnType;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| plugins |
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createFullAnalyzer(plugins?: Plugin[], options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createSourceRange](#-vuedx-analyze-createSourceRange-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createSourceRange(context: Context | ScriptAnalyzerContext, node: Node): SourceRange;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| context |Context | ScriptAnalyzerContext | - |\n| node | Node | - |\n\n\n\n\n\n### [toVeturData](#-vuedx-analyze-toVeturData-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function toVeturData(components: ComponentInfo[]): VeturData;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| components |ComponentInfo[] | - |\n\n\n\n\n\n### [toWebTypes](#-vuedx-analyze-toWebTypes-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function toWebTypes(name: string, version: string, components: ComponentInfo[]): WebTypes;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| name |string | - |\n| version | string | - |\n| components | ComponentInfo[] | - |\n\n\n\n\n\n### [transformToFunction](#-vuedx-analyze-transformToFunction-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function transformToFunction(content: string, options?: FunctionTransformOptions): string;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| content |string | - |\n| options | FunctionTransformOptions | - |\n\n\n\n## Types\n\n\n\n\n### [Analyzer](#-vuedx-analyze-Analyzer-interface)\n\n\n\n```ts\ninterface Analyzer {\n analyze(content: string, fileName?: string): ComponentInfo;\n analyzeScript(content: string, fileName?: string, mode?: 'script' | 'scriptSetup'): ComponentInfo;\n analyzeTemplate(content: string, fileName?: string): ComponentInfo;\n}\n```\n\n\n
\n\n\n\n### [ComponentInfo](#-vuedx-analyze-ComponentInfo-interface)\n\n\n\n```ts\ninterface ComponentInfo extends Taggable {\n aliases: string[];\n components: LocalComponentRegistrationInfo[];\n description: string;\n emits: EmitInfo[];\n errors: SyntaxError[];\n fileName: string;\n fnSetupOption?: SetupInfo;\n identifierSource: Record
\n\n\n\n### [ComponentRegistrationInfo](#-vuedx-analyze-ComponentRegistrationInfo-interface)\n\n\n\n```ts\ninterface ComponentRegistrationInfo {\n aliases: string[];\n name: string;\n source: ImportSource;\n}\n```\n\n\n
\n\n\n\n### [EmitInfo](#-vuedx-analyze-EmitInfo-interface)\n\n\n\n```ts\ninterface EmitInfo extends Taggable, Addressable {\n description: string;\n isDynamic: boolean;\n isInferred: boolean;\n name: string;\n references: SourceRange[];\n type: TypeInfo[];\n}\n```\n\n\n
\n\n\n\n### [IdentifierSource](#-vuedx-analyze-IdentifierSource-interface)\n\n\n\n```ts\ninterface IdentifierSource extends Addressable {\n name: string;\n}\n```\n\n\n
\n\n\n\n### [ImportSource](#-vuedx-analyze-ImportSource-interface)\n\n\n\n```ts\ninterface ImportSource {\n exportName?: string;\n localName: string;\n moduleName: string;\n}\n```\n\n\n
\n\n\n\n### [ImportSourceWithLocation](#-vuedx-analyze-ImportSourceWithLocation-interface)\n\n\n\n```ts\ninterface ImportSourceWithLocation extends ImportSource, Addressable {\n}\n```\n\n\n
\n\n\n\n### [LocalComponentRegistrationInfo](#-vuedx-analyze-LocalComponentRegistrationInfo-interface)\n\n\n\n```ts\ninterface LocalComponentRegistrationInfo extends ComponentRegistrationInfo, Addressable {\n kind: 'script' | 'scriptSetup';\n source: ImportSourceWithLocation;\n}\n```\n\n\n
\n\n\n\n### [Plugin](#-vuedx-analyze-Plugin-2-interface)\n\n\n\n```ts\ninterface Plugin {\n babel?: AbstractScriptAnalyzerFn | AbstractAnalyzerHandler;\n blocks?: Partial<{\n script: BlockAnalyzer
\n\n\n\n### [PropInfo](#-vuedx-analyze-PropInfo-interface)\n\n\n\n```ts\ninterface PropInfo extends Taggable, Addressable {\n defaultValue: ValueInfo | null;\n description: string;\n name: string;\n required: boolean;\n type: TypeInfo[];\n}\n```\n\n\n
\n\n\n\n### [ScriptSetupInfo](#-vuedx-analyze-ScriptSetupInfo-interface)\n\n\n\n```ts\ninterface ScriptSetupInfo {\n defineEmit?: Addressable;\n defineProps?: Addressable;\n}\n```\n\n\n
\n\n\n\n### [SetupInfo](#-vuedx-analyze-SetupInfo-interface)\n\n\n\n```ts\ninterface SetupInfo extends Addressable {\n context?: {\n identifiers: Partial<{\n attrs: string;\n slots: string;\n emit: string;\n }>;\n rest?: string;\n } & Addressable;\n props?: {\n identifiers: string[];\n rest?: string;\n } & Addressable;\n return?: Addressable;\n}\n```\n\n\n
\n\n\n\n### [SourceRange](#-vuedx-analyze-SourceRange-interface)\n\n\n\n```ts\ninterface SourceRange {\n end: SourceLocation;\n source: string;\n start: SourceLocation;\n}\n```\n\n\n
\n\n\n\n### [SyntaxError](#-vuedx-analyze-SyntaxError-2-interface)\n\n\n\n```ts\ninterface SyntaxError {\n loc: SourceLocation;\n message: string;\n}\n```\n\n\n
\n\n\n\n### [VeturData](#-vuedx-analyze-VeturData-interface)\n\n\n\n```ts\ninterface VeturData {\n attributes: Record
\n\n\n\n### [WebTypes](#-vuedx-analyze-WebTypes-interface)\n\n\n\n```ts\ninterface WebTypes {\n contributions: {\n 'types-syntax': 'typescript';\n 'description-markup': 'html' | 'markdown' | 'none';\n tags: Tag[];\n attributes: Attribute[];\n };\n framework: 'vue';\n name: string;\n version: string;\n}\n```\n\n\n
\n\n","readmeFilename":"readme.md","_id":"@vuedx/analyze@0.4.2-insiders-1609960000.0","_nodeVersion":"14.14.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-RmFFZqQxjd3kGwyp/UMgHSglLa9sXhCZlIzFDCKPbBYNOgU1GIlm+gHCbA+Ld7h4Am3OyRk8R1wiAn6D3HeauA==","shasum":"a1adbba8996796cac6c8d799db5149057bce2be8","tarball":"https://registry.npmjs.org/@vuedx/analyze/-/analyze-0.4.2-insiders-1609960000.0.tgz","fileCount":9,"unpackedSize":479813,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJf9gpbCRA9TVsSAnZWagAAH+wQAJWbF5c/IqEaEd7skIGd\nTr5L2eveVAYp3B0Cnb86v/y23z+MY5/DCrcS2rCgdXqoSP4Vl8rZGU03TTL8\niAH7wXtdvf1ftopBHCxi12LiEXhp2RNCiUWCSMhZuZr65wiVYYkFfhKKmLDB\nrVphUGf2WLY/1MSDvRsJ4ogU331MOAgeuS06zQlslnfaaby5/vnqmsR5KjID\nsY22O228OYCeXXUqekUkiBAH8EoprS7nImmmf7ZOu12HNFiwwMDizEYoYXx1\ndtUFDSFjeFEKg6i8pj0CenNYGe33VTWZCq9/GXCb644e/+6n2seSzPD2Kel6\nO2kngzHEZa9fC/FKgQeEvClEn754puv1UgLziO4BnBxAgAsn+6KBe1Vxe4O3\nfXd7XzkkBYCqnSpwcsy29mxhiEj3UFHjSaknPHLWGPPUpglLdzNWS10kA+qu\nCd5+6kmKzIDJO+ZpjBb8DQAmH1r/LgVEfuSJGSVRxYyUDcJ835ZxQhbBIWxO\nY1+Rb1I6fArjYKq5BN0Zi9gfRG4E+y8hNDpQLpZv4wfzkvKOZGrxMWCX1676\nmXt2d5U7ASpotAUD+OC+gEz8vue22JP0Vv/+d86KO23XQHsK4ulOS9R4SsST\nxZQjJBgKXxPbnRdGXxUSkRevfN60mVFKYijpbL/swadNG6QC5jXe1sz+DpDJ\n7crd\r\n=1+32\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIDjAwvMfbAb5dck36opVB7GvExPdlE72n3B7TkqleXpNAiEAuFLTqecfTNxqS4GSejqAXnE/55xNc9HSWxDiU2UfjJ0="}]},"_npmUser":{"name":"znck","email":"rahulkdn@gmail.com"},"directories":{},"maintainers":[{"name":"znck","email":"rahulkdn@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/analyze_0.4.2-insiders-1609960000.0_1609960027206_0.11568654258812061"},"_hasShrinkwrap":false},"0.4.2-insiders-1610169628.0":{"name":"@vuedx/analyze","version":"0.4.2-insiders-1610169628.0","description":"Extracts public API information from Vue component.","main":"dist/index.cjs.js","module":"dist/index.esm.js","types":"dist/index.d.ts","bin":{"vuedx-analyze":"bin/analyze.js"},"keywords":["vue","sfc","sfc api extractor","static analyzer","sfc analyzer","sfc static analyzer","docgen","documentation"],"repository":{"type":"git","url":"git+https://github.com/znck/vue-developer-experience.git"},"author":{"name":"Rahul Kadyan","email":"rahulkdn@gmail.com","url":"https://znck.me/"},"funding":{"type":"individual","url":"https://github.com/sponsors/znck"},"license":"MIT","bugs":{"url":"https://github.com/znck/vue-developer-experience/issues"},"homepage":"https://github.com/znck/vue-developer-experience#readme","dependencies":{"@babel/code-frame":"^7.10.4","@babel/generator":"^7.12.1","@babel/parser":"^7.12.3","@babel/template":"^7.12.7","@babel/traverse":"7.12.1","@babel/types":"7.12.1","@types/micromatch":"^4.0.1","@vuedx/compiler-sfc":"0.4.2-insiders-1610169628.0","@vuedx/compiler-tsx":"0.4.2-insiders-1610169628.0","@vuedx/projectconfig":"0.4.2-insiders-1610169628.0","@vuedx/template-ast-types":"0.4.2-insiders-1610169628.0","cli-highlight":"^2.1.4","commander":"^6.1.0","fast-glob":"^3.2.4","hash-sum":"^2.0.0","micromatch":"^4.0.2"},"devDependencies":{"@types/babel__traverse":"^7.0.15","@types/node":"^14.14.14","@vuedx/shared":"0.4.2-insiders-1610169628.0","typescript":"^4.0.3"},"readme":"
\n \n
\n\n## Support\n\nThis package is part of [VueDX project](https://github.com/znck/vue-developer-experience), maintained by [Rahul Kadyan](https://github.com/znck). You can [💖 sponsor him](https://github.com/sponsors/znck) for continued development of this package and other VueDX tools.\n\n## Usage\n\n\n\n\n## API\n\n\n\n\n### [ConfiguredVueProject](#-vuedx-analyze-ConfiguredVueProject-class)\n\n\n\n\n Analyze
\nA tool to statically analyze Vue single file components.
\nMore info
\n\n**Signature:**\n```ts\ndeclare class ConfiguredVueProject extends VueProject {\n constructor(rootDir: string, packageFile: string | undefined, packageJSON: Partial\n\n\n\n#### [setFileNames](#-vuedx-analyze-ConfiguredVueProject-setFileNames-member-1-)\n\n\n\n**Signature:**\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n\n### [InferredVueProject](#-vuedx-analyze-InferredVueProject-class)\n\n\n\n
More info
\n\n**Signature:**\n```ts\ndeclare class InferredVueProject extends VueProject {\n kind: \"inferred\";\n protected refresh(): void;\n}\n```\n\n**Members:**\n\n\n\n\n#### [refresh](#-vuedx-analyze-InferredVueProject-refresh-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected refresh(): void;\n```\n\n\n\n
\n\n\n\n\n### [VueProject](#-vuedx-analyze-VueProject-class)\n\n\n\n
More info
\n\n**Signature:**\n```ts\ndeclare abstract class VueProject {\n protected _config: Readonly\n\n\n\n#### [markDirty](#-vuedx-analyze-VueProject-markDirty-member-1-)\n\n\n\n**Signature:**\n```ts\nmarkDirty(): void;\n```\n\n\n
\n\n\n\n#### [refresh](#-vuedx-analyze-VueProject-refresh-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected abstract refresh(): void;\n```\n\n\n
\n\n\n\n#### [reloadIfNeeded](#-vuedx-analyze-VueProject-reloadIfNeeded-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected reloadIfNeeded(): void;\n```\n\n\n
\n\n\n\n#### [setConfig](#-vuedx-analyze-VueProject-setConfig-member-1-)\n\n\n\n**Signature:**\n```ts\nsetConfig(config: ProjectConfig): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| config |
ProjectConfig | - |\n\n\n\n\n\n#### [setFileNames](#-vuedx-analyze-VueProject-setFileNames-member-1-)\n\n\n\n**Signature:**\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n\n### [createAnalyzer](#-vuedx-analyze-createAnalyzer-function-1-)\n\n\n\n
\n): Analyzer;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| plugins |
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createAnalyzer(plugins: Plugin[], options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createFullAnalyzer](#-vuedx-analyze-createFullAnalyzer-function-1-)\n\n\n\n
\n): ReturnType;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| plugins |
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createFullAnalyzer(plugins?: Plugin[], options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createSourceRange](#-vuedx-analyze-createSourceRange-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createSourceRange(context: Context | ScriptAnalyzerContext, node: Node): SourceRange;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| context |Context | ScriptAnalyzerContext | - |\n| node | Node | - |\n\n\n\n\n\n### [toVeturData](#-vuedx-analyze-toVeturData-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function toVeturData(components: ComponentInfo[]): VeturData;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| components |ComponentInfo[] | - |\n\n\n\n\n\n### [toWebTypes](#-vuedx-analyze-toWebTypes-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function toWebTypes(name: string, version: string, components: ComponentInfo[]): WebTypes;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| name |string | - |\n| version | string | - |\n| components | ComponentInfo[] | - |\n\n\n\n\n\n### [transformToFunction](#-vuedx-analyze-transformToFunction-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function transformToFunction(content: string, options?: FunctionTransformOptions): string;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| content |string | - |\n| options | FunctionTransformOptions | - |\n\n\n\n## Types\n\n\n\n\n### [Analyzer](#-vuedx-analyze-Analyzer-interface)\n\n\n\n```ts\ninterface Analyzer {\n analyze(content: string, fileName?: string): ComponentInfo;\n analyzeScript(content: string, fileName?: string, mode?: 'script' | 'scriptSetup'): ComponentInfo;\n analyzeTemplate(content: string, fileName?: string): ComponentInfo;\n}\n```\n\n\n
\n\n\n\n### [ComponentInfo](#-vuedx-analyze-ComponentInfo-interface)\n\n\n\n```ts\ninterface ComponentInfo extends Taggable {\n aliases: string[];\n components: LocalComponentRegistrationInfo[];\n description: string;\n emits: EmitInfo[];\n errors: SyntaxError[];\n fileName: string;\n fnSetupOption?: SetupInfo;\n identifierSource: Record
\n\n\n\n### [ComponentRegistrationInfo](#-vuedx-analyze-ComponentRegistrationInfo-interface)\n\n\n\n```ts\ninterface ComponentRegistrationInfo {\n aliases: string[];\n name: string;\n source: ImportSource;\n}\n```\n\n\n
\n\n\n\n### [EmitInfo](#-vuedx-analyze-EmitInfo-interface)\n\n\n\n```ts\ninterface EmitInfo extends Taggable, Addressable {\n description: string;\n isDynamic: boolean;\n isInferred: boolean;\n name: string;\n references: SourceRange[];\n type: TypeInfo[];\n}\n```\n\n\n
\n\n\n\n### [IdentifierSource](#-vuedx-analyze-IdentifierSource-interface)\n\n\n\n```ts\ninterface IdentifierSource extends Addressable {\n name: string;\n}\n```\n\n\n
\n\n\n\n### [ImportSource](#-vuedx-analyze-ImportSource-interface)\n\n\n\n```ts\ninterface ImportSource {\n exportName?: string;\n localName: string;\n moduleName: string;\n}\n```\n\n\n
\n\n\n\n### [ImportSourceWithLocation](#-vuedx-analyze-ImportSourceWithLocation-interface)\n\n\n\n```ts\ninterface ImportSourceWithLocation extends ImportSource, Addressable {\n}\n```\n\n\n
\n\n\n\n### [LocalComponentRegistrationInfo](#-vuedx-analyze-LocalComponentRegistrationInfo-interface)\n\n\n\n```ts\ninterface LocalComponentRegistrationInfo extends ComponentRegistrationInfo, Addressable {\n kind: 'script' | 'scriptSetup';\n source: ImportSourceWithLocation;\n}\n```\n\n\n
\n\n\n\n### [Plugin](#-vuedx-analyze-Plugin-2-interface)\n\n\n\n```ts\ninterface Plugin {\n babel?: AbstractScriptAnalyzerFn | AbstractAnalyzerHandler;\n blocks?: Partial<{\n script: BlockAnalyzer
\n\n\n\n### [PropInfo](#-vuedx-analyze-PropInfo-interface)\n\n\n\n```ts\ninterface PropInfo extends Taggable, Addressable {\n defaultValue: ValueInfo | null;\n description: string;\n name: string;\n required: boolean;\n type: TypeInfo[];\n}\n```\n\n\n
\n\n\n\n### [ScriptSetupInfo](#-vuedx-analyze-ScriptSetupInfo-interface)\n\n\n\n```ts\ninterface ScriptSetupInfo {\n defineEmit?: Addressable;\n defineProps?: Addressable;\n}\n```\n\n\n
\n\n\n\n### [SetupInfo](#-vuedx-analyze-SetupInfo-interface)\n\n\n\n```ts\ninterface SetupInfo extends Addressable {\n context?: {\n identifiers: Partial<{\n attrs: string;\n slots: string;\n emit: string;\n }>;\n rest?: string;\n } & Addressable;\n props?: {\n identifiers: string[];\n rest?: string;\n } & Addressable;\n return?: Addressable;\n}\n```\n\n\n
\n\n\n\n### [SourceRange](#-vuedx-analyze-SourceRange-interface)\n\n\n\n```ts\ninterface SourceRange {\n end: SourceLocation;\n source: string;\n start: SourceLocation;\n}\n```\n\n\n
\n\n\n\n### [SyntaxError](#-vuedx-analyze-SyntaxError-2-interface)\n\n\n\n```ts\ninterface SyntaxError {\n loc: SourceLocation;\n message: string;\n}\n```\n\n\n
\n\n\n\n### [VeturData](#-vuedx-analyze-VeturData-interface)\n\n\n\n```ts\ninterface VeturData {\n attributes: Record
\n\n\n\n### [WebTypes](#-vuedx-analyze-WebTypes-interface)\n\n\n\n```ts\ninterface WebTypes {\n contributions: {\n 'types-syntax': 'typescript';\n 'description-markup': 'html' | 'markdown' | 'none';\n tags: Tag[];\n attributes: Attribute[];\n };\n framework: 'vue';\n name: string;\n version: string;\n}\n```\n\n\n
\n\n","readmeFilename":"readme.md","_id":"@vuedx/analyze@0.4.2-insiders-1610169628.0","_nodeVersion":"14.14.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-jrkQjSh+lDXNo+SqSlWqIgaASzPBLVfXIehePZpybFhcFcRJ38/FK8XL3cALAJ10bddgnDNy21xHFoF+J+ahug==","shasum":"72ecd9083609ab1cfa6554a3a8d78c2475d7747b","tarball":"https://registry.npmjs.org/@vuedx/analyze/-/analyze-0.4.2-insiders-1610169628.0.tgz","fileCount":9,"unpackedSize":479813,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJf+T03CRA9TVsSAnZWagAA+0YQAIB6VZffC4LmM+tApx9M\n47taZThqKUZl30uwbsMktLai2ZVNklSiv1LFfzXXOoTQyRZO+25bByfYMnW7\nWEO9CpRdNcX+SxHpKHp5lhVIwHzO/GKtuhrB7491pB7CINoJD91rt+HEUIue\nEtweD1K90wYKlPeELdGzY9/a1xRE4e2GjiEnvM8ytlmfVx2cNub5UGnAnWlU\n9MqsrQN5xHxRhMEy8DTLhEhXh662mvw8+kr9MsXVbe+4hkKTvR1+kw1kmlKV\nrk2yxOVob0Vxu9Ur+V+inwe4oBMCBd4KIeO7CaE1lGAuNeseRyqHVvi+5H+j\nAWheS9tr9wUpqbMDcuHAd99BFUY2GKkdsUN7fN2pwdpWK/v3DlFmQ/wwM+nc\nDcA72Z+54mGb6OVZJWttgGO+zqqs42b+MqxfPgHmThPsZamLa/jtxUey8k4b\nveG7AiftkIMrR58xWvYx22bjdBemgWRmaSmSyMBJdnydhpQhpM3nSh861gHZ\nCs3ayNOL0zwomCKYwVdIdXtgGs/264DdM2xPBFzf9I7mYmgQ0MHHlJH2wC5M\n/CIBbx9ARB505tfLDYzk6Ishzq7KZC/KLfgBlojd2jtFTcl4kBvBZ6fxqqM0\nNP0L1OhBBX20znwAyoJotVU0x4c6vpI38JYY1zO+pA5Cmvlscj/XXvSslO+Q\nTcz2\r\n=wUbI\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQD7c9xUY2bMEi1MsatAB6iWTx/nGcBoxwlBhTrz0hcQiAIgYLFV7qzBE67hZHSdqmPoZI9phkcVwOzif5E1rRWkaew="}]},"_npmUser":{"name":"znck","email":"rahulkdn@gmail.com"},"directories":{},"maintainers":[{"name":"znck","email":"rahulkdn@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/analyze_0.4.2-insiders-1610169628.0_1610169654669_0.8394634749980643"},"_hasShrinkwrap":false},"0.4.2-insiders-1610448877.0":{"name":"@vuedx/analyze","version":"0.4.2-insiders-1610448877.0","description":"Extracts public API information from Vue component.","main":"dist/index.cjs.js","module":"dist/index.esm.js","types":"dist/index.d.ts","bin":{"vuedx-analyze":"bin/analyze.js"},"keywords":["vue","sfc","sfc api extractor","static analyzer","sfc analyzer","sfc static analyzer","docgen","documentation"],"repository":{"type":"git","url":"git+https://github.com/znck/vue-developer-experience.git"},"author":{"name":"Rahul Kadyan","email":"rahulkdn@gmail.com","url":"https://znck.me/"},"funding":{"type":"individual","url":"https://github.com/sponsors/znck"},"license":"MIT","bugs":{"url":"https://github.com/znck/vue-developer-experience/issues"},"homepage":"https://github.com/znck/vue-developer-experience#readme","dependencies":{"@babel/code-frame":"^7.10.4","@babel/generator":"^7.12.1","@babel/parser":"^7.12.3","@babel/template":"^7.12.7","@babel/traverse":"7.12.1","@babel/types":"7.12.1","@types/micromatch":"^4.0.1","@vuedx/compiler-sfc":"0.4.2-insiders-1610448877.0","@vuedx/compiler-tsx":"0.4.2-insiders-1610448877.0","@vuedx/projectconfig":"0.4.2-insiders-1610448877.0","@vuedx/template-ast-types":"0.4.2-insiders-1610448877.0","cli-highlight":"^2.1.4","commander":"^6.1.0","fast-glob":"^3.2.4","hash-sum":"^2.0.0","micromatch":"^4.0.2"},"devDependencies":{"@types/babel__traverse":"^7.0.15","@types/node":"^14.14.14","@vuedx/shared":"0.4.2-insiders-1610448877.0","typescript":"^4.0.3"},"readme":"
\n \n
\n\n## Support\n\nThis package is part of [VueDX project](https://github.com/znck/vue-developer-experience), maintained by [Rahul Kadyan](https://github.com/znck). You can [💖 sponsor him](https://github.com/sponsors/znck) for continued development of this package and other VueDX tools.\n\n## Usage\n\n\n\n\n## API\n\n\n\n\n### [ConfiguredVueProject](#-vuedx-analyze-ConfiguredVueProject-class)\n\n\n\n\n Analyze
\nA tool to statically analyze Vue single file components.
\nMore info
\n\n**Signature:**\n```ts\ndeclare class ConfiguredVueProject extends VueProject {\n constructor(rootDir: string, packageFile: string | undefined, packageJSON: Partial\n\n\n\n#### [setFileNames](#-vuedx-analyze-ConfiguredVueProject-setFileNames-member-1-)\n\n\n\n**Signature:**\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n\n### [InferredVueProject](#-vuedx-analyze-InferredVueProject-class)\n\n\n\n
More info
\n\n**Signature:**\n```ts\ndeclare class InferredVueProject extends VueProject {\n kind: \"inferred\";\n protected refresh(): void;\n}\n```\n\n**Members:**\n\n\n\n\n#### [refresh](#-vuedx-analyze-InferredVueProject-refresh-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected refresh(): void;\n```\n\n\n\n
\n\n\n\n\n### [VueProject](#-vuedx-analyze-VueProject-class)\n\n\n\n
More info
\n\n**Signature:**\n```ts\ndeclare abstract class VueProject {\n protected _config: Readonly\n\n\n\n#### [markDirty](#-vuedx-analyze-VueProject-markDirty-member-1-)\n\n\n\n**Signature:**\n```ts\nmarkDirty(): void;\n```\n\n\n
\n\n\n\n#### [refresh](#-vuedx-analyze-VueProject-refresh-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected abstract refresh(): void;\n```\n\n\n
\n\n\n\n#### [reloadIfNeeded](#-vuedx-analyze-VueProject-reloadIfNeeded-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected reloadIfNeeded(): void;\n```\n\n\n
\n\n\n\n#### [setConfig](#-vuedx-analyze-VueProject-setConfig-member-1-)\n\n\n\n**Signature:**\n```ts\nsetConfig(config: ProjectConfig): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| config |
ProjectConfig | - |\n\n\n\n\n\n#### [setFileNames](#-vuedx-analyze-VueProject-setFileNames-member-1-)\n\n\n\n**Signature:**\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n\n### [createAnalyzer](#-vuedx-analyze-createAnalyzer-function-1-)\n\n\n\n
\n): Analyzer;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| plugins |
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createAnalyzer(plugins: Plugin[], options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createFullAnalyzer](#-vuedx-analyze-createFullAnalyzer-function-1-)\n\n\n\n
\n): ReturnType;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| plugins |
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createFullAnalyzer(plugins?: Plugin[], options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createSourceRange](#-vuedx-analyze-createSourceRange-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createSourceRange(context: Context | ScriptAnalyzerContext, node: Node): SourceRange;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| context |Context | ScriptAnalyzerContext | - |\n| node | Node | - |\n\n\n\n\n\n### [toVeturData](#-vuedx-analyze-toVeturData-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function toVeturData(components: ComponentInfo[]): VeturData;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| components |ComponentInfo[] | - |\n\n\n\n\n\n### [toWebTypes](#-vuedx-analyze-toWebTypes-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function toWebTypes(name: string, version: string, components: ComponentInfo[]): WebTypes;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| name |string | - |\n| version | string | - |\n| components | ComponentInfo[] | - |\n\n\n\n\n\n### [transformToFunction](#-vuedx-analyze-transformToFunction-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function transformToFunction(content: string, options?: FunctionTransformOptions): string;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| content |string | - |\n| options | FunctionTransformOptions | - |\n\n\n\n## Types\n\n\n\n\n### [Analyzer](#-vuedx-analyze-Analyzer-interface)\n\n\n\n```ts\ninterface Analyzer {\n analyze(content: string, fileName?: string): ComponentInfo;\n analyzeScript(content: string, fileName?: string, mode?: 'script' | 'scriptSetup'): ComponentInfo;\n analyzeTemplate(content: string, fileName?: string): ComponentInfo;\n}\n```\n\n\n
\n\n\n\n### [ComponentInfo](#-vuedx-analyze-ComponentInfo-interface)\n\n\n\n```ts\ninterface ComponentInfo extends Taggable {\n aliases: string[];\n components: LocalComponentRegistrationInfo[];\n description: string;\n emits: EmitInfo[];\n errors: SyntaxError[];\n fileName: string;\n fnSetupOption?: SetupInfo;\n identifierSource: Record
\n\n\n\n### [ComponentRegistrationInfo](#-vuedx-analyze-ComponentRegistrationInfo-interface)\n\n\n\n```ts\ninterface ComponentRegistrationInfo {\n aliases: string[];\n name: string;\n source: ImportSource;\n}\n```\n\n\n
\n\n\n\n### [EmitInfo](#-vuedx-analyze-EmitInfo-interface)\n\n\n\n```ts\ninterface EmitInfo extends Taggable, Addressable {\n description: string;\n isDynamic: boolean;\n isInferred: boolean;\n name: string;\n references: SourceRange[];\n type: TypeInfo[];\n}\n```\n\n\n
\n\n\n\n### [IdentifierSource](#-vuedx-analyze-IdentifierSource-interface)\n\n\n\n```ts\ninterface IdentifierSource extends Addressable {\n name: string;\n}\n```\n\n\n
\n\n\n\n### [ImportSource](#-vuedx-analyze-ImportSource-interface)\n\n\n\n```ts\ninterface ImportSource {\n exportName?: string;\n localName: string;\n moduleName: string;\n}\n```\n\n\n
\n\n\n\n### [ImportSourceWithLocation](#-vuedx-analyze-ImportSourceWithLocation-interface)\n\n\n\n```ts\ninterface ImportSourceWithLocation extends ImportSource, Addressable {\n}\n```\n\n\n
\n\n\n\n### [LocalComponentRegistrationInfo](#-vuedx-analyze-LocalComponentRegistrationInfo-interface)\n\n\n\n```ts\ninterface LocalComponentRegistrationInfo extends ComponentRegistrationInfo, Addressable {\n kind: 'script' | 'scriptSetup';\n source: ImportSourceWithLocation;\n}\n```\n\n\n
\n\n\n\n### [Plugin](#-vuedx-analyze-Plugin-2-interface)\n\n\n\n```ts\ninterface Plugin {\n babel?: AbstractScriptAnalyzerFn | AbstractAnalyzerHandler;\n blocks?: Partial<{\n script: BlockAnalyzer
\n\n\n\n### [PropInfo](#-vuedx-analyze-PropInfo-interface)\n\n\n\n```ts\ninterface PropInfo extends Taggable, Addressable {\n defaultValue: ValueInfo | null;\n description: string;\n name: string;\n required: boolean;\n type: TypeInfo[];\n}\n```\n\n\n
\n\n\n\n### [ScriptSetupInfo](#-vuedx-analyze-ScriptSetupInfo-interface)\n\n\n\n```ts\ninterface ScriptSetupInfo {\n defineEmit?: Addressable;\n defineProps?: Addressable;\n}\n```\n\n\n
\n\n\n\n### [SetupInfo](#-vuedx-analyze-SetupInfo-interface)\n\n\n\n```ts\ninterface SetupInfo extends Addressable {\n context?: {\n identifiers: Partial<{\n attrs: string;\n slots: string;\n emit: string;\n }>;\n rest?: string;\n } & Addressable;\n props?: {\n identifiers: string[];\n rest?: string;\n } & Addressable;\n return?: Addressable;\n}\n```\n\n\n
\n\n\n\n### [SourceRange](#-vuedx-analyze-SourceRange-interface)\n\n\n\n```ts\ninterface SourceRange {\n end: SourceLocation;\n source: string;\n start: SourceLocation;\n}\n```\n\n\n
\n\n\n\n### [SyntaxError](#-vuedx-analyze-SyntaxError-2-interface)\n\n\n\n```ts\ninterface SyntaxError {\n loc: SourceLocation;\n message: string;\n}\n```\n\n\n
\n\n\n\n### [VeturData](#-vuedx-analyze-VeturData-interface)\n\n\n\n```ts\ninterface VeturData {\n attributes: Record
\n\n\n\n### [WebTypes](#-vuedx-analyze-WebTypes-interface)\n\n\n\n```ts\ninterface WebTypes {\n contributions: {\n 'types-syntax': 'typescript';\n 'description-markup': 'html' | 'markdown' | 'none';\n tags: Tag[];\n attributes: Attribute[];\n };\n framework: 'vue';\n name: string;\n version: string;\n}\n```\n\n\n
\n\n","readmeFilename":"readme.md","_id":"@vuedx/analyze@0.4.2-insiders-1610448877.0","_nodeVersion":"14.14.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-6xM/Aa7OVrO9k1wlgGNhPKy2MaKinSpFEh7Vo+iXju+PyePbTLm0ysNud2FK+2gW27deXYDeYOu7b31moZwrXg==","shasum":"18bc7c2f13004ba22d9bf8cdd30944b8bc2e164b","tarball":"https://registry.npmjs.org/@vuedx/analyze/-/analyze-0.4.2-insiders-1610448877.0.tgz","fileCount":9,"unpackedSize":479813,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJf/YAJCRA9TVsSAnZWagAAAxcP/2Us1LTQfP9sYBhKOmD8\njkDXEtd6hqtcYdMmCDPppBVk7S8v641F5RWElhwASiaZhplYUzTBpi767xks\nLCiXP8nMNcS6xk/pqUSPdplotK+XZ3nfXnXQlhQcUAJAeGKG1bNmHU/u+MNw\nFztvt0XZ4IJ3IUf686LQlXEMbh6LGSSFs3ZcV+u8VdxN6j6YtLws8ZT2Xw/b\n5s5+/jEIvpYJSJFrXCwx00MZODqkQ4asRBebMKsPsailD0THy3fNPJk+BGbR\n2B0hacAzpUv21FE5ElU702GCA4r2/jIer59oRYGewFjhbh3TU3DlqlJ/IiEN\ni9WD+xA2M1v0rWaW+t+nL31NTyUh5G9WJh6F6GKUEasUolD8oMFWqlE/kyR6\nIOmiKLv8w9PZPE+0fspPACg4UTyC9nfiD0vZrmALqLkNUrta6DqUCrx475Pq\n9rCwe52gyMxDJJMpBrsKKAMOM8Jro1WehJCr2y2E+zsLvoVuh8e9i753ppKj\nrrH2V0j4bdFq15u1Z0IthsEWPUf5CcltCve/gZk/q49ysM5gJw8H6/lMOz79\naM2Y6TxeRktsrtG25xCkRmMcWtSGdUMkfP2fG3aoxnIHQi8Rl4mYv7hZKEIf\noARQ3/NZUyY9qf9pd6doRHCKJ9P49AWO/J96P5EMQOqglobDsuTUKuepEsfY\ni9n8\r\n=td4I\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIFEsr1zmdAGhWsCK2DbSZ4529kFr+GfuGRcFg7djDMI3AiAUZ1tjgZatg81n+1NPUZg6/WLQRVRDB0xH7MLaPLw7MQ=="}]},"_npmUser":{"name":"znck","email":"rahulkdn@gmail.com"},"directories":{},"maintainers":[{"name":"znck","email":"rahulkdn@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/analyze_0.4.2-insiders-1610448877.0_1610448904751_0.6964265172256188"},"_hasShrinkwrap":false},"0.5.1-insiders-1610450632.0":{"name":"@vuedx/analyze","version":"0.5.1-insiders-1610450632.0","description":"Extracts public API information from Vue component.","main":"dist/index.cjs.js","module":"dist/index.esm.js","types":"dist/index.d.ts","bin":{"vuedx-analyze":"bin/analyze.js"},"keywords":["vue","sfc","sfc api extractor","static analyzer","sfc analyzer","sfc static analyzer","docgen","documentation"],"repository":{"type":"git","url":"git+https://github.com/znck/vue-developer-experience.git"},"author":{"name":"Rahul Kadyan","email":"rahulkdn@gmail.com","url":"https://znck.me/"},"funding":{"type":"individual","url":"https://github.com/sponsors/znck"},"license":"MIT","bugs":{"url":"https://github.com/znck/vue-developer-experience/issues"},"homepage":"https://github.com/znck/vue-developer-experience#readme","dependencies":{"@babel/code-frame":"^7.10.4","@babel/generator":"^7.12.1","@babel/parser":"^7.12.3","@babel/template":"^7.12.7","@babel/traverse":"7.12.1","@babel/types":"7.12.1","@types/micromatch":"^4.0.1","@vuedx/compiler-sfc":"0.5.1-insiders-1610450632.0","@vuedx/compiler-tsx":"0.5.1-insiders-1610450632.0","@vuedx/projectconfig":"0.5.1-insiders-1610450632.0","@vuedx/template-ast-types":"0.5.1-insiders-1610450632.0","cli-highlight":"^2.1.4","commander":"^6.1.0","fast-glob":"^3.2.4","hash-sum":"^2.0.0","micromatch":"^4.0.2"},"devDependencies":{"@types/babel__traverse":"^7.0.15","@types/node":"^14.14.14","@vuedx/shared":"0.5.1-insiders-1610450632.0","typescript":"^4.0.3"},"readme":"
\n \n
\n\n## Support\n\nThis package is part of [VueDX project](https://github.com/znck/vue-developer-experience), maintained by [Rahul Kadyan](https://github.com/znck). You can [💖 sponsor him](https://github.com/sponsors/znck) for continued development of this package and other VueDX tools.\n\n## Usage\n\n\n\n\n## API\n\n\n\n\n### [ConfiguredVueProject](#-vuedx-analyze-ConfiguredVueProject-class)\n\n\n\n\n Analyze
\nA tool to statically analyze Vue single file components.
\nMore info
\n\n**Signature:**\n```ts\ndeclare class ConfiguredVueProject extends VueProject {\n constructor(rootDir: string, packageFile: string | undefined, packageJSON: Partial\n\n\n\n#### [setFileNames](#-vuedx-analyze-ConfiguredVueProject-setFileNames-member-1-)\n\n\n\n**Signature:**\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n\n### [InferredVueProject](#-vuedx-analyze-InferredVueProject-class)\n\n\n\n
More info
\n\n**Signature:**\n```ts\ndeclare class InferredVueProject extends VueProject {\n kind: \"inferred\";\n protected refresh(): void;\n}\n```\n\n**Members:**\n\n\n\n\n#### [refresh](#-vuedx-analyze-InferredVueProject-refresh-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected refresh(): void;\n```\n\n\n\n
\n\n\n\n\n### [VueProject](#-vuedx-analyze-VueProject-class)\n\n\n\n
More info
\n\n**Signature:**\n```ts\ndeclare abstract class VueProject {\n protected _config: Readonly\n\n\n\n#### [markDirty](#-vuedx-analyze-VueProject-markDirty-member-1-)\n\n\n\n**Signature:**\n```ts\nmarkDirty(): void;\n```\n\n\n
\n\n\n\n#### [refresh](#-vuedx-analyze-VueProject-refresh-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected abstract refresh(): void;\n```\n\n\n
\n\n\n\n#### [reloadIfNeeded](#-vuedx-analyze-VueProject-reloadIfNeeded-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected reloadIfNeeded(): void;\n```\n\n\n
\n\n\n\n#### [setConfig](#-vuedx-analyze-VueProject-setConfig-member-1-)\n\n\n\n**Signature:**\n```ts\nsetConfig(config: ProjectConfig): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| config |
ProjectConfig | - |\n\n\n\n\n\n#### [setFileNames](#-vuedx-analyze-VueProject-setFileNames-member-1-)\n\n\n\n**Signature:**\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n\n### [createAnalyzer](#-vuedx-analyze-createAnalyzer-function-1-)\n\n\n\n
\n): Analyzer;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| plugins |
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createAnalyzer(plugins: Plugin[], options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createFullAnalyzer](#-vuedx-analyze-createFullAnalyzer-function-1-)\n\n\n\n
\n): ReturnType;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| plugins |
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createFullAnalyzer(plugins?: Plugin[], options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createSourceRange](#-vuedx-analyze-createSourceRange-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createSourceRange(context: Context | ScriptAnalyzerContext, node: Node): SourceRange;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| context |Context | ScriptAnalyzerContext | - |\n| node | Node | - |\n\n\n\n\n\n### [toVeturData](#-vuedx-analyze-toVeturData-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function toVeturData(components: ComponentInfo[]): VeturData;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| components |ComponentInfo[] | - |\n\n\n\n\n\n### [toWebTypes](#-vuedx-analyze-toWebTypes-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function toWebTypes(name: string, version: string, components: ComponentInfo[]): WebTypes;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| name |string | - |\n| version | string | - |\n| components | ComponentInfo[] | - |\n\n\n\n\n\n### [transformToFunction](#-vuedx-analyze-transformToFunction-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function transformToFunction(content: string, options?: FunctionTransformOptions): string;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| content |string | - |\n| options | FunctionTransformOptions | - |\n\n\n\n## Types\n\n\n\n\n### [Analyzer](#-vuedx-analyze-Analyzer-interface)\n\n\n\n```ts\ninterface Analyzer {\n analyze(content: string, fileName?: string): ComponentInfo;\n analyzeScript(content: string, fileName?: string, mode?: 'script' | 'scriptSetup'): ComponentInfo;\n analyzeTemplate(content: string, fileName?: string): ComponentInfo;\n}\n```\n\n\n
\n\n\n\n### [ComponentInfo](#-vuedx-analyze-ComponentInfo-interface)\n\n\n\n```ts\ninterface ComponentInfo extends Taggable {\n aliases: string[];\n components: LocalComponentRegistrationInfo[];\n description: string;\n emits: EmitInfo[];\n errors: SyntaxError[];\n fileName: string;\n fnSetupOption?: SetupInfo;\n identifierSource: Record
\n\n\n\n### [ComponentRegistrationInfo](#-vuedx-analyze-ComponentRegistrationInfo-interface)\n\n\n\n```ts\ninterface ComponentRegistrationInfo {\n aliases: string[];\n name: string;\n source: ImportSource;\n}\n```\n\n\n
\n\n\n\n### [EmitInfo](#-vuedx-analyze-EmitInfo-interface)\n\n\n\n```ts\ninterface EmitInfo extends Taggable, Addressable {\n description: string;\n isDynamic: boolean;\n isInferred: boolean;\n name: string;\n references: SourceRange[];\n type: TypeInfo[];\n}\n```\n\n\n
\n\n\n\n### [IdentifierSource](#-vuedx-analyze-IdentifierSource-interface)\n\n\n\n```ts\ninterface IdentifierSource extends Addressable {\n name: string;\n}\n```\n\n\n
\n\n\n\n### [ImportSource](#-vuedx-analyze-ImportSource-interface)\n\n\n\n```ts\ninterface ImportSource {\n exportName?: string;\n localName: string;\n moduleName: string;\n}\n```\n\n\n
\n\n\n\n### [ImportSourceWithLocation](#-vuedx-analyze-ImportSourceWithLocation-interface)\n\n\n\n```ts\ninterface ImportSourceWithLocation extends ImportSource, Addressable {\n}\n```\n\n\n
\n\n\n\n### [LocalComponentRegistrationInfo](#-vuedx-analyze-LocalComponentRegistrationInfo-interface)\n\n\n\n```ts\ninterface LocalComponentRegistrationInfo extends ComponentRegistrationInfo, Addressable {\n kind: 'script' | 'scriptSetup';\n source: ImportSourceWithLocation;\n}\n```\n\n\n
\n\n\n\n### [Plugin](#-vuedx-analyze-Plugin-2-interface)\n\n\n\n```ts\ninterface Plugin {\n babel?: AbstractScriptAnalyzerFn | AbstractAnalyzerHandler;\n blocks?: Partial<{\n script: BlockAnalyzer
\n\n\n\n### [PropInfo](#-vuedx-analyze-PropInfo-interface)\n\n\n\n```ts\ninterface PropInfo extends Taggable, Addressable {\n defaultValue: ValueInfo | null;\n description: string;\n name: string;\n required: boolean;\n type: TypeInfo[];\n}\n```\n\n\n
\n\n\n\n### [ScriptSetupInfo](#-vuedx-analyze-ScriptSetupInfo-interface)\n\n\n\n```ts\ninterface ScriptSetupInfo {\n defineEmit?: Addressable;\n defineProps?: Addressable;\n}\n```\n\n\n
\n\n\n\n### [SetupInfo](#-vuedx-analyze-SetupInfo-interface)\n\n\n\n```ts\ninterface SetupInfo extends Addressable {\n context?: {\n identifiers: Partial<{\n attrs: string;\n slots: string;\n emit: string;\n }>;\n rest?: string;\n } & Addressable;\n props?: {\n identifiers: string[];\n rest?: string;\n } & Addressable;\n return?: Addressable;\n}\n```\n\n\n
\n\n\n\n### [SourceRange](#-vuedx-analyze-SourceRange-interface)\n\n\n\n```ts\ninterface SourceRange {\n end: SourceLocation;\n source: string;\n start: SourceLocation;\n}\n```\n\n\n
\n\n\n\n### [SyntaxError](#-vuedx-analyze-SyntaxError-2-interface)\n\n\n\n```ts\ninterface SyntaxError {\n loc: SourceLocation;\n message: string;\n}\n```\n\n\n
\n\n\n\n### [VeturData](#-vuedx-analyze-VeturData-interface)\n\n\n\n```ts\ninterface VeturData {\n attributes: Record
\n\n\n\n### [WebTypes](#-vuedx-analyze-WebTypes-interface)\n\n\n\n```ts\ninterface WebTypes {\n contributions: {\n 'types-syntax': 'typescript';\n 'description-markup': 'html' | 'markdown' | 'none';\n tags: Tag[];\n attributes: Attribute[];\n };\n framework: 'vue';\n name: string;\n version: string;\n}\n```\n\n\n
\n\n","readmeFilename":"readme.md","_id":"@vuedx/analyze@0.5.1-insiders-1610450632.0","_nodeVersion":"14.14.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-kLusHZB6dP7CpFpIMS51EQFmeBBSfjCEavMN38dTgl9yS5nFkxkYXP1Vwm6EX4UsIx9i0+ZS/0iuFJxRjCUVfg==","shasum":"7e9a3370b022d5006b8c4c37da0af1f716cde1c7","tarball":"https://registry.npmjs.org/@vuedx/analyze/-/analyze-0.5.1-insiders-1610450632.0.tgz","fileCount":9,"unpackedSize":479813,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJf/YbpCRA9TVsSAnZWagAAGOYP/2fm3cFOfSuHG3fAEFZy\nMPByrmt02twewR9EkK2of4ZLLI0HPBNrOAcY/AARkkbq2gLjhQ1It0BBagAC\nHObAZIHzYxkUNstJdpBGmO7A71z6e4Ad8Ds82PnHO5H+brpQT3X+DneOl8rh\n3YbgaZ2Ac3U9UVZjsFxd8JFOXkU5FaSdhpEi601NevnY8QZNRAHP1rwFx7lg\nNlMLWeXtbncjELTh9PpSS8NZ6otzSvbDkUe0ksi6t6rsjkjK314gr7TA3KP9\nTj+3HAvPbAWTod5WTFfRwHv8z9rtfPyUvBrEW1VMidTMpwoEAnXvnp17dSrG\nGyygq7KmfA73vvccKy3pkA9SKwQPirqE76Y5iMBwCQikLHsUoXjJiXJYD1VW\n/rFiX7PanDR/oPjR+dxfOMwADJWGidpXrc2cQO2wXL6JvpSFvaX4+l9J8Hvs\nSC8DVylcDg2vTknr1Vxd0+QWsImySyoCSlnRfSBKPks7JqoH2e8FBoRw7KOR\nDyW++AMZ8/firY+QOHBFXr2vN/kAGExtWpvpeMutD97VP8smVaMD5NQQXV8c\naN3m253T93Sb52NiWVOfe6E3xl5cgEpkTp43cwVaGXH91SkjolKjjtmNbSFI\nFi4LsV6jQW8UoQIylidRd2qgZ21IjNJsuYmxpc7vcE306mDoGz66KChLUghP\nD6ce\r\n=YptZ\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDsUItR2oGwn+ouDd83MmBHk3tQeOUcwyIgF97WLIB2ewIhALZsIHp967tN5dL/RrXrNciVW1qTDNA5RFpM9WW7JXX7"}]},"_npmUser":{"name":"znck","email":"rahulkdn@gmail.com"},"directories":{},"maintainers":[{"name":"znck","email":"rahulkdn@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/analyze_0.5.1-insiders-1610450632.0_1610450664826_0.6911866130285607"},"_hasShrinkwrap":false},"0.5.0":{"name":"@vuedx/analyze","version":"0.5.0","description":"Extracts public API information from Vue component.","main":"dist/index.cjs.js","module":"dist/index.esm.js","types":"dist/index.d.ts","bin":{"vuedx-analyze":"bin/analyze.js"},"keywords":["vue","sfc","sfc api extractor","static analyzer","sfc analyzer","sfc static analyzer","docgen","documentation"],"repository":{"type":"git","url":"git+https://github.com/znck/vue-developer-experience.git"},"author":{"name":"Rahul Kadyan","email":"rahulkdn@gmail.com","url":"https://znck.me/"},"funding":{"type":"individual","url":"https://github.com/sponsors/znck"},"license":"MIT","bugs":{"url":"https://github.com/znck/vue-developer-experience/issues"},"homepage":"https://github.com/znck/vue-developer-experience#readme","dependencies":{"@babel/code-frame":"^7.10.4","@babel/generator":"^7.12.1","@babel/parser":"^7.12.3","@babel/template":"^7.12.7","@babel/traverse":"7.12.1","@babel/types":"7.12.1","@types/micromatch":"^4.0.1","@vuedx/compiler-sfc":"0.5.0","@vuedx/compiler-tsx":"0.5.0","@vuedx/projectconfig":"0.5.0","@vuedx/template-ast-types":"0.5.0","cli-highlight":"^2.1.4","commander":"^6.1.0","fast-glob":"^3.2.4","hash-sum":"^2.0.0","micromatch":"^4.0.2"},"devDependencies":{"@types/babel__traverse":"^7.0.15","@types/node":"^14.14.14","@vuedx/shared":"0.5.0","typescript":"^4.0.3"},"_id":"@vuedx/analyze@0.5.0","_nodeVersion":"14.14.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-F+Q8GVq17MIZrYdTuswx3vplEE9TV4K3lCgf+yWBuZyPnSdymFTrvkmI7CMUNkZutceBL7RmM2C1PASlJAWapA==","shasum":"5a16c65321d0b3d6997d69aefdc50abc92a082b6","tarball":"https://registry.npmjs.org/@vuedx/analyze/-/analyze-0.5.0.tgz","fileCount":9,"unpackedSize":479681,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJf/YfZCRA9TVsSAnZWagAAYdYP/0xcfmEPZR4UO9XFpdsS\n1hLo2EgcKrrx9lnyt9BRK5xhCyDXg4J32DMx/MwEj0qPyc2WUEULDsw3zjBx\nZOecu22c0FH/MjOlYkYzh3UJt6KFRrO2BVhaeq9Tv+bafWYLxtmUe9zIE713\ncuRjebcWqjeNaTL1xsoZJkineTAks3ZWy3kyIltkPKaXNx15M+tLmFaTNGos\nR6GCXsBatrQnPtD/ADlQur/CKV2aIoWP+btt18/rcl4REs/qq7y7fvrAEk7U\neddBBSId7R8jdNaja2+HIVFyrsu5F4KaFh3srw9UOX1eyurr8cBQt6FAFNeY\nbT4nBCAeP95GHdG86djf01LWcLeYD2mCSvJb9fepf+yxCWeO9BUS0XBDlAOk\nESky0vsb7bMwKCZz8qCvQ1El4ZppNIo6aiqjYVw7fZRPI2BK5FL7pDX4wHVq\nGk2cFLgx0K5f+w9ysJFYx+wq9yroQJgHLdZ7iWSiuxIsZ4wZepyGM2NkOD8a\nmGNf/ho4TQxKLfhUxCkxAj770Qvs0AkioncsSG9MUIk3FJNoa825Id6iueY9\nDQ8p80UnSauQdmQuc3Gh7Mq8opPKESS4tgc8WYnowIMBZvhZnn6xoOiIW662\n6WeVMK9UV2p1OaE5H4/V6AYNhDsSh7jIoyGDwD121DFPZ1ywlPdkCTRxxF+P\nf8c1\r\n=o4DY\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIGbp9qHNOFUzCBJz5CvfXeFjL22NU357JMCoHKG3HZp4AiEA7/j+pbsSjSwF/l7u/UM1VZwUEn8rpcGMPj73vClLi/0="}]},"_npmUser":{"name":"znck","email":"rahulkdn@gmail.com"},"directories":{},"maintainers":[{"name":"znck","email":"rahulkdn@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/analyze_0.5.0_1610450904716_0.8977305660713095"},"_hasShrinkwrap":false},"0.5.1-insiders-1610688008.0":{"name":"@vuedx/analyze","version":"0.5.1-insiders-1610688008.0","description":"Extracts public API information from Vue component.","main":"dist/index.cjs.js","module":"dist/index.esm.js","types":"dist/index.d.ts","bin":{"vuedx-analyze":"bin/analyze.js"},"keywords":["vue","sfc","sfc api extractor","static analyzer","sfc analyzer","sfc static analyzer","docgen","documentation"],"repository":{"type":"git","url":"git+https://github.com/znck/vue-developer-experience.git"},"author":{"name":"Rahul Kadyan","email":"rahulkdn@gmail.com","url":"https://znck.me/"},"funding":{"type":"individual","url":"https://github.com/sponsors/znck"},"license":"MIT","bugs":{"url":"https://github.com/znck/vue-developer-experience/issues"},"homepage":"https://github.com/znck/vue-developer-experience#readme","dependencies":{"@babel/code-frame":"^7.10.4","@babel/generator":"^7.12.1","@babel/parser":"^7.12.3","@babel/template":"^7.12.7","@babel/traverse":"7.12.1","@babel/types":"7.12.1","@types/micromatch":"^4.0.1","@vuedx/compiler-sfc":"0.5.1-insiders-1610688008.0","@vuedx/compiler-tsx":"0.5.1-insiders-1610688008.0","@vuedx/projectconfig":"0.5.1-insiders-1610688008.0","@vuedx/template-ast-types":"0.5.1-insiders-1610688008.0","cli-highlight":"^2.1.4","commander":"^6.1.0","fast-glob":"^3.2.4","hash-sum":"^2.0.0","micromatch":"^4.0.2"},"devDependencies":{"@types/babel__traverse":"^7.0.15","@types/node":"^14.14.14","@vuedx/shared":"0.5.1-insiders-1610688008.0","typescript":"^4.0.3"},"readme":"
\n \n
\n\n## Support\n\nThis package is part of [VueDX project](https://github.com/znck/vue-developer-experience), maintained by [Rahul Kadyan](https://github.com/znck). You can [💖 sponsor him](https://github.com/sponsors/znck) for continued development of this package and other VueDX tools.\n\n## Usage\n\n\n\n\n## API\n\n\n\n\n### [ConfiguredVueProject](#-vuedx-analyze-ConfiguredVueProject-class)\n\n\n\n\n Analyze
\nA tool to statically analyze Vue single file components.
\nMore info
\n\n**Signature:**\n```ts\ndeclare class ConfiguredVueProject extends VueProject {\n constructor(rootDir: string, packageFile: string | undefined, packageJSON: Partial\n\n\n\n#### [setFileNames](#-vuedx-analyze-ConfiguredVueProject-setFileNames-member-1-)\n\n\n\n**Signature:**\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n\n### [InferredVueProject](#-vuedx-analyze-InferredVueProject-class)\n\n\n\n
More info
\n\n**Signature:**\n```ts\ndeclare class InferredVueProject extends VueProject {\n kind: \"inferred\";\n protected refresh(): void;\n}\n```\n\n**Members:**\n\n\n\n\n#### [refresh](#-vuedx-analyze-InferredVueProject-refresh-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected refresh(): void;\n```\n\n\n\n
\n\n\n\n\n### [VueProject](#-vuedx-analyze-VueProject-class)\n\n\n\n
More info
\n\n**Signature:**\n```ts\ndeclare abstract class VueProject {\n protected _config: Readonly\n\n\n\n#### [markDirty](#-vuedx-analyze-VueProject-markDirty-member-1-)\n\n\n\n**Signature:**\n```ts\nmarkDirty(): void;\n```\n\n\n
\n\n\n\n#### [refresh](#-vuedx-analyze-VueProject-refresh-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected abstract refresh(): void;\n```\n\n\n
\n\n\n\n#### [reloadIfNeeded](#-vuedx-analyze-VueProject-reloadIfNeeded-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected reloadIfNeeded(): void;\n```\n\n\n
\n\n\n\n#### [setConfig](#-vuedx-analyze-VueProject-setConfig-member-1-)\n\n\n\n**Signature:**\n```ts\nsetConfig(config: ProjectConfig): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| config |
ProjectConfig | - |\n\n\n\n\n\n#### [setFileNames](#-vuedx-analyze-VueProject-setFileNames-member-1-)\n\n\n\n**Signature:**\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n\n### [createAnalyzer](#-vuedx-analyze-createAnalyzer-function-1-)\n\n\n\n
\n): Analyzer;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| plugins |
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createAnalyzer(plugins: Plugin[], options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createFullAnalyzer](#-vuedx-analyze-createFullAnalyzer-function-1-)\n\n\n\n
\n): ReturnType;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| plugins |
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createFullAnalyzer(plugins?: Plugin[], options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createSourceRange](#-vuedx-analyze-createSourceRange-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createSourceRange(context: Context | ScriptAnalyzerContext, node: Node): SourceRange;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| context |Context | ScriptAnalyzerContext | - |\n| node | Node | - |\n\n\n\n\n\n### [toVeturData](#-vuedx-analyze-toVeturData-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function toVeturData(components: ComponentInfo[]): VeturData;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| components |ComponentInfo[] | - |\n\n\n\n\n\n### [toWebTypes](#-vuedx-analyze-toWebTypes-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function toWebTypes(name: string, version: string, components: ComponentInfo[]): WebTypes;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| name |string | - |\n| version | string | - |\n| components | ComponentInfo[] | - |\n\n\n\n\n\n### [transformToFunction](#-vuedx-analyze-transformToFunction-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function transformToFunction(content: string, options?: FunctionTransformOptions): string;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| content |string | - |\n| options | FunctionTransformOptions | - |\n\n\n\n## Types\n\n\n\n\n### [Analyzer](#-vuedx-analyze-Analyzer-interface)\n\n\n\n```ts\ninterface Analyzer {\n analyze(content: string, fileName?: string): ComponentInfo;\n analyzeScript(content: string, fileName?: string, mode?: 'script' | 'scriptSetup'): ComponentInfo;\n analyzeTemplate(content: string, fileName?: string): ComponentInfo;\n}\n```\n\n\n
\n\n\n\n### [ComponentInfo](#-vuedx-analyze-ComponentInfo-interface)\n\n\n\n```ts\ninterface ComponentInfo extends Taggable {\n aliases: string[];\n components: LocalComponentRegistrationInfo[];\n description: string;\n emits: EmitInfo[];\n errors: SyntaxError[];\n fileName: string;\n fnSetupOption?: SetupInfo;\n identifierSource: Record
\n\n\n\n### [ComponentRegistrationInfo](#-vuedx-analyze-ComponentRegistrationInfo-interface)\n\n\n\n```ts\ninterface ComponentRegistrationInfo {\n aliases: string[];\n name: string;\n source: ImportSource;\n}\n```\n\n\n
\n\n\n\n### [EmitInfo](#-vuedx-analyze-EmitInfo-interface)\n\n\n\n```ts\ninterface EmitInfo extends Taggable, Addressable {\n description: string;\n isDynamic: boolean;\n isInferred: boolean;\n name: string;\n references: SourceRange[];\n type: TypeInfo[];\n}\n```\n\n\n
\n\n\n\n### [IdentifierSource](#-vuedx-analyze-IdentifierSource-interface)\n\n\n\n```ts\ninterface IdentifierSource extends Addressable {\n name: string;\n}\n```\n\n\n
\n\n\n\n### [ImportSource](#-vuedx-analyze-ImportSource-interface)\n\n\n\n```ts\ninterface ImportSource {\n exportName?: string;\n localName: string;\n moduleName: string;\n}\n```\n\n\n
\n\n\n\n### [ImportSourceWithLocation](#-vuedx-analyze-ImportSourceWithLocation-interface)\n\n\n\n```ts\ninterface ImportSourceWithLocation extends ImportSource, Addressable {\n}\n```\n\n\n
\n\n\n\n### [LocalComponentRegistrationInfo](#-vuedx-analyze-LocalComponentRegistrationInfo-interface)\n\n\n\n```ts\ninterface LocalComponentRegistrationInfo extends ComponentRegistrationInfo, Addressable {\n kind: 'script' | 'scriptSetup';\n source: ImportSourceWithLocation;\n}\n```\n\n\n
\n\n\n\n### [Plugin](#-vuedx-analyze-Plugin-2-interface)\n\n\n\n```ts\ninterface Plugin {\n babel?: AbstractScriptAnalyzerFn | AbstractAnalyzerHandler;\n blocks?: Partial<{\n script: BlockAnalyzer
\n\n\n\n### [PropInfo](#-vuedx-analyze-PropInfo-interface)\n\n\n\n```ts\ninterface PropInfo extends Taggable, Addressable {\n defaultValue: ValueInfo | null;\n description: string;\n name: string;\n required: boolean;\n type: TypeInfo[];\n}\n```\n\n\n
\n\n\n\n### [ScriptSetupInfo](#-vuedx-analyze-ScriptSetupInfo-interface)\n\n\n\n```ts\ninterface ScriptSetupInfo {\n defineEmit?: Addressable;\n defineProps?: Addressable;\n}\n```\n\n\n
\n\n\n\n### [SetupInfo](#-vuedx-analyze-SetupInfo-interface)\n\n\n\n```ts\ninterface SetupInfo extends Addressable {\n context?: {\n identifiers: Partial<{\n attrs: string;\n slots: string;\n emit: string;\n }>;\n rest?: string;\n } & Addressable;\n props?: {\n identifiers: string[];\n rest?: string;\n } & Addressable;\n return?: Addressable;\n}\n```\n\n\n
\n\n\n\n### [SourceRange](#-vuedx-analyze-SourceRange-interface)\n\n\n\n```ts\ninterface SourceRange {\n end: SourceLocation;\n source: string;\n start: SourceLocation;\n}\n```\n\n\n
\n\n\n\n### [SyntaxError](#-vuedx-analyze-SyntaxError-2-interface)\n\n\n\n```ts\ninterface SyntaxError {\n loc: SourceLocation;\n message: string;\n}\n```\n\n\n
\n\n\n\n### [VeturData](#-vuedx-analyze-VeturData-interface)\n\n\n\n```ts\ninterface VeturData {\n attributes: Record
\n\n\n\n### [WebTypes](#-vuedx-analyze-WebTypes-interface)\n\n\n\n```ts\ninterface WebTypes {\n contributions: {\n 'types-syntax': 'typescript';\n 'description-markup': 'html' | 'markdown' | 'none';\n tags: Tag[];\n attributes: Attribute[];\n };\n framework: 'vue';\n name: string;\n version: string;\n}\n```\n\n\n
\n\n","readmeFilename":"readme.md","_id":"@vuedx/analyze@0.5.1-insiders-1610688008.0","_nodeVersion":"14.14.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-aVUHmhi1PjsBwuqNaJ0yJVL55iGwjZHYydnU9XRQNJMhIS6Oat1wxcciYVPSOt1yajwOWPNG/h2iibRlhLRsGA==","shasum":"fb5d1acb836b542ac9e005d87835bfea790f6443","tarball":"https://registry.npmjs.org/@vuedx/analyze/-/analyze-0.5.1-insiders-1610688008.0.tgz","fileCount":9,"unpackedSize":479813,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgASYnCRA9TVsSAnZWagAAkrMP/3F5pDb4MNAkpV/v8gYr\nAypoSWgoo649EnwgGO5PeY3HxEUnQLK98tmtRk3cErBM2Q3a3m4iGrzsI+9Q\nA2vlo1rMbJc/gHhr9Z1DzBCCgBtQmPyuSdzeyH9Ty/Jh02A31n2Bmd66PI78\nJLXpqkb1DtrJgSQCYooZYvMMKJuzRJjGelB7lk2pBlKlwb47PsaFlic2yj73\ndQNo9HYw7WtWEvS5UznOVTzFEpZhDMulrg43ygsL22Ynlb6s4sTRSGQveufd\nQBXD8bhSeMp06pqlWSTGzj01S2j/MDkxR6XibVt8FrCsBp00r1aUjgqTtziT\nDBgRpO/bkwys1RESue4LFIWleF7w5rx1A+8OP3nrVn5A7vcaQUosD4NmJv83\nKN4zpXkH1I/KWUWu6PdA4RWWEn/yBl7pzDYYk2t+0XHlz3Fp2ABRYOb+eyHl\nXFfovL1pT/NSnyHMZOXjcwHRKC16wdabjU9W/EgmOF8yJ6cjKsuHuEXyOzwY\nR553xSLbi0ea5+uanHXtKV1noDLvErzHBQtxKSyuf7wP4F/ZVn+KeJhR2wVj\nr2NjyMZsaThSQY9bPRi/BN8zRhkJ1WbM804Tv7NQaMnAhxF97riv0Ej1bu0I\nXGpUEKlsYneoOHzd6qM5AKUxD1R7OK72AY/3022HOIeTrLRtwsFCRfu4+CmZ\nex67\r\n=nLu4\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCFbXlYLrZEPPgWp8Axa+btGEeh24O6NwVwvhJmctGUZAIhAOhqyCUE+w4UMrGw3NsHqFfTLw5bMpH4LlATUKNoRn8l"}]},"_npmUser":{"name":"znck","email":"rahulkdn@gmail.com"},"directories":{},"maintainers":[{"name":"znck","email":"rahulkdn@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/analyze_0.5.1-insiders-1610688008.0_1610688038765_0.3715326613947265"},"_hasShrinkwrap":false},"0.5.1-insiders-1610735282.0":{"name":"@vuedx/analyze","version":"0.5.1-insiders-1610735282.0","description":"Extracts public API information from Vue component.","main":"dist/index.cjs.js","module":"dist/index.esm.js","types":"dist/index.d.ts","bin":{"vuedx-analyze":"bin/analyze.js"},"keywords":["vue","sfc","sfc api extractor","static analyzer","sfc analyzer","sfc static analyzer","docgen","documentation"],"repository":{"type":"git","url":"git+https://github.com/znck/vue-developer-experience.git"},"author":{"name":"Rahul Kadyan","email":"rahulkdn@gmail.com","url":"https://znck.me/"},"funding":{"type":"individual","url":"https://github.com/sponsors/znck"},"license":"MIT","bugs":{"url":"https://github.com/znck/vue-developer-experience/issues"},"homepage":"https://github.com/znck/vue-developer-experience#readme","dependencies":{"@babel/code-frame":"^7.10.4","@babel/generator":"^7.12.1","@babel/parser":"^7.12.3","@babel/template":"^7.12.7","@babel/traverse":"7.12.1","@babel/types":"7.12.1","@types/micromatch":"^4.0.1","@vuedx/compiler-sfc":"0.5.1-insiders-1610735282.0","@vuedx/compiler-tsx":"0.5.1-insiders-1610735282.0","@vuedx/projectconfig":"0.5.1-insiders-1610735282.0","@vuedx/template-ast-types":"0.5.1-insiders-1610735282.0","cli-highlight":"^2.1.4","commander":"^6.1.0","fast-glob":"^3.2.4","hash-sum":"^2.0.0","micromatch":"^4.0.2"},"devDependencies":{"@types/babel__traverse":"^7.0.15","@types/node":"^14.14.14","@vuedx/shared":"0.5.1-insiders-1610735282.0","typescript":"^4.0.3"},"readme":"
\n \n
\n\n## Support\n\nThis package is part of [VueDX project](https://github.com/znck/vue-developer-experience), maintained by [Rahul Kadyan](https://github.com/znck). You can [💖 sponsor him](https://github.com/sponsors/znck) for continued development of this package and other VueDX tools.\n\n## Usage\n\n\n\n\n## API\n\n\n\n\n### [ConfiguredVueProject](#-vuedx-analyze-ConfiguredVueProject-class)\n\n\n\n\n Analyze
\nA tool to statically analyze Vue single file components.
\nMore info
\n\n**Signature:**\n```ts\ndeclare class ConfiguredVueProject extends VueProject {\n constructor(rootDir: string, packageFile: string | undefined, packageJSON: Partial\n\n\n\n#### [setFileNames](#-vuedx-analyze-ConfiguredVueProject-setFileNames-member-1-)\n\n\n\n**Signature:**\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n\n### [InferredVueProject](#-vuedx-analyze-InferredVueProject-class)\n\n\n\n
More info
\n\n**Signature:**\n```ts\ndeclare class InferredVueProject extends VueProject {\n kind: \"inferred\";\n protected refresh(): void;\n}\n```\n\n**Members:**\n\n\n\n\n#### [refresh](#-vuedx-analyze-InferredVueProject-refresh-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected refresh(): void;\n```\n\n\n\n
\n\n\n\n\n### [VueProject](#-vuedx-analyze-VueProject-class)\n\n\n\n
More info
\n\n**Signature:**\n```ts\ndeclare abstract class VueProject {\n protected _config: Readonly\n\n\n\n#### [markDirty](#-vuedx-analyze-VueProject-markDirty-member-1-)\n\n\n\n**Signature:**\n```ts\nmarkDirty(): void;\n```\n\n\n
\n\n\n\n#### [refresh](#-vuedx-analyze-VueProject-refresh-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected abstract refresh(): void;\n```\n\n\n
\n\n\n\n#### [reloadIfNeeded](#-vuedx-analyze-VueProject-reloadIfNeeded-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected reloadIfNeeded(): void;\n```\n\n\n
\n\n\n\n#### [setConfig](#-vuedx-analyze-VueProject-setConfig-member-1-)\n\n\n\n**Signature:**\n```ts\nsetConfig(config: ProjectConfig): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| config |
ProjectConfig | - |\n\n\n\n\n\n#### [setFileNames](#-vuedx-analyze-VueProject-setFileNames-member-1-)\n\n\n\n**Signature:**\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n\n### [createAnalyzer](#-vuedx-analyze-createAnalyzer-function-1-)\n\n\n\n
\n): Analyzer;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| plugins |
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createAnalyzer(plugins: Plugin[], options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createFullAnalyzer](#-vuedx-analyze-createFullAnalyzer-function-1-)\n\n\n\n
\n): ReturnType;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| plugins |
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createFullAnalyzer(plugins?: Plugin[], options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createSourceRange](#-vuedx-analyze-createSourceRange-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createSourceRange(context: Context | ScriptAnalyzerContext, node: Node): SourceRange;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| context |Context | ScriptAnalyzerContext | - |\n| node | Node | - |\n\n\n\n\n\n### [toVeturData](#-vuedx-analyze-toVeturData-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function toVeturData(components: ComponentInfo[]): VeturData;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| components |ComponentInfo[] | - |\n\n\n\n\n\n### [toWebTypes](#-vuedx-analyze-toWebTypes-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function toWebTypes(name: string, version: string, components: ComponentInfo[]): WebTypes;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| name |string | - |\n| version | string | - |\n| components | ComponentInfo[] | - |\n\n\n\n\n\n### [transformToFunction](#-vuedx-analyze-transformToFunction-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function transformToFunction(content: string, options?: FunctionTransformOptions): string;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| content |string | - |\n| options | FunctionTransformOptions | - |\n\n\n\n## Types\n\n\n\n\n### [Analyzer](#-vuedx-analyze-Analyzer-interface)\n\n\n\n```ts\ninterface Analyzer {\n analyze(content: string, fileName?: string): ComponentInfo;\n analyzeScript(content: string, fileName?: string, mode?: 'script' | 'scriptSetup'): ComponentInfo;\n analyzeTemplate(content: string, fileName?: string): ComponentInfo;\n}\n```\n\n\n
\n\n\n\n### [ComponentInfo](#-vuedx-analyze-ComponentInfo-interface)\n\n\n\n```ts\ninterface ComponentInfo extends Taggable {\n aliases: string[];\n components: LocalComponentRegistrationInfo[];\n description: string;\n emits: EmitInfo[];\n errors: SyntaxError[];\n fileName: string;\n fnSetupOption?: SetupInfo;\n identifierSource: Record
\n\n\n\n### [ComponentRegistrationInfo](#-vuedx-analyze-ComponentRegistrationInfo-interface)\n\n\n\n```ts\ninterface ComponentRegistrationInfo {\n aliases: string[];\n name: string;\n source: ImportSource;\n}\n```\n\n\n
\n\n\n\n### [EmitInfo](#-vuedx-analyze-EmitInfo-interface)\n\n\n\n```ts\ninterface EmitInfo extends Taggable, Addressable {\n description: string;\n isDynamic: boolean;\n isInferred: boolean;\n name: string;\n references: SourceRange[];\n type: TypeInfo[];\n}\n```\n\n\n
\n\n\n\n### [IdentifierSource](#-vuedx-analyze-IdentifierSource-interface)\n\n\n\n```ts\ninterface IdentifierSource extends Addressable {\n name: string;\n}\n```\n\n\n
\n\n\n\n### [ImportSource](#-vuedx-analyze-ImportSource-interface)\n\n\n\n```ts\ninterface ImportSource {\n exportName?: string;\n localName: string;\n moduleName: string;\n}\n```\n\n\n
\n\n\n\n### [ImportSourceWithLocation](#-vuedx-analyze-ImportSourceWithLocation-interface)\n\n\n\n```ts\ninterface ImportSourceWithLocation extends ImportSource, Addressable {\n}\n```\n\n\n
\n\n\n\n### [LocalComponentRegistrationInfo](#-vuedx-analyze-LocalComponentRegistrationInfo-interface)\n\n\n\n```ts\ninterface LocalComponentRegistrationInfo extends ComponentRegistrationInfo, Addressable {\n kind: 'script' | 'scriptSetup';\n source: ImportSourceWithLocation;\n}\n```\n\n\n
\n\n\n\n### [Plugin](#-vuedx-analyze-Plugin-2-interface)\n\n\n\n```ts\ninterface Plugin {\n babel?: AbstractScriptAnalyzerFn | AbstractAnalyzerHandler;\n blocks?: Partial<{\n script: BlockAnalyzer
\n\n\n\n### [PropInfo](#-vuedx-analyze-PropInfo-interface)\n\n\n\n```ts\ninterface PropInfo extends Taggable, Addressable {\n defaultValue: ValueInfo | null;\n description: string;\n name: string;\n required: boolean;\n type: TypeInfo[];\n}\n```\n\n\n
\n\n\n\n### [ScriptSetupInfo](#-vuedx-analyze-ScriptSetupInfo-interface)\n\n\n\n```ts\ninterface ScriptSetupInfo {\n defineEmit?: Addressable;\n defineProps?: Addressable;\n}\n```\n\n\n
\n\n\n\n### [SetupInfo](#-vuedx-analyze-SetupInfo-interface)\n\n\n\n```ts\ninterface SetupInfo extends Addressable {\n context?: {\n identifiers: Partial<{\n attrs: string;\n slots: string;\n emit: string;\n }>;\n rest?: string;\n } & Addressable;\n props?: {\n identifiers: string[];\n rest?: string;\n } & Addressable;\n return?: Addressable;\n}\n```\n\n\n
\n\n\n\n### [SourceRange](#-vuedx-analyze-SourceRange-interface)\n\n\n\n```ts\ninterface SourceRange {\n end: SourceLocation;\n source: string;\n start: SourceLocation;\n}\n```\n\n\n
\n\n\n\n### [SyntaxError](#-vuedx-analyze-SyntaxError-2-interface)\n\n\n\n```ts\ninterface SyntaxError {\n loc: SourceLocation;\n message: string;\n}\n```\n\n\n
\n\n\n\n### [VeturData](#-vuedx-analyze-VeturData-interface)\n\n\n\n```ts\ninterface VeturData {\n attributes: Record
\n\n\n\n### [WebTypes](#-vuedx-analyze-WebTypes-interface)\n\n\n\n```ts\ninterface WebTypes {\n contributions: {\n 'types-syntax': 'typescript';\n 'description-markup': 'html' | 'markdown' | 'none';\n tags: Tag[];\n attributes: Attribute[];\n };\n framework: 'vue';\n name: string;\n version: string;\n}\n```\n\n\n
\n\n","readmeFilename":"readme.md","_id":"@vuedx/analyze@0.5.1-insiders-1610735282.0","_nodeVersion":"14.14.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-uEoXX076oHMgZvAvQ+abKejkBQmbXGVTtqzzHK17WOOmpNFNz6D7rA+GgzynfaFdAQ92WfRmwC87BlQtKfQDFA==","shasum":"126c42df813e638c828028c0b761c28eeaccf9ea","tarball":"https://registry.npmjs.org/@vuedx/analyze/-/analyze-0.5.1-insiders-1610735282.0.tgz","fileCount":9,"unpackedSize":479813,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgAd7MCRA9TVsSAnZWagAAllMP/0ifneD2NKy9Z+JjqmHT\n+lFxyUboM4EOuVHjEoQjlW2CZr/n6EED+wQVnkWSUk6U9bfqW85f9oyWiQRp\nZQUPVDo8UiXZZn77qCsyKT53cHQt2Jw8cHpdukSRzzsWkDQ99F3Dy7WMVjB2\n+KvR2orf5Q6Bm3xN9j8ahhbWXWLT7jm1BzLdBy03lRgss4pwwNuXAvrqmbyH\nzamMv3BdPQLrTpez7hNkYCk9DljScFDD+3j4G5uHBNzkLJOIdZyeE8MbRqIu\nsNFe+YVll5J6UrEk9DN9ov2VgvMHTndQ5xmO6EncjdFod0sDo7G0rlAIfp97\nSq2aJByRDGLpolvZNstOPIwcltRlkO3H2T6rapKIITGfjyOekSPNhZC3ACoI\n755JJwh0tHVZQRhJ4LosmIeHhui2oY0iMx5WGhJrNHA2Mycv0fNsnzS6qw8K\nv9LYAhFlKY3vvb97qKLeUmH3g1QZiXBiAyio0Qfs5QyuYquuymaSQrdqp45/\nDA/50jU2BIixxAaKgnI34ZuoSfvm3Q7knGEfBoa74lU85bb8T1yxKGIAHQFw\nyL6MawPO+1r21jWvUaMQ3vALsXoKP1KsuhIMTNcp4rIXYiqpYOOV36ZJb+GV\nMv7CtLzpXl5MG65Uu8HE6pSsUGq6uXmTSz5jDClQ5Y1saskKV6z4Kx6PIRGz\nEVW4\r\n=8iLf\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQD93LNGxhpodPWezR9wS5QVoPxsfhsO1c33HwlcIhrO7QIhANXXLeU/d9sBdFIs582jqHokUu9SU+ybDHj4FH4uwAvL"}]},"_npmUser":{"name":"znck","email":"rahulkdn@gmail.com"},"directories":{},"maintainers":[{"name":"znck","email":"rahulkdn@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/analyze_0.5.1-insiders-1610735282.0_1610735308318_0.4210078808078481"},"_hasShrinkwrap":false},"0.5.1-insiders-1610828338.0":{"name":"@vuedx/analyze","version":"0.5.1-insiders-1610828338.0","description":"Extracts public API information from Vue component.","main":"dist/index.cjs.js","module":"dist/index.esm.js","types":"dist/index.d.ts","bin":{"vuedx-analyze":"bin/analyze.js"},"keywords":["vue","sfc","sfc api extractor","static analyzer","sfc analyzer","sfc static analyzer","docgen","documentation"],"repository":{"type":"git","url":"git+https://github.com/znck/vue-developer-experience.git"},"author":{"name":"Rahul Kadyan","email":"rahulkdn@gmail.com","url":"https://znck.me/"},"funding":{"type":"individual","url":"https://github.com/sponsors/znck"},"license":"MIT","bugs":{"url":"https://github.com/znck/vue-developer-experience/issues"},"homepage":"https://github.com/znck/vue-developer-experience#readme","dependencies":{"@babel/code-frame":"^7.10.4","@babel/generator":"^7.12.1","@babel/parser":"^7.12.3","@babel/template":"^7.12.7","@babel/traverse":"7.12.1","@babel/types":"7.12.1","@types/micromatch":"^4.0.1","@vuedx/compiler-sfc":"0.5.1-insiders-1610828338.0","@vuedx/compiler-tsx":"0.5.1-insiders-1610828338.0","@vuedx/projectconfig":"0.5.1-insiders-1610828338.0","@vuedx/template-ast-types":"0.5.1-insiders-1610828338.0","cli-highlight":"^2.1.4","commander":"^6.1.0","fast-glob":"^3.2.4","hash-sum":"^2.0.0","@vuedx/shared":"0.5.1-insiders-1610828338.0","micromatch":"^4.0.2"},"devDependencies":{"@types/babel__traverse":"^7.0.15","@types/node":"^14.14.14","typescript":"^4.0.3"},"readme":"
\n \n
\n\n## Support\n\nThis package is part of [VueDX project](https://github.com/znck/vue-developer-experience), maintained by [Rahul Kadyan](https://github.com/znck). You can [💖 sponsor him](https://github.com/sponsors/znck) for continued development of this package and other VueDX tools.\n\n## Usage\n\n\n\n\n## API\n\n\n\n\n### [ConfiguredVueProject](#-vuedx-analyze-ConfiguredVueProject-class)\n\n\n\n\n Analyze
\nA tool to statically analyze Vue single file components.
\nMore info
\n\n**Signature:**\n```ts\ndeclare class ConfiguredVueProject extends VueProject {\n constructor(rootDir: string, packageFile: string | undefined, packageJSON: Partial\n\n\n\n#### [setFileNames](#-vuedx-analyze-ConfiguredVueProject-setFileNames-member-1-)\n\n\n\n**Signature:**\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n\n### [InferredVueProject](#-vuedx-analyze-InferredVueProject-class)\n\n\n\n
More info
\n\n**Signature:**\n```ts\ndeclare class InferredVueProject extends VueProject {\n kind: \"inferred\";\n protected refresh(): void;\n}\n```\n\n**Members:**\n\n\n\n\n#### [refresh](#-vuedx-analyze-InferredVueProject-refresh-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected refresh(): void;\n```\n\n\n\n
\n\n\n\n\n### [VueProject](#-vuedx-analyze-VueProject-class)\n\n\n\n
More info
\n\n**Signature:**\n```ts\ndeclare abstract class VueProject {\n protected _config: Readonly\n\n\n\n#### [markDirty](#-vuedx-analyze-VueProject-markDirty-member-1-)\n\n\n\n**Signature:**\n```ts\nmarkDirty(): void;\n```\n\n\n
\n\n\n\n#### [refresh](#-vuedx-analyze-VueProject-refresh-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected abstract refresh(): void;\n```\n\n\n
\n\n\n\n#### [reloadIfNeeded](#-vuedx-analyze-VueProject-reloadIfNeeded-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected reloadIfNeeded(): void;\n```\n\n\n
\n\n\n\n#### [setConfig](#-vuedx-analyze-VueProject-setConfig-member-1-)\n\n\n\n**Signature:**\n```ts\nsetConfig(config: ProjectConfig): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| config |
ProjectConfig | - |\n\n\n\n\n\n#### [setFileNames](#-vuedx-analyze-VueProject-setFileNames-member-1-)\n\n\n\n**Signature:**\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n\n### [createAnalyzer](#-vuedx-analyze-createAnalyzer-function-1-)\n\n\n\n
\n): Analyzer;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| plugins |
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createAnalyzer(plugins: Plugin[], options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createFullAnalyzer](#-vuedx-analyze-createFullAnalyzer-function-1-)\n\n\n\n
\n): ReturnType;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| plugins |
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createFullAnalyzer(plugins?: Plugin[], options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createSourceRange](#-vuedx-analyze-createSourceRange-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createSourceRange(context: Context | ScriptAnalyzerContext, node: Node): SourceRange;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| context |Context | ScriptAnalyzerContext | - |\n| node | Node | - |\n\n\n\n\n\n### [toVeturData](#-vuedx-analyze-toVeturData-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function toVeturData(components: ComponentInfo[]): VeturData;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| components |ComponentInfo[] | - |\n\n\n\n\n\n### [toWebTypes](#-vuedx-analyze-toWebTypes-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function toWebTypes(name: string, version: string, components: ComponentInfo[]): WebTypes;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| name |string | - |\n| version | string | - |\n| components | ComponentInfo[] | - |\n\n\n\n\n\n### [transformToFunction](#-vuedx-analyze-transformToFunction-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function transformToFunction(content: string, options?: FunctionTransformOptions): string;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| content |string | - |\n| options | FunctionTransformOptions | - |\n\n\n\n## Types\n\n\n\n\n### [Analyzer](#-vuedx-analyze-Analyzer-interface)\n\n\n\n```ts\ninterface Analyzer {\n analyze(content: string, fileName?: string): ComponentInfo;\n analyzeScript(content: string, fileName?: string, mode?: 'script' | 'scriptSetup'): ComponentInfo;\n analyzeTemplate(content: string, fileName?: string): ComponentInfo;\n}\n```\n\n\n
\n\n\n\n### [ComponentInfo](#-vuedx-analyze-ComponentInfo-interface)\n\n\n\n```ts\ninterface ComponentInfo extends Taggable {\n aliases: string[];\n components: LocalComponentRegistrationInfo[];\n description: string;\n emits: EmitInfo[];\n errors: SyntaxError[];\n fileName: string;\n fnSetupOption?: SetupInfo;\n identifierSource: Record
\n\n\n\n### [ComponentRegistrationInfo](#-vuedx-analyze-ComponentRegistrationInfo-interface)\n\n\n\n```ts\ninterface ComponentRegistrationInfo {\n aliases: string[];\n name: string;\n source: ImportSource;\n}\n```\n\n\n
\n\n\n\n### [EmitInfo](#-vuedx-analyze-EmitInfo-interface)\n\n\n\n```ts\ninterface EmitInfo extends Taggable, Addressable {\n description: string;\n isDynamic: boolean;\n isInferred: boolean;\n name: string;\n references: SourceRange[];\n type: TypeInfo[];\n}\n```\n\n\n
\n\n\n\n### [IdentifierSource](#-vuedx-analyze-IdentifierSource-interface)\n\n\n\n```ts\ninterface IdentifierSource extends Addressable {\n name: string;\n}\n```\n\n\n
\n\n\n\n### [ImportSource](#-vuedx-analyze-ImportSource-interface)\n\n\n\n```ts\ninterface ImportSource {\n exportName?: string;\n localName: string;\n moduleName: string;\n}\n```\n\n\n
\n\n\n\n### [ImportSourceWithLocation](#-vuedx-analyze-ImportSourceWithLocation-interface)\n\n\n\n```ts\ninterface ImportSourceWithLocation extends ImportSource, Addressable {\n}\n```\n\n\n
\n\n\n\n### [LocalComponentRegistrationInfo](#-vuedx-analyze-LocalComponentRegistrationInfo-interface)\n\n\n\n```ts\ninterface LocalComponentRegistrationInfo extends ComponentRegistrationInfo, Addressable {\n kind: 'script' | 'scriptSetup';\n source: ImportSourceWithLocation;\n}\n```\n\n\n
\n\n\n\n### [Plugin](#-vuedx-analyze-Plugin-2-interface)\n\n\n\n```ts\ninterface Plugin {\n babel?: AbstractScriptAnalyzerFn | AbstractAnalyzerHandler;\n blocks?: Partial<{\n script: BlockAnalyzer
\n\n\n\n### [PropInfo](#-vuedx-analyze-PropInfo-interface)\n\n\n\n```ts\ninterface PropInfo extends Taggable, Addressable {\n defaultValue: ValueInfo | null;\n description: string;\n name: string;\n required: boolean;\n type: TypeInfo[];\n}\n```\n\n\n
\n\n\n\n### [ScriptSetupInfo](#-vuedx-analyze-ScriptSetupInfo-interface)\n\n\n\n```ts\ninterface ScriptSetupInfo {\n defineEmit?: Addressable;\n defineProps?: Addressable;\n}\n```\n\n\n
\n\n\n\n### [SetupInfo](#-vuedx-analyze-SetupInfo-interface)\n\n\n\n```ts\ninterface SetupInfo extends Addressable {\n context?: {\n identifiers: Partial<{\n attrs: string;\n slots: string;\n emit: string;\n }>;\n rest?: string;\n } & Addressable;\n props?: {\n identifiers: string[];\n rest?: string;\n } & Addressable;\n return?: Addressable;\n}\n```\n\n\n
\n\n\n\n### [SourceRange](#-vuedx-analyze-SourceRange-interface)\n\n\n\n```ts\ninterface SourceRange {\n end: SourceLocation;\n source: string;\n start: SourceLocation;\n}\n```\n\n\n
\n\n\n\n### [SyntaxError](#-vuedx-analyze-SyntaxError-2-interface)\n\n\n\n```ts\ninterface SyntaxError {\n loc: SourceLocation;\n message: string;\n}\n```\n\n\n
\n\n\n\n### [VeturData](#-vuedx-analyze-VeturData-interface)\n\n\n\n```ts\ninterface VeturData {\n attributes: Record
\n\n\n\n### [WebTypes](#-vuedx-analyze-WebTypes-interface)\n\n\n\n```ts\ninterface WebTypes {\n contributions: {\n 'types-syntax': 'typescript';\n 'description-markup': 'html' | 'markdown' | 'none';\n tags: Tag[];\n attributes: Attribute[];\n };\n framework: 'vue';\n name: string;\n version: string;\n}\n```\n\n\n
\n\n","readmeFilename":"readme.md","_id":"@vuedx/analyze@0.5.1-insiders-1610828338.0","_nodeVersion":"14.14.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-S7jWNrgyGUw105L5UpIpSNTpHOHowkCkcFM31a7KTbEUWLH1ULhZgu8QIwI8mgFnfRDDoabgzm29K6bk4D5+mA==","shasum":"a14a65208482da1cdb036f3baffd60c72c494fd7","tarball":"https://registry.npmjs.org/@vuedx/analyze/-/analyze-0.5.1-insiders-1610828338.0.tgz","fileCount":9,"unpackedSize":466500,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgA0pRCRA9TVsSAnZWagAAycMP/AtEvQM1cUg5VseqSAwV\niGOO3U3IUAs3BXNdvIsKF4hkaeZllAEMzX9CWFaOsAkwPccmU21pHT1D1Jm8\nxzeo1Kn4oqFJDyku2n3i0C0sc62mJ72cLpnV78IhsvcwOt1+WX6Q8oPi/ajU\nnlIfsSVmgUubuK8K0oOcGnmHsTjW5rBLZ9trcSjRZQMZtZZxDNSFkDJ2RN8V\nvm0iPFlG6lsoduWWPli7psK2ysmBaZcz9J7yFBfFucoj1anJbXIgsxoOrqeq\nS5uHhOxDFFWFV5qXTPr4Mn3TZsm8QPt9hOfcUvZoT6OnYkCw6KlT+ahbesk0\nogf0sfB/wsvXVDwcSCaVmp0MquWwn+qnwWf8HnWIUBhiA0TXEk0JNS8TyQ0S\n7vejTjzqTyFGW4dYVLMP056gFJlE3yN6wvEckKGaxZX6LJc+PZBecl+XEq8e\n44iLEy2VlN41u/Uoai/393RzM224jv3De7Sf5dmyJbHQAi7gygO82WFrVR5B\ndnJFTenkVmjUcUAkj+jtgjADo/hAAazw2dfh2s312BWfmDwg9De0oPUGVe2W\n99E99jm4UmMJZFNBJrRWFIPODuDqYuYJkQrypPT+Jx+7KcW5uCNtPMG4nEhG\nxe6Bv2bEle07byiAusPbNwepd9UBIRm1xfoiFOQpOQhJkKEAfO1Fu4mdDqU8\nltai\r\n=9NaE\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIByfTWjtjvQSselrzrKcrWBctLdG7geFflXqGb9WjBWTAiAlLOHw8EjeFdXUljke/Scm85pmDHcwtdQp+LFhuJxbGg=="}]},"_npmUser":{"name":"znck","email":"rahulkdn@gmail.com"},"directories":{},"maintainers":[{"name":"znck","email":"rahulkdn@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/analyze_0.5.1-insiders-1610828338.0_1610828369117_0.32996881564334957"},"_hasShrinkwrap":false},"0.6.1-insiders-1610883378.0":{"name":"@vuedx/analyze","version":"0.6.1-insiders-1610883378.0","description":"Extracts public API information from Vue component.","main":"dist/index.cjs.js","module":"dist/index.esm.js","types":"dist/index.d.ts","bin":{"vuedx-analyze":"bin/analyze.js"},"keywords":["vue","sfc","sfc api extractor","static analyzer","sfc analyzer","sfc static analyzer","docgen","documentation"],"repository":{"type":"git","url":"git+https://github.com/znck/vue-developer-experience.git"},"author":{"name":"Rahul Kadyan","email":"rahulkdn@gmail.com","url":"https://znck.me/"},"funding":{"type":"individual","url":"https://github.com/sponsors/znck"},"license":"MIT","bugs":{"url":"https://github.com/znck/vue-developer-experience/issues"},"homepage":"https://github.com/znck/vue-developer-experience#readme","dependencies":{"@babel/code-frame":"^7.10.4","@babel/generator":"^7.12.1","@babel/parser":"^7.12.3","@babel/template":"^7.12.7","@babel/traverse":"7.12.1","@babel/types":"7.12.1","@types/micromatch":"^4.0.1","@vuedx/compiler-sfc":"0.6.1-insiders-1610883378.0","@vuedx/compiler-tsx":"0.6.1-insiders-1610883378.0","@vuedx/projectconfig":"0.6.1-insiders-1610883378.0","@vuedx/template-ast-types":"0.6.1-insiders-1610883378.0","cli-highlight":"^2.1.4","commander":"^6.1.0","fast-glob":"^3.2.4","hash-sum":"^2.0.0","@vuedx/shared":"0.6.1-insiders-1610883378.0","micromatch":"^4.0.2"},"devDependencies":{"@types/babel__traverse":"^7.0.15","@types/node":"^14.14.14","typescript":"^4.0.3"},"readme":"
\n \n
\n\n## Support\n\nThis package is part of [VueDX project](https://github.com/znck/vue-developer-experience), maintained by [Rahul Kadyan](https://github.com/znck). You can [💖 sponsor him](https://github.com/sponsors/znck) for continued development of this package and other VueDX tools.\n\n## Usage\n\n\n\n\n## API\n\n\n\n\n### [ConfiguredVueProject](#-vuedx-analyze-ConfiguredVueProject-class)\n\n\n\n\n Analyze
\nA tool to statically analyze Vue single file components.
\nMore info
\n\n**Signature:**\n```ts\ndeclare class ConfiguredVueProject extends VueProject {\n constructor(rootDir: string, packageFile: string | undefined, packageJSON: Partial\n\n\n\n#### [setFileNames](#-vuedx-analyze-ConfiguredVueProject-setFileNames-member-1-)\n\n\n\n**Signature:**\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n\n### [InferredVueProject](#-vuedx-analyze-InferredVueProject-class)\n\n\n\n
More info
\n\n**Signature:**\n```ts\ndeclare class InferredVueProject extends VueProject {\n kind: \"inferred\";\n protected refresh(): void;\n}\n```\n\n**Members:**\n\n\n\n\n#### [refresh](#-vuedx-analyze-InferredVueProject-refresh-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected refresh(): void;\n```\n\n\n\n
\n\n\n\n\n### [VueProject](#-vuedx-analyze-VueProject-class)\n\n\n\n
More info
\n\n**Signature:**\n```ts\ndeclare abstract class VueProject {\n protected _config: Readonly\n\n\n\n#### [markDirty](#-vuedx-analyze-VueProject-markDirty-member-1-)\n\n\n\n**Signature:**\n```ts\nmarkDirty(): void;\n```\n\n\n
\n\n\n\n#### [refresh](#-vuedx-analyze-VueProject-refresh-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected abstract refresh(): void;\n```\n\n\n
\n\n\n\n#### [reloadIfNeeded](#-vuedx-analyze-VueProject-reloadIfNeeded-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected reloadIfNeeded(): void;\n```\n\n\n
\n\n\n\n#### [setConfig](#-vuedx-analyze-VueProject-setConfig-member-1-)\n\n\n\n**Signature:**\n```ts\nsetConfig(config: ProjectConfig): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| config |
ProjectConfig | - |\n\n\n\n\n\n#### [setFileNames](#-vuedx-analyze-VueProject-setFileNames-member-1-)\n\n\n\n**Signature:**\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n\n### [createAnalyzer](#-vuedx-analyze-createAnalyzer-function-1-)\n\n\n\n
\n): Analyzer;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| plugins |
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createAnalyzer(plugins: Plugin[], options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createFullAnalyzer](#-vuedx-analyze-createFullAnalyzer-function-1-)\n\n\n\n
\n): ReturnType;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| plugins |
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createFullAnalyzer(plugins?: Plugin[], options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createSourceRange](#-vuedx-analyze-createSourceRange-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createSourceRange(context: Context | ScriptAnalyzerContext, node: Node): SourceRange;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| context |Context | ScriptAnalyzerContext | - |\n| node | Node | - |\n\n\n\n\n\n### [toVeturData](#-vuedx-analyze-toVeturData-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function toVeturData(components: ComponentInfo[]): VeturData;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| components |ComponentInfo[] | - |\n\n\n\n\n\n### [toWebTypes](#-vuedx-analyze-toWebTypes-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function toWebTypes(name: string, version: string, components: ComponentInfo[]): WebTypes;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| name |string | - |\n| version | string | - |\n| components | ComponentInfo[] | - |\n\n\n\n\n\n### [transformToFunction](#-vuedx-analyze-transformToFunction-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function transformToFunction(content: string, options?: FunctionTransformOptions): string;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| content |string | - |\n| options | FunctionTransformOptions | - |\n\n\n\n## Types\n\n\n\n\n### [Analyzer](#-vuedx-analyze-Analyzer-interface)\n\n\n\n```ts\ninterface Analyzer {\n analyze(content: string, fileName?: string): ComponentInfo;\n analyzeScript(content: string, fileName?: string, mode?: 'script' | 'scriptSetup'): ComponentInfo;\n analyzeTemplate(content: string, fileName?: string): ComponentInfo;\n}\n```\n\n\n
\n\n\n\n### [ComponentInfo](#-vuedx-analyze-ComponentInfo-interface)\n\n\n\n```ts\ninterface ComponentInfo extends Taggable {\n aliases: string[];\n components: LocalComponentRegistrationInfo[];\n description: string;\n emits: EmitInfo[];\n errors: SyntaxError[];\n fileName: string;\n fnSetupOption?: SetupInfo;\n identifierSource: Record
\n\n\n\n### [ComponentRegistrationInfo](#-vuedx-analyze-ComponentRegistrationInfo-interface)\n\n\n\n```ts\ninterface ComponentRegistrationInfo {\n aliases: string[];\n name: string;\n source: ImportSource;\n}\n```\n\n\n
\n\n\n\n### [EmitInfo](#-vuedx-analyze-EmitInfo-interface)\n\n\n\n```ts\ninterface EmitInfo extends Taggable, Addressable {\n description: string;\n isDynamic: boolean;\n isInferred: boolean;\n name: string;\n references: SourceRange[];\n type: TypeInfo[];\n}\n```\n\n\n
\n\n\n\n### [IdentifierSource](#-vuedx-analyze-IdentifierSource-interface)\n\n\n\n```ts\ninterface IdentifierSource extends Addressable {\n name: string;\n}\n```\n\n\n
\n\n\n\n### [ImportSource](#-vuedx-analyze-ImportSource-interface)\n\n\n\n```ts\ninterface ImportSource {\n exportName?: string;\n localName: string;\n moduleName: string;\n}\n```\n\n\n
\n\n\n\n### [ImportSourceWithLocation](#-vuedx-analyze-ImportSourceWithLocation-interface)\n\n\n\n```ts\ninterface ImportSourceWithLocation extends ImportSource, Addressable {\n}\n```\n\n\n
\n\n\n\n### [LocalComponentRegistrationInfo](#-vuedx-analyze-LocalComponentRegistrationInfo-interface)\n\n\n\n```ts\ninterface LocalComponentRegistrationInfo extends ComponentRegistrationInfo, Addressable {\n kind: 'script' | 'scriptSetup';\n source: ImportSourceWithLocation;\n}\n```\n\n\n
\n\n\n\n### [Plugin](#-vuedx-analyze-Plugin-2-interface)\n\n\n\n```ts\ninterface Plugin {\n babel?: AbstractScriptAnalyzerFn | AbstractAnalyzerHandler;\n blocks?: Partial<{\n script: BlockAnalyzer
\n\n\n\n### [PropInfo](#-vuedx-analyze-PropInfo-interface)\n\n\n\n```ts\ninterface PropInfo extends Taggable, Addressable {\n defaultValue: ValueInfo | null;\n description: string;\n name: string;\n required: boolean;\n type: TypeInfo[];\n}\n```\n\n\n
\n\n\n\n### [ScriptSetupInfo](#-vuedx-analyze-ScriptSetupInfo-interface)\n\n\n\n```ts\ninterface ScriptSetupInfo {\n defineEmit?: Addressable;\n defineProps?: Addressable;\n}\n```\n\n\n
\n\n\n\n### [SetupInfo](#-vuedx-analyze-SetupInfo-interface)\n\n\n\n```ts\ninterface SetupInfo extends Addressable {\n context?: {\n identifiers: Partial<{\n attrs: string;\n slots: string;\n emit: string;\n }>;\n rest?: string;\n } & Addressable;\n props?: {\n identifiers: string[];\n rest?: string;\n } & Addressable;\n return?: Addressable;\n}\n```\n\n\n
\n\n\n\n### [SourceRange](#-vuedx-analyze-SourceRange-interface)\n\n\n\n```ts\ninterface SourceRange {\n end: SourceLocation;\n source: string;\n start: SourceLocation;\n}\n```\n\n\n
\n\n\n\n### [SyntaxError](#-vuedx-analyze-SyntaxError-2-interface)\n\n\n\n```ts\ninterface SyntaxError {\n loc: SourceLocation;\n message: string;\n}\n```\n\n\n
\n\n\n\n### [VeturData](#-vuedx-analyze-VeturData-interface)\n\n\n\n```ts\ninterface VeturData {\n attributes: Record
\n\n\n\n### [WebTypes](#-vuedx-analyze-WebTypes-interface)\n\n\n\n```ts\ninterface WebTypes {\n contributions: {\n 'types-syntax': 'typescript';\n 'description-markup': 'html' | 'markdown' | 'none';\n tags: Tag[];\n attributes: Attribute[];\n };\n framework: 'vue';\n name: string;\n version: string;\n}\n```\n\n\n
\n\n","readmeFilename":"readme.md","_id":"@vuedx/analyze@0.6.1-insiders-1610883378.0","_nodeVersion":"14.14.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-nJ7Cz57kxl3BhrVYaw+7fNKXmsHwMJIHGTC+kFifvD4vcH/DeKaAy2FHfKByaS5OprYiJUzYIJga9Lk2Dsp/uw==","shasum":"4a35c111f0cf6e822ce828e4b2b7c52820e1acc6","tarball":"https://registry.npmjs.org/@vuedx/analyze/-/analyze-0.6.1-insiders-1610883378.0.tgz","fileCount":9,"unpackedSize":467826,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgBCFPCRA9TVsSAnZWagAAspMQAJ5K66XZon4QdUOs5EBT\nTVq2aoXx6hTlHB4L2SuOtl3lRW9z2E8f1yGAl2jdrZW/ok1p/GLWoaoY3d3y\nPfhAsgZsJOGABXI8UIBY9oDayp5peYiugoCmIhAEut5NP/Agie+Pq3s4snMw\nMAeIKlyVsUu4V8/VeveesqlUsL26sW+FvlBPmKU5EAfDTSpYfv0yIHIk2USS\nr8b3HMtlW8Wwi/BpMgDo1Wr8wFqFSU+q4CyL9w3Z8sxSgDSDJyJfo0vBoLDe\nobS7nt73vnaZe7PKRi/X++1Jlki/OD+n2I1MJujGgFZ/KEkfiE1rwtMnMFVD\nb089QNp3twfSPAaoqQqzS+/dhcANxpFrRASZZN6xx3CYiP30tb7VJb4qAzc7\n2DKwxrLD+0SMrZ3G6AY0yvfVstr0y3oUNTPTCoJ3JzFpHpOXOTFvbDSkyOAp\n95gApEGKxsrfK036+Vfx+pSaag1o1wMIbi8Hh5YjquDgIz70Ejg5bL6hIwsh\nm5LSz1SFBQVigQaJlAIc4MZmgfEfZF+1Oq4MqGGoXse0MzelnImz8tYT0EFY\nuV6lTSJ2Ergsx3T1Lt5I4P7bVw+IVzQqQB+RzMB2F1iUWHPbpQe+V+f8VgBm\nvj8rrAoP5A1JgoQK1agN1QOZmhOrRqXKkFJGvXiNxTbxmbGPQDB25HiRNngk\na/N0\r\n=HyTl\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCICWelehy1h/C8DHgm4OYYc5TyQvTOKnR6aj9/iLtrKS2AiBnFmMMuZTTtfNDtV8hxWCXblDV5QPejkvb6aQfNBoljg=="}]},"_npmUser":{"name":"znck","email":"rahulkdn@gmail.com"},"directories":{},"maintainers":[{"name":"znck","email":"rahulkdn@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/analyze_0.6.1-insiders-1610883378.0_1610883407549_0.8528540671663412"},"_hasShrinkwrap":false},"0.6.0":{"name":"@vuedx/analyze","version":"0.6.0","description":"Extracts public API information from Vue component.","main":"dist/index.cjs.js","module":"dist/index.esm.js","types":"dist/index.d.ts","bin":{"vuedx-analyze":"bin/analyze.js"},"keywords":["vue","sfc","sfc api extractor","static analyzer","sfc analyzer","sfc static analyzer","docgen","documentation"],"repository":{"type":"git","url":"git+https://github.com/znck/vue-developer-experience.git"},"author":{"name":"Rahul Kadyan","email":"rahulkdn@gmail.com","url":"https://znck.me/"},"funding":{"type":"individual","url":"https://github.com/sponsors/znck"},"license":"MIT","bugs":{"url":"https://github.com/znck/vue-developer-experience/issues"},"homepage":"https://github.com/znck/vue-developer-experience#readme","dependencies":{"@babel/code-frame":"^7.10.4","@babel/generator":"^7.12.1","@babel/parser":"^7.12.3","@babel/template":"^7.12.7","@babel/traverse":"7.12.1","@babel/types":"7.12.1","@types/micromatch":"^4.0.1","@vuedx/compiler-sfc":"0.6.0","@vuedx/compiler-tsx":"0.6.0","@vuedx/projectconfig":"0.6.0","@vuedx/template-ast-types":"0.6.0","cli-highlight":"^2.1.4","commander":"^6.1.0","fast-glob":"^3.2.4","hash-sum":"^2.0.0","@vuedx/shared":"0.6.0","micromatch":"^4.0.2"},"devDependencies":{"@types/babel__traverse":"^7.0.15","@types/node":"^14.14.14","typescript":"^4.0.3"},"_id":"@vuedx/analyze@0.6.0","_nodeVersion":"14.14.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-zq1d6PSQslESD8P1o0SejIjEWSnOLeWHfaWWW55oIVzMFseWiJKU56azn4nGA8gsb2goF2DPpbf74z1ZF4xrjg==","shasum":"93e1136e5259cb5ffc6b714cd5ffe63b70e89fb8","tarball":"https://registry.npmjs.org/@vuedx/analyze/-/analyze-0.6.0.tgz","fileCount":9,"unpackedSize":467694,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgBCHlCRA9TVsSAnZWagAAtvoP/222E5xufhGXkqvtTAi6\nJ+zyB+nP1BrabWPbLh5Pcw1+HnbQEji/SQXZM0uLijXc6xltNwuO0jgOS433\nThaG7g2NWL3sXhmDcN9Ll60DyT6ZSyh9ccIb8tkNXbPGdo75vuO7V2zi2SWt\nDXNjCKcoH2lZAKtPKR61REc3HSXG0q7ydsYxf+zfj7fyBpLjVD6RTgcdGnWv\nTzPXPK2TYTiKqa+5adChjGYTRnwMhYU2sj2aYfShQds38MnZy8dJMrE31czh\nlG50A7Ez3Vn6bV0vaCa6+mmnydkj5SgtpfB7lxu9EPcX95+f5xGnmWnGD78M\nu6t6WgZRt5XAjOtajK3WA4liTD7Tm7XjBH8Ypznf70QUBYu++ymCTolPK7UR\nfdqp8QQUY/9ncoZUvSINcAaAD5ELzqgl5HNBkv6ZAH/+4EbdZOIRv4tS5y/r\nUZJ6dga5S+AlgnpCYxwrLdfj/8FnKp+dE6zFw1Yyf8tObtiXSb6SXGqniG/g\nYfwqkaIuvLFvTYvzmwQAL+ADjakS240E9M6lteDMhn9RURb7n/6OqP+pXszG\nHndT0mkkCozMJ3b7+/4igaTQPSsYL5Ow9BolvnCyq2VhxHZEjDUPM9qvgCiL\nKiTe7ofVNhRUCsV7pyo3evQfkXt59SBXD1YIGZul2Q7l27SDDLbLldeKNLhG\nTzk0\r\n=7XDK\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDdPN33O5A849beXkLr3HbZAw0G6u2Rss0WN+q8Yeva8wIgd6VsHUnX2KRkjgIVvOKAuWo8/u/QUP0l442Wj7IyAds="}]},"_npmUser":{"name":"znck","email":"rahulkdn@gmail.com"},"directories":{},"maintainers":[{"name":"znck","email":"rahulkdn@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/analyze_0.6.0_1610883557365_0.9736562621277245"},"_hasShrinkwrap":false},"0.6.1-insiders-1610891537.0":{"name":"@vuedx/analyze","version":"0.6.1-insiders-1610891537.0","description":"Extracts public API information from Vue component.","main":"dist/index.cjs.js","module":"dist/index.esm.js","types":"dist/index.d.ts","bin":{"vuedx-analyze":"bin/analyze.js"},"keywords":["vue","sfc","sfc api extractor","static analyzer","sfc analyzer","sfc static analyzer","docgen","documentation"],"repository":{"type":"git","url":"git+https://github.com/znck/vue-developer-experience.git"},"author":{"name":"Rahul Kadyan","email":"rahulkdn@gmail.com","url":"https://znck.me/"},"funding":{"type":"individual","url":"https://github.com/sponsors/znck"},"license":"MIT","bugs":{"url":"https://github.com/znck/vue-developer-experience/issues"},"homepage":"https://github.com/znck/vue-developer-experience#readme","dependencies":{"@babel/code-frame":"^7.10.4","@babel/generator":"^7.12.1","@babel/parser":"^7.12.3","@babel/template":"^7.12.7","@babel/traverse":"7.12.1","@babel/types":"7.12.1","@types/micromatch":"^4.0.1","@vuedx/compiler-sfc":"0.6.1-insiders-1610891537.0","@vuedx/compiler-tsx":"0.6.1-insiders-1610891537.0","@vuedx/projectconfig":"0.6.1-insiders-1610891537.0","@vuedx/template-ast-types":"0.6.1-insiders-1610891537.0","cli-highlight":"^2.1.4","commander":"^6.1.0","fast-glob":"^3.2.4","hash-sum":"^2.0.0","@vuedx/shared":"0.6.1-insiders-1610891537.0","micromatch":"^4.0.2"},"devDependencies":{"@types/babel__traverse":"^7.0.15","@types/node":"^14.14.14","typescript":"^4.0.3"},"readme":"
\n \n
\n\n## Support\n\nThis package is part of [VueDX project](https://github.com/znck/vue-developer-experience), maintained by [Rahul Kadyan](https://github.com/znck). You can [💖 sponsor him](https://github.com/sponsors/znck) for continued development of this package and other VueDX tools.\n\n## Usage\n\n\n\n\n## API\n\n\n\n\n### [ConfiguredVueProject](#-vuedx-analyze-ConfiguredVueProject-class)\n\n\n\n\n Analyze
\nA tool to statically analyze Vue single file components.
\nMore info
\n\n**Signature:**\n```ts\ndeclare class ConfiguredVueProject extends VueProject {\n constructor(rootDir: string, packageFile: string | undefined, packageJSON: Partial\n\n\n\n#### [setFileNames](#-vuedx-analyze-ConfiguredVueProject-setFileNames-member-1-)\n\n\n\n**Signature:**\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n\n### [InferredVueProject](#-vuedx-analyze-InferredVueProject-class)\n\n\n\n
More info
\n\n**Signature:**\n```ts\ndeclare class InferredVueProject extends VueProject {\n kind: \"inferred\";\n protected refresh(): void;\n}\n```\n\n**Members:**\n\n\n\n\n#### [refresh](#-vuedx-analyze-InferredVueProject-refresh-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected refresh(): void;\n```\n\n\n\n
\n\n\n\n\n### [VueProject](#-vuedx-analyze-VueProject-class)\n\n\n\n
More info
\n\n**Signature:**\n```ts\ndeclare abstract class VueProject {\n protected _config: Readonly\n\n\n\n#### [markDirty](#-vuedx-analyze-VueProject-markDirty-member-1-)\n\n\n\n**Signature:**\n```ts\nmarkDirty(): void;\n```\n\n\n
\n\n\n\n#### [refresh](#-vuedx-analyze-VueProject-refresh-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected abstract refresh(): void;\n```\n\n\n
\n\n\n\n#### [reloadIfNeeded](#-vuedx-analyze-VueProject-reloadIfNeeded-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected reloadIfNeeded(): void;\n```\n\n\n
\n\n\n\n#### [setConfig](#-vuedx-analyze-VueProject-setConfig-member-1-)\n\n\n\n**Signature:**\n```ts\nsetConfig(config: ProjectConfig): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| config |
ProjectConfig | - |\n\n\n\n\n\n#### [setFileNames](#-vuedx-analyze-VueProject-setFileNames-member-1-)\n\n\n\n**Signature:**\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n\n### [createAnalyzer](#-vuedx-analyze-createAnalyzer-function-1-)\n\n\n\n
\n): Analyzer;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| plugins |
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createAnalyzer(plugins: Plugin[], options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createFullAnalyzer](#-vuedx-analyze-createFullAnalyzer-function-1-)\n\n\n\n
\n): ReturnType;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| plugins |
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createFullAnalyzer(plugins?: Plugin[], options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createSourceRange](#-vuedx-analyze-createSourceRange-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createSourceRange(context: Context | ScriptAnalyzerContext, node: Node): SourceRange;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| context |Context | ScriptAnalyzerContext | - |\n| node | Node | - |\n\n\n\n\n\n### [toVeturData](#-vuedx-analyze-toVeturData-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function toVeturData(components: ComponentInfo[]): VeturData;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| components |ComponentInfo[] | - |\n\n\n\n\n\n### [toWebTypes](#-vuedx-analyze-toWebTypes-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function toWebTypes(name: string, version: string, components: ComponentInfo[]): WebTypes;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| name |string | - |\n| version | string | - |\n| components | ComponentInfo[] | - |\n\n\n\n\n\n### [transformToFunction](#-vuedx-analyze-transformToFunction-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function transformToFunction(content: string, options?: FunctionTransformOptions): string;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| content |string | - |\n| options | FunctionTransformOptions | - |\n\n\n\n## Types\n\n\n\n\n### [Analyzer](#-vuedx-analyze-Analyzer-interface)\n\n\n\n```ts\ninterface Analyzer {\n analyze(content: string, fileName?: string): ComponentInfo;\n analyzeScript(content: string, fileName?: string, mode?: 'script' | 'scriptSetup'): ComponentInfo;\n analyzeTemplate(content: string, fileName?: string): ComponentInfo;\n}\n```\n\n\n
\n\n\n\n### [ComponentInfo](#-vuedx-analyze-ComponentInfo-interface)\n\n\n\n```ts\ninterface ComponentInfo extends Taggable {\n aliases: string[];\n components: LocalComponentRegistrationInfo[];\n description: string;\n emits: EmitInfo[];\n errors: SyntaxError[];\n fileName: string;\n fnSetupOption?: SetupInfo;\n identifierSource: Record
\n\n\n\n### [ComponentRegistrationInfo](#-vuedx-analyze-ComponentRegistrationInfo-interface)\n\n\n\n```ts\ninterface ComponentRegistrationInfo {\n aliases: string[];\n name: string;\n source: ImportSource;\n}\n```\n\n\n
\n\n\n\n### [EmitInfo](#-vuedx-analyze-EmitInfo-interface)\n\n\n\n```ts\ninterface EmitInfo extends Taggable, Addressable {\n description: string;\n isDynamic: boolean;\n isInferred: boolean;\n name: string;\n references: SourceRange[];\n type: TypeInfo[];\n}\n```\n\n\n
\n\n\n\n### [IdentifierSource](#-vuedx-analyze-IdentifierSource-interface)\n\n\n\n```ts\ninterface IdentifierSource extends Addressable {\n name: string;\n}\n```\n\n\n
\n\n\n\n### [ImportSource](#-vuedx-analyze-ImportSource-interface)\n\n\n\n```ts\ninterface ImportSource {\n exportName?: string;\n localName: string;\n moduleName: string;\n}\n```\n\n\n
\n\n\n\n### [ImportSourceWithLocation](#-vuedx-analyze-ImportSourceWithLocation-interface)\n\n\n\n```ts\ninterface ImportSourceWithLocation extends ImportSource, Addressable {\n}\n```\n\n\n
\n\n\n\n### [LocalComponentRegistrationInfo](#-vuedx-analyze-LocalComponentRegistrationInfo-interface)\n\n\n\n```ts\ninterface LocalComponentRegistrationInfo extends ComponentRegistrationInfo, Addressable {\n kind: 'script' | 'scriptSetup';\n source: ImportSourceWithLocation;\n}\n```\n\n\n
\n\n\n\n### [Plugin](#-vuedx-analyze-Plugin-2-interface)\n\n\n\n```ts\ninterface Plugin {\n babel?: AbstractScriptAnalyzerFn | AbstractAnalyzerHandler;\n blocks?: Partial<{\n script: BlockAnalyzer
\n\n\n\n### [PropInfo](#-vuedx-analyze-PropInfo-interface)\n\n\n\n```ts\ninterface PropInfo extends Taggable, Addressable {\n defaultValue: ValueInfo | null;\n description: string;\n name: string;\n required: boolean;\n type: TypeInfo[];\n}\n```\n\n\n
\n\n\n\n### [ScriptSetupInfo](#-vuedx-analyze-ScriptSetupInfo-interface)\n\n\n\n```ts\ninterface ScriptSetupInfo {\n defineEmit?: Addressable;\n defineProps?: Addressable;\n}\n```\n\n\n
\n\n\n\n### [SetupInfo](#-vuedx-analyze-SetupInfo-interface)\n\n\n\n```ts\ninterface SetupInfo extends Addressable {\n context?: {\n identifiers: Partial<{\n attrs: string;\n slots: string;\n emit: string;\n }>;\n rest?: string;\n } & Addressable;\n props?: {\n identifiers: string[];\n rest?: string;\n } & Addressable;\n return?: Addressable;\n}\n```\n\n\n
\n\n\n\n### [SourceRange](#-vuedx-analyze-SourceRange-interface)\n\n\n\n```ts\ninterface SourceRange {\n end: SourceLocation;\n source: string;\n start: SourceLocation;\n}\n```\n\n\n
\n\n\n\n### [SyntaxError](#-vuedx-analyze-SyntaxError-2-interface)\n\n\n\n```ts\ninterface SyntaxError {\n loc: SourceLocation;\n message: string;\n}\n```\n\n\n
\n\n\n\n### [VeturData](#-vuedx-analyze-VeturData-interface)\n\n\n\n```ts\ninterface VeturData {\n attributes: Record
\n\n\n\n### [WebTypes](#-vuedx-analyze-WebTypes-interface)\n\n\n\n```ts\ninterface WebTypes {\n contributions: {\n 'types-syntax': 'typescript';\n 'description-markup': 'html' | 'markdown' | 'none';\n tags: Tag[];\n attributes: Attribute[];\n };\n framework: 'vue';\n name: string;\n version: string;\n}\n```\n\n\n
\n\n","readmeFilename":"readme.md","_id":"@vuedx/analyze@0.6.1-insiders-1610891537.0","_nodeVersion":"14.14.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-QNkUrU5M1waOA0HX7GJjoipeBe210W8EZKpGLFad1q+Y8ZocktVtkuD1c28bhJ+1UVQdd9IjCkX2dVf140g9Jg==","shasum":"31cbc0b2735367b67f15060a54876ec0791467fd","tarball":"https://registry.npmjs.org/@vuedx/analyze/-/analyze-0.6.1-insiders-1610891537.0.tgz","fileCount":9,"unpackedSize":467824,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgBEEuCRA9TVsSAnZWagAA60kP+wXXccJehR05b1ydm2t9\nzBee0jnsTzp3A5VQzN2BaLI9Bsfh119IW/BFKbAJqMlwDkJsMY5GvywOS9pt\n0LrjuCCBYoLHhjk/A2nQJsa/AELA/fFMe1Bur9HRGuVVUUtWeFVLRHOagibg\n041PmllNPuHRZTQdIiSk1xYZI/9qZuYH4u1346NHuCWjQNuk+zQIl++CX30K\nn6M9FAv2rpicc6HTXbfpbE9d/ZekbNxZWRtZ1W2xc+He1e2Nvq4FXzb/E7Rp\nLZf/7J7I3cN2N3yxuZ3+sJzqnzJXTTrKjsPPE42UKBYNyQOiGdR6R6uV5gdS\nsznIwsujeQlYhIMadlZk76s7L1pCHg79IUfY57O4KszAyj+EC3okfaJej2dV\nU/71K8csNmDadY/nLviTmHBZLDPK+aK1olYQwYis/uhptqKauYclaW/iAx85\n4bLQUT21kvw/QQuFuMWs/olnzahxGhjwm3bZ/FVbXAYH8o67BtCeK8frWCtn\n3IRSNdAi7YBMqee/8Xl9LX4TK/K2gf7FyUoy1eCXuQdUlykZRRZuJoZUYT5H\n8Fyo1d52fUn218u2agfWvikG8dbedU5JMx6gMzh6YZmNig3Q5EFcgb/TQ9Wr\njx+mn0c0DzK15kwOImwUuhQbx3qH/y9CzVERaUJJsIZ6Q97XBj1aq7/8RIqn\n8NDl\r\n=hMmU\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCICG/FK8ZNKK5gtXf9kDkF2bB2wfXoeyrslg6NMVEpB4DAiAKiCGLXsp1rgcAvMFHZsbz+AbIIKja9vtHt+dVzVC6Sw=="}]},"_npmUser":{"name":"znck","email":"rahulkdn@gmail.com"},"directories":{},"maintainers":[{"name":"znck","email":"rahulkdn@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/analyze_0.6.1-insiders-1610891537.0_1610891565523_0.0808246654113911"},"_hasShrinkwrap":false},"0.6.1-insiders-1610911987.0":{"name":"@vuedx/analyze","version":"0.6.1-insiders-1610911987.0","description":"Extracts public API information from Vue component.","main":"dist/index.cjs.js","module":"dist/index.esm.js","types":"dist/index.d.ts","bin":{"vuedx-analyze":"bin/analyze.js"},"keywords":["vue","sfc","sfc api extractor","static analyzer","sfc analyzer","sfc static analyzer","docgen","documentation"],"repository":{"type":"git","url":"git+https://github.com/znck/vue-developer-experience.git"},"author":{"name":"Rahul Kadyan","email":"rahulkdn@gmail.com","url":"https://znck.me/"},"funding":{"type":"individual","url":"https://github.com/sponsors/znck"},"license":"MIT","bugs":{"url":"https://github.com/znck/vue-developer-experience/issues"},"homepage":"https://github.com/znck/vue-developer-experience#readme","dependencies":{"@babel/code-frame":"^7.10.4","@babel/generator":"^7.12.1","@babel/parser":"^7.12.3","@babel/template":"^7.12.7","@babel/traverse":"7.12.1","@babel/types":"7.12.1","@types/micromatch":"^4.0.1","@vuedx/compiler-sfc":"0.6.1-insiders-1610911987.0","@vuedx/compiler-tsx":"0.6.1-insiders-1610911987.0","@vuedx/projectconfig":"0.6.1-insiders-1610911987.0","@vuedx/template-ast-types":"0.6.1-insiders-1610911987.0","cli-highlight":"^2.1.4","commander":"^6.1.0","fast-glob":"^3.2.4","hash-sum":"^2.0.0","@vuedx/shared":"0.6.1-insiders-1610911987.0","micromatch":"^4.0.2"},"devDependencies":{"@types/babel__traverse":"^7.0.15","@types/node":"^14.14.14","typescript":"^4.0.3"},"readme":"
\n \n
\n\n## Support\n\nThis package is part of [VueDX project](https://github.com/znck/vue-developer-experience), maintained by [Rahul Kadyan](https://github.com/znck). You can [💖 sponsor him](https://github.com/sponsors/znck) for continued development of this package and other VueDX tools.\n\n## Usage\n\n\n\n\n## API\n\n\n\n\n### [ConfiguredVueProject](#-vuedx-analyze-ConfiguredVueProject-class)\n\n\n\n\n Analyze
\nA tool to statically analyze Vue single file components.
\nMore info
\n\n**Signature:**\n```ts\ndeclare class ConfiguredVueProject extends VueProject {\n constructor(rootDir: string, packageFile: string | undefined, packageJSON: Partial\n\n\n\n#### [setFileNames](#-vuedx-analyze-ConfiguredVueProject-setFileNames-member-1-)\n\n\n\n**Signature:**\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n\n### [InferredVueProject](#-vuedx-analyze-InferredVueProject-class)\n\n\n\n
More info
\n\n**Signature:**\n```ts\ndeclare class InferredVueProject extends VueProject {\n kind: \"inferred\";\n protected refresh(): void;\n}\n```\n\n**Members:**\n\n\n\n\n#### [refresh](#-vuedx-analyze-InferredVueProject-refresh-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected refresh(): void;\n```\n\n\n\n
\n\n\n\n\n### [VueProject](#-vuedx-analyze-VueProject-class)\n\n\n\n
More info
\n\n**Signature:**\n```ts\ndeclare abstract class VueProject {\n protected _config: Readonly\n\n\n\n#### [markDirty](#-vuedx-analyze-VueProject-markDirty-member-1-)\n\n\n\n**Signature:**\n```ts\nmarkDirty(): void;\n```\n\n\n
\n\n\n\n#### [refresh](#-vuedx-analyze-VueProject-refresh-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected abstract refresh(): void;\n```\n\n\n
\n\n\n\n#### [reloadIfNeeded](#-vuedx-analyze-VueProject-reloadIfNeeded-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected reloadIfNeeded(): void;\n```\n\n\n
\n\n\n\n#### [setConfig](#-vuedx-analyze-VueProject-setConfig-member-1-)\n\n\n\n**Signature:**\n```ts\nsetConfig(config: ProjectConfig): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| config |
ProjectConfig | - |\n\n\n\n\n\n#### [setFileNames](#-vuedx-analyze-VueProject-setFileNames-member-1-)\n\n\n\n**Signature:**\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n\n### [createAnalyzer](#-vuedx-analyze-createAnalyzer-function-1-)\n\n\n\n
\n): Analyzer;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| plugins |
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createAnalyzer(plugins: Plugin[], options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createFullAnalyzer](#-vuedx-analyze-createFullAnalyzer-function-1-)\n\n\n\n
\n): ReturnType;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| plugins |
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createFullAnalyzer(plugins?: Plugin[], options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createSourceRange](#-vuedx-analyze-createSourceRange-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createSourceRange(context: Context | ScriptAnalyzerContext, node: Node): SourceRange;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| context |Context | ScriptAnalyzerContext | - |\n| node | Node | - |\n\n\n\n\n\n### [toVeturData](#-vuedx-analyze-toVeturData-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function toVeturData(components: ComponentInfo[]): VeturData;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| components |ComponentInfo[] | - |\n\n\n\n\n\n### [toWebTypes](#-vuedx-analyze-toWebTypes-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function toWebTypes(name: string, version: string, components: ComponentInfo[]): WebTypes;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| name |string | - |\n| version | string | - |\n| components | ComponentInfo[] | - |\n\n\n\n\n\n### [transformToFunction](#-vuedx-analyze-transformToFunction-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function transformToFunction(content: string, options?: FunctionTransformOptions): string;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| content |string | - |\n| options | FunctionTransformOptions | - |\n\n\n\n## Types\n\n\n\n\n### [Analyzer](#-vuedx-analyze-Analyzer-interface)\n\n\n\n```ts\ninterface Analyzer {\n analyze(content: string, fileName?: string): ComponentInfo;\n analyzeScript(content: string, fileName?: string, mode?: 'script' | 'scriptSetup'): ComponentInfo;\n analyzeTemplate(content: string, fileName?: string): ComponentInfo;\n}\n```\n\n\n
\n\n\n\n### [ComponentInfo](#-vuedx-analyze-ComponentInfo-interface)\n\n\n\n```ts\ninterface ComponentInfo extends Taggable {\n aliases: string[];\n components: LocalComponentRegistrationInfo[];\n description: string;\n emits: EmitInfo[];\n errors: SyntaxError[];\n fileName: string;\n fnSetupOption?: SetupInfo;\n identifierSource: Record
\n\n\n\n### [ComponentRegistrationInfo](#-vuedx-analyze-ComponentRegistrationInfo-interface)\n\n\n\n```ts\ninterface ComponentRegistrationInfo {\n aliases: string[];\n name: string;\n source: ImportSource;\n}\n```\n\n\n
\n\n\n\n### [EmitInfo](#-vuedx-analyze-EmitInfo-interface)\n\n\n\n```ts\ninterface EmitInfo extends Taggable, Addressable {\n description: string;\n isDynamic: boolean;\n isInferred: boolean;\n name: string;\n references: SourceRange[];\n type: TypeInfo[];\n}\n```\n\n\n
\n\n\n\n### [IdentifierSource](#-vuedx-analyze-IdentifierSource-interface)\n\n\n\n```ts\ninterface IdentifierSource extends Addressable {\n name: string;\n}\n```\n\n\n
\n\n\n\n### [ImportSource](#-vuedx-analyze-ImportSource-interface)\n\n\n\n```ts\ninterface ImportSource {\n exportName?: string;\n localName: string;\n moduleName: string;\n}\n```\n\n\n
\n\n\n\n### [ImportSourceWithLocation](#-vuedx-analyze-ImportSourceWithLocation-interface)\n\n\n\n```ts\ninterface ImportSourceWithLocation extends ImportSource, Addressable {\n}\n```\n\n\n
\n\n\n\n### [LocalComponentRegistrationInfo](#-vuedx-analyze-LocalComponentRegistrationInfo-interface)\n\n\n\n```ts\ninterface LocalComponentRegistrationInfo extends ComponentRegistrationInfo, Addressable {\n kind: 'script' | 'scriptSetup';\n source: ImportSourceWithLocation;\n}\n```\n\n\n
\n\n\n\n### [Plugin](#-vuedx-analyze-Plugin-2-interface)\n\n\n\n```ts\ninterface Plugin {\n babel?: AbstractScriptAnalyzerFn | AbstractAnalyzerHandler;\n blocks?: Partial<{\n script: BlockAnalyzer
\n\n\n\n### [PropInfo](#-vuedx-analyze-PropInfo-interface)\n\n\n\n```ts\ninterface PropInfo extends Taggable, Addressable {\n defaultValue: ValueInfo | null;\n description: string;\n name: string;\n required: boolean;\n type: TypeInfo[];\n}\n```\n\n\n
\n\n\n\n### [ScriptSetupInfo](#-vuedx-analyze-ScriptSetupInfo-interface)\n\n\n\n```ts\ninterface ScriptSetupInfo {\n defineEmit?: Addressable;\n defineProps?: Addressable;\n}\n```\n\n\n
\n\n\n\n### [SetupInfo](#-vuedx-analyze-SetupInfo-interface)\n\n\n\n```ts\ninterface SetupInfo extends Addressable {\n context?: {\n identifiers: Partial<{\n attrs: string;\n slots: string;\n emit: string;\n }>;\n rest?: string;\n } & Addressable;\n props?: {\n identifiers: string[];\n rest?: string;\n } & Addressable;\n return?: Addressable;\n}\n```\n\n\n
\n\n\n\n### [SourceRange](#-vuedx-analyze-SourceRange-interface)\n\n\n\n```ts\ninterface SourceRange {\n end: SourceLocation;\n source: string;\n start: SourceLocation;\n}\n```\n\n\n
\n\n\n\n### [SyntaxError](#-vuedx-analyze-SyntaxError-2-interface)\n\n\n\n```ts\ninterface SyntaxError {\n loc: SourceLocation;\n message: string;\n}\n```\n\n\n
\n\n\n\n### [VeturData](#-vuedx-analyze-VeturData-interface)\n\n\n\n```ts\ninterface VeturData {\n attributes: Record
\n\n\n\n### [WebTypes](#-vuedx-analyze-WebTypes-interface)\n\n\n\n```ts\ninterface WebTypes {\n contributions: {\n 'types-syntax': 'typescript';\n 'description-markup': 'html' | 'markdown' | 'none';\n tags: Tag[];\n attributes: Attribute[];\n };\n framework: 'vue';\n name: string;\n version: string;\n}\n```\n\n\n
\n\n","readmeFilename":"readme.md","_id":"@vuedx/analyze@0.6.1-insiders-1610911987.0","_nodeVersion":"14.14.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-uQdr+9Y43EFXNV1yZMBm7TDYoq1YP1K3HqxEuXjEpHOT0rlbZjdu8+v/xgg7TifIO6gG8EkyTlsSw2RxNbiRIQ==","shasum":"804bb3fe934da021c66ddfa4a0358dd395d516cc","tarball":"https://registry.npmjs.org/@vuedx/analyze/-/analyze-0.6.1-insiders-1610911987.0.tgz","fileCount":9,"unpackedSize":467824,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgBJEPCRA9TVsSAnZWagAAzHkP/R6PSdWQ6nUzO9kQIHru\n1jDysr2tSfKMsq79yG7czOs6Eoe7wko3fPWq2yEU1g+DEASUG1fb28qV2jMk\n32hofUeXOSkz5NDa+aMUfRuxgYjO83F+dUBwZIWF/1dZS9j52+w8LVZgxW3M\n7zGnY8wb6p6wUEqBxNcTFZcyjpQFkeRvUijnswz08AfSNEHnbxt2b1kiO5d4\n4JKxomGR/fO9YfC/r+xH7u+ZiF/HSeMMLgraid4UL7DhMVBiy/VQvLQSp8hn\n3aWLfmTD23EI9v/09ApUE++7mtY3JsEmQeDZYtoBulmL5Up4zT2HA6pn4lok\nzRpJZ4QLvOWZFvhYzM/2/DWQGJen5DZhvZ1mbjZMajbM0zD+GKFlXUapx59v\nY07j2/KryhsM/4zqObKWOlkZP2CUaRAeeheanCgLRIgjmYnCpn4kqdiRAG2f\n81FR83GEHOp3hbSq0f4aMfpmH8J9HDUB/d+t6V3HbpNeeMEJV45Shsu8VMxY\nGbzBO1IidgMjJQVvwtauA2VYQBktHHRFhsm3h9RyOweJgptOHyx06JxbUs4g\nCzgDNBuFbEwKkQRWTGfR6N7eRyLgiUgibfU6eYu2VuWpmlliDzOvx5EAUNc5\n7YsNACNLfGXhngiHe5DEyTrjhcmLuivMmo+q+vuGopJQZ1Q05sTNky+qsBSH\nccyW\r\n=GIP2\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDjGmlpxRfn/tRQPi1kejvwz7c2TkHkq+q+x567X0MlrQIgF5JMuaL9fwTp541SA3yXoQ8HaubbocwiiOrzD6wCGe0="}]},"_npmUser":{"name":"znck","email":"rahulkdn@gmail.com"},"directories":{},"maintainers":[{"name":"znck","email":"rahulkdn@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/analyze_0.6.1-insiders-1610911987.0_1610912015562_0.031176676963138972"},"_hasShrinkwrap":false},"0.6.1-insiders-1611324083.0":{"name":"@vuedx/analyze","version":"0.6.1-insiders-1611324083.0","description":"Extracts public API information from Vue component.","main":"dist/index.cjs.js","module":"dist/index.esm.js","types":"dist/index.d.ts","bin":{"vuedx-analyze":"bin/analyze.js"},"keywords":["vue","sfc","sfc api extractor","static analyzer","sfc analyzer","sfc static analyzer","docgen","documentation"],"repository":{"type":"git","url":"git+https://github.com/znck/vue-developer-experience.git"},"author":{"name":"Rahul Kadyan","email":"rahulkdn@gmail.com","url":"https://znck.me/"},"funding":{"type":"individual","url":"https://github.com/sponsors/znck"},"license":"MIT","bugs":{"url":"https://github.com/znck/vue-developer-experience/issues"},"homepage":"https://github.com/znck/vue-developer-experience#readme","dependencies":{"@babel/code-frame":"^7.10.4","@babel/generator":"^7.12.1","@babel/parser":"^7.12.3","@babel/template":"^7.12.7","@babel/traverse":"7.12.1","@babel/types":"7.12.1","@types/micromatch":"^4.0.1","@vuedx/compiler-sfc":"0.6.1-insiders-1611324083.0","@vuedx/compiler-tsx":"0.6.1-insiders-1611324083.0","@vuedx/projectconfig":"0.6.1-insiders-1611324083.0","@vuedx/template-ast-types":"0.6.1-insiders-1611324083.0","cli-highlight":"^2.1.4","commander":"^6.1.0","fast-glob":"^3.2.4","hash-sum":"^2.0.0","@vuedx/shared":"0.6.1-insiders-1611324083.0","micromatch":"^4.0.2"},"devDependencies":{"@types/babel__traverse":"^7.0.15","@types/node":"^14.14.14","typescript":"^4.0.3"},"readme":"
\n \n
\n\n## Support\n\nThis package is part of [VueDX project](https://github.com/znck/vue-developer-experience), maintained by [Rahul Kadyan](https://github.com/znck). You can [💖 sponsor him](https://github.com/sponsors/znck) for continued development of this package and other VueDX tools.\n\n## Usage\n\n\n\n\n## API\n\n\n\n\n### [ConfiguredVueProject](#-vuedx-analyze-ConfiguredVueProject-class)\n\n\n\n\n Analyze
\nA tool to statically analyze Vue single file components.
\nMore info
\n\n**Signature:**\n```ts\ndeclare class ConfiguredVueProject extends VueProject {\n constructor(rootDir: string, packageFile: string | undefined, packageJSON: Partial\n\n\n\n#### [setFileNames](#-vuedx-analyze-ConfiguredVueProject-setFileNames-member-1-)\n\n\n\n**Signature:**\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n\n### [InferredVueProject](#-vuedx-analyze-InferredVueProject-class)\n\n\n\n
More info
\n\n**Signature:**\n```ts\ndeclare class InferredVueProject extends VueProject {\n kind: \"inferred\";\n protected refresh(): void;\n}\n```\n\n**Members:**\n\n\n\n\n#### [refresh](#-vuedx-analyze-InferredVueProject-refresh-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected refresh(): void;\n```\n\n\n\n
\n\n\n\n\n### [VueProject](#-vuedx-analyze-VueProject-class)\n\n\n\n
More info
\n\n**Signature:**\n```ts\ndeclare abstract class VueProject {\n protected _config: Readonly\n\n\n\n#### [markDirty](#-vuedx-analyze-VueProject-markDirty-member-1-)\n\n\n\n**Signature:**\n```ts\nmarkDirty(): void;\n```\n\n\n
\n\n\n\n#### [refresh](#-vuedx-analyze-VueProject-refresh-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected abstract refresh(): void;\n```\n\n\n
\n\n\n\n#### [reloadIfNeeded](#-vuedx-analyze-VueProject-reloadIfNeeded-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected reloadIfNeeded(): void;\n```\n\n\n
\n\n\n\n#### [setConfig](#-vuedx-analyze-VueProject-setConfig-member-1-)\n\n\n\n**Signature:**\n```ts\nsetConfig(config: ProjectConfig): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| config |
ProjectConfig | - |\n\n\n\n\n\n#### [setFileNames](#-vuedx-analyze-VueProject-setFileNames-member-1-)\n\n\n\n**Signature:**\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n\n### [createAnalyzer](#-vuedx-analyze-createAnalyzer-function-1-)\n\n\n\n
\n): Analyzer;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| plugins |
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createAnalyzer(plugins: Plugin[], options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createFullAnalyzer](#-vuedx-analyze-createFullAnalyzer-function-1-)\n\n\n\n
\n): ReturnType;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| plugins |
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createFullAnalyzer(plugins?: Plugin[], options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createSourceRange](#-vuedx-analyze-createSourceRange-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createSourceRange(context: Context | ScriptAnalyzerContext, node: Node): SourceRange;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| context |Context | ScriptAnalyzerContext | - |\n| node | Node | - |\n\n\n\n\n\n### [toVeturData](#-vuedx-analyze-toVeturData-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function toVeturData(components: ComponentInfo[]): VeturData;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| components |ComponentInfo[] | - |\n\n\n\n\n\n### [toWebTypes](#-vuedx-analyze-toWebTypes-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function toWebTypes(name: string, version: string, components: ComponentInfo[]): WebTypes;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| name |string | - |\n| version | string | - |\n| components | ComponentInfo[] | - |\n\n\n\n\n\n### [transformToFunction](#-vuedx-analyze-transformToFunction-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function transformToFunction(content: string, options?: FunctionTransformOptions): string;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| content |string | - |\n| options | FunctionTransformOptions | - |\n\n\n\n## Types\n\n\n\n\n### [Analyzer](#-vuedx-analyze-Analyzer-interface)\n\n\n\n```ts\ninterface Analyzer {\n analyze(content: string, fileName?: string): ComponentInfo;\n analyzeScript(content: string, fileName?: string, mode?: 'script' | 'scriptSetup'): ComponentInfo;\n analyzeTemplate(content: string, fileName?: string): ComponentInfo;\n}\n```\n\n\n
\n\n\n\n### [ComponentInfo](#-vuedx-analyze-ComponentInfo-interface)\n\n\n\n```ts\ninterface ComponentInfo extends Taggable {\n aliases: string[];\n components: LocalComponentRegistrationInfo[];\n description: string;\n emits: EmitInfo[];\n errors: SyntaxError[];\n fileName: string;\n fnSetupOption?: SetupInfo;\n identifierSource: Record
\n\n\n\n### [ComponentRegistrationInfo](#-vuedx-analyze-ComponentRegistrationInfo-interface)\n\n\n\n```ts\ninterface ComponentRegistrationInfo {\n aliases: string[];\n name: string;\n source: ImportSource;\n}\n```\n\n\n
\n\n\n\n### [EmitInfo](#-vuedx-analyze-EmitInfo-interface)\n\n\n\n```ts\ninterface EmitInfo extends Taggable, Addressable {\n description: string;\n isDynamic: boolean;\n isInferred: boolean;\n name: string;\n references: SourceRange[];\n type: TypeInfo[];\n}\n```\n\n\n
\n\n\n\n### [IdentifierSource](#-vuedx-analyze-IdentifierSource-interface)\n\n\n\n```ts\ninterface IdentifierSource extends Addressable {\n name: string;\n}\n```\n\n\n
\n\n\n\n### [ImportSource](#-vuedx-analyze-ImportSource-interface)\n\n\n\n```ts\ninterface ImportSource {\n exportName?: string;\n localName: string;\n moduleName: string;\n}\n```\n\n\n
\n\n\n\n### [ImportSourceWithLocation](#-vuedx-analyze-ImportSourceWithLocation-interface)\n\n\n\n```ts\ninterface ImportSourceWithLocation extends ImportSource, Addressable {\n}\n```\n\n\n
\n\n\n\n### [LocalComponentRegistrationInfo](#-vuedx-analyze-LocalComponentRegistrationInfo-interface)\n\n\n\n```ts\ninterface LocalComponentRegistrationInfo extends ComponentRegistrationInfo, Addressable {\n kind: 'script' | 'scriptSetup';\n source: ImportSourceWithLocation;\n}\n```\n\n\n
\n\n\n\n### [Plugin](#-vuedx-analyze-Plugin-2-interface)\n\n\n\n```ts\ninterface Plugin {\n babel?: AbstractScriptAnalyzerFn | AbstractAnalyzerHandler;\n blocks?: Partial<{\n script: BlockAnalyzer
\n\n\n\n### [PropInfo](#-vuedx-analyze-PropInfo-interface)\n\n\n\n```ts\ninterface PropInfo extends Taggable, Addressable {\n defaultValue: ValueInfo | null;\n description: string;\n name: string;\n required: boolean;\n type: TypeInfo[];\n}\n```\n\n\n
\n\n\n\n### [ScriptSetupInfo](#-vuedx-analyze-ScriptSetupInfo-interface)\n\n\n\n```ts\ninterface ScriptSetupInfo {\n defineEmit?: Addressable;\n defineProps?: Addressable;\n}\n```\n\n\n
\n\n\n\n### [SetupInfo](#-vuedx-analyze-SetupInfo-interface)\n\n\n\n```ts\ninterface SetupInfo extends Addressable {\n context?: {\n identifiers: Partial<{\n attrs: string;\n slots: string;\n emit: string;\n }>;\n rest?: string;\n } & Addressable;\n props?: {\n identifiers: string[];\n rest?: string;\n } & Addressable;\n return?: Addressable;\n}\n```\n\n\n
\n\n\n\n### [SourceRange](#-vuedx-analyze-SourceRange-interface)\n\n\n\n```ts\ninterface SourceRange {\n end: SourceLocation;\n source: string;\n start: SourceLocation;\n}\n```\n\n\n
\n\n\n\n### [SyntaxError](#-vuedx-analyze-SyntaxError-2-interface)\n\n\n\n```ts\ninterface SyntaxError {\n loc: SourceLocation;\n message: string;\n}\n```\n\n\n
\n\n\n\n### [VeturData](#-vuedx-analyze-VeturData-interface)\n\n\n\n```ts\ninterface VeturData {\n attributes: Record
\n\n\n\n### [WebTypes](#-vuedx-analyze-WebTypes-interface)\n\n\n\n```ts\ninterface WebTypes {\n contributions: {\n 'types-syntax': 'typescript';\n 'description-markup': 'html' | 'markdown' | 'none';\n tags: Tag[];\n attributes: Attribute[];\n };\n framework: 'vue';\n name: string;\n version: string;\n}\n```\n\n\n
\n\n","readmeFilename":"readme.md","_id":"@vuedx/analyze@0.6.1-insiders-1611324083.0","_nodeVersion":"14.14.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-3yZvSRMRCJsMTf9Xtll6cD8kDk6mK4s6orXgDtfBaMCGAmb3Se5ulvhBy+WnOcT7EECIcnaKRW5cFyg9P5aPFA==","shasum":"abe85cdd6cd0c4e822ae454373fcb531b99b352f","tarball":"https://registry.npmjs.org/@vuedx/analyze/-/analyze-0.6.1-insiders-1611324083.0.tgz","fileCount":9,"unpackedSize":467824,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgCtrTCRA9TVsSAnZWagAAf0AP/0qBRqJsK8g38QS+++9J\neo/ucHbPd7tuXVOuqr5OfYZpRHY6qllDXW0aEkTAaXJy5eT+YjCqXLyZsR4U\n2vvOM7VPaOb84Ts+dux/oECW4ynZu1XCCA/1BfWREaik3QjAR1u/T+ws7FUw\nsunfnrh1GrMLHW0S8IskAWi9mvsYlM6tWen/BTwTaV+6F4tci1kWWRNyMYBp\njTvQAo91wmhqk9eXrM3vjpvGVvU7zkreYepm6xzDBiDHQHNNlG+yuCFfWNyj\ntnSbca8vUhgXpk9rhhQR2gC5W00Xqu8CugCIlwIc59vtW7JODvVhE6/Xl6dm\nx3+0z4FEvHBlmT2353zFem9rCPeAD2zQI0HxWf2m3nQKc2ExeP1U9dGmuDml\nXwLRVLURONrrVJocmQ/PNJ8dWxjFJXcyfxr0uwE3hcs1x+eKfI0g7XdCeQEh\nF12LAIa1+iDI3PRywRyX37YSNKHET85JzIQtisqgjrq3t7VdxOMpmleMaeay\nPaMteHhgUYivr2fKZsc/GJy5ejvFU6DlmEUDvrWM0nYoC2JSbgSPkBVCeHaG\ncRwMd+mS1zb+OGdkZ895NeMm9HRAb/bXYcmP7rVYazflCq85PtT/WvRF2XlC\nbKTvsoMynF4KK+11nxhC/7qhku/fnJo9OTzq8pKwQ60M2SEbvwkLiWIM7Adg\nakhQ\r\n=9o7B\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIBnSmB/omjjXdISxzWZ/CRjV1CJJhSfB/YM7Vx1bBtOtAiA4SkyhEg8IDLbSsjZ0uelb8djtF0J+Eq77r07hir3OKA=="}]},"_npmUser":{"name":"znck","email":"rahulkdn@gmail.com"},"directories":{},"maintainers":[{"name":"znck","email":"rahulkdn@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/analyze_0.6.1-insiders-1611324083.0_1611324115367_0.5147869495754205"},"_hasShrinkwrap":false},"0.6.1-insiders-1611498830.0":{"name":"@vuedx/analyze","version":"0.6.1-insiders-1611498830.0","description":"Extracts public API information from Vue component.","main":"dist/index.cjs.js","module":"dist/index.esm.js","types":"dist/index.d.ts","bin":{"vuedx-analyze":"bin/analyze.js"},"keywords":["vue","sfc","sfc api extractor","static analyzer","sfc analyzer","sfc static analyzer","docgen","documentation"],"repository":{"type":"git","url":"git+https://github.com/znck/vue-developer-experience.git"},"author":{"name":"Rahul Kadyan","email":"rahulkdn@gmail.com","url":"https://znck.me/"},"funding":{"type":"individual","url":"https://github.com/sponsors/znck"},"license":"MIT","bugs":{"url":"https://github.com/znck/vue-developer-experience/issues"},"homepage":"https://github.com/znck/vue-developer-experience#readme","dependencies":{"@babel/code-frame":"^7.10.4","@babel/generator":"^7.12.1","@babel/parser":"^7.12.3","@babel/template":"^7.12.7","@babel/traverse":"7.12.1","@babel/types":"7.12.1","@types/micromatch":"^4.0.1","@vuedx/compiler-sfc":"0.6.1-insiders-1611498830.0","@vuedx/compiler-tsx":"0.6.1-insiders-1611498830.0","@vuedx/projectconfig":"0.6.1-insiders-1611498830.0","@vuedx/template-ast-types":"0.6.1-insiders-1611498830.0","cli-highlight":"^2.1.4","commander":"^6.1.0","fast-glob":"^3.2.4","hash-sum":"^2.0.0","@vuedx/shared":"0.6.1-insiders-1611498830.0","micromatch":"^4.0.2"},"devDependencies":{"@types/babel__traverse":"^7.0.15","@types/node":"^14.14.14","typescript":"^4.0.3"},"readme":"
\n \n
\n\n## Support\n\nThis package is part of [VueDX project](https://github.com/znck/vue-developer-experience), maintained by [Rahul Kadyan](https://github.com/znck). You can [💖 sponsor him](https://github.com/sponsors/znck) for continued development of this package and other VueDX tools.\n\n## Usage\n\n\n\n\n## API\n\n\n\n\n### [ConfiguredVueProject](#-vuedx-analyze-ConfiguredVueProject-class)\n\n\n\n\n Analyze
\nA tool to statically analyze Vue single file components.
\nMore info
\n\n**Signature:**\n```ts\ndeclare class ConfiguredVueProject extends VueProject {\n constructor(rootDir: string, packageFile: string | undefined, packageJSON: Partial\n\n\n\n#### [setFileNames](#-vuedx-analyze-ConfiguredVueProject-setFileNames-member-1-)\n\n\n\n**Signature:**\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n\n### [InferredVueProject](#-vuedx-analyze-InferredVueProject-class)\n\n\n\n
More info
\n\n**Signature:**\n```ts\ndeclare class InferredVueProject extends VueProject {\n kind: \"inferred\";\n protected refresh(): void;\n}\n```\n\n**Members:**\n\n\n\n\n#### [refresh](#-vuedx-analyze-InferredVueProject-refresh-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected refresh(): void;\n```\n\n\n\n
\n\n\n\n\n### [VueProject](#-vuedx-analyze-VueProject-class)\n\n\n\n
More info
\n\n**Signature:**\n```ts\ndeclare abstract class VueProject {\n protected _config: Readonly\n\n\n\n#### [markDirty](#-vuedx-analyze-VueProject-markDirty-member-1-)\n\n\n\n**Signature:**\n```ts\nmarkDirty(): void;\n```\n\n\n
\n\n\n\n#### [refresh](#-vuedx-analyze-VueProject-refresh-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected abstract refresh(): void;\n```\n\n\n
\n\n\n\n#### [reloadIfNeeded](#-vuedx-analyze-VueProject-reloadIfNeeded-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected reloadIfNeeded(): void;\n```\n\n\n
\n\n\n\n#### [setConfig](#-vuedx-analyze-VueProject-setConfig-member-1-)\n\n\n\n**Signature:**\n```ts\nsetConfig(config: ProjectConfig): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| config |
ProjectConfig | - |\n\n\n\n\n\n#### [setFileNames](#-vuedx-analyze-VueProject-setFileNames-member-1-)\n\n\n\n**Signature:**\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n\n### [createAnalyzer](#-vuedx-analyze-createAnalyzer-function-1-)\n\n\n\n
\n): Analyzer;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| plugins |
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createAnalyzer(plugins: Plugin[], options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createFullAnalyzer](#-vuedx-analyze-createFullAnalyzer-function-1-)\n\n\n\n
\n): ReturnType;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| plugins |
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createFullAnalyzer(plugins?: Plugin[], options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createSourceRange](#-vuedx-analyze-createSourceRange-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createSourceRange(context: Context | ScriptAnalyzerContext, node: Node): SourceRange;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| context |Context | ScriptAnalyzerContext | - |\n| node | Node | - |\n\n\n\n\n\n### [toVeturData](#-vuedx-analyze-toVeturData-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function toVeturData(components: ComponentInfo[]): VeturData;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| components |ComponentInfo[] | - |\n\n\n\n\n\n### [toWebTypes](#-vuedx-analyze-toWebTypes-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function toWebTypes(name: string, version: string, components: ComponentInfo[]): WebTypes;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| name |string | - |\n| version | string | - |\n| components | ComponentInfo[] | - |\n\n\n\n\n\n### [transformToFunction](#-vuedx-analyze-transformToFunction-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function transformToFunction(content: string, options?: FunctionTransformOptions): string;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| content |string | - |\n| options | FunctionTransformOptions | - |\n\n\n\n## Types\n\n\n\n\n### [Analyzer](#-vuedx-analyze-Analyzer-interface)\n\n\n\n```ts\ninterface Analyzer {\n analyze(content: string, fileName?: string): ComponentInfo;\n analyzeScript(content: string, fileName?: string, mode?: 'script' | 'scriptSetup'): ComponentInfo;\n analyzeTemplate(content: string, fileName?: string): ComponentInfo;\n}\n```\n\n\n
\n\n\n\n### [ComponentInfo](#-vuedx-analyze-ComponentInfo-interface)\n\n\n\n```ts\ninterface ComponentInfo extends Taggable {\n aliases: string[];\n components: LocalComponentRegistrationInfo[];\n description: string;\n emits: EmitInfo[];\n errors: SyntaxError[];\n fileName: string;\n fnSetupOption?: SetupInfo;\n identifierSource: Record
\n\n\n\n### [ComponentRegistrationInfo](#-vuedx-analyze-ComponentRegistrationInfo-interface)\n\n\n\n```ts\ninterface ComponentRegistrationInfo {\n aliases: string[];\n name: string;\n source: ImportSource;\n}\n```\n\n\n
\n\n\n\n### [EmitInfo](#-vuedx-analyze-EmitInfo-interface)\n\n\n\n```ts\ninterface EmitInfo extends Taggable, Addressable {\n description: string;\n isDynamic: boolean;\n isInferred: boolean;\n name: string;\n references: SourceRange[];\n type: TypeInfo[];\n}\n```\n\n\n
\n\n\n\n### [IdentifierSource](#-vuedx-analyze-IdentifierSource-interface)\n\n\n\n```ts\ninterface IdentifierSource extends Addressable {\n name: string;\n}\n```\n\n\n
\n\n\n\n### [ImportSource](#-vuedx-analyze-ImportSource-interface)\n\n\n\n```ts\ninterface ImportSource {\n exportName?: string;\n localName: string;\n moduleName: string;\n}\n```\n\n\n
\n\n\n\n### [ImportSourceWithLocation](#-vuedx-analyze-ImportSourceWithLocation-interface)\n\n\n\n```ts\ninterface ImportSourceWithLocation extends ImportSource, Addressable {\n}\n```\n\n\n
\n\n\n\n### [LocalComponentRegistrationInfo](#-vuedx-analyze-LocalComponentRegistrationInfo-interface)\n\n\n\n```ts\ninterface LocalComponentRegistrationInfo extends ComponentRegistrationInfo, Addressable {\n kind: 'script' | 'scriptSetup';\n source: ImportSourceWithLocation;\n}\n```\n\n\n
\n\n\n\n### [Plugin](#-vuedx-analyze-Plugin-2-interface)\n\n\n\n```ts\ninterface Plugin {\n babel?: AbstractScriptAnalyzerFn | AbstractAnalyzerHandler;\n blocks?: Partial<{\n script: BlockAnalyzer
\n\n\n\n### [PropInfo](#-vuedx-analyze-PropInfo-interface)\n\n\n\n```ts\ninterface PropInfo extends Taggable, Addressable {\n defaultValue: ValueInfo | null;\n description: string;\n name: string;\n required: boolean;\n type: TypeInfo[];\n}\n```\n\n\n
\n\n\n\n### [ScriptSetupInfo](#-vuedx-analyze-ScriptSetupInfo-interface)\n\n\n\n```ts\ninterface ScriptSetupInfo {\n defineEmit?: Addressable;\n defineProps?: Addressable;\n}\n```\n\n\n
\n\n\n\n### [SetupInfo](#-vuedx-analyze-SetupInfo-interface)\n\n\n\n```ts\ninterface SetupInfo extends Addressable {\n context?: {\n identifiers: Partial<{\n attrs: string;\n slots: string;\n emit: string;\n }>;\n rest?: string;\n } & Addressable;\n props?: {\n identifiers: string[];\n rest?: string;\n } & Addressable;\n return?: Addressable;\n}\n```\n\n\n
\n\n\n\n### [SourceRange](#-vuedx-analyze-SourceRange-interface)\n\n\n\n```ts\ninterface SourceRange {\n end: SourceLocation;\n source: string;\n start: SourceLocation;\n}\n```\n\n\n
\n\n\n\n### [SyntaxError](#-vuedx-analyze-SyntaxError-2-interface)\n\n\n\n```ts\ninterface SyntaxError {\n loc: SourceLocation;\n message: string;\n}\n```\n\n\n
\n\n\n\n### [VeturData](#-vuedx-analyze-VeturData-interface)\n\n\n\n```ts\ninterface VeturData {\n attributes: Record
\n\n\n\n### [WebTypes](#-vuedx-analyze-WebTypes-interface)\n\n\n\n```ts\ninterface WebTypes {\n contributions: {\n 'types-syntax': 'typescript';\n 'description-markup': 'html' | 'markdown' | 'none';\n tags: Tag[];\n attributes: Attribute[];\n };\n framework: 'vue';\n name: string;\n version: string;\n}\n```\n\n\n
\n\n","readmeFilename":"readme.md","_id":"@vuedx/analyze@0.6.1-insiders-1611498830.0","_nodeVersion":"14.14.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-Od4McMtLYC7JY7cgttWDFfuxsGSgcVMZzHswFC1EMCZxRiB8D1oAevIwAWRBb7wRd9SfJ+4TAJi2emm5/icrQA==","shasum":"9d6ed5be9fa500d4e717451edad796e95a6b5439","tarball":"https://registry.npmjs.org/@vuedx/analyze/-/analyze-0.6.1-insiders-1611498830.0.tgz","fileCount":9,"unpackedSize":467824,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgDYVpCRA9TVsSAnZWagAA/+sP/joiaR4Xtu8ATJb9eBZE\nFzT5GWiVTBQJBXG942i1P9Iz17YTBBbD0Bkudo94wHDpRfY76ehAzIGdiAPN\n2fgG4V54J4jBp/kMPjl+voSXgMl7cid2G6OMGIhFU5FkCkjeXy0aElFLyZDu\n1y+dTT39IJi0PnJBKo466GUPRljqD1IMl/itMPsveQQjdZ5UVK0YxuJ1Whwe\ntlLA51eM4XimYTucCC6UFKUcL1nupGOTVA48fwGc+A2jiHMk2o+VnAkFqgYW\nyX0897eNuIqGlRxE2pot7ZcLYTfSVs2MwBGP6cELOSl2SiO9RmEpKWk/FODd\nffzwPftqK1Oow1TH2qfvPfK+/9uxy6mOnFAFUIgNsMM+6qLHj3KCmEED/Dl1\nawW6jmLAGLg8nJ5UhDxMHaAokeMHCCrgoH8Wpb6zUw6GcI0nOlm+BZPAmxGw\nJmlUEdZ14lp34gpAjl/1FDvu9gDTzZj/D/nSS/Y+r3n6hd8EykQaVzMR+b+I\nJySS4kKzpJfb5Fn/ZXQrPqZ3FXbVuPJ2l04eCJEzv7wW0jYySxgflD7V3RTN\nqm49Lcs9XL4NWDHALKd0tB+yC+8XTLsYotf1EeJQD3YMByKmukFiOhjMng+u\nvTw3PzeTbV8l3KZIQykU3OgDaDxTO+YhfirshoRxKgHm5bcoALSP9eQkv44l\nCESs\r\n=paqN\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIFR+Ums9vOA9wDHilR8TBy17/514QUOSfncd8xZ6w1+ZAiEAgiQvkAip/tl6sgM718H0ofPegsfDWMZmQSW4foKlWeM="}]},"_npmUser":{"name":"znck","email":"rahulkdn@gmail.com"},"directories":{},"maintainers":[{"name":"znck","email":"rahulkdn@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/analyze_0.6.1-insiders-1611498830.0_1611498857049_0.5360807903315294"},"_hasShrinkwrap":false},"0.6.2-insiders-1611564162.0":{"name":"@vuedx/analyze","version":"0.6.2-insiders-1611564162.0","description":"Extracts public API information from Vue component.","main":"dist/index.cjs.js","module":"dist/index.esm.js","types":"dist/index.d.ts","bin":{"vuedx-analyze":"bin/analyze.js"},"keywords":["vue","sfc","sfc api extractor","static analyzer","sfc analyzer","sfc static analyzer","docgen","documentation"],"repository":{"type":"git","url":"git+https://github.com/znck/vue-developer-experience.git"},"author":{"name":"Rahul Kadyan","email":"rahulkdn@gmail.com","url":"https://znck.me/"},"funding":{"type":"individual","url":"https://github.com/sponsors/znck"},"license":"MIT","bugs":{"url":"https://github.com/znck/vue-developer-experience/issues"},"homepage":"https://github.com/znck/vue-developer-experience#readme","dependencies":{"@babel/code-frame":"^7.10.4","@babel/generator":"^7.12.1","@babel/parser":"^7.12.3","@babel/template":"^7.12.7","@babel/traverse":"7.12.1","@babel/types":"7.12.1","@types/micromatch":"^4.0.1","@vuedx/compiler-sfc":"0.6.1-insiders-1611564162.0","@vuedx/compiler-tsx":"0.6.2-insiders-1611564162.0","@vuedx/projectconfig":"0.6.1-insiders-1611564162.0","@vuedx/template-ast-types":"0.6.1-insiders-1611564162.0","cli-highlight":"^2.1.4","commander":"^6.1.0","fast-glob":"^3.2.4","hash-sum":"^2.0.0","@vuedx/shared":"0.6.1-insiders-1611564162.0","micromatch":"^4.0.2"},"devDependencies":{"@types/babel__traverse":"^7.0.15","@types/node":"^14.14.14","typescript":"^4.0.3"},"readme":"
\n \n
\n\n## Support\n\nThis package is part of [VueDX project](https://github.com/znck/vue-developer-experience), maintained by [Rahul Kadyan](https://github.com/znck). You can [💖 sponsor him](https://github.com/sponsors/znck) for continued development of this package and other VueDX tools.\n\n## Usage\n\n\n\n\n## API\n\n\n\n\n### [ConfiguredVueProject](#-vuedx-analyze-ConfiguredVueProject-class)\n\n\n\n\n Analyze
\nA tool to statically analyze Vue single file components.
\nMore info
\n\n**Signature:**\n```ts\ndeclare class ConfiguredVueProject extends VueProject {\n constructor(rootDir: string, packageFile: string | undefined, packageJSON: Partial\n\n\n\n#### [setFileNames](#-vuedx-analyze-ConfiguredVueProject-setFileNames-member-1-)\n\n\n\n**Signature:**\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n\n### [InferredVueProject](#-vuedx-analyze-InferredVueProject-class)\n\n\n\n
More info
\n\n**Signature:**\n```ts\ndeclare class InferredVueProject extends VueProject {\n kind: \"inferred\";\n protected refresh(): void;\n}\n```\n\n**Members:**\n\n\n\n\n#### [refresh](#-vuedx-analyze-InferredVueProject-refresh-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected refresh(): void;\n```\n\n\n\n
\n\n\n\n\n### [VueProject](#-vuedx-analyze-VueProject-class)\n\n\n\n
More info
\n\n**Signature:**\n```ts\ndeclare abstract class VueProject {\n protected _config: Readonly\n\n\n\n#### [markDirty](#-vuedx-analyze-VueProject-markDirty-member-1-)\n\n\n\n**Signature:**\n```ts\nmarkDirty(): void;\n```\n\n\n
\n\n\n\n#### [refresh](#-vuedx-analyze-VueProject-refresh-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected abstract refresh(): void;\n```\n\n\n
\n\n\n\n#### [reloadIfNeeded](#-vuedx-analyze-VueProject-reloadIfNeeded-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected reloadIfNeeded(): void;\n```\n\n\n
\n\n\n\n#### [setConfig](#-vuedx-analyze-VueProject-setConfig-member-1-)\n\n\n\n**Signature:**\n```ts\nsetConfig(config: ProjectConfig): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| config |
ProjectConfig | - |\n\n\n\n\n\n#### [setFileNames](#-vuedx-analyze-VueProject-setFileNames-member-1-)\n\n\n\n**Signature:**\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n\n### [createAnalyzer](#-vuedx-analyze-createAnalyzer-function-1-)\n\n\n\n
\n): Analyzer;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| plugins |
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createAnalyzer(plugins: Plugin[], options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createFullAnalyzer](#-vuedx-analyze-createFullAnalyzer-function-1-)\n\n\n\n
\n): ReturnType;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| plugins |
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createFullAnalyzer(plugins?: Plugin[], options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createSourceRange](#-vuedx-analyze-createSourceRange-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createSourceRange(context: Context | ScriptAnalyzerContext, node: Node): SourceRange;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| context |Context | ScriptAnalyzerContext | - |\n| node | Node | - |\n\n\n\n\n\n### [toVeturData](#-vuedx-analyze-toVeturData-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function toVeturData(components: ComponentInfo[]): VeturData;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| components |ComponentInfo[] | - |\n\n\n\n\n\n### [toWebTypes](#-vuedx-analyze-toWebTypes-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function toWebTypes(name: string, version: string, components: ComponentInfo[]): WebTypes;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| name |string | - |\n| version | string | - |\n| components | ComponentInfo[] | - |\n\n\n\n\n\n### [transformToFunction](#-vuedx-analyze-transformToFunction-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function transformToFunction(content: string, options?: FunctionTransformOptions): string;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| content |string | - |\n| options | FunctionTransformOptions | - |\n\n\n\n## Types\n\n\n\n\n### [Analyzer](#-vuedx-analyze-Analyzer-interface)\n\n\n\n```ts\ninterface Analyzer {\n analyze(content: string, fileName?: string): ComponentInfo;\n analyzeScript(content: string, fileName?: string, mode?: 'script' | 'scriptSetup'): ComponentInfo;\n analyzeTemplate(content: string, fileName?: string): ComponentInfo;\n}\n```\n\n\n
\n\n\n\n### [ComponentInfo](#-vuedx-analyze-ComponentInfo-interface)\n\n\n\n```ts\ninterface ComponentInfo extends Taggable {\n aliases: string[];\n components: LocalComponentRegistrationInfo[];\n description: string;\n emits: EmitInfo[];\n errors: SyntaxError[];\n fileName: string;\n fnSetupOption?: SetupInfo;\n identifierSource: Record
\n\n\n\n### [ComponentRegistrationInfo](#-vuedx-analyze-ComponentRegistrationInfo-interface)\n\n\n\n```ts\ninterface ComponentRegistrationInfo {\n aliases: string[];\n name: string;\n source: ImportSource;\n}\n```\n\n\n
\n\n\n\n### [EmitInfo](#-vuedx-analyze-EmitInfo-interface)\n\n\n\n```ts\ninterface EmitInfo extends Taggable, Addressable {\n description: string;\n isDynamic: boolean;\n isInferred: boolean;\n name: string;\n references: SourceRange[];\n type: TypeInfo[];\n}\n```\n\n\n
\n\n\n\n### [IdentifierSource](#-vuedx-analyze-IdentifierSource-interface)\n\n\n\n```ts\ninterface IdentifierSource extends Addressable {\n name: string;\n}\n```\n\n\n
\n\n\n\n### [ImportSource](#-vuedx-analyze-ImportSource-interface)\n\n\n\n```ts\ninterface ImportSource {\n exportName?: string;\n localName: string;\n moduleName: string;\n}\n```\n\n\n
\n\n\n\n### [ImportSourceWithLocation](#-vuedx-analyze-ImportSourceWithLocation-interface)\n\n\n\n```ts\ninterface ImportSourceWithLocation extends ImportSource, Addressable {\n}\n```\n\n\n
\n\n\n\n### [LocalComponentRegistrationInfo](#-vuedx-analyze-LocalComponentRegistrationInfo-interface)\n\n\n\n```ts\ninterface LocalComponentRegistrationInfo extends ComponentRegistrationInfo, Addressable {\n kind: 'script' | 'scriptSetup';\n source: ImportSourceWithLocation;\n}\n```\n\n\n
\n\n\n\n### [Plugin](#-vuedx-analyze-Plugin-2-interface)\n\n\n\n```ts\ninterface Plugin {\n babel?: AbstractScriptAnalyzerFn | AbstractAnalyzerHandler;\n blocks?: Partial<{\n script: BlockAnalyzer
\n\n\n\n### [PropInfo](#-vuedx-analyze-PropInfo-interface)\n\n\n\n```ts\ninterface PropInfo extends Taggable, Addressable {\n defaultValue: ValueInfo | null;\n description: string;\n name: string;\n required: boolean;\n type: TypeInfo[];\n}\n```\n\n\n
\n\n\n\n### [ScriptSetupInfo](#-vuedx-analyze-ScriptSetupInfo-interface)\n\n\n\n```ts\ninterface ScriptSetupInfo {\n defineEmit?: Addressable;\n defineProps?: Addressable;\n}\n```\n\n\n
\n\n\n\n### [SetupInfo](#-vuedx-analyze-SetupInfo-interface)\n\n\n\n```ts\ninterface SetupInfo extends Addressable {\n context?: {\n identifiers: Partial<{\n attrs: string;\n slots: string;\n emit: string;\n }>;\n rest?: string;\n } & Addressable;\n props?: {\n identifiers: string[];\n rest?: string;\n } & Addressable;\n return?: Addressable;\n}\n```\n\n\n
\n\n\n\n### [SourceRange](#-vuedx-analyze-SourceRange-interface)\n\n\n\n```ts\ninterface SourceRange {\n end: SourceLocation;\n source: string;\n start: SourceLocation;\n}\n```\n\n\n
\n\n\n\n### [SyntaxError](#-vuedx-analyze-SyntaxError-2-interface)\n\n\n\n```ts\ninterface SyntaxError {\n loc: SourceLocation;\n message: string;\n}\n```\n\n\n
\n\n\n\n### [VeturData](#-vuedx-analyze-VeturData-interface)\n\n\n\n```ts\ninterface VeturData {\n attributes: Record
\n\n\n\n### [WebTypes](#-vuedx-analyze-WebTypes-interface)\n\n\n\n```ts\ninterface WebTypes {\n contributions: {\n 'types-syntax': 'typescript';\n 'description-markup': 'html' | 'markdown' | 'none';\n tags: Tag[];\n attributes: Attribute[];\n };\n framework: 'vue';\n name: string;\n version: string;\n}\n```\n\n\n
\n\n","readmeFilename":"readme.md","_id":"@vuedx/analyze@0.6.2-insiders-1611564162.0","_nodeVersion":"14.14.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-x7IlgQqeFeswIvSwVwSNzmJEFVUpvvojEl43cWOlWa0T7+hqoSrym5Sa192p0Cj1bnx7zmnCKU6BoVDHQHP/vA==","shasum":"3e9bdb46cab7c1d3cc12d41cbcbdb25613e7ac9e","tarball":"https://registry.npmjs.org/@vuedx/analyze/-/analyze-0.6.2-insiders-1611564162.0.tgz","fileCount":10,"unpackedSize":467933,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgDoSeCRA9TVsSAnZWagAA75gP/Aj2e6x1B6NYh/tZX430\nMYRVZYvO8qAVRb5yac4Q5i3kR5o/myrW1LQLx+HwzTVj0ZDivma2v0TqBhjJ\nEub/CESCycirYzNm0vqcd77cawNgB578ayfE8WyvONV07NYQY3s/rSHFUKtF\nYXWo31I0QUe1QPLTyLvnNtbiNJGnERJcIunzfg0HN1JYrSVzcxq7b6m2T286\nINokxc+qsdlNed0WYp2WIFEZHJHupuyu7uC3gAisWGuDgXVJGaRIkMFnLr4/\n7+Bu6EyXs13YDGbpnNzKmT5q5mE4DuZpYGBbUbKN+EmnAKR3sD7mdAn2Vw+v\nvDJRjKeqHkxSDoY+EYm0ovXmZlUfKng5DqRz4y4YQevFg4EMlfW4J40QIP+V\neWIvWus9xzJwTM/BuxLwophkPq/zEcplbFYCLFi/2ZNx+KCvtIEAuFICgZrm\nXqJixXXhGmbfu/yyMNk67I/2fA45TIdTgpUNbea0U47wFvphjhHQDGUa69gs\n0isTPgKd8hXe+/VaDK0Ljm9IO1wFAdm8j70p+YWtVKbJa6JjiLDr4dHn9nZ5\n1AuqC1geZaGSrb1zGx78goOoBU510FF18PN+rUSS9XVMxnIewMuF4mASuj/9\nFF7y317AZccE15X37lYPamcAW57XNlAwSw3cBEezzatAcQ2UUBdGcQIMfmCc\nsA33\r\n=9msa\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQD+ulttMUAeW+jPDRQ3xy8Ymr6vW692813j6nvaCXbpEQIgcRKi7hNg2X2r4S72QZsbSx/teVuedU7q51mTxjG1RBM="}]},"_npmUser":{"name":"znck","email":"rahulkdn@gmail.com"},"directories":{},"maintainers":[{"name":"znck","email":"rahulkdn@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/analyze_0.6.2-insiders-1611564162.0_1611564189972_0.0042319490755955425"},"_hasShrinkwrap":false},"0.6.3":{"name":"@vuedx/analyze","version":"0.6.3","description":"Extracts public API information from Vue component.","main":"dist/index.cjs.js","module":"dist/index.esm.js","types":"dist/index.d.ts","bin":{"vuedx-analyze":"bin/analyze.js"},"keywords":["vue","sfc","sfc api extractor","static analyzer","sfc analyzer","sfc static analyzer","docgen","documentation"],"repository":{"type":"git","url":"git+https://github.com/znck/vue-developer-experience.git"},"author":{"name":"Rahul Kadyan","email":"rahulkdn@gmail.com","url":"https://znck.me/"},"funding":{"type":"individual","url":"https://github.com/sponsors/znck"},"license":"MIT","bugs":{"url":"https://github.com/znck/vue-developer-experience/issues"},"homepage":"https://github.com/znck/vue-developer-experience#readme","dependencies":{"@babel/code-frame":"^7.10.4","@babel/generator":"^7.12.1","@babel/parser":"^7.12.3","@babel/template":"^7.12.7","@babel/traverse":"7.12.1","@babel/types":"7.12.1","@types/micromatch":"^4.0.1","@vuedx/compiler-sfc":"0.6.2","@vuedx/compiler-tsx":"0.6.3","@vuedx/projectconfig":"0.6.2","@vuedx/template-ast-types":"0.6.2","cli-highlight":"^2.1.4","commander":"^6.1.0","fast-glob":"^3.2.4","hash-sum":"^2.0.0","@vuedx/shared":"0.6.2","micromatch":"^4.0.2"},"devDependencies":{"@types/babel__traverse":"^7.0.15","@types/node":"^14.14.14","typescript":"^4.0.3"},"_id":"@vuedx/analyze@0.6.3","_nodeVersion":"14.14.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-LiQ7Ppw4nEr5qjth+gg1m48yXD7usOcAygUU10lLwfRRlDZevxAdZRcNuC0vBOXUG3xbl6CSDXnAMeWFdlUiyw==","shasum":"f7f367ea1a1b10e22212a4f2f89d5781f17f3c84","tarball":"https://registry.npmjs.org/@vuedx/analyze/-/analyze-0.6.3.tgz","fileCount":10,"unpackedSize":468292,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgDozqCRA9TVsSAnZWagAAgF4P/3E0ECIxS9D839bHbaHP\nUovTED9mO0tZ8a6+BX2dr9WPyQ5nxtcGxncVUGQCznEHrplDRXKMrl/mldD4\nnIV1g+gw9SllCKQcZO7x+fTnyC1g8sy0fFWXHe838XmYjSb0bjdMtQlhWaSS\ncF2PhZ579M2d0dM82yOA6CdYuI2oLdJh0eG76sLV4nCdwMimalwTu+NYZoBh\nfYDcbgwviKSilBuYT9T2LTjs/Ra54vWtS2IN25Y6ZDE+7TGG+ZPOHSBuS9zy\nO6399AKKMZ9nLaIBKAHh2USdWqlUKXgMrj8f3oJM9s5uHXP9RZGMkxB+lz3m\ng3WrCb3qmdddIPf/1pdF+j2PW8m6VPITjXggISa5k3lb95+r5Njt0+T76ztf\nHKSfYWTjbICf6DZrZTnmhkxpMucJQNX7nL8hO/XJ0hKyx5PUsGP0EOXcVYC2\ncPp2g0KseSkKTazruLder17wFFNCpCw3HO2Mc04+jEQTTa1gJGECiUJ8Z7Xm\nouyJcv138TAwh1ozgXAn8EwFCf1CJjxXycsUJzRuZnDmWOAyqqd0IIuDxzi9\nMpCp+Ke6itNBFwUSCtPYlyfg5Qy8qCu8Kj8nOHxI9ppznWRLjloOplf1fPPz\npkjxGndD56kREVHR4hTxGNrBGqeZPRCRARX+P6JLLYf4+tV4pMSd+BIGRZSW\nzZOK\r\n=Rnw2\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIECrm0V60lhkvVpjZP0CS92etf+OFUa4Fq1AP9b4XppOAiBhNoOoiP8XJPdOqYLxY2w/fnCccD2mG8jhUGc+yVPJcQ=="}]},"_npmUser":{"name":"znck","email":"rahulkdn@gmail.com"},"directories":{},"maintainers":[{"name":"znck","email":"rahulkdn@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/analyze_0.6.3_1611566314473_0.39769068301014254"},"_hasShrinkwrap":false},"0.6.4-insiders-1611829384.0":{"name":"@vuedx/analyze","version":"0.6.4-insiders-1611829384.0","description":"Extracts public API information from Vue component.","main":"dist/index.cjs.js","module":"dist/index.esm.js","types":"dist/index.d.ts","bin":{"vuedx-analyze":"bin/analyze.js"},"keywords":["vue","sfc","sfc api extractor","static analyzer","sfc analyzer","sfc static analyzer","docgen","documentation"],"repository":{"type":"git","url":"git+https://github.com/znck/vue-developer-experience.git"},"author":{"name":"Rahul Kadyan","email":"rahulkdn@gmail.com","url":"https://znck.me/"},"funding":{"type":"individual","url":"https://github.com/sponsors/znck"},"license":"MIT","bugs":{"url":"https://github.com/znck/vue-developer-experience/issues"},"homepage":"https://github.com/znck/vue-developer-experience#readme","dependencies":{"@babel/code-frame":"^7.10.4","@babel/generator":"^7.12.1","@babel/parser":"^7.12.3","@babel/template":"^7.12.7","@babel/traverse":"7.12.1","@babel/types":"7.12.1","@types/micromatch":"^4.0.1","@vuedx/compiler-sfc":"0.6.3-insiders-1611829384.0","@vuedx/compiler-tsx":"0.6.4-insiders-1611829384.0","@vuedx/projectconfig":"0.6.3-insiders-1611829384.0","@vuedx/template-ast-types":"0.6.3-insiders-1611829384.0","cli-highlight":"^2.1.4","commander":"^6.1.0","fast-glob":"^3.2.4","hash-sum":"^2.0.0","@vuedx/shared":"0.6.3-insiders-1611829384.0","micromatch":"^4.0.2"},"devDependencies":{"@types/babel__traverse":"^7.0.15","@types/node":"^14.14.14","typescript":"^4.0.3"},"readme":"
\n \n
\n\n## Support\n\nThis package is part of [VueDX project](https://github.com/znck/vue-developer-experience), maintained by [Rahul Kadyan](https://github.com/znck). You can [💖 sponsor him](https://github.com/sponsors/znck) for continued development of this package and other VueDX tools.\n\n## Usage\n\n\n\n\n## API\n\n\n\n\n### [ConfiguredVueProject](#-vuedx-analyze-ConfiguredVueProject-class)\n\n\n\n\n Analyze
\nA tool to statically analyze Vue single file components.
\nMore info
\n\n**Signature:**\n```ts\ndeclare class ConfiguredVueProject extends VueProject {\n constructor(rootDir: string, packageFile: string | undefined, packageJSON: Partial\n\n\n\n#### [setFileNames](#-vuedx-analyze-ConfiguredVueProject-setFileNames-member-1-)\n\n\n\n**Signature:**\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n\n### [InferredVueProject](#-vuedx-analyze-InferredVueProject-class)\n\n\n\n
More info
\n\n**Signature:**\n```ts\ndeclare class InferredVueProject extends VueProject {\n kind: \"inferred\";\n protected refresh(): void;\n}\n```\n\n**Members:**\n\n\n\n\n#### [refresh](#-vuedx-analyze-InferredVueProject-refresh-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected refresh(): void;\n```\n\n\n\n
\n\n\n\n\n### [VueProject](#-vuedx-analyze-VueProject-class)\n\n\n\n
More info
\n\n**Signature:**\n```ts\ndeclare abstract class VueProject {\n protected _config: Readonly\n\n\n\n#### [markDirty](#-vuedx-analyze-VueProject-markDirty-member-1-)\n\n\n\n**Signature:**\n```ts\nmarkDirty(): void;\n```\n\n\n
\n\n\n\n#### [refresh](#-vuedx-analyze-VueProject-refresh-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected abstract refresh(): void;\n```\n\n\n
\n\n\n\n#### [reloadIfNeeded](#-vuedx-analyze-VueProject-reloadIfNeeded-member-1-)\n\n\n\n**Signature:**\n```ts\nprotected reloadIfNeeded(): void;\n```\n\n\n
\n\n\n\n#### [setConfig](#-vuedx-analyze-VueProject-setConfig-member-1-)\n\n\n\n**Signature:**\n```ts\nsetConfig(config: ProjectConfig): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| config |
ProjectConfig | - |\n\n\n\n\n\n#### [setFileNames](#-vuedx-analyze-VueProject-setFileNames-member-1-)\n\n\n\n**Signature:**\n```ts\nsetFileNames(fileNames: string[]): void;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| fileNames |
string[] | - |\n\n\n
\n\n\n\n\n### [createAnalyzer](#-vuedx-analyze-createAnalyzer-function-1-)\n\n\n\n
\n): Analyzer;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| plugins |
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createAnalyzer(plugins: Plugin[], options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createFullAnalyzer](#-vuedx-analyze-createFullAnalyzer-function-1-)\n\n\n\n
\n): ReturnType;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| plugins |
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createFullAnalyzer(plugins?: Plugin[], options?: PartialPlugin[] | - |\n| options | Partial<Context['parsers']> | - |\n\n\n\n\n\n### [createSourceRange](#-vuedx-analyze-createSourceRange-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function createSourceRange(context: Context | ScriptAnalyzerContext, node: Node): SourceRange;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| context |Context | ScriptAnalyzerContext | - |\n| node | Node | - |\n\n\n\n\n\n### [toVeturData](#-vuedx-analyze-toVeturData-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function toVeturData(components: ComponentInfo[]): VeturData;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| components |ComponentInfo[] | - |\n\n\n\n\n\n### [toWebTypes](#-vuedx-analyze-toWebTypes-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function toWebTypes(name: string, version: string, components: ComponentInfo[]): WebTypes;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| name |string | - |\n| version | string | - |\n| components | ComponentInfo[] | - |\n\n\n\n\n\n### [transformToFunction](#-vuedx-analyze-transformToFunction-function-1-)\n\n\n\n
\n
\nMore info
\n\n**Signature:**\n```ts\ndeclare function transformToFunction(content: string, options?: FunctionTransformOptions): string;\n```\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| content |string | - |\n| options | FunctionTransformOptions | - |\n\n\n\n## Types\n\n\n\n\n### [Analyzer](#-vuedx-analyze-Analyzer-interface)\n\n\n\n```ts\ninterface Analyzer {\n analyze(content: string, fileName?: string): ComponentInfo;\n analyzeScript(content: string, fileName?: string, mode?: 'script' | 'scriptSetup'): ComponentInfo;\n analyzeTemplate(content: string, fileName?: string): ComponentInfo;\n}\n```\n\n\n
\n\n\n\n### [ComponentInfo](#-vuedx-analyze-ComponentInfo-interface)\n\n\n\n```ts\ninterface ComponentInfo extends Taggable {\n aliases: string[];\n components: LocalComponentRegistrationInfo[];\n description: string;\n emits: EmitInfo[];\n errors: SyntaxError[];\n fileName: string;\n fnSetupOption?: SetupInfo;\n identifierSource: Record
\n\n\n\n### [ComponentRegistrationInfo](#-vuedx-analyze-ComponentRegistrationInfo-interface)\n\n\n\n```ts\ninterface ComponentRegistrationInfo {\n aliases: string[];\n name: string;\n source: ImportSource;\n}\n```\n\n\n
\n\n\n\n### [EmitInfo](#-vuedx-analyze-EmitInfo-interface)\n\n\n\n```ts\ninterface EmitInfo extends Taggable, Addressable {\n description: string;\n isDynamic: boolean;\n isInferred: boolean;\n name: string;\n references: SourceRange[];\n type: TypeInfo[];\n}\n```\n\n\n
\n\n\n\n### [IdentifierSource](#-vuedx-analyze-IdentifierSource-interface)\n\n\n\n```ts\ninterface IdentifierSource extends Addressable {\n name: string;\n}\n```\n\n\n
\n\n\n\n### [ImportSource](#-vuedx-analyze-ImportSource-interface)\n\n\n\n```ts\ninterface ImportSource {\n exportName?: string;\n localName: string;\n moduleName: string;\n}\n```\n\n\n
\n\n\n\n### [ImportSourceWithLocation](#-vuedx-analyze-ImportSourceWithLocation-interface)\n\n\n\n```ts\ninterface ImportSourceWithLocation extends ImportSource, Addressable {\n}\n```\n\n\n
\n\n\n\n### [LocalComponentRegistrationInfo](#-vuedx-analyze-LocalComponentRegistrationInfo-interface)\n\n\n\n```ts\ninterface LocalComponentRegistrationInfo extends ComponentRegistrationInfo, Addressable {\n kind: 'script' | 'scriptSetup';\n source: ImportSourceWithLocation;\n}\n```\n\n\n
\n\n\n\n### [Plugin](#-vuedx-analyze-Plugin-2-interface)\n\n\n\n```ts\ninterface Plugin {\n babel?: AbstractScriptAnalyzerFn | AbstractAnalyzerHandler;\n blocks?: Partial<{\n script: BlockAnalyzer
\n\n\n\n### [PropInfo](#-vuedx-analyze-PropInfo-interface)\n\n\n\n```ts\ninterface PropInfo extends Taggable, Addressable {\n defaultValue: ValueInfo | null;\n description: string;\n name: string;\n required: boolean;\n type: TypeInfo[];\n}\n```\n\n\n
\n\n\n\n### [ScriptSetupInfo](#-vuedx-analyze-ScriptSetupInfo-interface)\n\n\n\n```ts\ninterface ScriptSetupInfo {\n defineEmit?: Addressable;\n defineProps?: Addressable;\n}\n```\n\n\n
\n\n\n\n### [SetupInfo](#-vuedx-analyze-SetupInfo-interface)\n\n\n\n```ts\ninterface SetupInfo extends Addressable {\n context?: {\n identifiers: Partial<{\n attrs: string;\n slots: string;\n emit: string;\n }>;\n rest?: string;\n } & Addressable;\n props?: {\n identifiers: string[];\n rest?: string;\n } & Addressable;\n return?: Addressable;\n}\n```\n\n\n
\n\n\n\n### [SourceRange](#-vuedx-analyze-SourceRange-interface)\n\n\n\n```ts\ninterface SourceRange {\n end: SourceLocation;\n source: string;\n start: SourceLocation;\n}\n```\n\n\n
\n\n\n\n### [SyntaxError](#-vuedx-analyze-SyntaxError-2-interface)\n\n\n\n```ts\ninterface SyntaxError {\n loc: SourceLocation;\n message: string;\n}\n```\n\n\n
\n\n\n\n### [VeturData](#-vuedx-analyze-VeturData-interface)\n\n\n\n```ts\ninterface VeturData {\n attributes: Record
\n\n\n\n### [WebTypes](#-vuedx-analyze-WebTypes-interface)\n\n\n\n```ts\ninterface WebTypes {\n contributions: {\n 'types-syntax': 'typescript';\n 'description-markup': 'html' | 'markdown' | 'none';\n tags: Tag[];\n attributes: Attribute[];\n };\n framework: 'vue';\n name: string;\n version: string;\n}\n```\n\n\n
\n\n","readmeFilename":"readme.md","_id":"@vuedx/analyze@0.6.4-insiders-1611829384.0","_nodeVersion":"14.14.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-ohs1Ebwze/v3wd3uq5UZAmgTDsNViEu8i4t2mLdGXG1M/5Yuv73a8Zuq8HwxXXnIe4I2mHDkxv1fz9WHviMqOw==","shasum":"0a8d57222fafe23efaf6a43a7e0122f143f3a353","tarball":"https://registry.npmjs.org/@vuedx/analyze/-/analyze-0.6.4-insiders-1611829384.0.tgz","fileCount":10,"unpackedSize":468424,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgEpClCRA9TVsSAnZWagAAVy4P/2gZbn6PryYP7z7UOWcF\nFJAmWrji8LowO9StmIY0KRxKKrgeL43yywNte9CPaQynfxdOUZfmZD72t1zC\nlafmA8e/JT3zcCMfVL9i+u0AdnkeglYmPrJSMcDjxl8o7bbnDlm0NDuKuuvr\n5EWhZuqu7ZssZ45LJwQ2JY8ht9dqyHbK7FlhTRoi1nx4shegmx5flwhntDni\nRmaEoOOmnxryaQgr17qBrGxvafkZbwyCKFZyXCk7SiKUkXsxfeln54VGdA65\noNpUizBUOVnNBb+bdzCh8Q8o1aW35D3JHt1CXtq39Eq8eYQrM1g76oOzw+lP\nszSl7YcsEuQu/kOtq72eWAoDNyvKHWIfcFF+CoZgqOj46Ia3VMffX9Pj2K6I\nIZ4WSY6Ji/MNdTbp9OxJ0b124C0jQobHNIVSFxkwtVVSfbMMZRYQbWwPzDPb\nFFhny2UGsFa19DKpVv6kDvBFVZd0Q8lluKVJLoGDIy1DRNiFhXQY2MpCff/+\nNq8oTSpypRj7I0kXbHhlsYNPMM4TMe9DB5BHXRxDgthDifw5FP1g+B8RXVdz\nMJzRkTx+mTU/r++eatJzl5dzNZS/3kWWBC1B2xQaUVV/xCB4fRp5YP3GalTa\ncwH3uU6VzcsigN0G8ctWqOx2aV5MtplteNbHHv9qfNafNHBngQIhQQlxv8IN\nImKK\r\n=5Qlj\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIDxCX+OMFhoHUV5mbZ5QTVp3DA9IELyoh6pC5LlGC9PVAiBiHlvLKnqpMsoGotMzo7orRIWqVDmc6E3ieu+SLEHU1g=="}]},"_npmUser":{"name":"znck","email":"rahulkdn@gmail.com"},"directories":{},"maintainers":[{"name":"znck","email":"rahulkdn@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/analyze_0.6.4-insiders-1611829384.0_1611829412937_0.420589645554037"},"_hasShrinkwrap":false},"0.7.1-insiders-1623221784.0":{"name":"@vuedx/analyze","version":"0.7.1-insiders-1623221784.0","description":"Extracts public API information from Vue component.","main":"lib/index.js","module":"lib/index.mjs","types":"lib/index.d.ts","exports":{"require":"./lib/index.js","import":"./lib/index.mjs"},"publishConfig":{"types":"lib/index.d.ts"},"bin":{"vuedx-analyze":"bin/analyze.js"},"buildConfig":{"external":["typescript"]},"keywords":["vue","sfc","sfc api extractor","static analyzer","sfc analyzer","sfc static analyzer","docgen","documentation"],"repository":{"type":"git","url":"git+https://github.com/znck/vue-developer-experience.git"},"author":{"name":"Rahul Kadyan","email":"rahulkdn@gmail.com","url":"https://znck.me/"},"funding":{"type":"individual","url":"https://github.com/sponsors/znck"},"license":"MIT","bugs":{"url":"https://github.com/znck/vue-developer-experience/issues"},"homepage":"https://github.com/znck/vue-developer-experience#readme","dependencies":{"@babel/code-frame":"^7.10.4","@babel/generator":"^7.12.1","@babel/parser":"^7.12.3","@babel/template":"^7.12.7","@babel/traverse":"7.12.1","@babel/types":"7.12.1","@types/micromatch":"^4.0.1","@vuedx/compiler-sfc":"0.7.1-insiders-1623221784.0","@vuedx/compiler-tsx":"0.7.1-insiders-1623221784.0","@vuedx/projectconfig":"0.7.1-insiders-1623221784.0","@vuedx/template-ast-types":"0.7.1-insiders-1623221784.0","cli-highlight":"^2.1.4","commander":"^6.1.0","fast-glob":"^3.2.4","hash-sum":"^2.0.0","@vuedx/shared":"0.7.1-insiders-1623221784.0","micromatch":"^4.0.2"},"devDependencies":{"@types/babel__traverse":"^7.0.15","@types/node":"^14.14.14","typescript":"^4.0.3"},"readme":"
\n \n
\n\n## Support\n\nThis package is part of [VueDX project](https://github.com/znck/vue-developer-experience), maintained by [Rahul Kadyan](https://github.com/znck). You can [💖 sponsor him](https://github.com/sponsors/znck) for continued development of this package and other VueDX tools.\n\n## Usage\n\n\n\n\n## API\n\n\n\n\n### [ConfiguredVueProject](#-vuedx-analyze-ConfiguredVueProject-class)\n\n\n\n\n Analyze
\nA tool to statically analyze Vue single file components.
\n