fix: refactor, lint and bump to 0.0.10

Author: gagik

snippets/ai/.eslintrc.js

@@ -1,10 +1,13 @@
-const { fixCygwinPath } = require('@mongodb-js/eslint-config-mongosh/utils');
 
 module.exports = {
   root: true,
-  extends: ['@mongodb-js/eslint-config-mongosh'],
+  extends: ['@mongodb-js/eslint-config-devtools'],
   parserOptions: {
-    tsconfigRootDir: fixCygwinPath(__dirname),
+    tsconfigRootDir: __dirname,
     project: ['./tsconfig-lint.json'],
   },
+  rules: {
+    '@typescript-eslint/consistent-type-imports': 'off',
+    '@typescript-eslint/no-var-requires': 'off',
+  },
 };

snippets/ai/package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "@gagik.co/snippet-ai",
   "snippetName": "ai",
-  "version": "0.0.2",
+  "version": "0.0.10",
   "description": "Provides a ai command suite for mongosh to ask for MongoDB query expressions in natural language.",
   "author": "Gagik Amaryan",
   "main": "dist/index.js",
@@ -12,6 +12,7 @@
   },
   "scripts": {
     "build": "tsc",
+    "lint": "eslint src",
     "prepare": "npm run build"
   },
   "dependencies": {
@@ -27,6 +28,7 @@
   "devDependencies": {
     "@mongodb-js/connection-info": "^0.12.0",
     "@mongodb-js/eslint-config-compass": "^1.3.8",
+    "@mongodb-js/eslint-config-devtools": "^0.9.11",
     "@mongodb-js/prettier-config-devtools": "^1.0.2",
     "@types/node": "^20.17.47",
     "mongodb-rag-core": "^0.7.0",

snippets/ai/package.json

@@ -3,7 +3,7 @@ import type { Config, ConfigSchema } from './config.js';
 import type { CliContext } from './helpers.js';
 import type { Models } from './providers/generic/ai-sdk-provider.js';
 
-module.exports = ((globalThis: CliContext) => {
+module.exports = (async (globalThis: CliContext) => {
   const _localRequire = require('module').createRequire(__filename);
   const localRequire = <T>(module: string): T => _localRequire(module);
 
@@ -16,7 +16,7 @@ module.exports = ((globalThis: CliContext) => {
   const chalk = localRequire<typeof import('chalk')>('chalk');
 class AI {
   private readonly replConfig: {
-    set: (key: string, value: any) => Promise<void>;
+    set: (key: string, value: unknown) => Promise<void>;
     get: <T>(key: string) => Promise<T>;
   };
 
@@ -36,14 +36,15 @@ class AI {
     this.config = new Config(this.replConfig);
 
     // Set up provider change listener
+    // eslint-disable-next-line @typescript-eslint/no-misused-promises
     this.config.on('change', async (event) => {
       switch (event.key) {
         case 'provider':
           this.ai = this.getProvider(event.value as ConfigSchema['provider']);
           break;
         case 'model':
             if (!Object.keys(models).includes(this.config.get('provider') as Models)) {
-              if (event.value == 'default') {
+              if (event.value === 'default') {
                 return;
               }
               await this.config.set('model', 'default');
@@ -52,13 +53,13 @@ class AI {
           try {
             this.ai = getAiSdkProvider(
               models[this.config.get('provider') as keyof typeof models](
-                event.value == 'default' ? undefined : event.value as string,
+                event.value === 'default' ? undefined : event.value as string,
               ),
               this.cliContext,
               this.config,
             );
           } catch (error) {
-            throw new Error(`Invalid model, please ensure your name is correct: ${error}`);
+            throw new Error(`Invalid model, please ensure your name is correct: ${error as string}`);
           }
           break;
         default:
@@ -71,10 +72,9 @@ class AI {
     );
     wrapAllFunctions(this.cliContext, this);
 
-    this.setupConfig();
   }
 
-  async setupConfig() {
+  async setup() {
     await this.config.setup();
 
     this.ai = this.getProvider(this.config.get('provider'));
@@ -88,13 +88,14 @@ class AI {
         return getDocsAiProvider(this.cliContext, this.config);
       case 'openai':
       case 'mistral':
-      case 'ollama':
+      case 'ollama': {
         const model = this.config.get('model');
         return getAiSdkProvider(
           models[provider](model === 'default' ? undefined : model),
           this.cliContext,
           this.config,
         );
+      }
       default:
         return new EmptyAiProvider(this.cliContext, this.config);
     }
@@ -131,32 +132,32 @@ class AI {
   }
 
   @aiCommand({requiresPrompt: false})
-  async help() {
+  help() {
     this.ai.help({
       provider: this.config.get('provider'),
       model: this.config.get('model'),
     });
   }
 
   @aiCommand()
-  async clear() {
+  clear() {
     this.ai.clear();
   }
 
   @aiCommand()
-  async collection(name: string) {
-    await this.ai.collection(name);
+  collection(name: string) {
+    this.ai.collection(name);
   }
 
   @aiCommand()
   async provider(provider: string) {
-    this.config.set('provider', provider);
+    await this.config.set('provider', provider);
     this.ai.respond(`Switched to ${chalk.blue(provider)} provider`);
   }
 
   @aiCommand()
   async model(model: string) {
-    this.config.set('model', model);
+    await this.config.set('model', model);
     this.ai.respond(`Switched to ${chalk.blue(model)} model`);
   }
 
@@ -168,4 +169,8 @@ class AI {
 
 
 (globalThis as unknown as CliContext).ai = new AI(globalThis as unknown as CliContext);
+await (globalThis as unknown as {
+  ai: AI;
+}).ai.setup();
+
 });

snippets/ai/src/ai.ts

@@ -1,4 +1,4 @@
-const _localRequire = <T>(module: string): T => require(module).createRequire(__filename);
+const _localRequire = require('module').createRequire(__filename);
 const localRequire = <T>(module: string): T => _localRequire(module);
 import type { z as ZodType } from 'zod';
 
@@ -19,7 +19,7 @@ const configKeys = Object.keys(configSchema.shape) as Array<keyof ConfigSchema>;
 export type ConfigSchema = ZodType.infer<typeof configSchema>;
 type ConfigKeys = keyof ConfigSchema;
 
-const defaults: Record<ConfigKeys, any> = {
+const defaults: Record<ConfigKeys, ConfigSchema[ConfigKeys]> = {
   provider: process.env.MONGOSH_AI_PROVIDER ?? 'docs',
   model: process.env.MONGOSH_AI_MODEL ?? 'default',
   includeSampleDocs: process.env.MONGOSH_AI_INCLUDE_SAMPLE_DOCS ?? true,
@@ -34,11 +34,11 @@ export class Config extends EventEmitter<{
     },
   ];
 }> {
-  private configMap: Record<string, any> = {};
+  private configMap: Record<ConfigKeys, ConfigSchema[ConfigKeys]> = defaults;
 
   constructor(
     private readonly replConfig: {
-      set: (key: string, value: any) => Promise<void>;
+      set: (key: string, value: unknown) => Promise<void>;
       get: <T>(key: string) => Promise<T>;
     },
   ) {
@@ -48,13 +48,13 @@ export class Config extends EventEmitter<{
   async setup(): Promise<void> {
     const keys = Object.keys(configSchema.shape) as Array<keyof ConfigSchema>;
     for (const key of keys) {
-      this.configMap[key] = (await this.replConfig.get(key)) ?? defaults[key];
+      this.configMap[key] ??= (await this.replConfig.get(key));
     }
   }
 
   get<K extends keyof ConfigSchema>(key: K): ConfigSchema[K] {
     this.assertKey(key);
-    return this.configMap[key];
+    return this.configMap[key] as ConfigSchema[K];
   }
 
   assertKey(key: string): asserts key is ConfigKeys {
@@ -65,7 +65,7 @@ export class Config extends EventEmitter<{
     }
   }
 
-  async set(key: ConfigKeys, value: any): Promise<void> {
+  async set(key: ConfigKeys, value: ConfigSchema[ConfigKeys]): Promise<void> {
     this.assertKey(key);
 
     // Validate the value based on the key
@@ -82,9 +82,9 @@ export class Config extends EventEmitter<{
       if (schema._def.typeName === 'ZodEnum') {
         type = `${schema._def.values.join(' | ')}`;
       }
-      const i = (value: any) => inspect(value, {colors: true});
+      const i = (value: unknown) => inspect(value, {colors: true});
 
-      return `  ${i(key)}: ${chalk.white(i(this.configMap[key]))},${type ? chalk.gray(` // ${type}`) : ''}`;
+      return `  ${i(key)}: ${chalk.white(i(this.configMap[key as ConfigKeys]))},${type ? chalk.gray(` // ${type}`) : ''}`;
     });
 
     return `{\n${lines.join('\n')}\n}`;

snippets/ai/src/config.ts

@@ -5,12 +5,12 @@ export interface AiCommandOptions {
 export function aiCommand({
   requiresPrompt = true,
 }: AiCommandOptions = {}) {
-  return function decorator<T extends Function>(
+  return function decorator<T extends (...args: string[]) => unknown>(
     value: T,
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     context: ClassMethodDecoratorContext
   ): T & { isDirectShellCommand: true } {
-    const wrappedFunction = function(this: any, ...args: any[]) {
+    const wrappedFunction = function(this: unknown, ...args: string[]) {
       if (requiresPrompt === false && args.length > 0) {
         throw new Error('This command does not accept any arguments');
       } else if (requiresPrompt && args.length === 0) {

snippets/ai/src/decorators.ts

@@ -54,30 +54,37 @@ export class LoadingAnimation {
 export interface CliContext {
   ai: unknown;
   db: {
+    _name: string;
+    getCollectionNames: () => Promise<string[]>;
+    getCollection: (name: string) => {
+      aggregate: (pipeline: unknown[]) => Promise<{
+        toArray: () => Promise<Record<string, unknown>[]>;
+      }>;
+    };
     _mongo: {
       _instanceState: {
         evaluationListener: {
-          setConfig: (key: string, value: any) => Promise<void>;
+          setConfig: (key: string, value: unknown) => Promise<void>;
           getConfig: <T>(key: string) => Promise<T>;
         };
-        registerPlugin: (plugin: any) => void;
-        shellApi: Record<string, any>;
-        context: Record<string, any>;
+        registerPlugin: (plugin: unknown) => void;
+        shellApi: Record<string, unknown>;
+        context: Record<string, unknown>;
       };
     };
   };
 }
 
 export function wrapFunction(
   cliContext: CliContext,
-  instance: any,
+  instance: unknown,
   name: string | undefined,
-  fn: Function,
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  fn: (..._args: unknown[]) => Record<string, unknown>,
 ) {
-  const wrapperFn = (...args: string[]) => {
-    return Object.assign(fn(...args), {
-      [Symbol.for('@@mongosh.syntheticPromise')]: true,
-    });
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  const wrapperFn = (..._args: unknown[]) => {
+    return fn(..._args);
   };
   wrapperFn.isDirectShellCommand = true;
   wrapperFn.returnsPromise = true;
@@ -89,8 +96,14 @@ export function wrapFunction(
   ] = wrapperFn;
 }
 
-export function wrapAllFunctions(cliContext: CliContext, instance: any) {
+export function wrapAllFunctions(cliContext: CliContext, currentInstance: unknown) {
   const instanceState = cliContext.db._mongo._instanceState;
+  const instance = currentInstance as {
+    [key: string]: (...args: unknown[]) => Record<string, unknown> | {
+      isDirectShellCommand: boolean;
+    }
+  };
+
   const methods = Object.getOwnPropertyNames(
     Object.getPrototypeOf(instance),
   ).filter((name) => {
@@ -105,10 +118,12 @@ export function wrapAllFunctions(cliContext: CliContext, instance: any) {
     );
   });
 
+
+
   // for all methods, wrap them with the wrapFunction method
   for (const methodName of methods) {
     const method = instance[methodName];
-    if (typeof method === 'function' && method.isDirectShellCommand) {
+    if (typeof method === 'function' && (method as unknown as { isDirectShellCommand: boolean }).isDirectShellCommand) {
       wrapFunction(cliContext, instance, methodName, method.bind(instance));
     }
   }

snippets/ai/src/helpers.ts

@@ -1,5 +1,6 @@
 // tsc generates a module.exports for TypeScript files so we have this wrapper to load the module
 (() => {
     const localRequire = require('module').createRequire(__filename);
+    // eslint-disable-next-line no-undef
     localRequire('./ai.js')(globalThis);
 })();

snippets/ai/src/index.js

@@ -7,20 +7,23 @@ const IS_DEBUG = process.env.DEBUG === 'true';
 class Logger extends EventEmitter {
     debug(...args: unknown[]) {
       if (IS_DEBUG) {
+        // eslint-disable-next-line no-console
         console.debug(...args);
         this.emit('debug', ...args);
       }
     }
 
     info(...args: unknown[]) {
       if (IS_DEBUG) {
+        // eslint-disable-next-line no-console
         console.info(...args);
         this.emit('info', ...args);
       }
     }
 
     error(...args: unknown[]) {
       if (IS_DEBUG) {
+        // eslint-disable-next-line no-console
         console.error(...args);
         this.emit('error', ...args);
       }