Merge pull request #195 from x0k/form-lint

Form package lint

Author: x0k

mkfile

@@ -77,6 +77,10 @@ f/:
     pnpm run check
   t:
     pnpm run test $@
+  l:
+    pnpm run lint
+  f:
+    pnpm run format
   tui:
     pnpm run test:ui
   popd

packages/form/.prettierignore

@@ -0,0 +1,11 @@
+# Package Managers
+package-lock.json
+pnpm-lock.yaml
+yarn.lock
+bun.lock
+bun.lockb
+.svelte-kit
+dist
+
+# Miscellaneous
+/static/

packages/form/.prettierrc

@@ -0,0 +1,15 @@
+{
+  "useTabs": false,
+  "singleQuote": false,
+  "trailingComma": "es5",
+  "printWidth": 80,
+  "plugins": ["prettier-plugin-svelte"],
+  "overrides": [
+    {
+      "files": "*.svelte",
+      "options": {
+        "parser": "svelte"
+      }
+    }
+  ]
+}

packages/form/README.md

@@ -19,41 +19,41 @@ npm install @sjsf/form @sjsf/basic-theme @sjsf/ajv8-validator ajv@8
 
 ```svelte
 <script lang="ts">
-  import { createForm, BasicForm, type Schema } from '@sjsf/form';
-  import { resolver } from '@sjsf/form/resolvers/basic';
-  import { translation } from '@sjsf/form/translations/en';
-  import { theme } from '@sjsf/basic-theme';
+  import { createForm, BasicForm, type Schema } from "@sjsf/form";
+  import { resolver } from "@sjsf/form/resolvers/basic";
+  import { translation } from "@sjsf/form/translations/en";
+  import { theme } from "@sjsf/basic-theme";
   import { createFormValidator } from "@sjsf/ajv8-validator";
 
   const validator = createFormValidator();
 
   const schema: Schema = {
-    title: 'Tasks',
-    type: 'array',
+    title: "Tasks",
+    type: "array",
     items: {
-      type: 'object',
+      type: "object",
       properties: {
         name: {
-          type: 'string',
-          title: 'Name',
+          type: "string",
+          title: "Name",
         },
         description: {
-          type: 'string',
-          title: 'Description',
+          type: "string",
+          title: "Description",
         },
       },
-      required: ["name"]
+      required: ["name"],
     },
-  }
+  };
 
   const form = createForm({
     theme,
     schema,
-    resolver
+    resolver,
     validator,
     translation,
-    onSubmit: console.log
-  })
+    onSubmit: console.log,
+  });
 </script>
 
 <BasicForm {form} />

packages/form/eslint.config.mjs

@@ -0,0 +1,65 @@
+// @ts-check
+import { fileURLToPath } from "node:url";
+import { defineConfig } from "eslint/config";
+import { includeIgnoreFile } from "@eslint/compat";
+import js from "@eslint/js";
+import ts from "typescript-eslint";
+import svelte from "eslint-plugin-svelte";
+import prettier from "eslint-config-prettier";
+import globals from "globals";
+
+import svelteConfig from "./svelte.config.js";
+
+const gitignorePath = fileURLToPath(
+  new URL("../../.gitignore", import.meta.url)
+);
+
+export default defineConfig(
+  includeIgnoreFile(gitignorePath),
+  js.configs.recommended,
+  ts.configs.recommendedTypeChecked,
+  ...svelte.configs.recommended,
+  prettier,
+  ...svelte.configs.prettier,
+  {
+    languageOptions: {
+      globals: { ...globals.browser, ...globals.node },
+    },
+    rules: { "no-undef": "off" },
+  },
+  {
+    languageOptions: {
+      parserOptions: {
+        tsconfigRootDir: import.meta.dirname,
+        projectService: {
+          allowDefaultProject: ["*.ts", "*.js", "*.mjs"],
+        },
+        extraFileExtensions: [".svelte"],
+        parser: ts.parser,
+        svelteConfig,
+      },
+    },
+  },
+  {
+    rules: {
+      "require-yield": "off",
+      "@typescript-eslint/no-empty-object-type": "off",
+      "@typescript-eslint/no-explicit-any": "off",
+      "svelte/prefer-svelte-reactivity": "off",
+      "@typescript-eslint/no-deprecated": "warn",
+      "@typescript-eslint/no-unused-expressions": "warn",
+      "@typescript-eslint/no-unused-vars": [
+        "error",
+        {
+          args: "all",
+          argsIgnorePattern: "^_",
+          caughtErrors: "all",
+          caughtErrorsIgnorePattern: "^_",
+          destructuredArrayIgnorePattern: "^_",
+          varsIgnorePattern: "^_",
+          ignoreRestSiblings: true,
+        },
+      ],
+    },
+  }
+);

packages/form/package.json

@@ -31,12 +31,14 @@
     "test": "vitest run --typecheck --exclude '.svelte-kit/**'",
     "bench": "vitest bench --exclude '.svelte-kit/**'",
     "build": "svelte-package && publint",
-    "check": "svelte-check --tsconfig ./tsconfig.json"
+    "check": "svelte-check --tsconfig ./tsconfig.json",
+    "format": "prettier --write .",
+    "lint": "prettier --check . && eslint ."
   },
   "dependencies": {
+    "@standard-schema/spec": "^1.0.0",
     "@types/json-schema": "^7.0.15",
     "@types/json-schema-merge-allof": "^0.6.5",
-    "@standard-schema/spec": "^1.0.0",
     "json-schema-merge-allof": "^0.8.1",
     "jsonpointer": "^5.0.1"
   },
@@ -49,6 +51,7 @@
     "ajv": "catalog:",
     "allof-merge": "^0.6.7",
     "deep-freeze-es6": "^4.0.1",
+    "globals": "catalog:",
     "json-schema-compare": "^0.2.2",
     "svelte": "catalog:"
   },
@@ -145,4 +148,4 @@
       "default": "./dist/static-analysis.js"
     }
   }
-}
+}

packages/form/src/core/constant-schema.ts

@@ -12,13 +12,13 @@ export function isSchemaOfConstantValue(schema: Schema): boolean {
 }
 
 export function getSchemaConstantValue(schema: Schema) {
-  const enumValues = schema.enum
+  const enumValues = schema.enum;
   if (Array.isArray(enumValues) && enumValues.length === 1) {
     return enumValues[0]!;
   }
-  const constant = schema.const
+  const constant = schema.const;
   if (constant !== undefined) {
-    return constant
+    return constant;
   }
-  throw new Error('schema cannot be inferred as a constant');
+  throw new Error("schema cannot be inferred as a constant");
 }

packages/form/src/core/deep-equal.ts

@@ -38,7 +38,7 @@ export function isSchemaValueDeepEqual(
     }
     return Object.keys(b).length === aKeys.length;
   }
-  return a !== a && b !== b
+  return a !== a && b !== b;
 }
 
 export const isSchemaDeepEqual = isSchemaValueDeepEqual as (

packages/form/src/core/default-state.test.ts

@@ -1,3 +1,5 @@
+/* eslint-disable @typescript-eslint/no-unsafe-member-access */
+/* eslint-disable @typescript-eslint/no-unsafe-assignment */
 // This file was copied and modified from https://github.com/rjsf-team/react-jsonschema-form/blob/b12175679079be956570349771dddd65406b3773/packages/utils/test/schema/getDefaultFormStateTest.ts
 // Licensed under the Apache License, Version 2.0.
 // Modifications made by Roman Krasilnikov.
@@ -1089,7 +1091,8 @@ describe("getDefaultFormState2()", () => {
                 emptyObjectFields: "populateAllDefaults",
                 allOf: "skipDefaults",
                 arrayMinItems: {
-                  populate: "populate" as any,
+                  // CHANGED: I don't know why this line is here.
+                  // populate: "all" as any,
                   mergeExtraDefaults: false,
                 },
                 mergeDefaultsIntoFormData: "useFormDataIfPresent",
@@ -6343,8 +6346,8 @@ describe("getDefaultFormState2()", () => {
       expect(Array.isArray(result.config.items)).toBe(true);
 
       // Verify objects are independent instances - modifying one shouldn't affect the other
-      (result.config.items[0] as any).field = "test-value-1";
-      expect((result.config.items[1] as any).field).toBeUndefined();
+      result.config.items[0].field = "test-value-1";
+      expect(result.config.items[1].field).toBeUndefined();
       expect(result.config.items[0]).not.toBe(result.config.items[1]);
     });
 
@@ -6361,8 +6364,8 @@ describe("getDefaultFormState2()", () => {
       expect(Array.isArray(result.config.items)).toBe(true);
 
       // Verify objects are independent instances - modifying one shouldn't affect the other
-      (result.config.items[0] as any).field = "test-value-1";
-      expect((result.config.items[1] as any).field).toBeUndefined();
+      result.config.items[0].field = "test-value-1";
+      expect(result.config.items[1].field).toBeUndefined();
       expect(result.config.items[0]).not.toBe(result.config.items[1]);
     });
 
@@ -6398,9 +6401,9 @@ describe("getDefaultFormState2()", () => {
       expect(Array.isArray(result)).toBe(true);
 
       // Verify objects are independent instances
-      (result[0] as any).field = "test-value-1";
-      (result[1] as any).field = "test-value-2";
-      expect((result[2] as any).field).toBeUndefined();
+      result[0].field = "test-value-1";
+      result[1].field = "test-value-2";
+      expect(result[2].field).toBeUndefined();
       expect(result[0]).not.toBe(result[1]);
       expect(result[1]).not.toBe(result[2]);
       expect(result[0]).not.toBe(result[2]);
@@ -6442,8 +6445,8 @@ describe("getDefaultFormState2()", () => {
       expect(Array.isArray(result)).toBe(true);
 
       // Verify objects are independent instances - modifying one shouldn't affect the other
-      (result[0] as any).field = "modified-value";
-      expect((result[1] as any).field).toBe("default-value");
+      result[0].field = "modified-value";
+      expect(result[1].field).toBe("default-value");
       expect(result[0]).not.toBe(result[1]);
     });
 
@@ -6488,10 +6491,10 @@ describe("getDefaultFormState2()", () => {
       expect(Array.isArray(result)).toBe(true);
 
       // Verify nested objects are independent instances
-      (result[0] as any).nested.value = "modified-nested-value";
-      expect((result[1] as any).nested.value).toBe("nested-default");
+      result[0].nested.value = "modified-nested-value";
+      expect(result[1].nested.value).toBe("nested-default");
       expect(result[0]).not.toBe(result[1]);
-      expect((result[0] as any).nested).not.toBe((result[1] as any).nested);
+      expect(result[0].nested).not.toBe(result[1].nested);
     });
   });
 });

packages/form/src/core/default-state.ts

@@ -3,7 +3,7 @@
 // Modifications made by Roman Krasilnikov.
 
 import { isRecordEmpty, isObject } from "@/lib/object.js";
-import { isSchemaObject } from '@/lib/json-schema/index.js'
+import { isSchemaObject } from "@/lib/json-schema/index.js";
 
 import { resolveDependencies, retrieveSchema } from "./resolve.js";
 import {
@@ -51,9 +51,11 @@ export function getDefaultValueForType(type: SchemaType) {
       return "";
     case "null":
       return null;
-    default:
+    default: {
       const n: never = type;
+      // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
       throw new Error(`Unsupported schema type: ${n}`);
+    }
   }
 }