Merge pull request #2 from code4rena-dev/nlf/update-eslint-config

fix: sync eslint config with api v0

Author: nlf

.eslintrc.js

@@ -16,15 +16,65 @@ module.exports = {
     "plugin:@typescript-eslint/strict",
   ],
   rules: {
-    semi: "off", // have to disable eslint's core semicolon rules before enabling typescript-eslint's
+    // require semi-colons via @typescript-eslint
+    semi: "off",
     "@typescript-eslint/semi": "error",
     "@typescript-eslint/member-delimiter-style": "error",
-    quotes: ["error", "double", { "avoidEscape": true }],
+
+    // 2 space indentation, allow anything for switch statements and template strings
+    indent: "off", // disable eslint's core indent rule
+    "@typescript-eslint/indent": ["error", 2, {
+      SwitchCase: 1,
+      ignoredNodes: ["TemplateLiteral"],
+    }],
+
+    // allow multiple spaces for comments after a line, property values, and variable declarations
+    // these are here to allow for aligning blocks
+    "no-multi-spaces": ["error", {
+      ignoreEOLComments: true,
+      exceptions: {
+        Property: true,
+        VariableDeclarator: true,
+      },
+    }],
+
+    // don't allow trailing spaces
+    "no-trailing-spaces": "error",
+
+    // only allow whitespace before property access when chaining on new lines
+    "no-whitespace-before-property": "error",
+
+    // require that dots for property access are on the same line as the property
+    "dot-location": ["error", "property"],
+
+    // require no spaces around parens in function calls
+    "func-call-spacing": "off",
+    "@typescript-eslint/func-call-spacing": ["error", "never"],
+
+    // require double quotes, but avoid escaping
+    quotes: "off",
+    "@typescript-eslint/quotes": ["error", "double", {
+      avoidEscape: true,
+      allowTemplateLiterals: true,
+    }],
+
+    // IIFE wrap -> (function foo() {})()
+    "wrap-iife": ["error", "inside"],
+
+    // don't allow spaces before commas, require at least one after
+    "comma-spacing": "off",
+    "@typescript-eslint/comma-spacing": "error",
+
+    // require at least one space before and after keywords
+    "keyword-spacing": "off",
+    "@typescript-eslint/keyword-spacing": "error",
   },
   ignorePatterns,
   overrides: [{
     files: ["test/**/*"],
     rules: {
+      // non-null assertions can be useful in tests where we've already asserted something
+      // exists before attempting to assert its value
       "@typescript-eslint/no-non-null-assertion": "off",
     },
   }],

lib/content/eslintrc.js

@@ -16,15 +16,65 @@ module.exports = {
     "plugin:@typescript-eslint/strict",
   ],
   rules: {
-    semi: "off", // have to disable eslint's core semicolon rules before enabling typescript-eslint's
+    // require semi-colons via @typescript-eslint
+    semi: "off",
     "@typescript-eslint/semi": "error",
     "@typescript-eslint/member-delimiter-style": "error",
-    quotes: ["error", "double", { "avoidEscape": true }],
+
+    // 2 space indentation, allow anything for switch statements and template strings
+    indent: "off", // disable eslint's core indent rule
+    "@typescript-eslint/indent": ["error", 2, {
+      SwitchCase: 1,
+      ignoredNodes: ["TemplateLiteral"],
+    }],
+
+    // allow multiple spaces for comments after a line, property values, and variable declarations
+    // these are here to allow for aligning blocks
+    "no-multi-spaces": ["error", {
+      ignoreEOLComments: true,
+      exceptions: {
+        Property: true,
+        VariableDeclarator: true,
+      },
+    }],
+
+    // don't allow trailing spaces
+    "no-trailing-spaces": "error",
+
+    // only allow whitespace before property access when chaining on new lines
+    "no-whitespace-before-property": "error",
+
+    // require that dots for property access are on the same line as the property
+    "dot-location": ["error", "property"],
+
+    // require no spaces around parens in function calls
+    "func-call-spacing": "off",
+    "@typescript-eslint/func-call-spacing": ["error", "never"],
+
+    // require double quotes, but avoid escaping
+    quotes: "off",
+    "@typescript-eslint/quotes": ["error", "double", {
+      avoidEscape: true,
+      allowTemplateLiterals: true,
+    }],
+
+    // IIFE wrap -> (function foo() {})()
+    "wrap-iife": ["error", "inside"],
+
+    // don't allow spaces before commas, require at least one after
+    "comma-spacing": "off",
+    "@typescript-eslint/comma-spacing": "error",
+
+    // require at least one space before and after keywords
+    "keyword-spacing": "off",
+    "@typescript-eslint/keyword-spacing": "error",
   },
   ignorePatterns,
   overrides: [{
     files: ["test/**/*"],
     rules: {
+      // non-null assertions can be useful in tests where we've already asserted something
+      // exists before attempting to assert its value
       "@typescript-eslint/no-non-null-assertion": "off",
     },
   }],

lib/index.ts

@@ -2,7 +2,7 @@ import { dirname, join } from "node:path";
 import { readFileSync } from "node:fs";
 import { readFile, rm } from "node:fs/promises";
 import { copy, json, pkg, type Skeleton } from "code-skeleton";
- 
+
 const ownPkg = JSON.parse(
   readFileSync(join(dirname(__dirname), "package.json"), { encoding: "utf8" })
 ) as { name: string; version: string };