fix(writer): rename internal RestProps --> $RestProps (#148)

Fixes #147
carbon-design-system · Oct 27, 2024 · 9534dd4 · 9534dd4
1 parent f4a2ee5
commit 9534dd4
Show file tree

Hide file tree

Showing 157 changed files with 324 additions and 324 deletions.
diff --git a/README.md b/README.md
@@ -41,7 +41,7 @@ The generated definition extends the official `SvelteComponentTyped` interface e
 import type { SvelteComponentTyped } from "svelte";
 import type { SvelteHTMLElements } from "svelte/elements";
 
-type RestProps = SvelteHTMLElements["button"];
+type $RestProps = SvelteHTMLElements["button"];
 
 type $Props = {
   /**
@@ -57,7 +57,7 @@ type $Props = {
   [key: `data-${string}`]: any;
 };
 
-export type ButtonProps = Omit<RestProps, keyof $Props> & $Props;
+export type ButtonProps = Omit<$RestProps, keyof $Props> & $Props;
 
 export default class Button extends SvelteComponentTyped<
   ButtonProps,
@@ -85,7 +85,7 @@ The accompanying JSDoc annotations would generate the following:
 ```ts
 import type { SvelteHTMLElements } from "svelte/elements";
 
-type RestProps = SvelteHTMLElements["button"];
+type $RestProps = SvelteHTMLElements["button"];
 
 type $Props = {
   /**
@@ -100,7 +100,7 @@ type $Props = {
   primary?: boolean;
 };
 
-export type ButtonProps = Omit<RestProps, keyof $Props> & $Props;
+export type ButtonProps = Omit<$RestProps, keyof $Props> & $Props;
 
 export default class Button extends SvelteComponentTyped<
   ButtonProps,

diff --git a/src/writer/writer-ts-definitions.ts b/src/writer/writer-ts-definitions.ts
@@ -89,14 +89,14 @@ function genPropDef(def: Pick<ComponentDocApi, "props" | "rest_props" | "moduleN
     const dataAttributes = "[key: `data-${string}`]: any;";
 
     prop_def = `
-    ${extend_tag_map ? `type RestProps = ${extend_tag_map};\n` : ""}
+    ${extend_tag_map ? `type $RestProps = ${extend_tag_map};\n` : ""}
     type $Props${genericsName} = {
       ${props}
       
       ${dataAttributes}
     };
 
-    export type ${props_name}${genericsName} = Omit<RestProps, keyof $Props${genericsName}> & $Props${genericsName};
+    export type ${props_name}${genericsName} = Omit<$RestProps, keyof $Props${genericsName}> & $Props${genericsName};
   `;
   } else {
     prop_def = `

diff --git a/tests/__snapshots__/fixtures.test.ts.snap b/tests/__snapshots__/fixtures.test.ts.snap
@@ -1326,13 +1326,13 @@ exports[`fixtures (TypeScript) "svg-props/input.svelte" 1`] = `
 "import type { SvelteComponentTyped } from "svelte";
 import type { SvelteHTMLElements } from "svelte/elements";
 
-type RestProps = SvelteHTMLElements["svg"];
+type $RestProps = SvelteHTMLElements["svg"];
 
 type $Props = {
   [key: \`data-${string}\`]: any;
 };
 
-export type SvgPropsProps = Omit<RestProps, keyof $Props> & $Props;
+export type SvgPropsProps = Omit<$RestProps, keyof $Props> & $Props;
 
 export default class SvgProps extends SvelteComponentTyped<SvgPropsProps, Record<string, any>, {}> {}
 "
@@ -1597,7 +1597,7 @@ export interface DataTableHeader<Row = DataTableRow> {
   value: string;
 }
 
-type RestProps = SvelteHTMLElements["div"];
+type $RestProps = SvelteHTMLElements["div"];
 
 type $Props<Row> = {
   /**
@@ -1613,7 +1613,7 @@ type $Props<Row> = {
   [key: \`data-${string}\`]: any;
 };
 
-export type GenericsWithRestPropsProps<Row> = Omit<RestProps, keyof $Props<Row>> & $Props<Row>;
+export type GenericsWithRestPropsProps<Row> = Omit<$RestProps, keyof $Props<Row>> & $Props<Row>;
 
 export default class GenericsWithRestProps<Row extends DataTableRow = DataTableRow> extends SvelteComponentTyped<
   GenericsWithRestPropsProps<Row>,
@@ -1822,7 +1822,7 @@ exports[`fixtures (TypeScript) "rest-props-multiple/input.svelte" 1`] = `
 "import type { SvelteComponentTyped } from "svelte";
 import type { SvelteHTMLElements } from "svelte/elements";
 
-type RestProps = SvelteHTMLElements["ul"] & SvelteHTMLElements["ol"];
+type $RestProps = SvelteHTMLElements["ul"] & SvelteHTMLElements["ol"];
 
 type $Props = {
   /**
@@ -1833,7 +1833,7 @@ type $Props = {
   [key: \`data-${string}\`]: any;
 };
 
-export type RestPropsMultipleProps = Omit<RestProps, keyof $Props> & $Props;
+export type RestPropsMultipleProps = Omit<$RestProps, keyof $Props> & $Props;
 
 export default class RestPropsMultiple extends SvelteComponentTyped<RestPropsMultipleProps, Record<string, any>, {}> {}
 "
@@ -1921,13 +1921,13 @@ exports[`fixtures (TypeScript) "rest-props-simple/input.svelte" 1`] = `
 "import type { SvelteComponentTyped } from "svelte";
 import type { SvelteHTMLElements } from "svelte/elements";
 
-type RestProps = SvelteHTMLElements["h1"];
+type $RestProps = SvelteHTMLElements["h1"];
 
 type $Props = {
   [key: \`data-${string}\`]: any;
 };
 
-export type RestPropsSimpleProps = Omit<RestProps, keyof $Props> & $Props;
+export type RestPropsSimpleProps = Omit<$RestProps, keyof $Props> & $Props;
 
 export default class RestPropsSimple extends SvelteComponentTyped<RestPropsSimpleProps, Record<string, any>, {}> {}
 "
@@ -1937,13 +1937,13 @@ exports[`fixtures (TypeScript) "anchor-props/input.svelte" 1`] = `
 "import type { SvelteComponentTyped } from "svelte";
 import type { SvelteHTMLElements } from "svelte/elements";
 
-type RestProps = SvelteHTMLElements["a"];
+type $RestProps = SvelteHTMLElements["a"];
 
 type $Props = {
   [key: \`data-${string}\`]: any;
 };
 
-export type AnchorPropsProps = Omit<RestProps, keyof $Props> & $Props;
+export type AnchorPropsProps = Omit<$RestProps, keyof $Props> & $Props;
 
 export default class AnchorProps extends SvelteComponentTyped<AnchorPropsProps, Record<string, any>, { default: {} }> {}
 "

diff --git a/tests/e2e/carbon/types/Accordion/AccordionItem.svelte.d.ts b/tests/e2e/carbon/types/Accordion/AccordionItem.svelte.d.ts
@@ -1,7 +1,7 @@
 import type { SvelteComponentTyped } from "svelte";
 import type { SvelteHTMLElements } from "svelte/elements";
 
-type RestProps = SvelteHTMLElements["li"];
+type $RestProps = SvelteHTMLElements["li"];
 
 type $Props = {
   /**
@@ -32,7 +32,7 @@ type $Props = {
   [key: `data-${string}`]: any;
 };
 
-export type AccordionItemProps = Omit<RestProps, keyof $Props> & $Props;
+export type AccordionItemProps = Omit<$RestProps, keyof $Props> & $Props;
 
 /** `AccordionItem` is slottable */
 export default class AccordionItem extends SvelteComponentTyped<

diff --git a/tests/e2e/carbon/types/Accordion/AccordionSkeleton.svelte.d.ts b/tests/e2e/carbon/types/Accordion/AccordionSkeleton.svelte.d.ts
@@ -1,7 +1,7 @@
 import type { SvelteComponentTyped } from "svelte";
 import type { SvelteHTMLElements } from "svelte/elements";
 
-type RestProps = SvelteHTMLElements["ul"];
+type $RestProps = SvelteHTMLElements["ul"];
 
 type $Props = {
   /**
@@ -31,7 +31,7 @@ type $Props = {
   [key: `data-${string}`]: any;
 };
 
-export type AccordionSkeletonProps = Omit<RestProps, keyof $Props> & $Props;
+export type AccordionSkeletonProps = Omit<$RestProps, keyof $Props> & $Props;
 
 export default class AccordionSkeleton extends SvelteComponentTyped<
   AccordionSkeletonProps,

diff --git a/tests/e2e/carbon/types/AspectRatio/AspectRatio.svelte.d.ts b/tests/e2e/carbon/types/AspectRatio/AspectRatio.svelte.d.ts
@@ -1,7 +1,7 @@
 import type { SvelteComponentTyped } from "svelte";
 import type { SvelteHTMLElements } from "svelte/elements";
 
-type RestProps = SvelteHTMLElements["div"];
+type $RestProps = SvelteHTMLElements["div"];
 
 type $Props = {
   /**
@@ -13,7 +13,7 @@ type $Props = {
   [key: `data-${string}`]: any;
 };
 
-export type AspectRatioProps = Omit<RestProps, keyof $Props> & $Props;
+export type AspectRatioProps = Omit<$RestProps, keyof $Props> & $Props;
 
 export default class AspectRatio extends SvelteComponentTyped<
   AspectRatioProps,

diff --git a/tests/e2e/carbon/types/Breadcrumb/BreadcrumbItem.svelte.d.ts b/tests/e2e/carbon/types/Breadcrumb/BreadcrumbItem.svelte.d.ts
@@ -1,7 +1,7 @@
 import type { SvelteComponentTyped } from "svelte";
 import type { SvelteHTMLElements } from "svelte/elements";
 
-type RestProps = SvelteHTMLElements["li"];
+type $RestProps = SvelteHTMLElements["li"];
 
 type $Props = {
   /**
@@ -19,7 +19,7 @@ type $Props = {
   [key: `data-${string}`]: any;
 };
 
-export type BreadcrumbItemProps = Omit<RestProps, keyof $Props> & $Props;
+export type BreadcrumbItemProps = Omit<$RestProps, keyof $Props> & $Props;
 
 export default class BreadcrumbItem extends SvelteComponentTyped<
   BreadcrumbItemProps,

diff --git a/tests/e2e/carbon/types/Breadcrumb/BreadcrumbSkeleton.svelte.d.ts b/tests/e2e/carbon/types/Breadcrumb/BreadcrumbSkeleton.svelte.d.ts
@@ -1,7 +1,7 @@
 import type { SvelteComponentTyped } from "svelte";
 import type { SvelteHTMLElements } from "svelte/elements";
 
-type RestProps = SvelteHTMLElements["div"];
+type $RestProps = SvelteHTMLElements["div"];
 
 type $Props = {
   /**
@@ -19,7 +19,7 @@ type $Props = {
   [key: `data-${string}`]: any;
 };
 
-export type BreadcrumbSkeletonProps = Omit<RestProps, keyof $Props> & $Props;
+export type BreadcrumbSkeletonProps = Omit<$RestProps, keyof $Props> & $Props;
 
 export default class BreadcrumbSkeleton extends SvelteComponentTyped<
   BreadcrumbSkeletonProps,

diff --git a/tests/e2e/carbon/types/Button/Button.svelte.d.ts b/tests/e2e/carbon/types/Button/Button.svelte.d.ts
@@ -3,7 +3,7 @@ import type { SvelteHTMLElements } from "svelte/elements";
 
 import type { ButtonSkeletonProps } from "./ButtonSkeleton.svelte";
 
-type RestProps = SvelteHTMLElements["button"] &
+type $RestProps = SvelteHTMLElements["button"] &
   SvelteHTMLElements["a"] &
   SvelteHTMLElements["div"];
 
@@ -105,7 +105,7 @@ type $Props = {
   [key: `data-${string}`]: any;
 };
 
-export type ButtonProps = Omit<RestProps, keyof $Props> & $Props;
+export type ButtonProps = Omit<$RestProps, keyof $Props> & $Props;
 
 export default class Button extends SvelteComponentTyped<
   ButtonProps,

diff --git a/tests/e2e/carbon/types/Button/ButtonSet.svelte.d.ts b/tests/e2e/carbon/types/Button/ButtonSet.svelte.d.ts
@@ -1,7 +1,7 @@
 import type { SvelteComponentTyped } from "svelte";
 import type { SvelteHTMLElements } from "svelte/elements";
 
-type RestProps = SvelteHTMLElements["div"];
+type $RestProps = SvelteHTMLElements["div"];
 
 type $Props = {
   /**
@@ -13,7 +13,7 @@ type $Props = {
   [key: `data-${string}`]: any;
 };
 
-export type ButtonSetProps = Omit<RestProps, keyof $Props> & $Props;
+export type ButtonSetProps = Omit<$RestProps, keyof $Props> & $Props;
 
 export default class ButtonSet extends SvelteComponentTyped<
   ButtonSetProps,

diff --git a/tests/e2e/carbon/types/Button/ButtonSkeleton.svelte.d.ts b/tests/e2e/carbon/types/Button/ButtonSkeleton.svelte.d.ts
@@ -1,7 +1,7 @@
 import type { SvelteComponentTyped } from "svelte";
 import type { SvelteHTMLElements } from "svelte/elements";
 
-type RestProps = SvelteHTMLElements["a"];
+type $RestProps = SvelteHTMLElements["a"];
 
 type $Props = {
   /**
@@ -26,7 +26,7 @@ type $Props = {
   [key: `data-${string}`]: any;
 };
 
-export type ButtonSkeletonProps = Omit<RestProps, keyof $Props> & $Props;
+export type ButtonSkeletonProps = Omit<$RestProps, keyof $Props> & $Props;
 
 export default class ButtonSkeleton extends SvelteComponentTyped<
   ButtonSkeletonProps,

diff --git a/tests/e2e/carbon/types/Checkbox/CheckboxSkeleton.svelte.d.ts b/tests/e2e/carbon/types/Checkbox/CheckboxSkeleton.svelte.d.ts
@@ -1,13 +1,13 @@
 import type { SvelteComponentTyped } from "svelte";
 import type { SvelteHTMLElements } from "svelte/elements";
 
-type RestProps = SvelteHTMLElements["div"];
+type $RestProps = SvelteHTMLElements["div"];
 
 type $Props = {
   [key: `data-${string}`]: any;
 };
 
-export type CheckboxSkeletonProps = Omit<RestProps, keyof $Props> & $Props;
+export type CheckboxSkeletonProps = Omit<$RestProps, keyof $Props> & $Props;
 
 export default class CheckboxSkeleton extends SvelteComponentTyped<
   CheckboxSkeletonProps,

diff --git a/tests/e2e/carbon/types/CodeSnippet/CodeSnippetSkeleton.svelte.d.ts b/tests/e2e/carbon/types/CodeSnippet/CodeSnippetSkeleton.svelte.d.ts
@@ -1,7 +1,7 @@
 import type { SvelteComponentTyped } from "svelte";
 import type { SvelteHTMLElements } from "svelte/elements";
 
-type RestProps = SvelteHTMLElements["div"];
+type $RestProps = SvelteHTMLElements["div"];
 
 type $Props = {
   /**
@@ -13,7 +13,7 @@ type $Props = {
   [key: `data-${string}`]: any;
 };
 
-export type CodeSnippetSkeletonProps = Omit<RestProps, keyof $Props> & $Props;
+export type CodeSnippetSkeletonProps = Omit<$RestProps, keyof $Props> & $Props;
 
 export default class CodeSnippetSkeleton extends SvelteComponentTyped<
   CodeSnippetSkeletonProps,

diff --git a/tests/e2e/carbon/types/ComboBox/ComboBox.svelte.d.ts b/tests/e2e/carbon/types/ComboBox/ComboBox.svelte.d.ts
@@ -6,7 +6,7 @@ export interface ComboBoxItem {
   text: string;
 }
 
-type RestProps = SvelteHTMLElements["div"];
+type $RestProps = SvelteHTMLElements["div"];
 
 type $Props = {
   /**
@@ -126,7 +126,7 @@ type $Props = {
   [key: `data-${string}`]: any;
 };
 
-export type ComboBoxProps = Omit<RestProps, keyof $Props> & $Props;
+export type ComboBoxProps = Omit<$RestProps, keyof $Props> & $Props;
 
 export default class ComboBox extends SvelteComponentTyped<
   ComboBoxProps,

diff --git a/tests/e2e/carbon/types/ComposedModal/ComposedModal.svelte.d.ts b/tests/e2e/carbon/types/ComposedModal/ComposedModal.svelte.d.ts
@@ -1,7 +1,7 @@
 import type { SvelteComponentTyped } from "svelte";
 import type { SvelteHTMLElements } from "svelte/elements";
 
-type RestProps = SvelteHTMLElements["div"];
+type $RestProps = SvelteHTMLElements["div"];
 
 type $Props = {
   /**
@@ -49,7 +49,7 @@ type $Props = {
   [key: `data-${string}`]: any;
 };
 
-export type ComposedModalProps = Omit<RestProps, keyof $Props> & $Props;
+export type ComposedModalProps = Omit<$RestProps, keyof $Props> & $Props;
 
 export default class ComposedModal extends SvelteComponentTyped<
   ComposedModalProps,

diff --git a/tests/e2e/carbon/types/ComposedModal/ModalBody.svelte.d.ts b/tests/e2e/carbon/types/ComposedModal/ModalBody.svelte.d.ts
@@ -1,7 +1,7 @@
 import type { SvelteComponentTyped } from "svelte";
 import type { SvelteHTMLElements } from "svelte/elements";
 
-type RestProps = SvelteHTMLElements["div"];
+type $RestProps = SvelteHTMLElements["div"];
 
 type $Props = {
   /**
@@ -19,7 +19,7 @@ type $Props = {
   [key: `data-${string}`]: any;
 };
 
-export type ModalBodyProps = Omit<RestProps, keyof $Props> & $Props;
+export type ModalBodyProps = Omit<$RestProps, keyof $Props> & $Props;
 
 export default class ModalBody extends SvelteComponentTyped<
   ModalBodyProps,

diff --git a/tests/e2e/carbon/types/ComposedModal/ModalFooter.svelte.d.ts b/tests/e2e/carbon/types/ComposedModal/ModalFooter.svelte.d.ts
@@ -1,7 +1,7 @@
 import type { SvelteComponentTyped } from "svelte";
 import type { SvelteHTMLElements } from "svelte/elements";
 
-type RestProps = SvelteHTMLElements["div"];
+type $RestProps = SvelteHTMLElements["div"];
 
 type $Props = {
   /**
@@ -43,7 +43,7 @@ type $Props = {
   [key: `data-${string}`]: any;
 };
 
-export type ModalFooterProps = Omit<RestProps, keyof $Props> & $Props;
+export type ModalFooterProps = Omit<$RestProps, keyof $Props> & $Props;
 
 export default class ModalFooter extends SvelteComponentTyped<
   ModalFooterProps,