update CLI for declaration merging (#435)

DevCycleHQ · Dec 3, 2024 · c5bfd6f · c5bfd6f
1 parent fc351a2
commit c5bfd6f
Show file tree

Hide file tree

Showing 2 changed files with 48 additions and 0 deletions.
diff --git a/src/commands/generate/__snapshots__/types.test.ts.snap b/src/commands/generate/__snapshots__/types.test.ts.snap
@@ -3,6 +3,10 @@
 exports[`generate types correctly generates JS SDK types with custom data type 1`] = `
 "import { DevCycleJSON } from '@devcycle/js-client-sdk'
 
+declare module '@devcycle/types' {
+   interface CustomVariableDefinitions extends DVCVariableTypes {}
+}
+
 export type CustomData = {
     'customString': string
     'customEnum'?: | 
@@ -130,6 +134,10 @@ export const DEPRECATED_VAR = 'deprecated-var' as const
 exports[`generate types correctly generates JS SDK types with custom data type in strict mode 1`] = `
 "import { DevCycleJSON } from '@devcycle/js-client-sdk'
 
+declare module '@devcycle/types' {
+   interface CustomVariableDefinitions extends DVCVariableTypes {}
+}
+
 export type CustomData = {
     'customString': string
     'customEnum'?: | 
@@ -257,6 +265,10 @@ export const DEPRECATED_VAR = 'deprecated-var' as const
 exports[`generate types correctly generates JS SDK types with obfuscated keys 1`] = `
 "import { DevCycleJSON } from '@devcycle/js-client-sdk'
 
+declare module '@devcycle/types' {
+   interface CustomVariableDefinitions extends DVCVariableTypes {}
+}
+
 export type CustomData = {
 
 }
@@ -333,6 +345,10 @@ exports[`generate types correctly generates Next.js SDK types 1`] = `
     DevCycleJSON
 } from '@devcycle/nextjs-sdk'
 
+declare module '@devcycle/types' {
+   interface CustomVariableDefinitions extends DVCVariableTypes {}
+}
+
 export type CustomData = {
     'customString': string
     'customEnum'?: | 
@@ -486,6 +502,10 @@ exports[`generate types correctly generates React SDK types 1`] = `
     DevCycleJSON
 } from '@devcycle/react-client-sdk'
 
+declare module '@devcycle/types' {
+   interface CustomVariableDefinitions extends DVCVariableTypes {}
+}
+
 export type CustomData = {
     'customString': string
     'customEnum'?: | 

diff --git a/src/commands/generate/types.ts b/src/commands/generate/types.ts
@@ -80,10 +80,23 @@ export default class GenerateTypes extends Base {
         react: Flags.boolean({
             description: 'Generate types for use with React',
             default: false,
+            deprecated: {
+                message:
+                    'The React SDK since v1.30.0 does not require this flag. Its types can be augmented automatically',
+            },
         }),
         nextjs: Flags.boolean({
             description: 'Generate types for use with Next.js',
             default: false,
+            deprecated: {
+                message:
+                    'The Next.js SDK since v2.7.0 does not require this flag. Its types can be augmented automatically',
+            },
+        }),
+        'no-declaration': Flags.boolean({
+            description:
+                'Do not generate a "declare module" statement that automatically overrides SDK types.',
+            default: false,
         }),
         'old-repos': Flags.boolean({
             description:
@@ -124,6 +137,7 @@ export default class GenerateTypes extends Base {
     project: Project
     outputDir: string
     includeDeprecationWarnings = true
+    noDeclaration = false
     features: Feature[] = []
     customProperties: CustomProperty[]
 
@@ -135,6 +149,7 @@ export default class GenerateTypes extends Base {
             'include-descriptions': includeDescriptions,
             obfuscate,
             'output-dir': outputDir,
+            'no-declaration': noDeclaration,
             'include-deprecation-warnings': includeDeprecationWarnings,
         } = flags
         this.includeDescriptions = includeDescriptions
@@ -146,6 +161,7 @@ export default class GenerateTypes extends Base {
             this.authToken,
             this.projectKey,
         )
+        this.noDeclaration = noDeclaration
 
         if (this.project.settings.obfuscation.required) {
             if (!this.obfuscate) {
@@ -230,6 +246,7 @@ export default class GenerateTypes extends Base {
 
         let types =
             imports +
+            this.generateDeclareModuleStatement() +
             generateCustomDataType(this.customProperties, strictCustomData) +
             (react || next ? reactOverrides : '') +
             'export type DVCVariableTypes = {\n' +
@@ -240,6 +257,17 @@ export default class GenerateTypes extends Base {
         return types
     }
 
+    private generateDeclareModuleStatement() {
+        if (this.noDeclaration) {
+            return ''
+        }
+        return (
+            `declare module '@devcycle/types' {\n` +
+            `   interface CustomVariableDefinitions extends DVCVariableTypes {}\n` +
+            `}\n\n`
+        )
+    }
+
     private getTypeDefinitionLine(variable: Variable) {
         if (this.obfuscate) {
             return `    ${this.getVariableKeyAndType(variable)}`