fix: disable type checking in generated files

einride · Apr 12, 2023 · 86daceb · 86daceb
1 parent 52badd5
commit 86daceb
Show file tree

Hide file tree

Showing 5 changed files with 5 additions and 0 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -3,5 +3,6 @@ module.exports = {
   rules: {
     "jest/no-deprecated-functions": "off", // we're not using Jest
     "prettier/prettier": "off", // we're not concerned with code style
+    "@typescript-eslint/ban-ts-comment": "off", // we need ts comment in generated files to disable type checking of files for consumers
   },
 };
diff --git a/examples/proto/gen/typescript/einride/example/freight/v1/index.ts b/examples/proto/gen/typescript/einride/example/freight/v1/index.ts
@@ -1,5 +1,6 @@
 // Code generated by protoc-gen-typescript-http. DO NOT EDIT.
 /* eslint-disable camelcase */
+// @ts-nocheck
 
 // A shipment represents transportation of goods between an origin
 // [site][einride.example.freight.v1.Site] and a destination

diff --git a/examples/proto/gen/typescript/einride/example/syntax/v1/index.ts b/examples/proto/gen/typescript/einride/example/syntax/v1/index.ts
@@ -1,5 +1,6 @@
 // Code generated by protoc-gen-typescript-http. DO NOT EDIT.
 /* eslint-disable camelcase */
+// @ts-nocheck
 
 // Enum
 export type Enum =

diff --git a/examples/proto/gen/typescript/einride/example/syntax/v2/index.ts b/examples/proto/gen/typescript/einride/example/syntax/v2/index.ts
@@ -1,5 +1,6 @@
 // Code generated by protoc-gen-typescript-http. DO NOT EDIT.
 /* eslint-disable camelcase */
+// @ts-nocheck
 
 // Message
 export type Message = {

diff --git a/internal/plugin/packagegen.go b/internal/plugin/packagegen.go
@@ -46,5 +46,6 @@ func (p packageGenerator) Generate(f *codegen.File) error {
 func (p packageGenerator) generateHeader(f *codegen.File) {
 	f.P("// Code generated by protoc-gen-typescript-http. DO NOT EDIT.")
 	f.P("/* eslint-disable camelcase */")
+	f.P("// @ts-nocheck")
 	f.P()
 }