Merge pull request #739 from streamich/formatting

Formatting

.github/workflows/pr.yml

@@ -38,7 +38,7 @@ jobs:
       - run: yarn install --frozen-lockfile
       - run: yarn build:all
       - run: yarn lint
-      - run: yarn prettier:check
+      - run: yarn format
       - run: yarn test:cli:pointer
       - run: yarn test:cli:patch
       - run: yarn test:cli:pack

.github/workflows/release.yml

@@ -19,7 +19,7 @@ jobs:
           node-version: ${{ matrix.node-version }}
           cache: yarn
       - run: yarn install --frozen-lockfile
-      - run: yarn prettier:check
+      - run: yarn format
       - run: yarn lint
       - run: yarn test:ci --ci
       - run: yarn build:all

biome.json

@@ -0,0 +1,43 @@
+{
+	"$schema": "https://biomejs.dev/schemas/1.9.3/schema.json",
+	"organizeImports": {
+		"enabled": true
+	},
+	"formatter": {
+		"indentStyle": "space",
+		"lineWidth": 120
+	},
+	"javascript": {
+		"formatter": {
+			"quoteStyle": "single",
+			"trailingCommas": "all",
+			"bracketSpacing": false
+		}
+	},
+	"linter": {
+		"enabled": true,
+		"rules": {
+			"recommended": true,
+			"style": {
+				"noNonNullAssertion": "off",
+				"useNodejsImportProtocol": "off",
+				"useTemplate": "off",
+				"noInferrableTypes": "off",
+				"noUselessElse": "off",
+				"noParameterAssign": "off",
+				"noCommaOperator": "off",
+				"useSingleVarDeclarator": "off",
+				"useLiteralEnumMembers": "off"
+			},
+			"suspicious": {
+				"noExplicitAny": "off",
+				"useIsArray": "off",
+				"noAssignInExpressions": "off"
+			},
+			"complexity": {
+				"noStaticOnlyClass": "off",
+				"useOptionalChain": "off"
+			}
+		}
+	}
+}

package.json

@@ -76,11 +76,10 @@
     "lib/"
   ],
   "scripts": {
-    "prettier": "npx [email protected] --write .",
-    "prettier:check": "npx [email protected] --check .",
-    "lint": "yarn tslint",
-    "lint:fix": "yarn tslint --fix",
-    "tslint": "tslint 'src/**/*.{js,jsx,ts,tsx}' -t verbose --project .",
+    "format": "biome format ./src",
+    "format:fix": "biome format --write ./src",
+    "lint": "biome lint ./src",
+    "lint:fix": "biome lint --apply ./src",
     "clean": "npx [email protected] lib es6 es2019 es2020 esm typedocs coverage gh-pages yarn-error.log src/**/__bench__/node_modules src/**/__bench__/yarn-error.log",
     "build:es2020": "tsc --project tsconfig.build.json --module commonjs --target es2020 --outDir lib",
     "build:all": "npx [email protected] \"yarn build:es2020\"",
@@ -137,6 +136,7 @@
     "tree-dump": "^1.0.2"
   },
   "devDependencies": {
+    "@biomejs/biome": "^1.9.4",
     "@types/benchmark": "^2.1.5",
     "@types/jest": "^29.5.12",
     "@types/react": "^18.3.11",
@@ -179,16 +179,6 @@
     ],
     "testRegex": ".*/(__tests__|__jest__|demo)/.*\\.(test|spec)\\.ts$"
   },
-  "prettier": {
-    "arrowParens": "always",
-    "printWidth": 120,
-    "tabWidth": 2,
-    "useTabs": false,
-    "semi": true,
-    "singleQuote": true,
-    "trailingComma": "all",
-    "bracketSpacing": false
-  },
   "config": {
     "commitizen": {
       "changelog": {

src/__bench__/data/json-object-many-keys.js

@@ -11,7 +11,6 @@ module.exports = {
   '-6666666': -6666666,
   62343423432: 62343423432,
   0.123: 0.123,
-  '0.0': 0.0,
   '-123.3434343': -123.3434343,
   127: 127,
   128: 128,
@@ -21,8 +20,6 @@ module.exports = {
   257: 257,
   258: 258,
   1000: 1000,
-  1000: 1000,
-  1000: 1000,
   '-222222': -222222,
   '-22222': -22222,
   a: 'a',

src/__bench__/data/text-editing-traces/collect-trace.js

@@ -1,7 +1,7 @@
 const fs = require('fs');
 const zlib = require('zlib');
 
-const filename = `/Users/mini/vscodelogs/actions_14_05_2023_olcXlNJx.json`;
+const filename = '/Users/mini/vscodelogs/actions_14_05_2023_olcXlNJx.json';
 const targetDocFileName = '/Users/mini/dev/json-joy-blog/blog-post-1.md';
 const data = fs.readFileSync(filename, 'utf8');
 const lines = data.split('\n');

src/__bench__/payloads.ts

@@ -44,7 +44,10 @@ export const payloads = [
 export const payloadsWithCombined = [
   ...(payloads.length > 1
     ? (() => {
-        const combined = payloads.reduce((acc, payload) => [...acc, payload.data], [] as unknown[]);
+        const combined = payloads.reduce((acc, payload) => {
+          acc.push(payload.data);
+          return acc;
+        }, [] as unknown[]);
         return [
           {
             data: combined,

src/__tests__/util.ts

@@ -4,5 +4,8 @@ export const until = async (check: () => boolean, pollInterval: number = 1) => {
   do {
     if (check()) return;
     await tick(pollInterval);
-  } while (true);
+  } while (
+    // biome-ignore lint: constant condition is intentional
+    true
+  );
 };

src/json-cli/json-pack-test.ts

@@ -3,12 +3,12 @@
 import {spawnSync} from 'child_process';
 import {
   testSuites,
-  TestCaseNil,
-  TestCaseBool,
-  TestCaseString,
-  TestCaseNumber,
-  TestCaseArray,
-  TestCaseMap,
+  type TestCaseNil,
+  type TestCaseBool,
+  type TestCaseString,
+  type TestCaseNumber,
+  type TestCaseArray,
+  type TestCaseMap,
 } from './test/msgpack-test-suite';
 
 const bin = String(process.argv[2]);
@@ -19,7 +19,7 @@ if (!bin) {
 }
 
 console.log('');
-console.log(`Running json-pack tests.`);
+console.log('Running json-pack tests.');
 console.log('');
 
 let cntCorrect = 0;
@@ -54,11 +54,11 @@ for (const name in testSuites) {
     const result = new Uint8Array(stdout.length);
     for (let i = 0; i < result.length; i++) result[i] = stdout[i];
     EXPECTED: for (const exp of testCase.msgpack) {
-      const expected = new Uint8Array(exp.split('-').map((a) => parseInt(a, 16)));
+      const expected = new Uint8Array(exp.split('-').map((a) => Number.parseInt(a, 16)));
       if (expected.length !== result.length) continue;
       for (let i = 0; i < expected.length; i++) if (expected[i] !== result[i]) continue EXPECTED;
       isCorrect = true;
-      break EXPECTED;
+      break;
     }
     if (isCorrect) {
       cntCorrect++;

src/json-cli/json-patch-test.ts

@@ -15,18 +15,18 @@ if (!bin) {
 let cntCorrect = 0;
 let cntFailed = 0;
 
-testSuites.forEach((suite) => {
+for (const suite of testSuites) {
   console.log('');
   console.log(suite.name);
   console.log('');
 
-  suite.tests.forEach((test: any) => {
-    if (test.disabled) return;
+  for (const test of suite.tests) {
+    if (test.disabled) break;
     const testName = test.comment || test.error || JSON.stringify(test.patch);
     if (test.expected !== undefined) {
-      test.patch.forEach(validateOperation);
+      test.patch.forEach(validateOperation as any);
       let isCorrect = false;
-      let result;
+      let result: unknown;
       try {
         const input = JSON.stringify(test.doc);
         const {stdout} = spawnSync(bin, [JSON.stringify(test.patch)], {input});
@@ -69,8 +69,8 @@ testSuites.forEach((suite) => {
     }
 
     if (cntFailed) process.exit(1);
-  });
-});
+  }
+}
 
 console.log('');
 console.log(`Successful = ${cntCorrect}, Failed = ${cntFailed}, Total = ${cntCorrect + cntFailed}`);

src/json-cli/json-pointer-test.ts

@@ -12,7 +12,7 @@ if (!bin) {
 }
 
 console.log('');
-console.log(`Running JSON Pointer tests.`);
+console.log('Running JSON Pointer tests.');
 console.log('');
 
 let cntCorrect = 0;

src/json-cli/test/op.add.tests.json.ts

@@ -1,4 +1,4 @@
-import {TestCase} from './types';
+import type {TestCase} from './types';
 
 const testCases: TestCase[] = [
   {

src/json-cli/test/op.contains.tests.json.ts

@@ -1,4 +1,4 @@
-import {TestCase} from './types';
+import type {TestCase} from './types';
 
 const testCases: TestCase[] = [
   {

src/json-cli/test/op.copy.tests.json.ts

@@ -1,4 +1,4 @@
-import {TestCase} from './types';
+import type {TestCase} from './types';
 
 const testCases: TestCase[] = [
   {

src/json-cli/test/op.defined.tests.json.ts

@@ -1,4 +1,4 @@
-import {TestCase} from './types';
+import type {TestCase} from './types';
 
 const testCases: TestCase[] = [
   {

src/json-cli/test/op.ends.tests.json.ts

@@ -1,4 +1,4 @@
-import {TestCase} from './types';
+import type {TestCase} from './types';
 
 const testCases: TestCase[] = [
   {

src/json-cli/test/op.extend.tests.json.ts

@@ -1,4 +1,4 @@
-import {TestCase} from './types';
+import type {TestCase} from './types';
 
 const testCases: TestCase[] = [
   {

src/json-cli/test/op.flip.tests.json.ts

@@ -1,4 +1,4 @@
-import {TestCase} from './types';
+import type {TestCase} from './types';
 
 const testCases: TestCase[] = [
   {

src/json-cli/test/op.in.tests.json.ts

@@ -1,4 +1,4 @@
-import {TestCase} from './types';
+import type {TestCase} from './types';
 
 const testCases: TestCase[] = [
   {

src/json-cli/test/op.inc.tests.json.ts

@@ -1,4 +1,4 @@
-import {TestCase} from './types';
+import type {TestCase} from './types';
 
 const testCases: TestCase[] = [
   {

src/json-cli/test/op.less.tests.json.ts

@@ -1,4 +1,4 @@
-import {TestCase} from './types';
+import type {TestCase} from './types';
 
 const testCases: TestCase[] = [
   {

src/json-cli/test/op.merge.tests.json.ts

@@ -1,4 +1,4 @@
-import {TestCase} from './types';
+import type {TestCase} from './types';
 
 const testCases: TestCase[] = [
   {

src/json-cli/test/op.more.tests.json.ts

@@ -1,4 +1,4 @@
-import {TestCase} from './types';
+import type {TestCase} from './types';
 
 const testCases: TestCase[] = [
   {

src/json-cli/test/op.move.tests.json.ts

@@ -1,4 +1,4 @@
-import {TestCase} from './types';
+import type {TestCase} from './types';
 
 const testCases: TestCase[] = [
   {

src/json-cli/test/op.remove.tests.json.ts

@@ -1,4 +1,4 @@
-import {TestCase} from './types';
+import type {TestCase} from './types';
 
 const testCases: TestCase[] = [
   {

src/json-cli/test/op.replace.tests.json.ts

@@ -1,5 +1,5 @@
 import {clone as deepClone} from '@jsonjoy.com/util/lib/json-clone/clone';
-import {TestCase} from './types';
+import type {TestCase} from './types';
 
 const values: [string, unknown][] = [
   ['"null"', null],

src/json-cli/test/op.split.tests.json.ts

@@ -1,4 +1,4 @@
-import {TestCase} from './types';
+import type {TestCase} from './types';
 
 const testCases: TestCase[] = [
   {

src/json-cli/test/op.starts.tests.json.ts

@@ -1,4 +1,4 @@
-import {TestCase} from './types';
+import type {TestCase} from './types';
 
 const testCases: TestCase[] = [
   {

src/json-cli/test/op.str_del.tests.json.ts

@@ -1,4 +1,4 @@
-import {TestCase} from './types';
+import type {TestCase} from './types';
 
 const testCases: TestCase[] = [
   {

src/json-cli/test/op.str_ins.tests.json.ts

@@ -1,4 +1,4 @@
-import {TestCase} from './types';
+import type {TestCase} from './types';
 
 const testCases: TestCase[] = [
   {

src/json-cli/test/op.test.tests.json.ts

@@ -1,4 +1,4 @@
-import {TestCase} from './types';
+import type {TestCase} from './types';
 
 const testCases: TestCase[] = [
   {

src/json-cli/test/op.type.tests.json.ts

@@ -1,4 +1,4 @@
-import {TestCase} from './types';
+import type {TestCase} from './types';
 
 const testCases: TestCase[] = [
   {

src/json-cli/test/op.undefined.tests.json.ts

@@ -1,4 +1,4 @@
-import {TestCase} from './types';
+import type {TestCase} from './types';
 
 const testCases: TestCase[] = [
   {

src/json-cli/test/spec.json.ts

@@ -1,4 +1,4 @@
-import {TestCase} from './types';
+import type {TestCase} from './types';
 
 const testCases: TestCase[] = [
   {
@@ -168,7 +168,7 @@ const testCases: TestCase[] = [
     },
     patch: [
       // @ts-ignore
-      {op: 'add', path: '/baz', value: 'qux', op: 'remove'},
+      {path: '/baz', value: 'qux', op: 'remove'},
     ],
     error: "operation has two 'op' members",
     disabled: true,

src/json-cli/test/suites.ts

@@ -22,7 +22,7 @@ import op_starts_tests_json from './op.starts.tests.json';
 import op_type_tests_json from './op.type.tests.json';
 import op_undefined_tests_json from './op.undefined.tests.json';
 import spec_json from './spec.json';
-import {TestSuite} from './types';
+import type {TestSuite} from './types';
 
 export const testSuites: TestSuite[] = [
   // JSON Patch

src/json-cli/test/tests.json.ts

@@ -1,4 +1,4 @@
-import {TestCase} from './types';
+import type {TestCase} from './types';
 
 const testCases: TestCase[] = [
   {