feat: tsconfig, gitignore, npm script enhancements (#782)

* chore: enable strict mode * feat: tsconfig enhancements for codegen'd SDK * chore: update test fixtures * feat: gitignore dist directory * feat: add tsc lint script
readmeio · Oct 25, 2023 · cd9e22c · cd9e22c
1 parent 521683a
commit cd9e22c
Show file tree

Hide file tree

Showing 28 changed files with 112 additions and 19 deletions.
diff --git a/packages/api/src/codegen/languages/typescript/index.ts b/packages/api/src/codegen/languages/typescript/index.ts
@@ -218,6 +218,7 @@ export default class TSGenerator extends CodeGenerator {
     const srcDirectory = this.project.createDirectory('src');
     const sdkSource = this.createSDKSource(srcDirectory);
 
+    this.createGitIgnore();
     this.createPackageJSON();
     this.createTSConfig();
     this.createREADME();
@@ -522,6 +523,22 @@ sdk.server('https://eu.api.example.com/v14');`),
     return sourceFile;
   }
 
+  /**
+   * Creates a `.gitignore` file to prevent the `dist/` directory from being tracked.
+   *
+   */
+  createGitIgnore() {
+    const file = `# This file prevents the \`dist/\` directory from being tracked via git.
+# This is recommended since the \`prepare\` npm script automatically
+# regenerates the contents of the \`dist/\` directory as needed.
+dist/
+`;
+
+    const sourceFile = this.project.createSourceFile('.gitignore', file);
+
+    return sourceFile;
+  }
+
   /**
    * Create the `tsconfig.json` file that will allow this SDK to be compiled for use.
    *
@@ -531,8 +548,11 @@ sdk.server('https://eu.api.example.com/v14');`),
 
     const config: TsConfigJson = {
       compilerOptions: {
-        module: 'NodeNext',
+        esModuleInterop: true,
+        module: 'ESNext',
+        moduleResolution: 'Bundler',
         resolveJsonModule: true,
+        strict: true,
       },
       include: ['./src/**/*'],
     };
@@ -607,6 +627,7 @@ sdk.server('https://eu.api.example.com/v14');`),
       license: this.spdxLicense ?? '',
       files: ['dist', 'openapi.json'],
       scripts: {
+        lint: 'tsc --noEmit',
         prepare: 'tsup',
       },
       dependencies,

diff --git a/packages/test-utils/sdks/alby/.gitignore b/packages/test-utils/sdks/alby/.gitignore
@@ -0,0 +1,4 @@
+# This file prevents the `dist/` directory from being tracked via git.
+# This is recommended since the `prepare` npm script automatically
+# regenerates the contents of the `dist/` directory as needed.
+dist/
diff --git a/packages/test-utils/sdks/alby/package.json b/packages/test-utils/sdks/alby/package.json
@@ -19,6 +19,7 @@
     "openapi.json"
   ],
   "scripts": {
+    "lint": "tsc --noEmit",
     "prepare": "tsup"
   },
   "dependencies": {

diff --git a/packages/test-utils/sdks/alby/tsconfig.json b/packages/test-utils/sdks/alby/tsconfig.json
@@ -1,7 +1,10 @@
 {
   "compilerOptions": {
-    "module": "NodeNext",
-    "resolveJsonModule": true
+    "esModuleInterop": true,
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "resolveJsonModule": true,
+    "strict": true
   },
   "include": [
     "./src/**/*"

diff --git a/packages/test-utils/sdks/metrotransit/.gitignore b/packages/test-utils/sdks/metrotransit/.gitignore
@@ -0,0 +1,4 @@
+# This file prevents the `dist/` directory from being tracked via git.
+# This is recommended since the `prepare` npm script automatically
+# regenerates the contents of the `dist/` directory as needed.
+dist/
diff --git a/packages/test-utils/sdks/metrotransit/package.json b/packages/test-utils/sdks/metrotransit/package.json
@@ -19,6 +19,7 @@
     "openapi.json"
   ],
   "scripts": {
+    "lint": "tsc --noEmit",
     "prepare": "tsup"
   },
   "dependencies": {

diff --git a/packages/test-utils/sdks/metrotransit/tsconfig.json b/packages/test-utils/sdks/metrotransit/tsconfig.json
@@ -1,7 +1,10 @@
 {
   "compilerOptions": {
-    "module": "NodeNext",
-    "resolveJsonModule": true
+    "esModuleInterop": true,
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "resolveJsonModule": true,
+    "strict": true
   },
   "include": [
     "./src/**/*"

diff --git a/packages/test-utils/sdks/operationid-quirks/.gitignore b/packages/test-utils/sdks/operationid-quirks/.gitignore
@@ -0,0 +1,4 @@
+# This file prevents the `dist/` directory from being tracked via git.
+# This is recommended since the `prepare` npm script automatically
+# regenerates the contents of the `dist/` directory as needed.
+dist/
diff --git a/packages/test-utils/sdks/operationid-quirks/package.json b/packages/test-utils/sdks/operationid-quirks/package.json
@@ -15,6 +15,7 @@
     "openapi.json"
   ],
   "scripts": {
+    "lint": "tsc --noEmit",
     "prepare": "tsup"
   },
   "dependencies": {

diff --git a/packages/test-utils/sdks/operationid-quirks/tsconfig.json b/packages/test-utils/sdks/operationid-quirks/tsconfig.json
@@ -1,7 +1,10 @@
 {
   "compilerOptions": {
-    "module": "NodeNext",
-    "resolveJsonModule": true
+    "esModuleInterop": true,
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "resolveJsonModule": true,
+    "strict": true
   },
   "include": [
     "./src/**/*"

diff --git a/packages/test-utils/sdks/optional-payload/.gitignore b/packages/test-utils/sdks/optional-payload/.gitignore
@@ -0,0 +1,4 @@
+# This file prevents the `dist/` directory from being tracked via git.
+# This is recommended since the `prepare` npm script automatically
+# regenerates the contents of the `dist/` directory as needed.
+dist/
diff --git a/packages/test-utils/sdks/optional-payload/package.json b/packages/test-utils/sdks/optional-payload/package.json
@@ -19,6 +19,7 @@
     "openapi.json"
   ],
   "scripts": {
+    "lint": "tsc --noEmit",
     "prepare": "tsup"
   },
   "dependencies": {

diff --git a/packages/test-utils/sdks/optional-payload/tsconfig.json b/packages/test-utils/sdks/optional-payload/tsconfig.json
@@ -1,7 +1,10 @@
 {
   "compilerOptions": {
-    "module": "NodeNext",
-    "resolveJsonModule": true
+    "esModuleInterop": true,
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "resolveJsonModule": true,
+    "strict": true
   },
   "include": [
     "./src/**/*"

diff --git a/packages/test-utils/sdks/petstore/.gitignore b/packages/test-utils/sdks/petstore/.gitignore
@@ -0,0 +1,4 @@
+# This file prevents the `dist/` directory from being tracked via git.
+# This is recommended since the `prepare` npm script automatically
+# regenerates the contents of the `dist/` directory as needed.
+dist/
diff --git a/packages/test-utils/sdks/petstore/package.json b/packages/test-utils/sdks/petstore/package.json
@@ -20,6 +20,7 @@
     "openapi.json"
   ],
   "scripts": {
+    "lint": "tsc --noEmit",
     "prepare": "tsup"
   },
   "dependencies": {

diff --git a/packages/test-utils/sdks/petstore/tsconfig.json b/packages/test-utils/sdks/petstore/tsconfig.json
@@ -1,7 +1,10 @@
 {
   "compilerOptions": {
-    "module": "NodeNext",
-    "resolveJsonModule": true
+    "esModuleInterop": true,
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "resolveJsonModule": true,
+    "strict": true
   },
   "include": [
     "./src/**/*"

diff --git a/packages/test-utils/sdks/readme/.gitignore b/packages/test-utils/sdks/readme/.gitignore
@@ -0,0 +1,4 @@
+# This file prevents the `dist/` directory from being tracked via git.
+# This is recommended since the `prepare` npm script automatically
+# regenerates the contents of the `dist/` directory as needed.
+dist/
diff --git a/packages/test-utils/sdks/readme/package.json b/packages/test-utils/sdks/readme/package.json
@@ -19,6 +19,7 @@
     "openapi.json"
   ],
   "scripts": {
+    "lint": "tsc --noEmit",
     "prepare": "tsup"
   },
   "dependencies": {

diff --git a/packages/test-utils/sdks/readme/tsconfig.json b/packages/test-utils/sdks/readme/tsconfig.json
@@ -1,7 +1,10 @@
 {
   "compilerOptions": {
-    "module": "NodeNext",
-    "resolveJsonModule": true
+    "esModuleInterop": true,
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "resolveJsonModule": true,
+    "strict": true
   },
   "include": [
     "./src/**/*"

diff --git a/packages/test-utils/sdks/response-title-quirks/.gitignore b/packages/test-utils/sdks/response-title-quirks/.gitignore
@@ -0,0 +1,4 @@
+# This file prevents the `dist/` directory from being tracked via git.
+# This is recommended since the `prepare` npm script automatically
+# regenerates the contents of the `dist/` directory as needed.
+dist/
diff --git a/packages/test-utils/sdks/response-title-quirks/package.json b/packages/test-utils/sdks/response-title-quirks/package.json
@@ -19,6 +19,7 @@
     "openapi.json"
   ],
   "scripts": {
+    "lint": "tsc --noEmit",
     "prepare": "tsup"
   },
   "dependencies": {

diff --git a/packages/test-utils/sdks/response-title-quirks/tsconfig.json b/packages/test-utils/sdks/response-title-quirks/tsconfig.json
@@ -1,7 +1,10 @@
 {
   "compilerOptions": {
-    "module": "NodeNext",
-    "resolveJsonModule": true
+    "esModuleInterop": true,
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "resolveJsonModule": true,
+    "strict": true
   },
   "include": [
     "./src/**/*"

diff --git a/packages/test-utils/sdks/simple/.gitignore b/packages/test-utils/sdks/simple/.gitignore
@@ -0,0 +1,4 @@
+# This file prevents the `dist/` directory from being tracked via git.
+# This is recommended since the `prepare` npm script automatically
+# regenerates the contents of the `dist/` directory as needed.
+dist/
diff --git a/packages/test-utils/sdks/simple/package.json b/packages/test-utils/sdks/simple/package.json
@@ -19,6 +19,7 @@
     "openapi.json"
   ],
   "scripts": {
+    "lint": "tsc --noEmit",
     "prepare": "tsup"
   },
   "dependencies": {

diff --git a/packages/test-utils/sdks/simple/tsconfig.json b/packages/test-utils/sdks/simple/tsconfig.json
@@ -1,7 +1,10 @@
 {
   "compilerOptions": {
-    "module": "NodeNext",
-    "resolveJsonModule": true
+    "esModuleInterop": true,
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "resolveJsonModule": true,
+    "strict": true
   },
   "include": [
     "./src/**/*"

diff --git a/packages/test-utils/sdks/star-trek/.gitignore b/packages/test-utils/sdks/star-trek/.gitignore
@@ -0,0 +1,4 @@
+# This file prevents the `dist/` directory from being tracked via git.
+# This is recommended since the `prepare` npm script automatically
+# regenerates the contents of the `dist/` directory as needed.
+dist/
diff --git a/packages/test-utils/sdks/star-trek/package.json b/packages/test-utils/sdks/star-trek/package.json
@@ -19,6 +19,7 @@
     "openapi.json"
   ],
   "scripts": {
+    "lint": "tsc --noEmit",
     "prepare": "tsup"
   },
   "dependencies": {

diff --git a/packages/test-utils/sdks/star-trek/tsconfig.json b/packages/test-utils/sdks/star-trek/tsconfig.json
@@ -1,7 +1,10 @@
 {
   "compilerOptions": {
-    "module": "NodeNext",
-    "resolveJsonModule": true
+    "esModuleInterop": true,
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "resolveJsonModule": true,
+    "strict": true
   },
   "include": [
     "./src/**/*"