Add elements manifest

Author: clintcs

.changeset/neat-carpets-applaud.md

@@ -0,0 +1,5 @@
+---
+'@crowdstrike/glide-core': patch
+---
+
+Each component now includes a JSDoc comment at the top with its attributes, slots, custom properties, events, properties, and methods,

custom-elements.config.js

@@ -0,0 +1,34 @@
+// The analyzer expects plugins to be JavaScript. But writing plugins in
+// JavaScript is unruly and error prone. So they're written in TypeScript,
+// then compiled and imported as JavaScript.
+import addCustomProperties from './dist/cem-analyzer-plugins/add-custom-properties.js';
+import addEvents from './dist/cem-analyzer-plugins/add-events.js';
+import addRequired from './dist/cem-analyzer-plugins/add-required.js';
+import addSlots from './dist/cem-analyzer-plugins/add-slots.js';
+import modifyVersionAttribute from './dist/cem-analyzer-plugins/modify-version-attribute.js';
+import removeBlockComments from './dist/cem-analyzer-plugins/remove-block-comments.js';
+
+export default {
+  exclude: [
+    './src/**/*stories*',
+    './src/**/*test*',
+    './src/cem-analzyer-plugins/**',
+    './src/eslint/**',
+    './src/icons/**',
+    './src/library/**',
+    './src/stylelint/**',
+    './src/styles/**',
+    './src/translations/**',
+    './src/ts-morph/**',
+  ],
+  globs: ['./src/*.ts'],
+  litelement: true,
+  plugins: [
+    removeBlockComments(),
+    addCustomProperties(),
+    addEvents(),
+    addRequired(),
+    addSlots(),
+    modifyVersionAttribute(),
+  ],
+};

custom-elements.json

@@ -43,12 +43,19 @@
   "scripts": {
     "start": "per-env",
     "start:development": "npm-run-all --parallel --print-name start:development:*",
+    "start:development:cem-analyze": "chokidar ./custom-elements.config.js './src/*.ts' './src/*.*.ts' './src/cem-analyzer-plugins/**' --ignore '**/*stories*' --ignore '**/*test*' --initial --silent --command 'tsc --noCheck --outDir ./dist && NODE_OPTIONS=--no-warnings=ExperimentalWarning cem analyze --config ./custom-elements.config.js --quiet'",
+    "start:development:cem-analyze:comment": "JSON module imports produce a warning. Remove NODE_OPTIONS when JSON module imports are no longer experimental.",
     "start:development:storybook": "storybook dev --config-dir .storybook --no-open --no-version-updates --port 6006",
+    "start:development:ts-morph": "chokidar './src/ts-morph/**' --initial --silent --command 'tsx ./src/ts-morph/run.ts'",
+    "start:development:ts-morph:comment:tsx": "Remove `tsx` once Node.js type stripping is available.",
+    "start:development:ts-morph:comment:watching": "It would be helpful to also watch './custom-elements.json`. But doing so would create a loop between this script and `start:development:cem-analyze`.",
     "start:production": "rimraf ./dist && npm-run-all --aggregate-output --print-label --parallel start:production:components start:production:storybook start:production:stylesheets",
     "start:production:components": "tsc --noCheck --outDir ./dist && node ./terser.js",
     "start:production:figma": "pnpm dt export-variables && pnpm dt build-tokens && pnpm dt build-styles",
+    "start:production:cem-analyze": "tsc --noCheck --outDir ./dist && NODE_OPTIONS=--no-warnings=ExperimentalWarning cem analyze --config ./custom-elements.config.js --quiet && git diff --quiet -- || { echo ERROR: Uncommitted elements manifest changes. Run this command locally and commit the changes.; exit 1; }",
     "start:production:storybook": "storybook build --config-dir .storybook --disable-telemetry --output-dir ./dist/storybook",
     "start:production:stylesheets": "node ./esbuild.js",
+    "start:production:ts-morph": "tsx ./src/ts-morph/run.ts && git diff --quiet -- || { echo ERROR: Uncommitted code modifications. Run this command locally and commit the changes.; exit 1; }",
     "format": "per-env",
     "format:development": "chokidar '**/*' --ignore 'dist/**' --ignore '.changeset/**' --ignore '.git/**' --ignore 'node_modules/**' --ignore 'pnpm-lock.yaml' --initial --silent --comand 'prettier --write --ignore-unknown {path} && stylelint {path}'",
     "format:production": "prettier . --debug-check",
@@ -89,6 +96,7 @@
     "@changesets/changelog-github": "^0.5.0",
     "@changesets/cli": "^2.27.10",
     "@crowdstrike/design-tokens": "^2.0.1",
+    "@custom-elements-manifest/analyzer": "^0.10.4",
     "@eslint/eslintrc": "^3.2.0",
     "@eslint/js": "^9.17.0",
     "@open-wc/testing": "^4.0.0",
@@ -118,6 +126,7 @@
     "chalk": "^5.3.0",
     "chokidar-cli": "^3.0.0",
     "comment-parser": "^1.4.1",
+    "custom-elements-manifest": "^2.1.0",
     "esbuild": "^0.25.0",
     "eslint": "^9.17.0",
     "eslint-config-prettier": "^10.0.1",
@@ -152,6 +161,8 @@
     "stylelint-use-nesting": "^6.0.0",
     "terser": "^5.37.0",
     "ts-lit-plugin": "^2.0.2",
+    "ts-morph": "^25.0.1",
+    "tsx": "^4.19.2",
     "typescript": "^5.7.2",
     "typescript-eslint": "^8.23.0",
     "vite": "^6.0.7",