@cssdoc/vscode-custom-data 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Danny Wahl
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,34 @@
+# @cssdoc/vscode-custom-data
+
+Generate [VS Code custom data](https://github.com/microsoft/vscode-custom-data) from the cssdoc model,
+so the built-in CSS and HTML language services offer completions and hover for the documented surface —
+no extension required.
+
+- `html.customData` lists component classes and modifiers as `class`-attribute values → class-name
+  completion in `class="…"`.
+- `css.customData` lists the declared custom properties.
+
+## Usage
+
+```ts
+import { createIndex } from "@cssdoc/index";
+import { writeVscodeCustomData } from "@cssdoc/vscode-custom-data";
+import { readFileSync } from "node:fs";
+
+const index = createIndex(readFileSync("dist/components.css", "utf8"));
+writeVscodeCustomData({ index, outDir: ".vscode" });
+```
+
+Then point VS Code at the files:
+
+```jsonc
+// .vscode/settings.json
+{
+  "css.customData": [".vscode/css-custom-data.json"],
+  "html.customData": [".vscode/html-custom-data.json"],
+}
+```
+
+## License
+
+MIT

package/dist/index.d.mts

@@ -0,0 +1,41 @@
+import { CssDocIndex } from "@cssdoc/index";
+
+//#region src/index.d.ts
+/** A CSS custom-data property entry. */
+interface CssDataProperty {
+  name: string;
+  description?: string;
+}
+/** The `css.customData` document shape. */
+interface CssCustomData {
+  version: 1.1;
+  properties: CssDataProperty[];
+}
+/** An HTML custom-data attribute value. */
+interface HtmlAttributeValue {
+  name: string;
+  description?: string;
+}
+/** The `html.customData` document shape (only the `class` global attribute is populated). */
+interface HtmlCustomData {
+  version: 1.1;
+  globalAttributes: {
+    name: string;
+    description?: string;
+    values: HtmlAttributeValue[];
+  }[];
+}
+/** Build the `css.customData` document: the declared custom properties. */
+declare function cssCustomData(index: CssDocIndex): CssCustomData;
+/** Build the `html.customData` document: component classes and modifiers as `class` values. */
+declare function htmlCustomData(index: CssDocIndex): HtmlCustomData;
+/** Write `css-custom-data.json` and `html-custom-data.json` into `outDir`. */
+declare function writeVscodeCustomData(options: {
+  index: CssDocIndex;
+  outDir: string;
+}): {
+  cssPath: string;
+  htmlPath: string;
+};
+//#endregion
+export { CssCustomData, CssDataProperty, HtmlAttributeValue, HtmlCustomData, cssCustomData, htmlCustomData, writeVscodeCustomData };

package/dist/index.mjs

@@ -0,0 +1,61 @@
+import { mkdirSync, writeFileSync } from "node:fs";
+import { join } from "node:path";
+//#region src/index.ts
+/**
+* `@cssdoc/vscode-custom-data` — generate VS Code custom data from the cssdoc model, so the built-in
+* CSS and HTML language services offer completions and hover for the documented surface with no
+* extension. `html.customData` lists the component classes and modifiers as `class`-attribute values;
+* `css.customData` lists the declared custom properties.
+*
+* @module @cssdoc/vscode-custom-data
+*/
+const stripDot = (name) => name.replace(/^\./u, "");
+/** Build the `css.customData` document: the declared custom properties. */
+function cssCustomData(index) {
+	return {
+		version: 1.1,
+		properties: index.allCustomProperties().map(({ property }) => ({
+			name: property.name,
+			description: [property.syntax && `syntax: \`${property.syntax}\``, property.description].filter(Boolean).join(" — ") || void 0
+		}))
+	};
+}
+/** Build the `html.customData` document: component classes and modifiers as `class` values. */
+function htmlCustomData(index) {
+	const values = [];
+	const seen = /* @__PURE__ */ new Set();
+	const add = (name, description) => {
+		if (seen.has(name)) return;
+		seen.add(name);
+		values.push({
+			name,
+			description
+		});
+	};
+	for (const entry of index.entries) {
+		add(stripDot(entry.className), entry.summary);
+		for (const m of entry.modifiers) add(`-${m.name.replace(/^-/u, "")}`, [m.description, m.deprecated && "(deprecated)"].filter(Boolean).join(" ") || void 0);
+	}
+	return {
+		version: 1.1,
+		globalAttributes: [{
+			name: "class",
+			description: "Documented CSS classes and modifiers.",
+			values
+		}]
+	};
+}
+/** Write `css-custom-data.json` and `html-custom-data.json` into `outDir`. */
+function writeVscodeCustomData(options) {
+	mkdirSync(options.outDir, { recursive: true });
+	const cssPath = join(options.outDir, "css-custom-data.json");
+	const htmlPath = join(options.outDir, "html-custom-data.json");
+	writeFileSync(cssPath, `${JSON.stringify(cssCustomData(options.index), null, 2)}\n`);
+	writeFileSync(htmlPath, `${JSON.stringify(htmlCustomData(options.index), null, 2)}\n`);
+	return {
+		cssPath,
+		htmlPath
+	};
+}
+//#endregion
+export { cssCustomData, htmlCustomData, writeVscodeCustomData };

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@cssdoc/vscode-custom-data",
+  "version": "0.1.0",
+  "description": "Generate VS Code custom data (css.customData + html.customData) from the cssdoc model, for built-in editor completions and hover.",
+  "keywords": [
+    "css",
+    "cssdoc",
+    "custom-data",
+    "intellisense",
+    "vscode"
+  ],
+  "homepage": "https://cssdoc.dev",
+  "bugs": "https://github.com/thedannywahl/cssdoc/issues",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/thedannywahl/cssdoc.git",
+    "directory": "generators/vscode-custom-data"
+  },
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "exports": {
+    ".": "./dist/index.mjs",
+    "./package.json": "./package.json"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@cssdoc/core": "0.1.0",
+    "@cssdoc/index": "0.1.0"
+  },
+  "devDependencies": {
+    "@types/node": "^24.13.3",
+    "publint": "^0.3.21",
+    "typescript": "^6.0.3",
+    "vite": "npm:@voidzero-dev/vite-plus-core@0.2.4",
+    "vite-plus": "0.2.4"
+  },
+  "scripts": {
+    "build": "vp pack",
+    "dev": "vp pack --watch",
+    "test": "vp test",
+    "check": "vp check",
+    "publint": "publint"
+  }
+}