style: lint code

Author: remarkablemark

.commitlintrc.json

@@ -0,0 +1,7 @@
+{
+  "extends": ["@commitlint/config-conventional"],
+  "rules": {
+    "body-max-line-length": [1, "always", 100],
+    "footer-max-line-length": [1, "always", 100]
+  }
+}

.husky/commit-msg

@@ -0,0 +1 @@
+npx commitlint --edit $1

.husky/pre-commit

@@ -0,0 +1,2 @@
+npm run lint:tsc
+npx lint-staged

.lintstagedrc.json

@@ -0,0 +1,4 @@
+{
+  "*.{js,mjs,ts}": "eslint --fix",
+  "*.{css,json,md,yml}": "prettier --write"
+}

.prettierrc.json

@@ -0,0 +1,3 @@
+{
+  "singleQuote": true
+}

cypress.config.ts

@@ -1,12 +1,12 @@
-import { defineConfig } from "cypress";
+import { defineConfig } from 'cypress';
 
 export default defineConfig({
+  // don't block CORS for LLM request
+  chromeWebSecurity: false,
+
   e2e: {
-    setupNodeEvents(on, config) {
+    setupNodeEvents() {
       // implement node event listeners here
     },
   },
-
-  // don't block CORS for LLM request
-  chromeWebSecurity: false,
 });

cypress/e2e/home.cy.ts

@@ -1,8 +1,8 @@
 describe('template spec', () => {
   it('passes', () => {
-    cy.ai('go to example.cypress.io and see heading "Kitchen Sink"')
-    cy.ai('click on "Commands" nav dropdown and click on link "Actions"')
-    cy.ai('find label "Coupon Code" and type "HALFOFF" in text field')
-    cy.ai('click button "Submit"')
-  })
-})
+    cy.ai('go to example.cypress.io and see heading "Kitchen Sink"');
+    cy.ai('click on "Commands" nav dropdown and click on link "Actions"');
+    cy.ai('find label "Coupon Code" and type "HALFOFF" in text field');
+    cy.ai('click button "Submit"');
+  });
+});

cypress/support/commands.ts

@@ -36,15 +36,15 @@
 //   }
 // }
 
-import { Ollama } from '@langchain/ollama'
-import { PromptTemplate } from '@langchain/core/prompts'
-import { resolve } from 'path'
-import { sanitize } from 'dompurify'
+import { PromptTemplate } from '@langchain/core/prompts';
+import { Ollama } from '@langchain/ollama';
+import { sanitize } from 'dompurify';
+import { resolve } from 'path';
 
 const llm = new Ollama({
   model: 'qwen2.5-coder',
   numCtx: 16384, // truncating input prompt limit=4096
-})
+});
 
 const template = `
 You're a QA engineer writing an E2E test step with Cypress
@@ -62,93 +62,93 @@ DOM:
 \`\`\`html
 {html}
 \`\`\`
-`
+`;
 
-const prompt = PromptTemplate.fromTemplate(template.trim())
-const chain = prompt.pipe(llm)
+const prompt = PromptTemplate.fromTemplate(template.trim());
+const chain = prompt.pipe(llm);
 
 function minutesToMilliseconds(minutes: number) {
-  return 1000 * 60 * minutes
+  return 1000 * 60 * minutes;
 }
 
 function getGeneratedFilePath(): string {
-  return resolve(Cypress.spec.absolute, `../__generated__/${Cypress.spec.name}.json`)
+  return resolve(
+    Cypress.spec.absolute,
+    `../__generated__/${Cypress.spec.name}.json`,
+  );
 }
 
-const noop = () => {}
+const noop = () => {};
 
 function readGeneratedFile() {
-  return cy.readFile(getGeneratedFilePath(), { log: false }).should(noop)
+  return cy.readFile(getGeneratedFilePath(), { log: false }).should(noop);
 }
 
 function getTestKey(): string {
-  return Cypress.currentTest.titlePath.join(' ')
+  return Cypress.currentTest.titlePath.join(' ');
 }
 
 function saveGeneratedCode(task: string, code: string) {
   readGeneratedFile().then((contents) => {
-    contents = contents || {}
+    contents = contents || {};
 
-    const key = getTestKey()
-    contents[key] = contents[key] || {}
-    contents[key][task] = code
+    const key = getTestKey();
+    contents[key] = contents[key] || {};
+    contents[key][task] = code;
 
-    cy.writeFile(getGeneratedFilePath(), JSON.stringify(contents, null, 2), { log: false })
-  })
+    cy.writeFile(getGeneratedFilePath(), JSON.stringify(contents, null, 2), {
+      log: false,
+    });
+  });
 }
 
-function getGeneratedCode(task: string) {
-  return readGeneratedFile().then((json) => {
-    try {
-      return json[getTestKey()][task]
-    } catch (error) {
-      return ''
-    }
-  })
-}
-
-Cypress.Commands.add('ai', (task, options) => {
-  Cypress.log({ displayName: 'ai', message: task })
+Cypress.Commands.add('ai', (task) => {
+  Cypress.log({ displayName: 'ai', message: task });
 
   return readGeneratedFile().then((json) => {
     try {
-      const code = json[getTestKey()][task]
-
-      if (code) {
-        return eval(code)
-      }
-    } catch (error) {
-      // pass
-    }
-
-    cy.document({ log: false }).then({ timeout: minutesToMilliseconds(2) }, async (doc) => {
-      const response = await chain.invoke({
-        task,
-        // html: sanitize(doc.documentElement.outerHTML),
-        html: sanitize(doc.body.innerHTML),
-      })
-      // console.log(response)
-
-      const error = "I'm sorry, but I can't assist with that request."
-      if (response.includes(error)) {
-        throw new Error(error)
-      }
+      const code = json[getTestKey()][task];
 
-      const code = response.match(/```(javascript|js)?([\s\S]+?)```/)?.[2]?.trim()
       if (code) {
-        eval(code)
-        saveGeneratedCode(task, code)
+        return eval(code);
       }
-    })
-  })
-})
+      // eslint-disable-next-line @typescript-eslint/no-unused-vars, no-empty
+    } catch (error) {}
+
+    cy.document({ log: false }).then(
+      { timeout: minutesToMilliseconds(2) },
+      async (doc) => {
+        const response = await chain.invoke({
+          task,
+          // html: sanitize(doc.documentElement.outerHTML),
+          html: sanitize(doc.body.innerHTML),
+        });
+        // console.log(response)
+
+        const error = "I'm sorry, but I can't assist with that request.";
+        if (response.includes(error)) {
+          throw new Error(error);
+        }
+
+        const code = response
+          .match(/```(javascript|js)?([\s\S]+?)```/)?.[2]
+          ?.trim();
+        if (code) {
+          eval(code);
+          saveGeneratedCode(task, code);
+        }
+      },
+    );
+  });
+});
 
 declare global {
+  // eslint-disable-next-line @typescript-eslint/no-namespace
   namespace Cypress {
     interface Chainable {
-      ai(task: string, options?: object): Chainable<void>
+      ai(task: string): Chainable<void>;
     }
   }
 }
 
-export {}
+export {};

cypress/support/e2e.ts

@@ -14,4 +14,4 @@
 // ***********************************************************
 
 // Import commands.js using ES2015 syntax:
-import './commands'
+import './commands';

eslint.config.mjs

@@ -0,0 +1,60 @@
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+import { includeIgnoreFile } from '@eslint/compat';
+import { FlatCompat } from '@eslint/eslintrc';
+import js from '@eslint/js';
+import typescriptEslint from '@typescript-eslint/eslint-plugin';
+import tsParser from '@typescript-eslint/parser';
+import prettier from 'eslint-plugin-prettier';
+import simpleImportSort from 'eslint-plugin-simple-import-sort';
+import tsdoc from 'eslint-plugin-tsdoc';
+import globals from 'globals';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const gitignorePath = path.resolve(__dirname, '.gitignore');
+
+const compat = new FlatCompat({
+  baseDirectory: __dirname,
+  recommendedConfig: js.configs.recommended,
+  allConfig: js.configs.all,
+});
+
+export default [
+  includeIgnoreFile(gitignorePath),
+
+  ...compat.extends(
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+  ),
+
+  {
+    files: ['**/*.js', '**/*.mjs', '**/*.ts', '**/*.tsx'],
+
+    plugins: {
+      '@typescript-eslint': typescriptEslint,
+      prettier,
+      'simple-import-sort': simpleImportSort,
+      tsdoc,
+    },
+
+    languageOptions: {
+      globals: {
+        ...globals.node,
+      },
+      parser: tsParser,
+    },
+
+    rules: {
+      '@typescript-eslint/no-extra-semi': 'off',
+      '@typescript-eslint/no-unused-vars': 'error',
+      'no-console': 'error',
+      'no-debugger': 'error',
+      'prettier/prettier': 'error',
+      'simple-import-sort/exports': 'error',
+      'simple-import-sort/imports': 'error',
+      'tsdoc/syntax': 'error',
+    },
+  },
+];