fix: remove eslint-plugin-prettier

ojeytonwilliams · ojeytonwilliams · commit 75be87d40ac3 · 2025-01-31T12:12:31.000+01:00
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -1,16 +1,15 @@
 {
   "extends": [
     "xo",
-    "prettier",
     "eslint:recommended",
-    "plugin:@typescript-eslint/recommended"
+    "plugin:@typescript-eslint/recommended",
+    "prettier"
   ],
   "env": {
     "jest": true,
     "node": true
   },
   "rules": {
-    "prettier/prettier": "error",
     "complexity": "off",
     "@typescript-eslint/no-namespace": "off",
     "no-warning-comments": "off",
@@ -25,6 +24,6 @@
       }
     ]
   },
-  "plugins": ["prettier", "@typescript-eslint"],
+  "plugins": ["@typescript-eslint"],
   "parser": "@typescript-eslint/parser"
 }
diff --git a/lib/__tests__/css-helper.test.ts b/lib/__tests__/css-helper.test.ts
@@ -28,7 +28,7 @@ describe("css-help", () => {
     });
     it("should return a whitespaceless string", () => {
       expect(t.getStyle(".bb1d")?.getPropVal("background", true)).toEqual(
-        "linear-gradient(var(--building-color1)50%,var(--window-color1))"
+        "linear-gradient(var(--building-color1)50%,var(--window-color1))",
       );
     });
   });
@@ -56,22 +56,22 @@ describe("css-help", () => {
   describe("getPropertyValue", () => {
     it("should return custom property value needing trim", () => {
       expect(
-        t.getStyle(":root")?.getPropertyValue("--building-color1")?.trim()
+        t.getStyle(":root")?.getPropertyValue("--building-color1")?.trim(),
       ).toEqual("#aa80ff");
     });
     it("should return value to existing property", () => {
       expect(
-        t.getStyle(".bb4a")?.getPropertyValue("background-color")
+        t.getStyle(".bb4a")?.getPropertyValue("background-color"),
       ).toBeTruthy();
     });
     it("should return property value without evaluating result", () => {
       expect(t.getStyle(".bb4a")?.getPropertyValue("background-color")).toEqual(
-        "var(--building-color4)"
+        "var(--building-color4)",
       );
     });
     it("should return value of pseudo class selector", () => {
       expect(
-        t.getStyle(".card:hover")?.getPropertyValue("background-color")
+        t.getStyle(".card:hover")?.getPropertyValue("background-color"),
       ).toEqual("khaki");
     });
   });
@@ -85,23 +85,23 @@ describe("css-help", () => {
       expect(
         t
           .getRuleListsWithinMedia("(max-width: 1000px)")
-          .find((x) => x.selectorText === ".sky")
+          .find((x) => x.selectorText === ".sky"),
       ).toBeTruthy();
     });
     it("should return CSSStyleDeclaration property with complex value", () => {
       // NOTE: JSDOM causes value to have tabbed characters, DOM has single-line values.
       expect(
         t
           .getRuleListsWithinMedia("(max-width: 1000px)")
-          .find((x) => x.selectorText === ".sky")?.style?.background
+          .find((x) => x.selectorText === ".sky")?.style?.background,
       ).toEqual(
         `radial-gradient(
       closest-corner circle at 15% 15%,
       #ffcf33,
       #ffcf33 20%,
       #ffff66 21%,
       #bbeeff 100%
-    )`
+    )`,
       );
     });
   });
diff --git a/lib/__tests__/curriculum-helper.test.tsx b/lib/__tests__/curriculum-helper.test.tsx
@@ -74,13 +74,13 @@ describe("removeWhiteSpace", () => {
   const { removeWhiteSpace } = helper;
   it("returns a string", () => {
     expect(typeof removeWhiteSpace("This should return a string")).toBe(
-      "string"
+      "string",
     );
   });
 
   it("returns a string with no white space characters", () => {
     expect(removeWhiteSpace(stringWithWhiteSpaceChars)).toBe(
-      stringWithWhiteSpaceCharsRemoved
+      stringWithWhiteSpaceCharsRemoved,
     );
   });
 });
@@ -89,13 +89,13 @@ describe("removeJSComments", () => {
   const { removeJSComments } = helper;
   it("returns a string", () => {
     expect(typeof removeJSComments('const should = "return a string"')).toBe(
-      "string"
+      "string",
     );
   });
 
   it("returns a string with no single or multi-line comments", () => {
     expect(removeJSComments(jsCodeWithSingleAndMultLineComments)).toBe(
-      jsCodeWithSingleAndMultLineCommentsRemoved
+      jsCodeWithSingleAndMultLineCommentsRemoved,
     );
   });
 
@@ -125,14 +125,14 @@ describe("removeHtmlComments", () => {
   it("returns a string", () => {
     expect(
       typeof removeHtmlComments(
-        "<h1>hello world</h1><!-- a comment--><h2>h2 element</h2>"
-      )
+        "<h1>hello world</h1><!-- a comment--><h2>h2 element</h2>",
+      ),
     ).toBe("string");
   });
 
   it("returns an HTML string with no single or multi-line comments", () => {
     expect(removeHtmlComments(htmlFullExample)).toBe(
-      htmlCodeWithCommentsRemoved
+      htmlCodeWithCommentsRemoved,
     );
   });
 });
@@ -199,7 +199,7 @@ describe("functionRegex", () => {
     const funcName = "myFunc";
     const regEx = functionRegex(funcName, ["arg1", "arg2"]);
     expect(regEx.test("function myFunc(arg1, arg2){\n console.log()\n}")).toBe(
-      true
+      true,
     );
   });
 
@@ -248,7 +248,7 @@ describe("functionRegex", () => {
     const funcName = "myFunc";
     const regEx = functionRegex(funcName, ["arg1", "arg2"]);
     expect(regEx.test("function \n\n myFunc \n ( arg1 , arg2 ) \n{ }")).toBe(
-      true
+      true,
     );
   });
 
@@ -258,7 +258,7 @@ describe("functionRegex", () => {
     const combinedRegEx = helper.concatRegex(/var x = 'y'; /, regEx);
 
     const match = "var x = 'y'; function myFunc(arg1, arg2){}".match(
-      combinedRegEx
+      combinedRegEx,
     );
     expect(match).not.toBeNull();
     expect(match![0]).toBe("var x = 'y'; function myFunc(arg1, arg2){}");
@@ -267,7 +267,7 @@ describe("functionRegex", () => {
     const nonCapturingRegEx = functionRegex(funcName, ["arg1", "arg2"]);
 
     const nonCapturingMatch = "function myFunc(arg1, arg2){}".match(
-      nonCapturingRegEx
+      nonCapturingRegEx,
     );
     expect(nonCapturingMatch).not.toBeNull();
     expect(nonCapturingMatch![1]).toBeUndefined();
@@ -288,13 +288,13 @@ describe("functionRegex", () => {
 
     const match =
       "myFunc = arg1 => arg1; console.log()\n // captured, unfortunately".match(
-        regEx
+        regEx,
       );
     expect(match).not.toBeNull();
     // It's a greedy match, since it doesn't know where the function ends.
     // This should be fine for most use cases.
     expect(match![1]).toBe(
-      "myFunc = arg1 => arg1; console.log()\n // captured, unfortunately"
+      "myFunc = arg1 => arg1; console.log()\n // captured, unfortunately",
     );
   });
 
@@ -337,7 +337,7 @@ describe("functionRegex", () => {
     const combinedRegEx = helper.concatRegex(/var x = 'y'; /, regEx);
 
     const match = "var x = 'y'; function myFunc(arg1, arg2){return true}".match(
-      combinedRegEx
+      combinedRegEx,
     );
     expect(match).not.toBeNull();
     expect(match![0]).toBe("var x = 'y'; function myFunc(arg1, arg2){");
@@ -354,7 +354,7 @@ describe("functionRegex", () => {
 
     const match =
       "var x = 'y'; let myFunc = (arg1, arg2) => {return true}".match(
-        combinedRegEx
+        combinedRegEx,
       );
     expect(match).not.toBeNull();
     expect(match![0]).toBe("var x = 'y'; let myFunc = (arg1, arg2) => {");
diff --git a/lib/__tests__/python.test.ts b/lib/__tests__/python.test.ts
@@ -175,7 +175,7 @@ for i in range(10):
   b = 3
   if b == 3:
     a = 4
-`
+`,
         );
       }
 
@@ -213,7 +213,7 @@ def vigenere(message, key):
       const commentless_code = python.removeComments(el);
       const { block_body } = python.getBlock(commentless_code, "else")!;
       expect(block_body).toEqual(
-        "\n            key_char = key[key_index % len(key)]"
+        "\n            key_char = key[key_index % len(key)]",
       );
     });
   });
diff --git a/lib/index.ts b/lib/index.ts
@@ -101,7 +101,7 @@ export function escapeRegExp(exp: string): string {
 
 export function isCalledWithNoArgs(
   calledFuncName: string,
-  callingCode: string
+  callingCode: string,
 ): boolean {
   const noCommentsCallingCode = strip(callingCode);
   const funcExp = `^\\s*?${escapeRegExp(calledFuncName)}\\(\\s*?\\)`;
@@ -132,7 +132,7 @@ export function concatRegex(...regexes: (string | RegExp)[]) {
 export function functionRegex(
   funcName: string | null,
   paramList?: string[] | null,
-  options?: { capture?: boolean; includeBody?: boolean }
+  options?: { capture?: boolean; includeBody?: boolean },
 ): RegExp {
   const capture = options?.capture ?? false;
   const includeBody = options?.includeBody ?? true;
@@ -167,24 +167,24 @@ interface ExtendedStyleDeclaration extends CSSStyleDeclaration {
 
 const getIsDeclaredAfter = (styleRule: CSSStyleRule) => (selector: string) => {
   const cssStyleRules = Array.from(
-    styleRule.parentStyleSheet?.cssRules || []
+    styleRule.parentStyleSheet?.cssRules || [],
   )?.filter((ele) => ele.type === CSSRule.STYLE_RULE) as CSSStyleRule[];
   const previousStyleRule = cssStyleRules.find(
-    (ele) => ele?.selectorText === selector
+    (ele) => ele?.selectorText === selector,
   );
   if (!previousStyleRule) return false;
   const currPosition = Array.from(
-    styleRule.parentStyleSheet?.cssRules || []
+    styleRule.parentStyleSheet?.cssRules || [],
   ).indexOf(styleRule);
   const prevPosition = Array.from(
-    previousStyleRule?.parentStyleSheet?.cssRules || []
+    previousStyleRule?.parentStyleSheet?.cssRules || [],
   ).indexOf(previousStyleRule);
   return currPosition > prevPosition;
 };
 
 export async function prepTestComponent(
   component: unknown,
-  props?: Record<string, unknown>
+  props?: Record<string, unknown>,
 ) {
   globalThis.IS_REACT_ACT_ENVIRONMENT = true;
   const testDiv = document.createElement("div");
@@ -204,7 +204,7 @@ export const python = {
   getDef(code: string, functionName: string) {
     const regex = new RegExp(
       `\\n?(?<function_indentation> *?)def +${functionName} *\\((?<function_parameters>[^\\)]*)\\)\\s*:\\s*?\\n?(?<function_body>.*?)(?=\\n\\k<function_indentation>[\\w#]|$)`,
-      "s"
+      "s",
     );
 
     const matchedCode = regex.exec(code);
@@ -218,7 +218,7 @@ export const python = {
 
       const functionIndentationSansNewLine = function_indentation.replace(
         /\n+/,
-        ""
+        "",
       );
       return {
         // Entire function definition without leading \n
@@ -251,7 +251,7 @@ export const python = {
 
     const regex = new RegExp(
       `\\n?(?<block_indentation> *?)(?<block_condition>${escapedBlockPattern})\\s*:\\s*?\\n(?<block_body>(\\k<block_indentation> +[^\\n]*| *\\n)+)(\n|$)`,
-      "sm"
+      "sm",
     );
 
     const matchedCode = regex.exec(code);
@@ -286,7 +286,7 @@ export class CSSHelp {
   private _getStyleRules() {
     const styleSheet = this.getStyleSheet();
     return this.styleSheetToCssRulesArray(styleSheet).filter(
-      (ele) => ele.type === CSSRule.STYLE_RULE
+      (ele) => ele.type === CSSRule.STYLE_RULE,
     ) as CSSStyleRule[];
   }
 
@@ -298,7 +298,7 @@ export class CSSHelp {
 
   getStyle(selector: string): ExtendedStyleDeclaration | null {
     const style = this._getStyleRules().find(
-      (ele) => ele?.selectorText === selector
+      (ele) => ele?.selectorText === selector,
     )?.style as ExtendedStyleDeclaration | undefined;
     if (!style) return null;
     style.getPropVal = (prop: string, strip = false) => {
@@ -325,7 +325,7 @@ export class CSSHelp {
 
   getStyleRule(selector: string): ExtendedStyleRule | null {
     const styleRule = this._getStyleRules()?.find(
-      (ele) => ele?.selectorText === selector
+      (ele) => ele?.selectorText === selector,
     );
     if (styleRule) {
       return {
@@ -357,7 +357,7 @@ export class CSSHelp {
 
   isPropertyUsed(property: string): boolean {
     return this._getStyleRules().some((ele) =>
-      ele.style?.getPropertyValue(property)
+      ele.style?.getPropertyValue(property),
     );
   }
 
@@ -371,17 +371,17 @@ export class CSSHelp {
   getStyleSheet(): CSSStyleSheet | null {
     // TODO: Change selector to match exactly 'styles.css'
     const link: HTMLLinkElement | null = this.doc?.querySelector(
-      "link[href*='styles']"
+      "link[href*='styles']",
     );
 
     // When using the styles.css tab, we add a 'fcc-injected-styles' class so we can target that. This allows users to add external scripts without them interfering
     const stylesDotCss: HTMLStyleElement | null = this.doc?.querySelector(
-      "style.fcc-injected-styles"
+      "style.fcc-injected-styles",
     );
 
     // For steps that use <style> tags, where they don't add the above class - most* browser extensions inject styles with class/media attributes, so it filters those
     const styleTag: HTMLStyleElement | null = this.doc?.querySelector(
-      "style:not([class]):not([media])"
+      "style:not([class]):not([media])",
     );
 
     if (link?.sheet?.cssRules?.length) {
@@ -400,7 +400,7 @@ export class CSSHelp {
   }
 
   styleSheetToCssRulesArray(
-    styleSheet: ReturnType<CSSHelp["getStyleSheet"]>
+    styleSheet: ReturnType<CSSHelp["getStyleSheet"]>,
   ): CSSRule[] {
     return Array.from(styleSheet?.cssRules || []);
   }
diff --git a/lib/parse.ts b/lib/parse.ts
@@ -31,7 +31,7 @@ export const parse = (input: string, options: Partial<options> = {}) => {
   let prev: Block | CodeNode | undefined;
 
   const source = [BLOCK_OPEN_REGEX, BLOCK_CLOSE_REGEX].filter<RegExp>(
-    (x): x is RegExp => typeof x !== "undefined"
+    (x): x is RegExp => typeof x !== "undefined",
   );
   let tripleQuotes = false;
 
@@ -50,7 +50,7 @@ export const parse = (input: string, options: Partial<options> = {}) => {
 
   const scan = (
     regex: RegExp,
-    type = "text"
+    type = "text",
   ):
     | { type: string; match: RegExpExecArray; value: string; newline?: string }
     | undefined => {
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
