How to help your editor love your Vue component library
summary
An editor-facing metadata format called web-types JSON format describes components, props, events, slots and docs so editors and doc generators can consume a single machine-readable artifact; implementation explores parsing/indexing, runtime extraction and .d.ts-like approaches, and a generator that recovers about 60-70% extraction of events and slots from libraries. Web-types gets bundled with libraries (mentioned: bootstrap view and others), receives immediate local-development requests, and demonstrably improves completion, hover docs and auto-imports.
AI-written summary · about
chapters (15)
- 0:00Introduction
- 3:04Syntax highlighting
- 7:12Analyzing source code
- 10:06Analyzing libraries
- 12:35Typescript definition files
- 13:55Looking for other solutions
- 14:36API JSON files
- 15:03Vue doc parser
- 15:40Create your own standard
- 17:12Webtypes
- 18:56Documentation
- 19:51Markdown
- 20:35Future plans
- 21:20Community involvement
- 23:08Questions
related talks
19mWeb-Types or why quick documentation matters
29mTypescript + Vue @ Politico
44mVue 3: A Maturation of the Platform
45mInside Vue Components
47mVue.js and TypeScript: Working Together like Peanut Butter & Jelly
29mVue & TypeScript Up and Running
31mBuilding Components for Vue 2&3 - an Attempt at solving the challenge
30mState of DX