From f83b4231886474b067bf63db75757deb9f9a3d32 Mon Sep 17 00:00:00 2001 From: Amin Yahyaabadi Date: Wed, 10 May 2023 14:54:32 -0700 Subject: [PATCH] test: update the tests to use declare keyword --- README.md | 8 +- __tests__/__snapshots__/main.test.ts.snap | 96 +++++++++---------- __tests__/core/write-file.test.ts | 4 +- .../dummy-styles/alias-prefixes.scss.d.ts | 10 +- __tests__/dummy-styles/aliases.scss.d.ts | 10 +- __tests__/dummy-styles/complex.scss.d.ts | 6 +- __tests__/dummy-styles/composes.scss.d.ts | 2 +- __tests__/dummy-styles/dashes.scss.d.ts | 6 +- __tests__/dummy-styles/invalid.scss.d.ts | 2 +- .../nested-styles/style.scss.d.ts | 2 +- __tests__/dummy-styles/style.scss.d.ts | 2 +- __tests__/main.test.ts | 6 +- .../class-names-to-type-definitions.test.ts | 8 +- examples/basic/feature-a/style.scss.d.ts | 4 +- examples/basic/feature-b/style.scss.d.ts | 2 +- .../output-folder/feature-a/a.scss.d.ts | 2 +- .../output-folder/feature-b/b.scss.d.ts | 2 +- .../output-folder/feature-c/c.scss.d.ts | 2 +- .../feature-c/nested/nested.scss.d.ts | 2 +- 19 files changed, 88 insertions(+), 88 deletions(-) diff --git a/README.md b/README.md index afc67b0..edb659a 100644 --- a/README.md +++ b/README.md @@ -23,8 +23,8 @@ For example, given the following SCSS: The following type definitions will be generated: ```typescript -export const text: string; -export const textHighlighted: string; +export declare const text: string; +export declare const textHighlighted: string; ``` ## Basic Usage @@ -162,8 +162,8 @@ Given the following SCSS: The following type definitions will be generated: ```typescript -export const text: string; -export const textHighlighted: string; +export declare const text: string; +export declare const textHighlighted: string; ``` #### `default` diff --git a/__tests__/__snapshots__/main.test.ts.snap b/__tests__/__snapshots__/main.test.ts.snap index 41a17d3..03ec4d4 100644 --- a/__tests__/__snapshots__/main.test.ts.snap +++ b/__tests__/__snapshots__/main.test.ts.snap @@ -3,62 +3,62 @@ exports[`node-sass implementation main outputs the correct files when outputFolder is passed 1`] = ` Array [ Object { - "contents": "export const myCustomClass: string; -export const nestedAnother: string; -export const nestedClass: string; -export const nestedStyles: string; -export const number1: string; -export const someStyles: string; + "contents": "export declare const myCustomClass: string; +export declare const nestedAnother: string; +export declare const nestedClass: string; +export declare const nestedStyles: string; +export declare const number1: string; +export declare const someStyles: string; ", "path": "../__generated__/__tests__/dummy-styles/alias-prefixes.scss.d.ts", }, Object { - "contents": "export const myCustomClass: string; -export const nestedAnother: string; -export const nestedClass: string; -export const number1: string; -export const someClass: string; -export const someStyles: string; + "contents": "export declare const myCustomClass: string; +export declare const nestedAnother: string; +export declare const nestedClass: string; +export declare const number1: string; +export declare const someClass: string; +export declare const someStyles: string; ", "path": "../__generated__/__tests__/dummy-styles/aliases.scss.d.ts", }, Object { - "contents": "export const nestedAnother: string; -export const nestedClass: string; -export const number1: string; -export const someStyles: string; + "contents": "export declare const nestedAnother: string; +export declare const nestedClass: string; +export declare const number1: string; +export declare const someStyles: string; ", "path": "../__generated__/__tests__/dummy-styles/complex.scss.d.ts", }, Object { - "contents": "export const composedClass: string; + "contents": "export declare const composedClass: string; ", "path": "../__generated__/__tests__/dummy-styles/composes.scss.d.ts", }, Object { - "contents": "export const app: string; -export const appHeader: string; -export const logo: string; + "contents": "export declare const app: string; +export declare const appHeader: string; +export declare const logo: string; ", "path": "../__generated__/__tests__/dummy-styles/dashes.scss.d.ts", }, Object { - "contents": "export const globalStyle: string; + "contents": "export declare const globalStyle: string; ", "path": "../__generated__/__tests__/dummy-styles/global-variables.scss.d.ts", }, Object { - "contents": "export const randomClass: string; + "contents": "export declare const randomClass: string; ", "path": "../__generated__/__tests__/dummy-styles/invalid.scss.d.ts", }, Object { - "contents": "export const nestedStyles: string; + "contents": "export declare const nestedStyles: string; ", "path": "../__generated__/__tests__/dummy-styles/nested-styles/style.scss.d.ts", }, Object { - "contents": "export const someClass: string; + "contents": "export declare const someClass: string; ", "path": "../__generated__/__tests__/dummy-styles/style.scss.d.ts", }, @@ -205,62 +205,62 @@ export default styles; exports[`sass implementation main outputs the correct files when outputFolder is passed 1`] = ` Array [ Object { - "contents": "export const myCustomClass: string; -export const nestedAnother: string; -export const nestedClass: string; -export const nestedStyles: string; -export const number1: string; -export const someStyles: string; + "contents": "export declare const myCustomClass: string; +export declare const nestedAnother: string; +export declare const nestedClass: string; +export declare const nestedStyles: string; +export declare const number1: string; +export declare const someStyles: string; ", "path": "../__generated__/__tests__/dummy-styles/alias-prefixes.scss.d.ts", }, Object { - "contents": "export const myCustomClass: string; -export const nestedAnother: string; -export const nestedClass: string; -export const number1: string; -export const someClass: string; -export const someStyles: string; + "contents": "export declare const myCustomClass: string; +export declare const nestedAnother: string; +export declare const nestedClass: string; +export declare const number1: string; +export declare const someClass: string; +export declare const someStyles: string; ", "path": "../__generated__/__tests__/dummy-styles/aliases.scss.d.ts", }, Object { - "contents": "export const nestedAnother: string; -export const nestedClass: string; -export const number1: string; -export const someStyles: string; + "contents": "export declare const nestedAnother: string; +export declare const nestedClass: string; +export declare const number1: string; +export declare const someStyles: string; ", "path": "../__generated__/__tests__/dummy-styles/complex.scss.d.ts", }, Object { - "contents": "export const composedClass: string; + "contents": "export declare const composedClass: string; ", "path": "../__generated__/__tests__/dummy-styles/composes.scss.d.ts", }, Object { - "contents": "export const app: string; -export const appHeader: string; -export const logo: string; + "contents": "export declare const app: string; +export declare const appHeader: string; +export declare const logo: string; ", "path": "../__generated__/__tests__/dummy-styles/dashes.scss.d.ts", }, Object { - "contents": "export const globalStyle: string; + "contents": "export declare const globalStyle: string; ", "path": "../__generated__/__tests__/dummy-styles/global-variables.scss.d.ts", }, Object { - "contents": "export const randomClass: string; + "contents": "export declare const randomClass: string; ", "path": "../__generated__/__tests__/dummy-styles/invalid.scss.d.ts", }, Object { - "contents": "export const nestedStyles: string; + "contents": "export declare const nestedStyles: string; ", "path": "../__generated__/__tests__/dummy-styles/nested-styles/style.scss.d.ts", }, Object { - "contents": "export const someClass: string; + "contents": "export declare const someClass: string; ", "path": "../__generated__/__tests__/dummy-styles/style.scss.d.ts", }, diff --git a/__tests__/core/write-file.test.ts b/__tests__/core/write-file.test.ts index 6c8a32f..e3cab94 100644 --- a/__tests__/core/write-file.test.ts +++ b/__tests__/core/write-file.test.ts @@ -42,7 +42,7 @@ describeAllImplementations((implementation) => { ); expect(fs.writeFileSync).toBeCalledWith( expectedPath, - "export const someClass: string;\n" + "export declare const someClass: string;\n" ); expect(console.log).toBeCalledWith( expect.stringContaining(`[GENERATED TYPES] ${expectedPath}`) @@ -104,7 +104,7 @@ describeAllImplementations((implementation) => { ); expect(fs.writeFileSync).toBeCalledWith( expectedPath, - "export const someClass: string;\n" + "export declare const someClass: string;\n" ); expect(console.log).toBeCalledWith( expect.stringContaining(`[GENERATED TYPES] ${expectedPath}`) diff --git a/__tests__/dummy-styles/alias-prefixes.scss.d.ts b/__tests__/dummy-styles/alias-prefixes.scss.d.ts index 28f83c8..3755a34 100644 --- a/__tests__/dummy-styles/alias-prefixes.scss.d.ts +++ b/__tests__/dummy-styles/alias-prefixes.scss.d.ts @@ -1,5 +1,5 @@ -export const someStyles: string; -export const nestedClass: string; -export const nestedAnother: string; -export const nestedStyles: string; -export const myCustomClass: string; +export declare const someStyles: string; +export declare const nestedClass: string; +export declare const nestedAnother: string; +export declare const nestedStyles: string; +export declare const myCustomClass: string; diff --git a/__tests__/dummy-styles/aliases.scss.d.ts b/__tests__/dummy-styles/aliases.scss.d.ts index b07f773..0387429 100644 --- a/__tests__/dummy-styles/aliases.scss.d.ts +++ b/__tests__/dummy-styles/aliases.scss.d.ts @@ -1,5 +1,5 @@ -export const someStyles: string; -export const nestedClass: string; -export const nestedAnother: string; -export const someClass: string; -export const myCustomClass: string; +export declare const someStyles: string; +export declare const nestedClass: string; +export declare const nestedAnother: string; +export declare const someClass: string; +export declare const myCustomClass: string; diff --git a/__tests__/dummy-styles/complex.scss.d.ts b/__tests__/dummy-styles/complex.scss.d.ts index 8f7b8fe..ac0373b 100644 --- a/__tests__/dummy-styles/complex.scss.d.ts +++ b/__tests__/dummy-styles/complex.scss.d.ts @@ -1,3 +1,3 @@ -export const someStyles: string; -export const nestedClass: string; -export const nestedAnother: string; +export declare const someStyles: string; +export declare const nestedClass: string; +export declare const nestedAnother: string; diff --git a/__tests__/dummy-styles/composes.scss.d.ts b/__tests__/dummy-styles/composes.scss.d.ts index c2c0e7b..9fa24de 100644 --- a/__tests__/dummy-styles/composes.scss.d.ts +++ b/__tests__/dummy-styles/composes.scss.d.ts @@ -1 +1 @@ -export const composedClass: string; +export declare const composedClass: string; diff --git a/__tests__/dummy-styles/dashes.scss.d.ts b/__tests__/dummy-styles/dashes.scss.d.ts index a0cc8b7..4cd60d5 100644 --- a/__tests__/dummy-styles/dashes.scss.d.ts +++ b/__tests__/dummy-styles/dashes.scss.d.ts @@ -1,3 +1,3 @@ -export const app: string; -export const logo: string; -export const appHeader: string; +export declare const app: string; +export declare const logo: string; +export declare const appHeader: string; diff --git a/__tests__/dummy-styles/invalid.scss.d.ts b/__tests__/dummy-styles/invalid.scss.d.ts index fb1567b..c1b4084 100644 --- a/__tests__/dummy-styles/invalid.scss.d.ts +++ b/__tests__/dummy-styles/invalid.scss.d.ts @@ -1 +1 @@ -export const nope: string; +export declare const nope: string; diff --git a/__tests__/dummy-styles/nested-styles/style.scss.d.ts b/__tests__/dummy-styles/nested-styles/style.scss.d.ts index 8eb8456..71c2800 100644 --- a/__tests__/dummy-styles/nested-styles/style.scss.d.ts +++ b/__tests__/dummy-styles/nested-styles/style.scss.d.ts @@ -1 +1 @@ -export const nestedStyles: string; +export declare const nestedStyles: string; diff --git a/__tests__/dummy-styles/style.scss.d.ts b/__tests__/dummy-styles/style.scss.d.ts index 03fb465..1b91f79 100644 --- a/__tests__/dummy-styles/style.scss.d.ts +++ b/__tests__/dummy-styles/style.scss.d.ts @@ -1 +1 @@ -export const someClass: string; +export declare const someClass: string; diff --git a/__tests__/main.test.ts b/__tests__/main.test.ts index c115a5c..e0c54f0 100644 --- a/__tests__/main.test.ts +++ b/__tests__/main.test.ts @@ -60,11 +60,11 @@ describeAllImplementations((implementation) => { expect(fs.writeFileSync).toBeCalledWith( `${expectedDirname}/complex.scss.d.ts`, - "export const nestedAnother: string;\nexport const nestedClass: string;\nexport const number1: string;\nexport const someStyles: string;\n" + "export declare const nestedAnother: string;\nexport declare const nestedClass: string;\nexport declare const number1: string;\nexport declare const someStyles: string;\n" ); expect(fs.writeFileSync).toBeCalledWith( `${expectedDirname}/style.scss.d.ts`, - "export const someClass: string;\n" + "export declare const someClass: string;\n" ); }); @@ -101,7 +101,7 @@ describeAllImplementations((implementation) => { expect(fs.writeFileSync).toBeCalledWith( `${expectedDirname}/complex.scss.d.ts`, - "export const nestedAnother: string;\nexport const nestedClass: string;\nexport const number1: string;\nexport const someStyles: string;\n" + "export declare const nestedAnother: string;\nexport declare const nestedClass: string;\nexport declare const number1: string;\nexport declare const someStyles: string;\n" ); // Files that should match the ignore pattern. diff --git a/__tests__/typescript/class-names-to-type-definitions.test.ts b/__tests__/typescript/class-names-to-type-definitions.test.ts index 14dd222..03b3d45 100644 --- a/__tests__/typescript/class-names-to-type-definitions.test.ts +++ b/__tests__/typescript/class-names-to-type-definitions.test.ts @@ -19,7 +19,7 @@ describe("classNamesToTypeDefinitions (without Prettier)", () => { }); expect(definition).toEqual( - "export const myClass: string;\nexport const yourClass: string;\n" + "export declare const myClass: string;\nexport declare const yourClass: string;\n" ); }); @@ -40,7 +40,7 @@ describe("classNamesToTypeDefinitions (without Prettier)", () => { exportType: "named", }); - expect(definition).toEqual("export const myClass: string;\n"); + expect(definition).toEqual("export declare const myClass: string;\n"); expect(console.log).toBeCalledWith( expect.stringContaining(`[SKIPPING] 'if' is a reserved keyword`) ); @@ -53,7 +53,7 @@ describe("classNamesToTypeDefinitions (without Prettier)", () => { exportType: "named", }); - expect(definition).toEqual("export const myClass: string;\n"); + expect(definition).toEqual("export declare const myClass: string;\n"); expect(console.log).toBeCalledWith( expect.stringContaining(`[SKIPPING] 'invalid-variable' contains dashes`) ); @@ -119,7 +119,7 @@ describe("classNamesToTypeDefinitions (without Prettier)", () => { }); expect(definition).toEqual( - "export const myClass: string;\nexport const yourClass: string;\n" + "export declare const myClass: string;\nexport declare const yourClass: string;\n" ); }); }); diff --git a/examples/basic/feature-a/style.scss.d.ts b/examples/basic/feature-a/style.scss.d.ts index 3e3484c..6667643 100644 --- a/examples/basic/feature-a/style.scss.d.ts +++ b/examples/basic/feature-a/style.scss.d.ts @@ -1,3 +1,3 @@ // example banner -export const text: string; -export const textHighlighted: string; +export declare const text: string; +export declare const textHighlighted: string; diff --git a/examples/basic/feature-b/style.scss.d.ts b/examples/basic/feature-b/style.scss.d.ts index 9bc4876..5f5f878 100644 --- a/examples/basic/feature-b/style.scss.d.ts +++ b/examples/basic/feature-b/style.scss.d.ts @@ -1,2 +1,2 @@ // example banner -export const topBanner: string; +export declare const topBanner: string; diff --git a/examples/output-folder/__generated__/examples/output-folder/feature-a/a.scss.d.ts b/examples/output-folder/__generated__/examples/output-folder/feature-a/a.scss.d.ts index 425b80f..106d610 100644 --- a/examples/output-folder/__generated__/examples/output-folder/feature-a/a.scss.d.ts +++ b/examples/output-folder/__generated__/examples/output-folder/feature-a/a.scss.d.ts @@ -1 +1 @@ -export const a: string; +export declare const a: string; diff --git a/examples/output-folder/__generated__/examples/output-folder/feature-b/b.scss.d.ts b/examples/output-folder/__generated__/examples/output-folder/feature-b/b.scss.d.ts index 20ab8ab..f4efca8 100644 --- a/examples/output-folder/__generated__/examples/output-folder/feature-b/b.scss.d.ts +++ b/examples/output-folder/__generated__/examples/output-folder/feature-b/b.scss.d.ts @@ -1 +1 @@ -export const b: string; +export declare const b: string; diff --git a/examples/output-folder/__generated__/examples/output-folder/feature-c/c.scss.d.ts b/examples/output-folder/__generated__/examples/output-folder/feature-c/c.scss.d.ts index bf3a092..140818b 100644 --- a/examples/output-folder/__generated__/examples/output-folder/feature-c/c.scss.d.ts +++ b/examples/output-folder/__generated__/examples/output-folder/feature-c/c.scss.d.ts @@ -1 +1 @@ -export const c: string; +export declare const c: string; diff --git a/examples/output-folder/__generated__/examples/output-folder/feature-c/nested/nested.scss.d.ts b/examples/output-folder/__generated__/examples/output-folder/feature-c/nested/nested.scss.d.ts index a4d0f21..d038bcc 100644 --- a/examples/output-folder/__generated__/examples/output-folder/feature-c/nested/nested.scss.d.ts +++ b/examples/output-folder/__generated__/examples/output-folder/feature-c/nested/nested.scss.d.ts @@ -1 +1 @@ -export const nested: string; +export declare const nested: string;