(EAI-243): Lint space between entities (#383)

cbush · web-flow · commit 6212ef79a1f8 · 2024-03-29T14:02:05.000-04:00
* Add lint script and rules

* Add prettierrc.js to all packages

* Update prettierrc

* Update prettierrc

* Run lint
diff --git a/.eslintrc.cjs b/.eslintrc.cjs
@@ -4,7 +4,7 @@ module.exports = {
   },
   root: true,
   parser: "@typescript-eslint/parser",
-  plugins: ["@typescript-eslint", "jest", "jsdoc", "prettier"],
+  plugins: ["@typescript-eslint", "jest", "jsdoc", "prettier", "@stylistic/js"],
   extends: [
     "eslint:recommended",
     "prettier",
diff --git a/.prettierrc.cjs b/.prettierrc.cjs
@@ -0,0 +1,3 @@
+module.exports = {
+  embeddedLanguageFormatting: "off",
+};
diff --git a/examples/quick-start/packages/ui/package.json b/examples/quick-start/packages/ui/package.json
@@ -5,7 +5,8 @@
   "scripts": {
     "dev": "vite",
     "build": "tsc && vite build",
-    "lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
+    "lint": "eslint ./src --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
+    "lint:fix": "npm run lint -- --fix && prettier ./src --check --write",
     "preview": "vite preview"
   },
   "dependencies": {
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -15,6 +15,7 @@
     "build": "lerna run build",
     "test": "lerna run test",
     "lint": "lerna run lint",
+    "lint:fix": "lerna run lint:fix",
     "release:chat-ui": "lerna run release --scope='mongodb-chatbot-ui' && git add ./package-lock.json && git commit --amend --no-edit",
     "scripts:analyzeMessages": "lerna run analyzeMessages --scope='scripts'",
     "scripts:scrubMessages": "lerna run scrubMessages --scope='scripts'",
@@ -26,6 +27,7 @@
     "eval:faqConversationQualityCheckPipeline": "lerna run pipeline:faqConversationQualityCheck --scope='chatbot-eval-mongodb-public'"
   },
   "devDependencies": {
+    "@stylistic/eslint-plugin-js": "^1.7.0",
     "lerna": "^5.6.2"
   }
 }
diff --git a/packages/chatbot-eval-mongodb-public/.prettierrc.cjs b/packages/chatbot-eval-mongodb-public/.prettierrc.cjs
@@ -0,0 +1,5 @@
+const baseConfig = require(`${__dirname}/../../.prettierrc.cjs`);
+
+module.exports = {
+  ...baseConfig,
+};
diff --git a/packages/chatbot-eval-mongodb-public/package.json b/packages/chatbot-eval-mongodb-public/package.json
@@ -15,6 +15,7 @@
     "watch": "tsc -b -w",
     "release": "release-it",
     "lint": "eslint ./src --ext ts --report-unused-disable-directives",
+    "lint:fix": "npm run lint -- --fix && prettier ./src --check --write",
     "generate:conversations": "../mongodb-chatbot-eval/build/main.js generate --name conversations --config ./build/eval.config.js",
     "generate:faqConversations": "../mongodb-chatbot-eval/build/main.js generate --name faqConversations --config ./build/eval.config.js",
     "report:conversationQualityRun": "../mongodb-chatbot-eval/build/main.js report --name conversationQualityRun --config ./build/eval.config.js",
diff --git a/packages/chatbot-server-mongodb-public/.prettierrc.cjs b/packages/chatbot-server-mongodb-public/.prettierrc.cjs
@@ -0,0 +1,5 @@
+const baseConfig = require(`${__dirname}/../../.prettierrc.cjs`);
+
+module.exports = {
+  ...baseConfig,
+};
diff --git a/packages/chatbot-server-mongodb-public/package.json b/packages/chatbot-server-mongodb-public/package.json
@@ -18,7 +18,8 @@
     "dev": "nodemon src/index.ts",
     "format": "prettier ./src --write",
     "format:check": "prettier ./src --check",
-    "lint": "eslint ./src --ext js,jsx,ts,tsx --report-unused-disable-directives",
+    "lint": "eslint ./src --ext ts,tsx,js,jsx --report-unused-disable-directives",
+    "lint:fix": "npm run lint -- --fix && prettier ./src --check --write",
     "start": "pm2-runtime ./build/index.js",
     "test": "jest --forceExit",
     "release": "release-it"
diff --git a/packages/ingest-mongodb-public/.prettierrc.cjs b/packages/ingest-mongodb-public/.prettierrc.cjs
@@ -0,0 +1,5 @@
+const baseConfig = require(`${__dirname}/../../.prettierrc.cjs`);
+
+module.exports = {
+  ...baseConfig,
+};
diff --git a/packages/ingest-mongodb-public/package.json b/packages/ingest-mongodb-public/package.json
@@ -15,6 +15,7 @@
     "watch": "tsc -b -w",
     "release": "release-it",
     "lint": "eslint ./src --ext ts --report-unused-disable-directives",
+    "lint:fix": "npm run lint -- --fix && prettier ./src --check --write",
     "ingest:all": "ingest all --config ./build/config.js",
     "ingest:k8s": "../../node_modules/mongodb-rag-ingest/build/main.js all --config ./build/config.js",
     "ingest:pages": "ingest pages --config ./build/config.js",
diff --git a/packages/ingest-mongodb-public/src/sources/mongodbDeveloperCodeRepos.test.ts b/packages/ingest-mongodb-public/src/sources/mongodbDeveloperCodeRepos.test.ts
@@ -23,7 +23,7 @@ jest.setTimeout(90000);
 describe("mongodbDeveloperCodeRepos", () => {
   describe("smoke tests", () => {
     test("nodeJsQuickstart", async () => {
-      smokeTest(nodeJsQuickstart, "usersCollection.js")
+      smokeTest(nodeJsQuickstart, "usersCollection.js");
     });
 
     test("javaQuickstart", async () => {
diff --git a/packages/mongodb-artifact-generator/.prettierrc.cjs b/packages/mongodb-artifact-generator/.prettierrc.cjs
@@ -0,0 +1,5 @@
+const baseConfig = require(`${__dirname}/../../.prettierrc.cjs`);
+
+module.exports = {
+  ...baseConfig,
+};
diff --git a/packages/mongodb-artifact-generator/package.json b/packages/mongodb-artifact-generator/package.json
@@ -22,7 +22,8 @@
     "postbuild": "chmod +x build/main.js",
     "watch": "tsc -b -w",
     "test": "jest --forceExit",
-    "lint": "eslint ./src --ext js,jsx,ts,tsx --report-unused-disable-directives",
+    "lint": "eslint ./src --ext ts,tsx,js,jsx --report-unused-disable-directives",
+    "lint:fix": "npm run lint -- --fix && prettier ./src --check --write",
     "parseDriversCsv": "npm run build && node ./build/main.js parseDriversCsv --config='./build/standardConfig.js'"
   },
   "devDependencies": {
diff --git a/packages/mongodb-artifact-generator/src/Config.ts b/packages/mongodb-artifact-generator/src/Config.ts
@@ -1,8 +1,4 @@
-import {
-  Embedder,
-  PageStore,
-  EmbeddedContentStore,
-} from "mongodb-rag-core";
+import { Embedder, PageStore, EmbeddedContentStore } from "mongodb-rag-core";
 
 /**
   The configuration for the artifact generator.
diff --git a/packages/mongodb-artifact-generator/src/commands/parseDriversCsv.ts b/packages/mongodb-artifact-generator/src/commands/parseDriversCsv.ts
@@ -111,16 +111,15 @@ export const action = createConfiguredAction<ParseDriversCsvCommandArgs>(
       const nodeRepoBaseUrl =
         "https://github.com/mongodb/docs-node/blob/master/";
 
-
-        type RelevantAssetFields = {
-          nodeAssetName: string;
-          nodeAssetRemotePath: string;
-          nodeAssetPathRelativeToSourceRepo: string;
-          nodeAssetFullPath: string;
-          assetType: string;
-          fileRename?: string;
-        };
-        const relevantAssetFieldsOnly = parsedAndNormalized.map(
+      type RelevantAssetFields = {
+        nodeAssetName: string;
+        nodeAssetRemotePath: string;
+        nodeAssetPathRelativeToSourceRepo: string;
+        nodeAssetFullPath: string;
+        assetType: string;
+        fileRename?: string;
+      };
+      const relevantAssetFieldsOnly = parsedAndNormalized.map(
         ({ nodeAssetName, nodeAssetPath, assetType, fileRename }) => {
           const nodeAssetPathRelativeToSourceRepo = nodeAssetPath.replace(
             nodeRepoBaseUrl,
diff --git a/packages/mongodb-artifact-generator/src/commands/translateCode.ts b/packages/mongodb-artifact-generator/src/commands/translateCode.ts
@@ -153,9 +153,10 @@ export const action = createConfiguredAction<TranslateCodeCommandArgs>(
 
       logger.logInfo(`Created output:\n\n${transformed}\n`);
 
-
       const inputFileName = path.parse(source).name;
-      const outputFileName = `${outputFilename ?? inputFileName}.translated.${targetFileExtension}`;
+      const outputFileName = `${
+        outputFilename ?? inputFileName
+      }.translated.${targetFileExtension}`;
       const outputFilePath = outputPath
         ? path.join(outputPath, outputFileName)
         : outputFileName;
diff --git a/packages/mongodb-artifact-generator/src/commands/translateDocsPage.ts b/packages/mongodb-artifact-generator/src/commands/translateDocsPage.ts
@@ -9,12 +9,9 @@ import { stripIndents } from "common-tags";
 import { makeFindContent } from "../vectorSearch";
 import { makeGenerateChatCompletion } from "../chat";
 import { rewriteAsRst, summarizePage, translatePage } from "../operations";
-import {
-  makeRunLogger,
-  type RunLogger
-} from "../runlogger";
+import { makeRunLogger, type RunLogger } from "../runlogger";
 import { rstDescription, stringifyVectorSearchChunks } from "../prompt";
-import path from "path"
+import path from "path";
 
 let logger: RunLogger;
 
diff --git a/packages/mongodb-artifact-generator/src/createCommand.ts b/packages/mongodb-artifact-generator/src/createCommand.ts
@@ -1,9 +1,11 @@
 import { CommandModule } from "yargs";
 import { LoadConfigArgs } from "./withConfig";
 
-type CMD<T extends { [k: string]: unknown } = Record<string, never>> = CommandModule<unknown, LoadConfigArgs & T>;
+type CMD<T extends { [k: string]: unknown } = Record<string, never>> =
+  CommandModule<unknown, LoadConfigArgs & T>;
 
-
-export function createCommand<T extends { [k: string]: unknown } = Record<string, never>>(commandModule: CMD<T>) {
+export function createCommand<
+  T extends { [k: string]: unknown } = Record<string, never>
+>(commandModule: CMD<T>) {
   return commandModule;
 }
diff --git a/packages/mongodb-artifact-generator/src/pages.ts b/packages/mongodb-artifact-generator/src/pages.ts
@@ -8,23 +8,21 @@ export type FindPagesResult = {
   pages: Page[];
 };
 
-export type FindPages = ({
-  urls,
-}: FindPagesArgs) => Promise<FindPagesResult>;
+export type FindPages = ({ urls }: FindPagesArgs) => Promise<FindPagesResult>;
 
 export type MakeFindPagesArgs = {
   pageStore: PageStore;
 };
 
-export function makeFindPages({
-  pageStore,
-}: MakeFindPagesArgs): {
+export function makeFindPages({ pageStore }: MakeFindPagesArgs): {
   findPages: FindPages;
   cleanup: () => Promise<void>;
 } {
   const findPages: FindPages = async ({ urls }) => {
-    if(pageStore.queryType !== "mongodb") {
-      throw new Error(`Unsupported query type: ${pageStore.queryType}. Must be "mongodb".`);
+    if (pageStore.queryType !== "mongodb") {
+      throw new Error(
+        `Unsupported query type: ${pageStore.queryType}. Must be "mongodb".`
+      );
     }
     pageStore.loadPages({
       query: {
diff --git a/packages/mongodb-artifact-generator/src/prompt.ts b/packages/mongodb-artifact-generator/src/prompt.ts
@@ -126,4 +126,4 @@ export const rstDescription = html`
 
      * - Charlie
        - March 9, 2014
-`
+`;
diff --git a/packages/mongodb-artifact-generator/src/standardConfig.ts b/packages/mongodb-artifact-generator/src/standardConfig.ts
@@ -17,7 +17,6 @@ const {
   MONGODB_DATABASE_NAME,
 } = assertEnvVars(ArtifactGeneratorEnvVars);
 
-
 export const standardConfig = {
   embedder: () =>
     makeOpenAiEmbedder({
diff --git a/packages/mongodb-artifact-generator/src/yaml.ts b/packages/mongodb-artifact-generator/src/yaml.ts
@@ -2,7 +2,9 @@ import { promises as fs } from "fs";
 import path from "path";
 import YAML from "yaml";
 
-export async function readYamlDir(dir: string): Promise<[string, Record<string, unknown>][]> {
+export async function readYamlDir(
+  dir: string
+): Promise<[string, Record<string, unknown>][]> {
   try {
     const files = await fs.readdir(dir);
     const yamlFiles = files.filter(
diff --git a/packages/mongodb-atlas/.prettierrc.cjs b/packages/mongodb-atlas/.prettierrc.cjs
@@ -0,0 +1,5 @@
+const baseConfig = require(`${__dirname}/../../.prettierrc.cjs`);
+
+module.exports = {
+  ...baseConfig,
+};
diff --git a/packages/mongodb-chatbot-evaluation/.prettierrc.cjs b/packages/mongodb-chatbot-evaluation/.prettierrc.cjs
@@ -0,0 +1,5 @@
+const baseConfig = require(`${__dirname}/../../.prettierrc.cjs`);
+
+module.exports = {
+  ...baseConfig,
+};
diff --git a/packages/mongodb-chatbot-evaluation/package.json b/packages/mongodb-chatbot-evaluation/package.json
@@ -39,7 +39,8 @@
     "build": "tsc -b tsconfig.build.json",
     "postbuild": "chmod +x build/main.js",
     "watch": "tsc -b -w",
-    "lint": "eslint ./src --ext js,jsx,ts,tsx --report-unused-disable-directives",
+    "lint": "eslint ./src --ext ts --report-unused-disable-directives",
+    "lint:fix": "npm run lint -- --fix && prettier ./src --check --write",
     "release": "release-it",
     "test": "jest --forceExit"
   },
diff --git a/packages/mongodb-chatbot-server/.prettierrc.cjs b/packages/mongodb-chatbot-server/.prettierrc.cjs
@@ -0,0 +1,5 @@
+const baseConfig = require(`${__dirname}/../../.prettierrc.cjs`);
+
+module.exports = {
+  ...baseConfig,
+};
diff --git a/packages/mongodb-chatbot-server/package.json b/packages/mongodb-chatbot-server/package.json
@@ -31,7 +31,8 @@
     "build": "npm run clean && tsc -b tsconfig.build.json",
     "format": "prettier ./src --write",
     "format:check": "prettier ./src --check",
-    "lint": "eslint ./src --ext js,jsx,ts,tsx --report-unused-disable-directives",
+    "lint": "eslint ./src --ext ts,tsx,js,jsx --report-unused-disable-directives",
+    "lint:fix": "npm run lint -- --fix && prettier ./src --check --write",
     "test": "jest --forceExit",
     "release": "release-it"
   },
diff --git a/packages/mongodb-chatbot-ui/.prettierrc.cjs b/packages/mongodb-chatbot-ui/.prettierrc.cjs
@@ -0,0 +1,5 @@
+const baseConfig = require(`${__dirname}/../../.prettierrc.cjs`);
+
+module.exports = {
+  ...baseConfig,
+};
diff --git a/packages/mongodb-chatbot-ui/.prettierrc.json b/packages/mongodb-chatbot-ui/.prettierrc.json
diff --git a/packages/mongodb-chatbot-ui/package.json b/packages/mongodb-chatbot-ui/package.json
@@ -46,7 +46,8 @@
     "env:get-git-commit": "if [ -z \"$VITE_GIT_COMMIT\" ]; then echo \"$(git rev-parse --short HEAD)\"; else echo \"$VITE_GIT_COMMIT\"; fi",
     "format": "prettier ./src --write",
     "format:check": "prettier ./src --check",
-    "lint": "eslint ./src --ext js,jsx,ts,tsx --report-unused-disable-directives --max-warnings 0",
+    "lint": "eslint ./src --ext ts,tsx,js,jsx --report-unused-disable-directives",
+    "lint:fix": "npm run lint -- --fix && prettier ./src --check --write",
     "preview": "vite preview --config vite.config.component.js --mode development",
     "preview:static-site:dev": "npm run build:static-site:dev && vite preview --base ./ --config vite.config.static-site.js",
     "preview:static-site:staging": "npm run build:static-site:staging && vite preview --base ./ --config vite.config.static-site.js",
diff --git a/packages/mongodb-chatbot-ui/src/InputBar.tsx b/packages/mongodb-chatbot-ui/src/InputBar.tsx
@@ -29,11 +29,13 @@ const styles = {
     isError,
   }: StylesProps & { isError: boolean }) => css`
     white-space: nowrap;
-    color: ${isError
-      ? palette.red.base
-      : darkMode
-      ? palette.gray.light2
-      : palette.gray.dark2};
+    color: ${
+      isError
+        ? palette.red.base
+        : darkMode
+        ? palette.gray.light2
+        : palette.gray.dark2
+    };
   `,
 };
 
@@ -79,7 +81,7 @@ export function CharacterCount({
           darkMode,
           isError: current > max,
         }),
-        className,
+        className
       )}
     >
       {`${current} / ${max}`}
diff --git a/packages/mongodb-chatbot-ui/src/PoweredByAtlasVectorSearch.tsx b/packages/mongodb-chatbot-ui/src/PoweredByAtlasVectorSearch.tsx
diff --git a/packages/mongodb-chatbot-ui/src/services/conversations.test.ts b/packages/mongodb-chatbot-ui/src/services/conversations.test.ts
diff --git a/packages/mongodb-chatbot-ui/src/useChatbot.tsx b/packages/mongodb-chatbot-ui/src/useChatbot.tsx
diff --git a/packages/mongodb-chatbot-verified-answers/.prettierrc.cjs b/packages/mongodb-chatbot-verified-answers/.prettierrc.cjs
diff --git a/packages/mongodb-chatbot-verified-answers/package.json b/packages/mongodb-chatbot-verified-answers/package.json
diff --git a/packages/mongodb-rag-core/.prettierrc.cjs b/packages/mongodb-rag-core/.prettierrc.cjs
diff --git a/packages/mongodb-rag-core/package.json b/packages/mongodb-rag-core/package.json
diff --git a/packages/mongodb-rag-core/src/PageFormat.test.ts b/packages/mongodb-rag-core/src/PageFormat.test.ts
diff --git a/packages/mongodb-rag-ingest/.prettierrc.cjs b/packages/mongodb-rag-ingest/.prettierrc.cjs
diff --git a/packages/mongodb-rag-ingest/package.json b/packages/mongodb-rag-ingest/package.json
diff --git a/packages/performance-tests/.prettierrc.cjs b/packages/performance-tests/.prettierrc.cjs
diff --git a/packages/scripts/.prettierrc.cjs b/packages/scripts/.prettierrc.cjs
diff --git a/packages/scripts/package.json b/packages/scripts/package.json

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+module.exports = {`
	`2`	`+ embeddedLanguageFormatting: "off",`
	`3`	`+};`