Export DataType namespace

Fixes #138
frenic · May 16, 2022 · 22f3c89 · 22f3c89
1 parent 684b078
commit 22f3c89
Show file tree

Hide file tree

Showing 28 changed files with 29 additions and 49 deletions.
diff --git a/__tests__/__fixtures__/typecheck.ts b/__tests__/__fixtures__/typecheck.ts
@@ -147,9 +147,6 @@ propertyValueWithAutocompleteHack([1]); // Should fail
 
 const differentMajorVersions: CSS.Properties = {} as OldCSS.Properties;
 
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-type DataTypeShouldNotBeExposed = CSS.DataType.Color;
-
 css;
 cssWithFallbackValues;
 cssWithHyphenProperties;

diff --git a/__tests__/__snapshots__/dist.typescript-3.5.ts.snap b/__tests__/__snapshots__/dist.typescript-3.5.ts.snap
@@ -56,5 +56,3 @@ exports[`Typescript 3.5 detects errors 15`] = `
   Type '[1]' is not assignable to type '[0 | \\"auto\\" | \\"inherit\\" | (string & {}) | \\"-moz-initial\\" | \\"initial\\" | \\"revert\\" | \\"unset\\" | \\"-moz-fit-content\\" | \\"-moz-max-content\\" | \\"-moz-min-content\\" | \\"fit-content\\" | \\"max-content\\" | ... 4 more ... | \\"min-intrinsic\\"]'.
     Type '1' is not assignable to type '0 | \\"auto\\" | \\"inherit\\" | (string & {}) | \\"-moz-initial\\" | \\"initial\\" | \\"revert\\" | \\"unset\\" | \\"-moz-fit-content\\" | \\"-moz-max-content\\" | \\"-moz-min-content\\" | \\"fit-content\\" | \\"max-content\\" | ... 4 more ... | \\"min-intrinsic\\"'."
 `;
-
-exports[`Typescript 3.5 detects errors 16`] = `"150:38 - Namespace '\\"index\\"' has no exported member 'DataType'."`;
diff --git a/__tests__/__snapshots__/dist.typescript-3.6.ts.snap b/__tests__/__snapshots__/dist.typescript-3.6.ts.snap
@@ -56,5 +56,3 @@ exports[`Typescript 3.6 detects errors 15`] = `
   Type '[1]' is not assignable to type '[0 | \\"auto\\" | \\"inherit\\" | (string & {}) | \\"-moz-initial\\" | \\"initial\\" | \\"revert\\" | \\"unset\\" | \\"-moz-fit-content\\" | \\"-moz-max-content\\" | \\"-moz-min-content\\" | \\"fit-content\\" | \\"max-content\\" | ... 4 more ... | \\"min-intrinsic\\"]'.
     Type '1' is not assignable to type '0 | \\"auto\\" | \\"inherit\\" | (string & {}) | \\"-moz-initial\\" | \\"initial\\" | \\"revert\\" | \\"unset\\" | \\"-moz-fit-content\\" | \\"-moz-max-content\\" | \\"-moz-min-content\\" | \\"fit-content\\" | \\"max-content\\" | ... 4 more ... | \\"min-intrinsic\\"'."
 `;
-
-exports[`Typescript 3.6 detects errors 16`] = `"150:38 - Namespace '\\"index\\"' has no exported member 'DataType'."`;
diff --git a/__tests__/__snapshots__/dist.typescript-3.7.ts.snap b/__tests__/__snapshots__/dist.typescript-3.7.ts.snap
@@ -56,5 +56,3 @@ exports[`Typescript 3.7 detects errors 15`] = `
   Type '[1]' is not assignable to type '[0 | \\"auto\\" | \\"inherit\\" | (string & {}) | \\"-moz-initial\\" | \\"initial\\" | \\"revert\\" | \\"unset\\" | \\"-moz-fit-content\\" | \\"-moz-max-content\\" | \\"-moz-min-content\\" | \\"fit-content\\" | \\"max-content\\" | ... 4 more ... | \\"min-intrinsic\\"]'.
     Type '1' is not assignable to type '0 | \\"auto\\" | \\"inherit\\" | (string & {}) | \\"-moz-initial\\" | \\"initial\\" | \\"revert\\" | \\"unset\\" | \\"-moz-fit-content\\" | \\"-moz-max-content\\" | \\"-moz-min-content\\" | \\"fit-content\\" | \\"max-content\\" | ... 4 more ... | \\"min-intrinsic\\"'."
 `;
-
-exports[`Typescript 3.7 detects errors 16`] = `"150:38 - Namespace '\\"index\\"' has no exported member 'DataType'."`;
diff --git a/__tests__/__snapshots__/dist.typescript-3.8.ts.snap b/__tests__/__snapshots__/dist.typescript-3.8.ts.snap
@@ -38,5 +38,3 @@ exports[`Typescript 3.8 detects errors 13`] = `"134:25 - This condition will alw
 exports[`Typescript 3.8 detects errors 14`] = `"144:34 - Argument of type '1' is not assignable to parameter of type '0 | \\"auto\\" | \\"inherit\\" | (string & {}) | \\"-moz-initial\\" | \\"initial\\" | \\"revert\\" | \\"unset\\" | \\"-moz-fit-content\\" | \\"-moz-max-content\\" | \\"-moz-min-content\\" | \\"fit-content\\" | \\"max-content\\" | ... 5 more ... | [...]'."`;
 
 exports[`Typescript 3.8 detects errors 15`] = `"145:35 - Type '1' is not assignable to type '0 | \\"auto\\" | \\"inherit\\" | (string & {}) | \\"-moz-initial\\" | \\"initial\\" | \\"revert\\" | \\"unset\\" | \\"-moz-fit-content\\" | \\"-moz-max-content\\" | \\"-moz-min-content\\" | \\"fit-content\\" | \\"max-content\\" | ... 4 more ... | \\"min-intrinsic\\"'."`;
-
-exports[`Typescript 3.8 detects errors 16`] = `"150:38 - Namespace '\\"index\\"' has no exported member 'DataType'."`;
diff --git a/__tests__/__snapshots__/dist.typescript-3.9.ts.snap b/__tests__/__snapshots__/dist.typescript-3.9.ts.snap
@@ -38,5 +38,3 @@ exports[`Typescript 3.9 detects errors 13`] = `"134:25 - This condition will alw
 exports[`Typescript 3.9 detects errors 14`] = `"144:34 - Argument of type '1' is not assignable to parameter of type '0 | \\"auto\\" | \\"inherit\\" | (string & {}) | \\"-moz-initial\\" | \\"initial\\" | \\"revert\\" | \\"unset\\" | \\"-moz-fit-content\\" | \\"-moz-max-content\\" | \\"-moz-min-content\\" | \\"fit-content\\" | \\"max-content\\" | ... 5 more ... | [...]'."`;
 
 exports[`Typescript 3.9 detects errors 15`] = `"145:35 - Type '1' is not assignable to type 'Width<0 | (string & {})>'."`;
-
-exports[`Typescript 3.9 detects errors 16`] = `"150:38 - Namespace '\\"index\\"' has no exported member 'DataType'."`;
diff --git a/__tests__/__snapshots__/dist.typescript-4.0.ts.snap b/__tests__/__snapshots__/dist.typescript-4.0.ts.snap
@@ -38,5 +38,3 @@ exports[`Typescript 4.0 detects errors 13`] = `"134:25 - This condition will alw
 exports[`Typescript 4.0 detects errors 14`] = `"144:34 - Argument of type '1' is not assignable to parameter of type '0 | \\"auto\\" | \\"inherit\\" | (string & {}) | \\"-moz-initial\\" | \\"initial\\" | \\"revert\\" | \\"unset\\" | \\"-moz-fit-content\\" | \\"-moz-max-content\\" | \\"-moz-min-content\\" | \\"fit-content\\" | \\"max-content\\" | ... 5 more ... | [...]'."`;
 
 exports[`Typescript 4.0 detects errors 15`] = `"145:35 - Type '1' is not assignable to type 'Width<0 | (string & {})>'."`;
-
-exports[`Typescript 4.0 detects errors 16`] = `"150:38 - Namespace '\\"index\\"' has no exported member 'DataType'."`;
diff --git a/__tests__/__snapshots__/dist.typescript-4.1.ts.snap b/__tests__/__snapshots__/dist.typescript-4.1.ts.snap
@@ -38,5 +38,3 @@ exports[`Typescript 4.1 detects errors 13`] = `"134:25 - This condition will alw
 exports[`Typescript 4.1 detects errors 14`] = `"144:34 - Argument of type '1' is not assignable to parameter of type '0 | \\"auto\\" | \\"inherit\\" | (string & {}) | \\"-moz-initial\\" | \\"initial\\" | \\"revert\\" | \\"unset\\" | \\"-moz-fit-content\\" | \\"-moz-max-content\\" | \\"-moz-min-content\\" | \\"fit-content\\" | \\"max-content\\" | ... 5 more ... | [...]'."`;
 
 exports[`Typescript 4.1 detects errors 15`] = `"145:35 - Type '1' is not assignable to type 'Width<0 | (string & {})>'."`;
-
-exports[`Typescript 4.1 detects errors 16`] = `"150:38 - Namespace '\\"index\\"' has no exported member 'DataType'."`;
diff --git a/__tests__/__snapshots__/dist.typescript-4.2.ts.snap b/__tests__/__snapshots__/dist.typescript-4.2.ts.snap
@@ -38,5 +38,3 @@ exports[`Typescript 4.2 detects errors 13`] = `"134:25 - This condition will alw
 exports[`Typescript 4.2 detects errors 14`] = `"144:34 - Argument of type '1' is not assignable to parameter of type 'Width<0 | (string & {})> | [Width<0 | (string & {})>]'."`;
 
 exports[`Typescript 4.2 detects errors 15`] = `"145:35 - Type '1' is not assignable to type 'Width<0 | (string & {})>'."`;
-
-exports[`Typescript 4.2 detects errors 16`] = `"150:38 - Namespace '\\"index\\"' has no exported member 'DataType'."`;
diff --git a/__tests__/__snapshots__/dist.typescript-4.3.ts.snap b/__tests__/__snapshots__/dist.typescript-4.3.ts.snap
@@ -38,5 +38,3 @@ exports[`Typescript 4.3 detects errors 13`] = `"134:25 - This condition will alw
 exports[`Typescript 4.3 detects errors 14`] = `"144:34 - Argument of type '1' is not assignable to parameter of type 'Width<0 | (string & {})> | [Width<0 | (string & {})>]'."`;
 
 exports[`Typescript 4.3 detects errors 15`] = `"145:35 - Type '1' is not assignable to type 'Width<0 | (string & {})>'."`;
-
-exports[`Typescript 4.3 detects errors 16`] = `"150:38 - Namespace '\\"index\\"' has no exported member 'DataType'."`;
diff --git a/__tests__/__snapshots__/dist.typescript-4.4.ts.snap b/__tests__/__snapshots__/dist.typescript-4.4.ts.snap
@@ -38,5 +38,3 @@ exports[`Typescript 4.4 detects errors 13`] = `"134:25 - This condition will alw
 exports[`Typescript 4.4 detects errors 14`] = `"144:34 - Argument of type '1' is not assignable to parameter of type 'Width<0 | (string & {})> | [Width<0 | (string & {})>]'."`;
 
 exports[`Typescript 4.4 detects errors 15`] = `"145:35 - Type '1' is not assignable to type 'Width<0 | (string & {})>'."`;
-
-exports[`Typescript 4.4 detects errors 16`] = `"150:38 - Namespace '\\"index\\"' has no exported member 'DataType'."`;
diff --git a/__tests__/__snapshots__/dist.typescript-4.5.ts.snap b/__tests__/__snapshots__/dist.typescript-4.5.ts.snap
@@ -38,5 +38,3 @@ exports[`Typescript 4.5 detects errors 13`] = `"134:25 - This condition will alw
 exports[`Typescript 4.5 detects errors 14`] = `"144:34 - Argument of type '1' is not assignable to parameter of type 'Width<0 | (string & {})> | [Width<0 | (string & {})>]'."`;
 
 exports[`Typescript 4.5 detects errors 15`] = `"145:35 - Type '1' is not assignable to type 'Width<0 | (string & {})>'."`;
-
-exports[`Typescript 4.5 detects errors 16`] = `"150:38 - Namespace '\\"index\\"' has no exported member 'DataType'."`;
diff --git a/__tests__/__snapshots__/dist.typescript-latest.ts.snap b/__tests__/__snapshots__/dist.typescript-latest.ts.snap
@@ -38,5 +38,3 @@ exports[`Typescript 4.6 detects errors 13`] = `"134:25 - This condition will alw
 exports[`Typescript 4.6 detects errors 14`] = `"144:34 - Argument of type '1' is not assignable to parameter of type 'Width<0 | (string & {})> | [Width<0 | (string & {})>]'."`;
 
 exports[`Typescript 4.6 detects errors 15`] = `"145:35 - Type '1' is not assignable to type 'Width<0 | (string & {})>'."`;
-
-exports[`Typescript 4.6 detects errors 16`] = `"150:38 - Namespace '\\"index\\"' has no exported member 'DataType'."`;
diff --git a/__tests__/dist.typescript-3.5.ts b/__tests__/dist.typescript-3.5.ts
@@ -14,7 +14,7 @@ describe('Typescript 3.5', () => {
     });
 
     expect(Number(ts.versionMajorMinor)).toBe(3.5);
-    expect(errors.length).toBe(16);
+    expect(errors.length).toBe(15);
     for (const error of errors) {
       expect(error).toMatchSnapshot();
     }

diff --git a/__tests__/dist.typescript-3.6.ts b/__tests__/dist.typescript-3.6.ts
@@ -14,7 +14,7 @@ describe('Typescript 3.6', () => {
     });
 
     expect(Number(ts.versionMajorMinor)).toBe(3.6);
-    expect(errors.length).toBe(16);
+    expect(errors.length).toBe(15);
     for (const error of errors) {
       expect(error).toMatchSnapshot();
     }

diff --git a/__tests__/dist.typescript-3.7.ts b/__tests__/dist.typescript-3.7.ts
@@ -14,7 +14,7 @@ describe('Typescript 3.7', () => {
     });
 
     expect(Number(ts.versionMajorMinor)).toBe(3.7);
-    expect(errors.length).toBe(16);
+    expect(errors.length).toBe(15);
     for (const error of errors) {
       expect(error).toMatchSnapshot();
     }

diff --git a/__tests__/dist.typescript-3.8.ts b/__tests__/dist.typescript-3.8.ts
@@ -14,7 +14,7 @@ describe('Typescript 3.8', () => {
     });
 
     expect(Number(ts.versionMajorMinor)).toBe(3.8);
-    expect(errors.length).toBe(16);
+    expect(errors.length).toBe(15);
     for (const error of errors) {
       expect(error).toMatchSnapshot();
     }

diff --git a/__tests__/dist.typescript-3.9.ts b/__tests__/dist.typescript-3.9.ts
@@ -14,7 +14,7 @@ describe('Typescript 3.9', () => {
     });
 
     expect(Number(ts.versionMajorMinor)).toBe(3.9);
-    expect(errors.length).toBe(16);
+    expect(errors.length).toBe(15);
     for (const error of errors) {
       expect(error).toMatchSnapshot();
     }

diff --git a/__tests__/dist.typescript-4.0.ts b/__tests__/dist.typescript-4.0.ts
@@ -14,7 +14,7 @@ describe('Typescript 4.0', () => {
     });
 
     expect(Number(ts.versionMajorMinor)).toBe(4.0);
-    expect(errors.length).toBe(16);
+    expect(errors.length).toBe(15);
     for (const error of errors) {
       expect(error).toMatchSnapshot();
     }

diff --git a/__tests__/dist.typescript-4.1.ts b/__tests__/dist.typescript-4.1.ts
@@ -14,7 +14,7 @@ describe('Typescript 4.1', () => {
     });
 
     expect(Number(ts.versionMajorMinor)).toBe(4.1);
-    expect(errors.length).toBe(16);
+    expect(errors.length).toBe(15);
     for (const error of errors) {
       expect(error).toMatchSnapshot();
     }

diff --git a/__tests__/dist.typescript-4.2.ts b/__tests__/dist.typescript-4.2.ts
@@ -14,7 +14,7 @@ describe('Typescript 4.2', () => {
     });
 
     expect(Number(ts.versionMajorMinor)).toBe(4.2);
-    expect(errors.length).toBe(16);
+    expect(errors.length).toBe(15);
     for (const error of errors) {
       expect(error).toMatchSnapshot();
     }

diff --git a/__tests__/dist.typescript-4.3.ts b/__tests__/dist.typescript-4.3.ts
@@ -14,7 +14,7 @@ describe('Typescript 4.3', () => {
     });
 
     expect(Number(ts.versionMajorMinor)).toBe(4.3);
-    expect(errors.length).toBe(16);
+    expect(errors.length).toBe(15);
     for (const error of errors) {
       expect(error).toMatchSnapshot();
     }

diff --git a/__tests__/dist.typescript-4.4.ts b/__tests__/dist.typescript-4.4.ts
@@ -14,7 +14,7 @@ describe('Typescript 4.4', () => {
     });
 
     expect(Number(ts.versionMajorMinor)).toBe(4.4);
-    expect(errors.length).toBe(16);
+    expect(errors.length).toBe(15);
     for (const error of errors) {
       expect(error).toMatchSnapshot();
     }

diff --git a/__tests__/dist.typescript-4.5.ts b/__tests__/dist.typescript-4.5.ts
@@ -14,7 +14,7 @@ describe('Typescript 4.5', () => {
     });
 
     expect(Number(ts.versionMajorMinor)).toBe(4.5);
-    expect(errors.length).toBe(16);
+    expect(errors.length).toBe(15);
     for (const error of errors) {
       expect(error).toMatchSnapshot();
     }

diff --git a/__tests__/dist.typescript-latest.ts b/__tests__/dist.typescript-latest.ts
@@ -14,7 +14,7 @@ describe('Typescript 4.6', () => {
     });
 
     expect(Number(ts.versionMajorMinor)).toBe(4.6);
-    expect(errors.length).toBe(16);
+    expect(errors.length).toBe(15);
     for (const error of errors) {
       expect(error).toMatchSnapshot();
     }

diff --git a/index.d.ts b/index.d.ts
@@ -20313,7 +20313,13 @@ export namespace AtRule {
   type Zoom = "auto" | (string & {}) | (number & {});
 }
 
-declare namespace DataType {
+/**
+ * **Attention!** Data types receives its name from the spec. E.g. `<color>` becomes `DataType.Color` and
+ * `<content-distribution>` becomes `DataType.ContentDistribution`. It happens quite frequent that these data types
+ * are split into several data types or/and name changes as the spec develops. So there's a risk that a minor/patch
+ * update from `csstype` can break your typing if you're using the `DataType` namespace.
+ */
+export namespace DataType {
   type AbsoluteSize = "large" | "medium" | "small" | "x-large" | "x-small" | "xx-large" | "xx-small" | "xxx-large";
 
   type AnimateableFeature = "contents" | "scroll-position" | (string & {});

diff --git a/src/declarator.ts b/src/declarator.ts
@@ -71,7 +71,7 @@ export type SimpleType = Exclude<DeclarableType, IAlias>;
 
 export interface INamespace {
   name: string;
-  export: boolean;
+  comment?: string;
   body: () => (Interface | IDeclaration)[];
 }
 
@@ -274,12 +274,16 @@ export async function declarator(minTypesInDataTypes: number) {
 
   const propertyNamespace: INamespace = {
     name: 'Property',
-    export: true,
     body: () => Array.from(propertyDeclarations.values()),
   };
   const dataTypeNamespace: INamespace = {
     name: 'DataType',
-    export: false,
+    comment: `/**
+ * **Attention!** Data types receives its name from the spec. E.g. \`<color>\` becomes \`DataType.Color\` and
+ * \`<content-distribution>\` becomes \`DataType.ContentDistribution\`. It happens quite frequent that these data types
+ * are split into several data types or/and name changes as the spec develops. So there's a risk that a minor/patch
+ * update from \`csstype\` can break your typing if you're using the \`DataType\` namespace.
+ */`,
     body: () => Array.from(dataTypeDeclarations.values()),
   };
 
@@ -374,7 +378,6 @@ export async function declarator(minTypesInDataTypes: number) {
   const atRuleInterfaces: Interface[] = [];
   const atRuleNamespace: INamespace = {
     name: 'AtRule',
-    export: true,
     body: () => [...atRuleInterfaces, ...Array.from(atRuleDeclarations.values())],
   };
 

diff --git a/src/typescript.ts b/src/typescript.ts
@@ -38,13 +38,11 @@ export default async function typescript() {
       namespaceOutput += EOL;
     }
 
-    if (namespace.export) {
-      namespaceOutput += 'export ';
-    } else {
-      namespaceOutput += 'declare ';
+    if (namespace.comment) {
+      namespaceOutput += namespace.comment + EOL;
     }
 
-    namespaceOutput += `namespace ${namespace.name} {${EOL}`;
+    namespaceOutput += `export namespace ${namespace.name} {${EOL}`;
 
     const body = namespace.body();