vue-component-meta
Advanced tools
vue-component-meta allows you to extract the meta-data like props, slots, events, etc from your components via static code analysis. You can even generate description for your props from your source code. This helps document your components via automation. Please refer to the reference section for references.
First of all, you need to create a component meta checker using createChecker:
import * as url from 'url'
import path from 'path'
import type { MetaCheckerOptions } from 'vue-component-meta'
import { createChecker } from 'vue-component-meta'
const __dirname = url.fileURLToPath(new URL('.', import.meta.url))
const checkerOptions: MetaCheckerOptions = {
forceUseTs: true,
schema: { ignore: ['MyIgnoredNestedProps'] },
printer: { newLine: 1 },
}
const tsconfigChecker = createChecker(
// Write your tsconfig path
path.join(__dirname, 'path-to-tsconfig'),
checkerOptions,
)
Now, you can extract the component meta using getComponentMeta method of checker:
import * as url from 'url'
import path from 'path'
const __dirname = url.fileURLToPath(new URL('.', import.meta.url))
const componentPath = path.join(__dirname, 'path-to-component');
const meta = checker.getComponentMeta(componentPath);
This meta contains really useful stuff like component props, slots, events and more. You can refer to its type definition for more details.
vue-component-meta will automatically extract the prop details like its name, default value, is required or not, etc. Additionally, you can even write prop description in source code via JSDoc comment for that prop.
/**
* Hide/Show alert based on v-model value
*/
modelValue: {
type: Boolean,
default: null,
},
When you extract the component meta and extract the description property of that prop it will be "Hide/Show alert based on v-model value" 😍
Warning
Do note that
meta.propswill be array of props so you can't access it viameta.props.<prop-name>. Moreover,meta.propswill also contain some global prop which you can identify viaprop.globalproperty.
You can use it to document your component as you build your project without writing additional documentation.
As vue-component-meta uses static code analysis, it can't extract the dynamic prop definition.
vue-component-meta won't be able to extract default value for prop as props can't be analyzed.
props: {
// Props definition by function execution
...useLayerProps({
color: {
default: 'primary',
},
variant: {
default: 'light',
},
}),
}
In this scenario, to get the correct default value you can let vue-component-meta know it by writing them explicitly:
props: {
// let vue-component-meta found it
color: { default: 'primary' },
variant: { default: 'light' },
// Props definition by function execution
...useLayerProps({
color: {
default: 'primary',
},
variant: {
default: 'light',
},
}),
}
Same as above scenario you might have issue with description not generating when prop definition is dynamic. In this case writing prop description can be tricky.
When it's function execution, write prop description in function definition:
export const useLayerProp = (...) => {
const props = {
/**
* Layer variant
*/
variant: {
type: String,
default: 'text',
},
}
export { props }
}
For generating the correct required value for props like below:
// @/composables/useProps.ts
export const disabled = {
type: Boolean,
default: false,
}
import { disabled } from '@/composables/useProps'
export default defineComponent({
props: {
disabled,
},
})
You need to add as const to variable definition:
export const disabled = {
type: Boolean,
default: false,
- }
+ } as const
vue-component-meta to generate components' API via automation.
2.1.8 <sup>official</sup>, 2.1.9 <sup>insiders</sup> (2024-10-26)
$el type (#4805) - Thanks to @KazariEX!v-for with v-once correctly (#4830) - Thanks to @KazariEX!this to __VLS_ctx (#4845) - Thanks to @KazariEX!<component :is> and <slot :name> (#4661) - Thanks to @KazariEX, @so1ve!defineModel & defineEmits in generic (#4823) - Thanks to @KazariEX!useTemplateRef into correct location (#4829) - Thanks to @KazariEX!v-on on <slot> (#4864) - Thanks to @KazariEX!) (#4887) - Thanks to @KazariEX!value instead of model name into tuple (#4892) - Thanks to @KazariEX!v-for correctly (#4933) - Thanks to @KazariEX!Reactive on v-for (#4902) - Thanks to @KazariEX!v2.4.1 to v2.4.8:
importsNotUsedAsValues (#4897) - Thanks to @KazariEX!"module": "CommonJS" (#4944) - Thanks to @KazariEX!FAQs
Unknown package
The npm package vue-component-meta receives a total of 192,954 weekly downloads. As such, vue-component-meta popularity was classified as popular.
We found that vue-component-meta demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.