📐 formatting rules (#153)

* :rule: formatting rules

* ⛏️ infix ops

* lockfiles are dumb >_<

---------

Co-authored-by: Alex Ruddick <[email protected]>

.eslintrc.js

@@ -1,6 +1,6 @@
 module.exports = {
   parser: '@typescript-eslint/parser',
-  plugins: ['@typescript-eslint'],
+  plugins: ['@typescript-eslint', '@stylistic/eslint-plugin'],
   extends: [
     'eslint:recommended',
     'plugin:react/recommended',
@@ -22,6 +22,11 @@ module.exports = {
       argsIgnorePattern: "^_",
       varsIgnorePattern: "^_",
     }],
+    '@stylistic/indent': ['error', 2],
+    "@stylistic/space-infix-ops": 1,
+    '@stylistic/object-curly-spacing': ['error', 'always'],
+    // "semi": [1, "always"],
+    // "consistent-return": 2,
   },
   settings: {
     react: {

package.json

@@ -20,7 +20,7 @@
   },
   "scripts": {
     "prebuild": "npm run lint",
-    "lint": "eslint --cache --ext .ts,.tsx src",
+    "lint": "eslint --cache --ext .ts,.tsx src && eslint --format stylish --fix src",
     "build": "npm run build:server && npm run build:ui",
     "build:server": "tsc",
     "build:ui": "node --experimental-modules build.mjs",
@@ -36,6 +36,7 @@
     "@craftamap/esbuild-plugin-html": "^0.7.0 || ^0.8.0",
     "@rehooks/component-size": "^1.0.2",
     "@serialport/bindings-cpp": "^12.0.0 || ^13.0.0",
+    "@stylistic/eslint-plugin": "^2.10.1",
     "@types/cors": "^2.8.4",
     "@types/express": "^4.17.9",
     "@types/jest": "^29.0.0",

src/background-planner.ts

@@ -1,7 +1,7 @@
 import { replan } from './massager';
 
 self.addEventListener("message", (m) => {
-  const {paths, planOptions} = m.data;
+  const { paths, planOptions } = m.data;
   const plan = replan(paths, planOptions);
   console.time("serializing");
   const serialized = plan.serialize();

src/cli.ts

@@ -1,9 +1,9 @@
 import yargs from "yargs";
-import {connectEBB, startServer} from "./server";
-import {replan} from "./massager";
-import {Window} from "svgdom";
+import { connectEBB, startServer } from "./server";
+import { replan } from "./massager";
+import { Window } from "svgdom";
 import * as fs from "node:fs";
-import {flattenSVG} from "flatten-svg";
+import { flattenSVG } from "flatten-svg";
 import type { Vec2 } from "./vec";
 import { formatDuration } from "./util";
 import { Device, type PlanOptions, defaultPlanOptions } from "./planning";
@@ -45,7 +45,7 @@ export function cli(argv: string[]): void {
             } else {
               const m = /^([0-9]*(?:\.[0-9]+)?)\s*x\s*([0-9]*(?:\.[0-9]+)?)\s*(cm|mm|in)$/i.exec(String(value).trim())
               if (m) {
-                return new PaperSize({x: Number(m[1]), y: Number(m[2])})
+                return new PaperSize({ x: Number(m[1]), y: Number(m[2]) })
               }
             }
             throw new Error(`Paper size should be a standard size (${Object.keys(PaperSize.standard).join(", ")}) or a custom size such as "100x100mm" or "16x10in"`)
@@ -219,7 +219,7 @@ export function cli(argv: string[]): void {
       }
     )
     .command('pen [percent]', 'put the pen to [percent]', yargs => yargs
-      .positional('percent', { type: 'number', description: 'percent height between 0 and 100', required: true})
+      .positional('percent', { type: 'number', description: 'percent height between 0 and 100', required: true })
       .check(args => args.percent >= 0 && args.percent <= 100),
     async args => {
       console.log('connecting to plotter...')
@@ -260,7 +260,7 @@ export function cli(argv: string[]): void {
 
 function linesToVecs(lines: any[]): Vec2[][] {
   return lines.map((line) => {
-    const a = line.points.map(([x, y]: [number, number]) => ({x, y}));
+    const a = line.points.map(([x, y]: [number, number]) => ({ x, y }));
     (a as any).stroke = line.stroke;
     (a as any).groupId = line.groupId;
     return a;

src/ebb.ts

@@ -1,6 +1,6 @@
-import {type Block, type Motion, PenMotion, type Plan, XYMotion} from "./planning";
+import { type Block, type Motion, PenMotion, type Plan, XYMotion } from "./planning";
 import { RegexParser } from "./regex-transform-stream";
-import {type Vec2, vsub} from "./vec";
+import { type Vec2, vsub } from "./vec";
 
 /** Split d into its fractional and integral parts */
 function modf(d: number): [number, number] {
@@ -21,7 +21,7 @@ export class EBB {
   private microsteppingMode = 0;
 
   /** Accumulated XY error, used to correct for movements with sub-step resolution */
-  private error: Vec2 = {x: 0, y: 0};
+  private error: Vec2 = { x: 0, y: 0 };
 
   private cachedFirmwareVersion: [number, number, number] | undefined = undefined;
 

src/massager.ts

@@ -1,7 +1,7 @@
 import * as Optimization from "optimize-paths";
-import {Device, type Plan, type PlanOptions, plan} from "./planning";
-import {dedupPoints, scaleToPaper, cropToMargins} from "./util";
-import {type Vec2, vmul, vrot} from "./vec";
+import { Device, type Plan, type PlanOptions, plan } from "./planning";
+import { dedupPoints, scaleToPaper, cropToMargins } from "./util";
+import { type Vec2, vmul, vrot } from "./vec";
 
 // CSS, and thus SVG, defines 1px = 1/96th of 1in
 // https://www.w3.org/TR/css-values-4/#absolute-lengths
@@ -19,7 +19,7 @@ export function replan(inPaths: Vec2[][], planOptions: PlanOptions): Plan {
   if (planOptions.rotateDrawing !== 0) {
     console.time("rotating paths");
     paths = paths.map((pl) => pl.map((p) => vrot(p,
-      vmul({x:planOptions.paperSize.size.x/2, y: planOptions.paperSize.size.y/2}, 1/mmPerSvgUnit),
+      vmul({ x:planOptions.paperSize.size.x / 2, y: planOptions.paperSize.size.y / 2 }, 1 / mmPerSvgUnit),
       planOptions.rotateDrawing)
     ));
     console.timeEnd("rotating paths");