[v3] Enforce stricter typing for generated bindings (#3498)

* Subject generator output to stricter TS linting * Fix runtime support code typing * Relax tsconfig for templates * Update test data * Update binding example
wailsapp · May 19, 2024 · 939d22d · 939d22d
1 parent 90b7ea9
commit 939d22d
Show file tree

Hide file tree

Showing 442 changed files with 1,479 additions and 250 deletions.
diff --git a/...ples/binding/assets/bindings/github.com/wailsapp/wails/v3/examples/binding/data/models.js b/...ples/binding/assets/bindings/github.com/wailsapp/wails/v3/examples/binding/data/models.js
@@ -2,6 +2,8 @@
 // Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL
 // This file is automatically generated. DO NOT EDIT
 
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: Unused imports
 import {Create as $Create} from "/wails/runtime.js";
 
 /**

diff --git a/...les/binding/assets/bindings/github.com/wailsapp/wails/v3/examples/binding/greetservice.js b/...les/binding/assets/bindings/github.com/wailsapp/wails/v3/examples/binding/greetservice.js
@@ -7,8 +7,12 @@
  * @module
  */
 
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: Unused imports
 import {Call as $Call, Create as $Create} from "/wails/runtime.js";
 
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: Unused imports
 import * as data$0 from "./data/models.js";
 
 /**

diff --git a/v3/internal/generator/render/templates/models.js.tmpl b/v3/internal/generator/render/templates/models.js.tmpl
@@ -7,16 +7,25 @@
 // @ts-check
 // Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL
 // This file is automatically generated. DO NOT EDIT
-
+{{if not $useInterfaces}}
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: Unused imports
 import {Create as $Create} from "{{js $runtime}}";
+{{- end}}
 {{range $imports.External}}
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: Unused imports
 import * as {{jsimport .}} from "{{js .RelPath}}/{{js $models}}";
 {{- end}}{{if $imports.External}}
 {{end}}
-{{- if $imports.ImportModels}}
+{{- if or $useInterfaces $imports.ImportModels}}
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: Unused imports
 import * as $models from "./{{js $models}}";{{if not $imports.ImportInternal}}
 {{end}}{{end}}
 {{- if $imports.ImportInternal}}
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: Unused imports
 import * as $internal from "./{{js $internal}}";
 {{end}}
 {{- range $model := .Models}}
@@ -163,7 +172,7 @@ export class {{jsid $model.Name}} {
  * @template {{$typeParams}}
  {{- range $i, $param := $model.TypeParams}}
  {{- $param = (typeparam $i $param)}}
- * @param {(any) => {{$param -}} } $$createParam{{$param}}
+ * @param {(source: any) => {{$param -}} } $$createParam{{$param}}
  {{- end}}
  * @returns {($$source?: any) => {{jsid $model.Name}}{{$typeParamList -}} }
  {{- else}}

diff --git a/v3/internal/generator/render/templates/models.ts.tmpl b/v3/internal/generator/render/templates/models.ts.tmpl
@@ -6,16 +6,25 @@
 {{- $imports := $module.Imports -}}
 // Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL
 // This file is automatically generated. DO NOT EDIT
-
+{{if not $useInterfaces}}
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: Unused imports
 import {Create as $Create} from "{{js $runtime}}";
+{{- end}}
 {{range $imports.External}}
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: Unused imports
 import * as {{jsimport .}} from "{{js .RelPath}}/{{js $models}}";
 {{- end}}{{if $imports.External}}
 {{end}}
 {{- if $imports.ImportModels}}
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: Unused imports
 import * as $models from "./{{js $models}}";{{if not $imports.ImportInternal}}
 {{end}}{{end}}
 {{- if $imports.ImportInternal}}
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: Unused imports
 import * as $internal from "./{{js $internal}}";
 {{end}}
 {{- range $model := .Models}}
@@ -135,7 +144,7 @@ export {{if $isInterface}}interface{{else}}class{{end}} {{jsid $model.Name}}{{$t
  {{- range $i, $param := $model.TypeParams}}
  {{- $param = (typeparam $i $param)}}
  {{- if gt $i 0}}, {{end -}}
- $$createParam{{$param}}: (any) => {{$param}}{{end -}}
+ $$createParam{{$param}}: (source: any) => {{$param}}{{end -}}
  {{else}}$$source: any = {}{{end}}):
  {{- if $typeParamList}} ($$source?: any) =>{{end}} {{jsid $model.Name}}{{$typeParamList}} {
  {{- range $i, $spec := $model.Fields}}{{range $j, $field := $spec}}

diff --git a/v3/internal/generator/render/templates/service.js.tmpl b/v3/internal/generator/render/templates/service.js.tmpl
@@ -21,15 +21,23 @@
  * @module
  */
 {{end}}
-import {Call as $Call, Create as $Create} from "{{js $runtime}}";
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: Unused imports
+import {Call as $Call{{if not $useInterfaces}}, Create as $Create{{end -}} } from "{{js $runtime}}";
 {{range $imports.External}}
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: Unused imports
 import * as {{jsimport .}} from "{{js .RelPath}}/{{js $models}}";
 {{- end}}{{if $imports.External}}
 {{end}}
 {{- if $imports.ImportModels}}
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: Unused imports
 import * as $models from "./{{js $models}}";{{if not $imports.ImportInternal}}
 {{end}}{{end}}
 {{- if $imports.ImportInternal}}
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: Unused imports
 import * as $internal from "./{{js $internal}}";
 {{end}}
 {{- range .Injections}}

diff --git a/v3/internal/generator/render/templates/service.ts.tmpl b/v3/internal/generator/render/templates/service.ts.tmpl
@@ -20,15 +20,23 @@
  * @module
  */
 {{end}}
-import {Call as $Call, Create as $Create} from "{{js $runtime}}";
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: Unused imports
+import {Call as $Call{{if not $useInterfaces}}, Create as $Create{{end -}} } from "{{js $runtime}}";
 {{range $imports.External}}
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: Unused imports
 import * as {{jsimport .}} from "{{js .RelPath}}/{{js $models}}";
 {{- end}}{{if $imports.External}}
 {{end}}
 {{- if $imports.ImportModels}}
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: Unused imports
 import * as $models from "./{{js $models}}";{{if not $imports.ImportInternal}}
 {{end}}{{end}}
 {{- if $imports.ImportInternal}}
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: Unused imports
 import * as $internal from "./{{js $internal}}";
 {{end}}
 {{- range .Injections}}

diff --git a/...s=false/github.com/wailsapp/wails/v3/internal/generator/testcases/aliases/greetservice.js b/...s=false/github.com/wailsapp/wails/v3/internal/generator/testcases/aliases/greetservice.js
@@ -7,8 +7,12 @@
  * @module
  */
 
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: Unused imports
 import {Call as $Call, Create as $Create} from "/wails/runtime.js";
 
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: Unused imports
 import * as $models from "./models.js";
 
 /**

diff --git a/...seNames=false/github.com/wailsapp/wails/v3/internal/generator/testcases/aliases/models.js b/...seNames=false/github.com/wailsapp/wails/v3/internal/generator/testcases/aliases/models.js
@@ -2,6 +2,8 @@
 // Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL
 // This file is automatically generated. DO NOT EDIT
 
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: Unused imports
 import {Create as $Create} from "/wails/runtime.js";
 
 /**
@@ -82,7 +84,7 @@ export class GenericPerson {
  * returns a creation function for a concrete instance
  * of the generic class GenericPerson.
  * @template T
- * @param {(any) => T} $$createParamT
+ * @param {(source: any) => T} $$createParamT
  * @returns {($$source?: any) => GenericPerson<T>}
  */
  static createFrom($$createParamT) {

diff --git a/...com/wailsapp/wails/v3/internal/generator/testcases/complex_expressions/config/service7.js b/...com/wailsapp/wails/v3/internal/generator/testcases/complex_expressions/config/service7.js
@@ -2,6 +2,8 @@
 // Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL
 // This file is automatically generated. DO NOT EDIT
 
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: Unused imports
 import {Call as $Call, Create as $Create} from "/wails/runtime.js";
 
 /**

diff --git a/...com/wailsapp/wails/v3/internal/generator/testcases/complex_expressions/config/service9.js b/...com/wailsapp/wails/v3/internal/generator/testcases/complex_expressions/config/service9.js
@@ -2,6 +2,8 @@
 // Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL
 // This file is automatically generated. DO NOT EDIT
 
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: Unused imports
 import {Call as $Call, Create as $Create} from "/wails/runtime.js";
 
 /**

diff --git a/...se/github.com/wailsapp/wails/v3/internal/generator/testcases/complex_json/greetservice.js b/...se/github.com/wailsapp/wails/v3/internal/generator/testcases/complex_json/greetservice.js
@@ -7,8 +7,12 @@
  * @module
  */
 
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: Unused imports
 import {Call as $Call, Create as $Create} from "/wails/runtime.js";
 
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: Unused imports
 import * as $models from "./models.js";
 
 /**

diff --git a/...=false/github.com/wailsapp/wails/v3/internal/generator/testcases/complex_json/internal.js b/...=false/github.com/wailsapp/wails/v3/internal/generator/testcases/complex_json/internal.js
@@ -2,6 +2,8 @@
 // Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL
 // This file is automatically generated. DO NOT EDIT
 
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: Unused imports
 import {Create as $Create} from "/wails/runtime.js";
 
 export class embedded4 {

diff --git a/...es=false/github.com/wailsapp/wails/v3/internal/generator/testcases/complex_json/models.js b/...es=false/github.com/wailsapp/wails/v3/internal/generator/testcases/complex_json/models.js
@@ -2,8 +2,12 @@
 // Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL
 // This file is automatically generated. DO NOT EDIT
 
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: Unused imports
 import {Create as $Create} from "/wails/runtime.js";
 
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: Unused imports
 import * as $internal from "./internal.js";
 
 export class Embedded1 {

diff --git a/.../github.com/wailsapp/wails/v3/internal/generator/testcases/complex_method/greetservice.js b/.../github.com/wailsapp/wails/v3/internal/generator/testcases/complex_method/greetservice.js
@@ -7,8 +7,12 @@
  * @module
  */
 
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: Unused imports
 import {Call as $Call, Create as $Create} from "/wails/runtime.js";
 
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: Unused imports
 import * as $models from "./models.js";
 
 /**

diff --git a/...=false/github.com/wailsapp/wails/v3/internal/generator/testcases/complex_method/models.js b/...=false/github.com/wailsapp/wails/v3/internal/generator/testcases/complex_method/models.js
@@ -2,6 +2,8 @@
 // Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL
 // This file is automatically generated. DO NOT EDIT
 
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: Unused imports
 import {Create as $Create} from "/wails/runtime.js";
 
 /**

diff --git a/...es=false/github.com/wailsapp/wails/v3/internal/generator/testcases/cycles/greetservice.js b/...es=false/github.com/wailsapp/wails/v3/internal/generator/testcases/cycles/greetservice.js
@@ -7,8 +7,12 @@
  * @module
  */
 
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: Unused imports
 import {Call as $Call, Create as $Create} from "/wails/runtime.js";
 
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: Unused imports
 import * as $models from "./models.js";
 
 /**

diff --git a/...UseNames=false/github.com/wailsapp/wails/v3/internal/generator/testcases/cycles/models.js b/...UseNames=false/github.com/wailsapp/wails/v3/internal/generator/testcases/cycles/models.js
@@ -2,6 +2,8 @@
 // Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL
 // This file is automatically generated. DO NOT EDIT
 
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: Unused imports
 import {Create as $Create} from "/wails/runtime.js";
 
 /**

diff --git a/...hub.com/wailsapp/wails/v3/internal/generator/testcases/embedded_interface/greetservice.js b/...hub.com/wailsapp/wails/v3/internal/generator/testcases/embedded_interface/greetservice.js
@@ -7,6 +7,8 @@
  * @module
  */
 
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: Unused imports
 import {Call as $Call, Create as $Create} from "/wails/runtime.js";
 
 /**

diff --git a/...ames=false/github.com/wailsapp/wails/v3/internal/generator/testcases/enum/greetservice.js b/...ames=false/github.com/wailsapp/wails/v3/internal/generator/testcases/enum/greetservice.js
@@ -7,8 +7,12 @@
  * @module
  */
 
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: Unused imports
 import {Call as $Call, Create as $Create} from "/wails/runtime.js";
 
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: Unused imports
 import * as $models from "./models.js";
 
 /**

diff --git a/...e/UseNames=false/github.com/wailsapp/wails/v3/internal/generator/testcases/enum/models.js b/...e/UseNames=false/github.com/wailsapp/wails/v3/internal/generator/testcases/enum/models.js
@@ -2,6 +2,8 @@
 // Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL
 // This file is automatically generated. DO NOT EDIT
 
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: Unused imports
 import {Create as $Create} from "/wails/runtime.js";
 
 /**

diff --git a/...wailsapp/wails/v3/internal/generator/testcases/enum_from_imported_package/greetservice.js b/...wailsapp/wails/v3/internal/generator/testcases/enum_from_imported_package/greetservice.js
@@ -7,8 +7,12 @@
  * @module
  */
 
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: Unused imports
 import {Call as $Call, Create as $Create} from "/wails/runtime.js";
 
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: Unused imports
 import * as services$0 from "./services/models.js";
 
 /**

diff --git a/...lsapp/wails/v3/internal/generator/testcases/enum_from_imported_package/services/models.js b/...lsapp/wails/v3/internal/generator/testcases/enum_from_imported_package/services/models.js
@@ -2,6 +2,8 @@
 // Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL
 // This file is automatically generated. DO NOT EDIT
 
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: Unused imports
 import {Create as $Create} from "/wails/runtime.js";
 
 /**

diff --git a/...sapp/wails/v3/internal/generator/testcases/function_from_imported_package/greetservice.js b/...sapp/wails/v3/internal/generator/testcases/function_from_imported_package/greetservice.js
@@ -7,8 +7,12 @@
  * @module
  */
 
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: Unused imports
 import {Call as $Call, Create as $Create} from "/wails/runtime.js";
 
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: Unused imports
 import * as $models from "./models.js";
 
 /**

diff --git a/...m/wailsapp/wails/v3/internal/generator/testcases/function_from_imported_package/models.js b/...m/wailsapp/wails/v3/internal/generator/testcases/function_from_imported_package/models.js
@@ -2,8 +2,12 @@
 // Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL
 // This file is automatically generated. DO NOT EDIT
 
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: Unused imports
 import {Create as $Create} from "/wails/runtime.js";
 
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: Unused imports
 import * as services$0 from "./services/models.js";
 
 /**

diff --git a/...p/wails/v3/internal/generator/testcases/function_from_imported_package/services/models.js b/...p/wails/v3/internal/generator/testcases/function_from_imported_package/services/models.js
@@ -2,6 +2,8 @@
 // Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL
 // This file is automatically generated. DO NOT EDIT
 
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: Unused imports
 import {Create as $Create} from "/wails/runtime.js";
 
 export class Address {

diff --git a/...s/v3/internal/generator/testcases/function_from_imported_package/services/otherservice.js b/...s/v3/internal/generator/testcases/function_from_imported_package/services/otherservice.js
@@ -8,8 +8,12 @@
  * @module
  */
 
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: Unused imports
 import {Call as $Call, Create as $Create} from "/wails/runtime.js";
 
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: Unused imports
 import * as $models from "./models.js";
 
 /**

diff --git a/...ils/v3/internal/generator/testcases/function_from_nested_imported_package/greetservice.js b/...ils/v3/internal/generator/testcases/function_from_nested_imported_package/greetservice.js
@@ -7,8 +7,12 @@
  * @module
  */
 
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: Unused imports
 import {Call as $Call, Create as $Create} from "/wails/runtime.js";
 
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: Unused imports
 import * as $models from "./models.js";
 
 /**

diff --git a/...app/wails/v3/internal/generator/testcases/function_from_nested_imported_package/models.js b/...app/wails/v3/internal/generator/testcases/function_from_nested_imported_package/models.js
@@ -2,8 +2,12 @@
 // Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL
 // This file is automatically generated. DO NOT EDIT
 
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: Unused imports
 import {Create as $Create} from "/wails/runtime.js";
 
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: Unused imports
 import * as other$0 from "./services/other/models.js";
 
 export class Person {