Stricter typescript settings (#21)

web/create/LICENSE

@@ -0,0 +1,5 @@
+Copyright (c) 2024 by Conformal Authors
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

web/create/template/web/eslint-config-custom/config.cjs

@@ -3,7 +3,7 @@ module.exports = {
   env: { browser: true, es2020: true },
   extends: [
     "eslint:recommended",
-    "plugin:@typescript-eslint/recommended-type-checked",
+    "plugin:@typescript-eslint/strict-type-checked",
     "plugin:@typescript-eslint/stylistic-type-checked",
     "plugin:react-hooks/recommended",
     "plugin:react/recommended",
@@ -23,6 +23,7 @@ module.exports = {
         argsIgnorePattern: "^_",
       },
     ],
+    "@typescript-eslint/no-non-null-assertion": "off",
     "react-refresh/only-export-components": [
       "warn",
       { allowConstantExport: true },

web/create/template/web/tsconfig/tsconfig.json

@@ -2,7 +2,11 @@
   "compilerOptions": {
     "target": "es2020",
     "useDefineForClassFields": true,
-    "lib": ["es2020", "dom", "dom.iterable"],
+    "lib": [
+      "es2020",
+      "dom",
+      "dom.iterable"
+    ],
     "module": "esnext",
     "skipLibCheck": true,
     /* Bundler mode */
@@ -15,6 +19,7 @@
     "strict": true,
     "noUnusedLocals": true,
     "noUnusedParameters": true,
-    "noFallthroughCasesInSwitch": true
+    "noFallthroughCasesInSwitch": true,
+    "noUncheckedIndexedAccess": true
   }
-}
+}

web/create/template/web/{{plug_slug}}/vite.config.ts

@@ -2,6 +2,13 @@ import react from "@vitejs/plugin-react-swc";
 import license from "rollup-plugin-license";
 import { join } from "path";
 
+const unwrap = (x: string | null, name: string, field: string): string => {
+  if (x === null) {
+    throw new Error(`Malformed dependency ${name} (${field})`);
+  }
+  return x;
+};
+
 /** @type {import('vite').UserConfig} */
 export default {
   plugins: [
@@ -15,9 +22,9 @@ export default {
               .map(
                 (dependency) =>
                   `-----
-${dependency.name} ${dependency.version} (${dependency.license})
+${unwrap(dependency.name, "unknown", "name")} ${unwrap(dependency.version, dependency.name!, "version")} (${unwrap(dependency.license, dependency.name!, "license")})
 
-${dependency.licenseText}
+${unwrap(dependency.licenseText, dependency.name!, "licenseText")}
 `,
               )
               .join("\n"),

web/docs/theme.config.tsx

@@ -10,7 +10,13 @@ const themeConfig: DocsThemeConfig = {
   feedback: {
     useLink: () => {
       const config = useConfig();
-      return `https://github.com/russellmcc/conformal/discussions/new?category=q-a&title=Feedback regarding ${config.title}`;
+
+      // Not sure what's going on here, but typescript can't seem to correctly
+      // infer the type of `config` :'(.
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+      const title: string = config.title;
+
+      return `https://github.com/russellmcc/conformal/discussions/new?category=q-a&title=Feedback regarding ${title}`;
     },
   },
   footer: {

web/eslint-config-custom/config.cjs

@@ -3,7 +3,7 @@ module.exports = {
   env: { browser: true, es2020: true },
   extends: [
     "eslint:recommended",
-    "plugin:@typescript-eslint/recommended-type-checked",
+    "plugin:@typescript-eslint/strict-type-checked",
     "plugin:@typescript-eslint/stylistic-type-checked",
     "plugin:react-hooks/recommended",
     "plugin:react/recommended",
@@ -23,6 +23,7 @@ module.exports = {
         argsIgnorePattern: "^_",
       },
     ],
+    "@typescript-eslint/no-non-null-assertion": "off",
     "react-refresh/only-export-components": [
       "warn",
       { allowConstantExport: true },

web/plugin/LICENSE

@@ -0,0 +1,5 @@
+Copyright (c) 2024 by Conformal Authors
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

web/plugin/src/mock_store.ts

@@ -9,7 +9,7 @@ const mockGeneric = (infos: Map<string, Info>): Family<Value> =>
   atomFamily((path) => {
     const paramPath = path.match(/^params\/(.*)$/);
     if (paramPath) {
-      const param = paramPath[1];
+      const param = paramPath[1]!;
       const info = infos.get(param);
       if (!info) {
         throw new Error(`Unknown param: ${param}`);
@@ -30,7 +30,7 @@ const mockGeneric = (infos: Map<string, Info>): Family<Value> =>
     if (!paramInfoPath) {
       throw new Error(`Unknown path: ${path}`);
     }
-    const param = paramInfoPath[1];
+    const param = paramInfoPath[1]!;
     const info = infos.get(param);
     if (!info) {
       throw new Error(`Unknown param: ${param}`);

web/plugin/src/stores.ts

@@ -119,7 +119,8 @@ const createGeneric = (transport: Transport): Family<Value> => {
       for (const [path, value] of Object.entries(response.values)) {
         setters.get(path)?.(value);
       }
-    } else if (response.m === "subscribe_error") {
+    } else {
+      // response.m === "subscribe_error"
       setters.get(response.path)?.(
         Promise.reject(new Error(`Subscribe Error at ${response.path}`)),
       );

web/plugin/src/stores_react.ts

@@ -50,8 +50,12 @@ export const useGrab = (path: string): Grab => {
   const storage = useStores();
   const grab = useAtom(storage.grabbed(path))[1];
   return {
-    grab: () => grab(true),
-    release: () => grab(false),
+    grab: () => {
+      grab(true);
+    },
+    release: () => {
+      grab(false);
+    },
   };
 };
 

web/plugin/src/wry_transport.ts

@@ -15,7 +15,7 @@ declare global {
 
     // This is a function we add to the window object to receive messages from
     // Wry. It is set by the setOnResponse function below.
-    receiveMessage: (m: string) => void | undefined;
+    receiveMessage: (m: string) => void;
   }
 }
 

web/scripts/LICENSE

@@ -0,0 +1,5 @@
+Copyright (c) 2024 by Conformal Authors
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

web/scripts/src/bootstrap.ts

@@ -29,7 +29,11 @@ const rust = (): Tool => ({
     try {
       const cargoVersion = (await $`cargo --version`.text()).split(" ")[1];
       if (cargoVersion !== RUST_VERSION) {
-        console.warn(`cargo installed, but wrong version ${cargoVersion}`);
+        console.warn(
+          cargoVersion
+            ? `cargo installed, but wrong version ${cargoVersion}`
+            : "cargo installed, but could not get version",
+        );
         return false;
       }
       return true;
@@ -83,7 +87,11 @@ const vst3Validator = (): Tool => ({
 
   install: async () => {
     // use cmake to build the validator
-    const buildPath = `${process.env.VST3_SDK_DIR}/build`;
+    const sdk = process.env.VST3_SDK_DIR;
+    if (!sdk) {
+      throw new Error("VST3_SDK_DIR is not set");
+    }
+    const buildPath = `${sdk}/build`;
     await $`mkdir -p ${buildPath}`.quiet();
     await $`cmake ..`.cwd(buildPath);
     await $`cmake --build . --target validator`.cwd(buildPath);

web/scripts/src/bundle.ts

@@ -31,7 +31,7 @@ export const createBundle = async ({
   await runShell(["defaults", "write", bundleData.id, "dev_mode", "true"]);
 
   // Delete the bundle if it exists.
-  await runShell(["rm", "-rf", `${bundlePath}`]);
+  await runShell(["rm", "-rf", bundlePath]);
 
   // Create the binary directory for the bundle.
   await runShell(["mkdir", "-p", `${bundlePath}/Contents/MacOS`]);
@@ -123,8 +123,12 @@ export const createBundle = async ({
   const bundle_absolute_path = resolve(bundlePath);
 
   if (linkToLibrary) {
+    const home = process.env.HOME;
+    if (!home) {
+      throw new Error("HOME environment variable is not set");
+    }
     const bundle_dest = resolve(
-      `${process.env.HOME}/Library/Audio/Plug-Ins/VST3/${bundleData.name}.vst3`,
+      `${home}/Library/Audio/Plug-Ins/VST3/${bundleData.name}.vst3`,
     );
 
     await runShell(["rm", "-rf", bundle_dest]);

web/scripts/src/checkLfs.ts

@@ -30,7 +30,7 @@ const shouldLfsFiles = async function* () {
   for await (const line of $`git ls-files`.lines()) {
     if (line === "") continue;
     const filter_raw = await $`git check-attr filter ${line}`.text();
-    const filter = filter_raw.split("filter: ").slice(-1)[0].trim();
+    const filter = filter_raw.split("filter: ").slice(-1)[0]?.trim();
     if (filter === "lfs") {
       yield line;
     }

web/scripts/src/installer.ts

@@ -148,7 +148,7 @@ More info [here](https://developer.apple.com/documentation/security/notarizing_m
           "--root",
           tmpDir,
           "--identifier",
-          `${qualifiedIdent}`,
+          qualifiedIdent,
           "--version",
           bundleData.version,
           "--sign",

web/scripts/src/validate.ts

@@ -18,11 +18,11 @@ export const execute = async (config: Config) => {
   const { name } = await getBundleData(packageRoot);
 
   const bundlePath = `target/${config}/${name}.vst3`;
-
-  await runShell([
-    `${process.env.VST3_SDK_DIR}/build/bin/validator`,
-    bundlePath,
-  ]);
+  const sdkDir = process.env.VST3_SDK_DIR;
+  if (!sdkDir) {
+    throw new Error("VST3_SDK_DIR is not set");
+  }
+  await runShell([`${sdkDir}/build/bin/validator`, bundlePath]);
 };
 
 export const addValidateCommand = (command: Command) => {

web/tsconfig/tsconfig.json

@@ -20,5 +20,6 @@
         "noUnusedLocals": true,
         "noUnusedParameters": true,
         "noFallthroughCasesInSwitch": true,
+        "noUncheckedIndexedAccess": true,
     },
 }