@mongosh/autocomplete 1.10.1 → 1.10.2

package/src/index.ts

@@ -1,6 +1,5 @@
-/* eslint complexity: 0, camelcase: 0, no-nested-ternary: 0 */
-
-import { signatures as shellSignatures, Topologies, TypeSignature } from '@mongosh/shell-api';
+import type { Topologies, TypeSignature } from '@mongosh/shell-api';
+import { signatures as shellSignatures } from '@mongosh/shell-api';
 import semver from 'semver';
 import {
   CONVERSION_OPERATORS,
@@ -12,30 +11,34 @@ import {
   ATLAS,
   ADL,
   ON_PREM,
-  DATABASE
+  DATABASE,
 } from '@mongodb-js/mongodb-constants';
 
 type TypeSignatureAttributes = { [key: string]: TypeSignature };
 
 export interface AutocompleteParameters {
   topology: () => Topologies;
-  connectionInfo: () => undefined | {
-    is_atlas: boolean;
-    is_data_federation: boolean;
-    server_version: string;
-  },
-  apiVersionInfo: () => { version: string, strict: boolean } | undefined;
-  getCollectionCompletionsForCurrentDb: (collName: string) => string[] | Promise<string[]>;
+  connectionInfo: () =>
+    | undefined
+    | {
+        is_atlas: boolean;
+        is_data_federation: boolean;
+        server_version: string;
+      };
+  apiVersionInfo: () => { version: string; strict: boolean } | undefined;
+  getCollectionCompletionsForCurrentDb: (
+    collName: string
+  ) => string[] | Promise<string[]>;
   getDatabaseCompletions: (dbName: string) => string[] | Promise<string[]>;
 }
 
 type AnyCompletions = readonly (
-  | typeof CONVERSION_OPERATORS[number]
-  | typeof EXPRESSION_OPERATORS[number]
-  | typeof STAGE_OPERATORS[number]
-  | typeof QUERY_OPERATORS[number]
-  | typeof ACCUMULATORS[number]
-  | typeof BSON_TYPES[number]
+  | (typeof CONVERSION_OPERATORS)[number]
+  | (typeof EXPRESSION_OPERATORS)[number]
+  | (typeof STAGE_OPERATORS)[number]
+  | (typeof QUERY_OPERATORS)[number]
+  | (typeof ACCUMULATORS)[number]
+  | (typeof BSON_TYPES)[number]
 )[];
 
 export const BASE_COMPLETIONS = ([] as AnyCompletions).concat(
@@ -74,15 +77,26 @@ const GROUP = '$group';
  *
  * @returns {array} Matching Completions, Current User Input.
  */
-async function completer(params: AutocompleteParameters, line: string): Promise<[string[], string, 'exclusive'] | [string[], string]> {
-  const SHELL_COMPLETIONS = shellSignatures.ShellApi.attributes as TypeSignatureAttributes;
-  const COLL_COMPLETIONS = shellSignatures.Collection.attributes as TypeSignatureAttributes;
-  const DB_COMPLETIONS = shellSignatures.Database.attributes as TypeSignatureAttributes;
-  const AGG_CURSOR_COMPLETIONS = shellSignatures.AggregationCursor.attributes as TypeSignatureAttributes;
-  const COLL_CURSOR_COMPLETIONS = shellSignatures.Cursor.attributes as TypeSignatureAttributes;
-  const RS_COMPLETIONS = shellSignatures.ReplicaSet.attributes as TypeSignatureAttributes;
-  const CONFIG_COMPLETIONS = shellSignatures.ShellConfig.attributes as TypeSignatureAttributes;
-  const SHARD_COMPLETE = shellSignatures.Shard.attributes as TypeSignatureAttributes;
+async function completer(
+  params: AutocompleteParameters,
+  line: string
+): Promise<[string[], string, 'exclusive'] | [string[], string]> {
+  const SHELL_COMPLETIONS = shellSignatures.ShellApi
+    .attributes as TypeSignatureAttributes;
+  const COLL_COMPLETIONS = shellSignatures.Collection
+    .attributes as TypeSignatureAttributes;
+  const DB_COMPLETIONS = shellSignatures.Database
+    .attributes as TypeSignatureAttributes;
+  const AGG_CURSOR_COMPLETIONS = shellSignatures.AggregationCursor
+    .attributes as TypeSignatureAttributes;
+  const COLL_CURSOR_COMPLETIONS = shellSignatures.Cursor
+    .attributes as TypeSignatureAttributes;
+  const RS_COMPLETIONS = shellSignatures.ReplicaSet
+    .attributes as TypeSignatureAttributes;
+  const CONFIG_COMPLETIONS = shellSignatures.ShellConfig
+    .attributes as TypeSignatureAttributes;
+  const SHARD_COMPLETE = shellSignatures.Shard
+    .attributes as TypeSignatureAttributes;
 
   // Split at space-to-non-space transitions when looking at this as a command,
   // because multiple spaces (e.g. 'show  collections') are valid in commands.
@@ -104,10 +118,16 @@ async function completer(params: AutocompleteParameters, line: string): Promise<
         // Complete the first argument after the command.
         splitLineWhitespace.push('');
       }
-      const hits = await completer(params, splitLineWhitespace.map(item => item.trim())) || [];
+      const hits =
+        (await completer(
+          params,
+          splitLineWhitespace.map((item) => item.trim())
+        )) || [];
       // Adjust to full input, because `completer` only completed the last item
       // in the line, e.g. ['profile'] -> ['show profile']
-      const fullLineHits = hits.map(hit => [...splitLineWhitespace.slice(0, -1), hit].join(''));
+      const fullLineHits = hits.map((hit) =>
+        [...splitLineWhitespace.slice(0, -1), hit].join('')
+      );
       return [fullLineHits, line, 'exclusive'];
     }
     return [[line], line, 'exclusive'];
@@ -122,20 +142,19 @@ async function completer(params: AutocompleteParameters, line: string): Promise<
   if (splitLine.length <= 1) {
     const hits = filterShellAPI(params, SHELL_COMPLETIONS, elToComplete);
     return [hits.length ? hits : [], line];
-  } else if (firstLineEl.match(/\bdb\b/) && splitLine.length === 2) {
-    if (elToComplete.match(/aggregate\s*\(\s*\[\s*\{\s*/)) {
+  } else if (/\bdb\b/.exec(firstLineEl) && splitLine.length === 2) {
+    if (/aggregate\s*\(\s*\[\s*\{\s*/.exec(elToComplete)) {
       const splitQuery = line.split('{');
       const prefix = splitQuery.pop()?.trim() || '';
-      const command: string = prefix ? line.split(prefix).shift() as string : line;
+      const command: string = prefix
+        ? (line.split(prefix).shift() as string)
+        : line;
       const suggestFirstStage = splitQuery.length <= 2;
 
       const expressions = suggestFirstStage
-        // First stage in `db.aggregate` form can only be 'db' namespaced stages
-        ? DB_AGGREGATE_COMPLETIONS
-        : [
-          ...BASE_COMPLETIONS,
-          ...getStageAccumulators(params, elToComplete)
-        ];
+        ? // First stage in `db.aggregate` form can only be 'db' namespaced stages
+          DB_AGGREGATE_COMPLETIONS
+        : [...BASE_COMPLETIONS, ...getStageAccumulators(params, elToComplete)];
 
       const hits = filterQueries(params, expressions, prefix, command);
       return [hits.length ? hits : [], line];
@@ -143,12 +162,22 @@ async function completer(params: AutocompleteParameters, line: string): Promise<
     // We're seeing something like 'db.foo' and expand that to all methods on
     // db which start with 'foo' and all collections on the current db that
     // start with 'foo'.
-    const hits = filterShellAPI(params, DB_COMPLETIONS, elToComplete, splitLine);
-    const colls = await params.getCollectionCompletionsForCurrentDb(elToComplete.trim());
-    hits.push(...colls.map(coll => `${splitLine[0]}.${coll}`));
+    const hits = filterShellAPI(
+      params,
+      DB_COMPLETIONS,
+      elToComplete,
+      splitLine
+    );
+    const colls = await params.getCollectionCompletionsForCurrentDb(
+      elToComplete.trim()
+    );
+    hits.push(...colls.map((coll) => `${splitLine[0]}.${coll}`));
     return [hits.length ? hits : [], line];
-  } else if (firstLineEl.match(/\bdb\b/) && splitLine.length > 2) {
-    if (!splitLine[1].match(/^\s*\w+\s*$/) && !splitLine[1].match(/\bgetCollection\b/)) {
+  } else if (/\bdb\b/.exec(firstLineEl) && splitLine.length > 2) {
+    if (
+      !/^\s*\w+\s*$/.exec(splitLine[1]) &&
+      !/\bgetCollection\b/.exec(splitLine[1])
+    ) {
       // The collection name contains something that is not whitespace or an
       // alphanumeric character. This could be a function call, for example.
       // In any case, we can't currently provide reasonable autocompletion
@@ -158,15 +187,23 @@ async function completer(params: AutocompleteParameters, line: string): Promise<
 
     if (splitLine.length > 3) {
       // We're seeing something like db.coll.find().xyz or db.coll.aggregate().xyz
-      if (splitLine[2].match(/\baggregate\b/)) {
+      if (/\baggregate\b/.exec(splitLine[2])) {
         // aggregation cursor completions
         const hits = filterShellAPI(
-          params, AGG_CURSOR_COMPLETIONS, elToComplete, splitLine);
+          params,
+          AGG_CURSOR_COMPLETIONS,
+          elToComplete,
+          splitLine
+        );
         return [hits.length ? hits : [], line];
-      } else if (splitLine[2].match(/\bfind\b/)) {
+      } else if (/\bfind\b/.exec(splitLine[2])) {
         // collection cursor completions
         const hits = filterShellAPI(
-          params, COLL_CURSOR_COMPLETIONS, elToComplete, splitLine);
+          params,
+          COLL_CURSOR_COMPLETIONS,
+          elToComplete,
+          splitLine
+        );
         return [hits.length ? hits : [], line];
       }
       // This is something else, and we currently don't know what this is.
@@ -176,11 +213,11 @@ async function completer(params: AutocompleteParameters, line: string): Promise<
     // complete aggregation and collection  queries/stages
     if (splitLine[2].includes('([') || splitLine[2].includes('({')) {
       let expressions;
-      if (splitLine[2].match(/\baggregate\b/)) {
+      if (/\baggregate\b/.exec(splitLine[2])) {
         // aggregation needs extra accumulators to autocomplete properly
         expressions = [
           ...BASE_COMPLETIONS,
-          ...getStageAccumulators(params, elToComplete)
+          ...getStageAccumulators(params, elToComplete),
         ];
       } else {
         // collection querying just needs MATCH COMPLETIONS
@@ -189,25 +226,43 @@ async function completer(params: AutocompleteParameters, line: string): Promise<
       // split on {, as a stage/query will always follow an open curly brace
       const splitQuery = line.split('{');
       const prefix = splitQuery.pop()?.trim();
-      const command: string = prefix ? line.split(prefix).shift() as string : line;
+      const command: string = prefix
+        ? (line.split(prefix).shift() as string)
+        : line;
       const hits = filterQueries(params, expressions, prefix || '', command);
       return [hits.length ? hits : [], line];
     }
 
     const hits = filterShellAPI(
-      params, COLL_COMPLETIONS, elToComplete, splitLine);
+      params,
+      COLL_COMPLETIONS,
+      elToComplete,
+      splitLine
+    );
     return [hits.length ? hits : [], line];
-  } else if (firstLineEl.match(/\bsh\b/) && splitLine.length === 2) {
+  } else if (/\bsh\b/.exec(firstLineEl) && splitLine.length === 2) {
     const hits = filterShellAPI(
-      params, SHARD_COMPLETE, elToComplete, splitLine);
+      params,
+      SHARD_COMPLETE,
+      elToComplete,
+      splitLine
+    );
     return [hits.length ? hits : [], line];
-  } else if (firstLineEl.match(/\brs\b/) && splitLine.length === 2) {
+  } else if (/\brs\b/.exec(firstLineEl) && splitLine.length === 2) {
     const hits = filterShellAPI(
-      params, RS_COMPLETIONS, elToComplete, splitLine);
+      params,
+      RS_COMPLETIONS,
+      elToComplete,
+      splitLine
+    );
     return [hits.length ? hits : [], line];
-  } else if (firstLineEl.match(/\bconfig\b/) && splitLine.length === 2) {
+  } else if (/\bconfig\b/.exec(firstLineEl) && splitLine.length === 2) {
     const hits = filterShellAPI(
-      params, CONFIG_COMPLETIONS, elToComplete, splitLine);
+      params,
+      CONFIG_COMPLETIONS,
+      elToComplete,
+      splitLine
+    );
     return [hits.length ? hits : [], line];
   }
 
@@ -216,8 +271,14 @@ async function completer(params: AutocompleteParameters, line: string): Promise<
 
 function isAcceptable(
   params: AutocompleteParameters,
-  entry: { version?: string; projectVersion?: string; env?: string[]; apiVersions?: number[] },
-  versionKey: 'version' | 'projectVersion') {
+  entry: {
+    version?: string;
+    projectVersion?: string;
+    env?: string[];
+    apiVersions?: number[];
+  },
+  versionKey: 'version' | 'projectVersion'
+) {
   const connectionInfo = params.connectionInfo();
   const apiVersionInfo = params.apiVersionInfo();
   let isAcceptableVersion;
@@ -233,9 +294,11 @@ function isAcceptable(
   const isAcceptableEnvironment =
     !entry.env ||
     !connectionInfo ||
-    (connectionInfo.is_data_federation ? entry.env.includes(ADL) :
-      connectionInfo.is_atlas ? entry.env.includes(ATLAS) :
-        entry.env.includes(ON_PREM));
+    (connectionInfo.is_data_federation
+      ? entry.env.includes(ADL)
+      : connectionInfo.is_atlas
+      ? entry.env.includes(ATLAS)
+      : entry.env.includes(ON_PREM));
   return isAcceptableVersion && isAcceptableEnvironment;
 }
 
@@ -243,7 +306,7 @@ function isAcceptable(
 function getStageAccumulators(
   params: AutocompleteParameters,
   stage: string
-): readonly typeof ACCUMULATORS[number][] {
+): readonly (typeof ACCUMULATORS)[number][] {
   if (stage.includes(PROJECT)) {
     return ACCUMULATORS.filter((acc) => {
       return isAcceptable(params, acc, 'projectVersion');
@@ -254,19 +317,27 @@ function getStageAccumulators(
   return [];
 }
 
-function filterQueries(params: AutocompleteParameters, completions: any, prefix: string, split: string): string[] {
+function filterQueries(
+  params: AutocompleteParameters,
+  completions: any,
+  prefix: string,
+  split: string
+): string[] {
   const hits: any[] = completions.filter((e: any) => {
-    return e.name && e.name.startsWith(prefix) && isAcceptable(params, e, 'version');
+    return (
+      e.name && e.name.startsWith(prefix) && isAcceptable(params, e, 'version')
+    );
   });
 
-  return hits.map(h => `${split}${h.name}`);
+  return hits.map((h) => `${split}${h.name}`);
 }
 
 function filterShellAPI(
   params: AutocompleteParameters,
   completions: { [key: string]: TypeSignature },
   prefix: string,
-  split?: string[]): string[] {
+  split?: string[]
+): string[] {
   const hits: string[] = Object.keys(completions).filter((c: string) => {
     if (!c.toLowerCase().startsWith(prefix.toLowerCase())) return false;
     if (completions[c].deprecated) return false;
@@ -274,10 +345,13 @@ function filterShellAPI(
     const apiVersionInfo = params.apiVersionInfo();
     let isAcceptableVersion;
     let acceptableApiVersions;
-    if (apiVersionInfo?.strict && (acceptableApiVersions = completions[c].apiVersions)) {
+    if (
+      apiVersionInfo?.strict &&
+      (acceptableApiVersions = completions[c].apiVersions)
+    ) {
       isAcceptableVersion =
-         +apiVersionInfo.version >= acceptableApiVersions[0] &&
-         +apiVersionInfo.version <= acceptableApiVersions[1];
+        +apiVersionInfo.version >= acceptableApiVersions[0] &&
+        +apiVersionInfo.version <= acceptableApiVersions[1];
     } else {
       const serverVersion = params.connectionInfo()?.server_version;
       if (!serverVersion) return true;
@@ -286,19 +360,18 @@ function filterShellAPI(
       isAcceptableVersion =
         !acceptableVersions ||
         (semver.gte(serverVersion, acceptableVersions[0]) &&
-         semver.lte(serverVersion, acceptableVersions[1]));
+          semver.lte(serverVersion, acceptableVersions[1]));
     }
 
     const acceptableTopologies = completions[c].topologies;
     const isAcceptableTopology =
-      !acceptableTopologies ||
-      acceptableTopologies.includes(params.topology());
+      !acceptableTopologies || acceptableTopologies.includes(params.topology());
 
     return isAcceptableVersion && isAcceptableTopology;
   });
 
   if (split) {
-    return hits.map(h => `${split.slice(0, -1).join('.')}.${h}`);
+    return hits.map((h) => `${split.slice(0, -1).join('.')}.${h}`);
   }
 
   return hits;

package/tsconfig-lint.json

@@ -0,0 +1,5 @@
+{
+  "extends": "./tsconfig.json",
+  "include": ["**/*"],
+  "exclude": ["node_modules", "dist", "lib"]
+}

package/tsconfig.json

@@ -1,13 +1,9 @@
 {
-  "extends": "../../config/tsconfig.base.json",
+  "extends": "@mongodb-js/tsconfig-mongosh/tsconfig.common.json",
   "compilerOptions": {
     "outDir": "./lib",
     "allowJs": true
   },
-  "include": [
-    "./src/**/*"
-  ],
-  "exclude": [
-    "./src/**/*.spec.*"
-  ]
+  "include": ["src/**/*"],
+  "exclude": ["./src/**/*.spec.*"]
 }

package/tsconfig.lint.json

@@ -1,8 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "include": [
-    "./src/**/*",
-    "./test/**/*"
-  ],
-  "exclude": []
-}