chore(ci): fix linter misconfiguration to allow Projen upgrade to suc…

…ceed (#190) As I was debugging the `upgrade-projen` workflow, the upgrade from `0.88.0` => `0.91.6` was failing due to changes in the ESLint configuration. While digging for workarounds, I found the following. --------- Signed-off-by: team-tf-cdk <github-team-tf-cdk@hashicorp.com> Co-authored-by: team-tf-cdk <github-team-tf-cdk@hashicorp.com>
cdktf · Jan 21, 2025 · 75588db · 75588db
1 parent f0c440b
commit 75588db
Show file tree

Hide file tree

Showing 11 changed files with 23 additions and 11 deletions.
diff --git a/.projen/tasks.json b/.projen/tasks.json
diff --git a/.projenrc.ts b/.projenrc.ts
@@ -63,6 +63,12 @@ const project = new JsiiProject({
   typescriptVersion,
   jsiiVersion: typescriptVersion,
   pullRequestTemplate: false,
+  // Necessary due to this bug: https://github.com/projen/projen/issues/3950#issuecomment-2483442005
+  // If this bug gets fixed, the below `eslintOptions` section should be able to be removed
+  eslintOptions: {
+    fileExtensions: [],
+    dirs: ["src", "test", "projenrc", ".projenrc.ts"],
+  },
 });
 project.tsconfig?.exclude?.push("src/exampleCode/**");
 project.tsconfig?.exclude?.push("example/**");

diff --git a/examples/hybrid-module/.projen/tasks.json b/examples/hybrid-module/.projen/tasks.json
diff --git a/examples/hybrid-module/src/__tests__/index-test.ts b/examples/hybrid-module/src/__tests__/index-test.ts
@@ -13,4 +13,4 @@ describe("MyConstruct", () => {
       })
     ).toMatchSnapshot();
   });
-});
+});
diff --git a/examples/hybrid-module/src/index.ts b/examples/hybrid-module/src/index.ts
@@ -8,4 +8,4 @@ export class MyConstruct extends Construct {
   constructor(scope: Construct, id: string, public config: MyConstructOptions) {
     super(scope, id);
   }
-}
+}
diff --git a/examples/hybrid-module/src/tfModules.ts b/examples/hybrid-module/src/tfModules.ts
@@ -1,6 +1,6 @@
-import { TFModuleStack } from "@cdktf/tf-module-stack";
 import { App } from "cdktf";
 import { Construct } from "constructs";
+import { TFModuleStack } from "@cdktf/tf-module-stack";
 import { MyConstruct } from "./index";
 
 class MyAwesomeModule extends TFModuleStack {
@@ -14,8 +14,8 @@ class MyAwesomeModule extends TFModuleStack {
 }
 
 const app = new App();
-// This is the name the module can be found under.
+// This is the name the module can be found under. 
 // We expect a "my-awesome-module.md" file in this directory.
 // The README.md file will be generated from this file.
 new MyAwesomeModule(app, "my-awesome-module");
-app.synth();
+app.synth();
diff --git a/examples/terraform-module/.projen/tasks.json b/examples/terraform-module/.projen/tasks.json
diff --git a/examples/terraform-module/src/__tests__/index-test.ts b/examples/terraform-module/src/__tests__/index-test.ts
@@ -3,5 +3,5 @@
 
 // To learn more about testing see cdk.tf/testing
 describe("MyModule", () => {
-  it.todo("should be tested");
-});
+  it.todo("should be tested")
+});
diff --git a/examples/terraform-module/src/index.ts b/examples/terraform-module/src/index.ts
@@ -1,4 +1,4 @@
 // Re-Export module bindings
 export * from "./terraformModules";
 
-// Add your custom constructs here
+// Add your custom constructs here
diff --git a/src/hybrid-module.ts b/src/hybrid-module.ts
@@ -175,6 +175,9 @@ export class HybridModule extends JsiiProject {
       ...options,
       eslintOptions: Object.assign({}, options.eslintOptions, {
         lintProjenRc: false,
+        // Necessary due to this bug: https://github.com/projen/projen/issues/3950#issuecomment-2483442005
+        // If this bug gets fixed, the below line should be able to be removed
+        fileExtensions: [],
       }),
       postBuildSteps: [],
       jsiiVersion: "~5.5.0",

diff --git a/src/terraform-module.ts b/src/terraform-module.ts
@@ -59,6 +59,9 @@ export class TerraformModule extends ConstructLibrary {
       ...options,
       eslintOptions: Object.assign({}, options.eslintOptions, {
         lintProjenRc: false,
+        // Necessary due to this bug: https://github.com/projen/projen/issues/3950#issuecomment-2483442005
+        // If this bug gets fixed, the below line should be able to be removed
+        fileExtensions: [],
       }),
       postBuildSteps: [],
       jsiiVersion: "~5.5.0",
-Original file line number
+Diff line change
@@ Expand Up / @@ -13,4 +13,4 @@ describe("MyConstruct", () => { @@
           })
         ).toMatchSnapshot();
       });
-    });
+    });