summaryrefslogtreecommitdiffstats
path: root/browser/components/storybook/custom-elements-manifest.config.mjs
diff options
context:
space:
mode:
Diffstat (limited to 'browser/components/storybook/custom-elements-manifest.config.mjs')
-rw-r--r--browser/components/storybook/custom-elements-manifest.config.mjs46
1 files changed, 46 insertions, 0 deletions
diff --git a/browser/components/storybook/custom-elements-manifest.config.mjs b/browser/components/storybook/custom-elements-manifest.config.mjs
new file mode 100644
index 0000000000..e399b5432c
--- /dev/null
+++ b/browser/components/storybook/custom-elements-manifest.config.mjs
@@ -0,0 +1,46 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this file,
+ * You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+/**
+ * Custom element manifest analyzer plugin to remove static and private
+ * properties from custom-elements.json that we don't want to document in our
+ * Storybook props tables.
+ */
+function removePrivateAndStaticFields() {
+ return {
+ packageLinkPhase({ customElementsManifest }) {
+ customElementsManifest?.modules?.forEach(module => {
+ module?.declarations?.forEach(declaration => {
+ if (declaration.members != null) {
+ declaration.members = declaration.members.filter(member => {
+ return (
+ !member.kind === "field" ||
+ (!member.static && !member.name.startsWith("#"))
+ );
+ });
+ }
+ });
+ });
+ },
+ };
+}
+
+/**
+ * Custom element manifest config. Controls how we parse directories for custom
+ * elements to populate custom-elements.json, which is used by Storybook to
+ * generate docs.
+ */
+const config = {
+ globs: ["../../../toolkit/content/widgets/**/*.mjs"],
+ exclude: [
+ "../../../toolkit/content/widgets/**/*.stories.mjs",
+ "../../../toolkit/content/widgets/vendor/**",
+ "../../../toolkit/content/widgets/lit-utils.mjs",
+ ],
+ outdir: ".",
+ litelement: true,
+ plugins: [removePrivateAndStaticFields()],
+};
+
+export default config;