fix: ESLint issues in botbuilder-dialogs (#4832)

* fix eslint issues in botbuilder-dialogs * add eslint config file * combine unit tests and remove duplicated * initialize this.endReason
microsoft · Jan 6, 2025 · 5464ddd · 5464ddd
1 parent d5d82e6
commit 5464ddd
Show file tree

Hide file tree

Showing 49 changed files with 440 additions and 442 deletions.
diff --git a/libraries/botbuilder-dialogs/eslint.config.cjs b/libraries/botbuilder-dialogs/eslint.config.cjs
@@ -1,13 +1,8 @@
-const onlyWarn = require("eslint-plugin-only-warn");
-const sharedConfig = require("../../eslint.config.cjs")
+const sharedConfig = require('../../eslint.config.cjs');
 
 module.exports = [
     ...sharedConfig,
     {
-        ignores: ["**/vendor/"],
+        ignores: ['**/vendor/'],
     },
-    {
-        plugins: {
-            "only-warn": onlyWarn,
-        },
-    }];
+];
diff --git a/libraries/botbuilder-dialogs/package.json b/libraries/botbuilder-dialogs/package.json
@@ -33,8 +33,7 @@
     "@microsoft/recognizers-text-suite": "1.1.4",
     "botbuilder-core": "4.1.6",
     "botbuilder-dialogs-adaptive-runtime-core": "4.1.6",
-    "botframework-connector": "4.1.6",
-    "eslint-plugin-only-warn": "^1.1.0",    
+    "botframework-connector": "4.1.6",   
     "globalize": "^1.7.0",
     "lodash": "^4.17.21",
     "uuid": "^10.0.0",

diff --git a/libraries/botbuilder-dialogs/scripts/gen-cldr-data.js b/libraries/botbuilder-dialogs/scripts/gen-cldr-data.js
@@ -61,7 +61,7 @@ async function main() {
         await exec(
             process.platform === 'win32' ? 'npm.cmd' : 'npm',
             ['i', `${cldrDataPackageName}@${cldrDataPackageVersion}`, '--no-save'],
-            { cwd: tempDirectory, env: process.env }
+            { cwd: tempDirectory, env: process.env },
         );
     } catch (err) {
         plog('Could not install cldr-data');
@@ -88,17 +88,17 @@ async function main() {
         numbersDirectoryPaths.forEach((v) => {
             fs.copyFileSync(
                 path.join(cldrDataDirectory, v, numbersFileName),
-                path.join(vendorDirectory, v, numbersFileName)
+                path.join(vendorDirectory, v, numbersFileName),
             );
         });
 
         fs.copyFileSync(
             path.join(cldrDataDirectory, supplementalDirectoryName, likelySubtagsFileName),
-            path.join(vendorDirectory, supplementalDirectoryName, likelySubtagsFileName)
+            path.join(vendorDirectory, supplementalDirectoryName, likelySubtagsFileName),
         );
         fs.copyFileSync(
             path.join(cldrDataDirectory, supplementalDirectoryName, numberingSystemsFileName),
-            path.join(vendorDirectory, supplementalDirectoryName, numberingSystemsFileName)
+            path.join(vendorDirectory, supplementalDirectoryName, numberingSystemsFileName),
         );
     } catch (err) {
         plog('Could not copy files');

diff --git a/libraries/botbuilder-dialogs/src/choices/choiceFactory.ts b/libraries/botbuilder-dialogs/src/choices/choiceFactory.ts
@@ -96,7 +96,7 @@ export class ChoiceFactory {
         choices: (string | Choice)[],
         text?: string,
         speak?: string,
-        options?: ChoiceFactoryOptions
+        options?: ChoiceFactoryOptions,
     ): Partial<Activity> {
         const channelId: string =
             typeof channelOrContext === 'string' ? channelOrContext : channel.getChannelId(channelOrContext);
@@ -150,7 +150,7 @@ export class ChoiceFactory {
                     title: choice.value,
                     type: ActionTypes.ImBack,
                     value: choice.value,
-                } as CardAction)
+                }) as CardAction,
         );
         const attachment = CardFactory.heroCard(undefined, text, undefined, buttons);
 
@@ -178,7 +178,7 @@ export class ChoiceFactory {
         choices: (string | Choice)[],
         text?: string,
         speak?: string,
-        options?: ChoiceFactoryOptions
+        options?: ChoiceFactoryOptions,
     ): Partial<Activity> {
         const opt: ChoiceFactoryOptions = {
             inlineSeparator: ', ',
@@ -229,7 +229,7 @@ export class ChoiceFactory {
         choices: (string | Choice)[],
         text?: string,
         speak?: string,
-        options?: ChoiceFactoryOptions
+        options?: ChoiceFactoryOptions,
     ): Partial<Activity> {
         const opt: ChoiceFactoryOptions = {
             includeNumbers: true,

diff --git a/libraries/botbuilder-dialogs/src/choices/findChoices.ts b/libraries/botbuilder-dialogs/src/choices/findChoices.ts
@@ -135,13 +135,13 @@ export interface FoundChoice {
 export function findChoices(
     utterance: string,
     choices: (string | Choice)[],
-    options?: FindChoicesOptions
+    options?: FindChoicesOptions,
 ): ModelResult<FoundChoice>[] {
     const opt: FindChoicesOptions = options || {};
 
     // Normalize choices
     const list: Choice[] = (choices || []).map((choice: Choice) =>
-        typeof choice === 'string' ? { value: choice } : choice
+        typeof choice === 'string' ? { value: choice } : choice,
     );
 
     // Build up full list of synonyms to search over.

diff --git a/libraries/botbuilder-dialogs/src/choices/findValues.ts b/libraries/botbuilder-dialogs/src/choices/findValues.ts
@@ -88,7 +88,7 @@ export interface SortedValue {
 export function findValues(
     utterance: string,
     values: SortedValue[],
-    options?: FindValuesOptions
+    options?: FindValuesOptions,
 ): ModelResult<FoundValue>[] {
     function indexOfToken(token: Token, startPos: number): number {
         for (let i: number = startPos; i < tokens.length; i++) {
@@ -126,7 +126,7 @@ export function findValues(
         index: number,
         value: string,
         vTokens: Token[],
-        startPos: number
+        startPos: number,
     ): ModelResult<FoundValue> | undefined {
         // Match value to utterance and calculate total deviation.
         // - The tokens are matched in order so "second last" will match in
@@ -223,7 +223,7 @@ export function findValues(
 
     // Sort matches by score descending
     matches = matches.sort(
-        (a: ModelResult<FoundValue>, b: ModelResult<FoundValue>) => b.resolution.score - a.resolution.score
+        (a: ModelResult<FoundValue>, b: ModelResult<FoundValue>) => b.resolution.score - a.resolution.score,
     );
 
     // Filter out duplicate matching indexes and overlapping characters.

diff --git a/libraries/botbuilder-dialogs/src/choices/recognizeChoices.ts b/libraries/botbuilder-dialogs/src/choices/recognizeChoices.ts
@@ -45,7 +45,7 @@ import { ModelResult } from './modelResult';
 export function recognizeChoices(
     utterance: string,
     choices: (string | Choice)[],
-    options?: FindChoicesOptions
+    options?: FindChoicesOptions,
 ): ModelResult<FoundChoice>[] {
     function matchChoiceByIndex(match: ModelResult<any>): void {
         try {
@@ -77,14 +77,14 @@ export function recognizeChoices(
             recognizeNumbers: true,
             recognizeOrdinals: true,
         } as FindChoicesOptions,
-        options
+        options,
     );
 
     // Normalize choices
     const list: Choice[] = (choices || [])
         .map((choice: Choice) => (typeof choice === 'string' ? { value: choice } : choice))
         .filter(
-            (choice: Choice) => choice // TODO: does this do anything?
+            (choice: Choice) => choice, // TODO: does this do anything?
         );
 
     // Try finding choices by text search first

diff --git a/libraries/botbuilder-dialogs/src/dialogContext.ts b/libraries/botbuilder-dialogs/src/dialogContext.ts
@@ -247,7 +247,7 @@ export class DialogContext {
         if (!dialog) {
             throw new DialogContextError(
                 `DialogContext.beginDialog(): A dialog with an id of '${dialogId}' wasn't found.`,
-                this
+                this,
             );
         }
 
@@ -360,7 +360,7 @@ export class DialogContext {
      */
     async prompt(
         dialogId: string,
-        promptOrOptions: string | Partial<Activity> | PromptOptions
+        promptOrOptions: string | Partial<Activity> | PromptOptions,
     ): Promise<DialogTurnResult>;
 
     /**
@@ -383,7 +383,7 @@ export class DialogContext {
     async prompt(
         dialogId: string,
         promptOrOptions: string | Partial<Activity> | PromptOptions,
-        choices: (string | Choice)[]
+        choices: (string | Choice)[],
     ): Promise<DialogTurnResult>;
 
     /**
@@ -405,7 +405,7 @@ export class DialogContext {
     async prompt(
         dialogId: string,
         promptOrOptions: string | Partial<Activity>,
-        choices?: (string | Choice)[]
+        choices?: (string | Choice)[],
     ): Promise<DialogTurnResult> {
         let options: PromptOptions;
         if (
@@ -466,7 +466,7 @@ export class DialogContext {
             if (!dialog) {
                 throw new DialogContextError(
                     `DialogContext.continueDialog(): Can't continue dialog. A dialog with an id of '${instance.id}' wasn't found.`,
-                    this
+                    this,
                 );
             }
 
@@ -520,7 +520,7 @@ export class DialogContext {
             if (!dialog) {
                 throw new DialogContextError(
                     `DialogContext.endDialog(): Can't resume previous dialog. A dialog with an id of '${instance.id}' wasn't found.`,
-                    this
+                    this,
                 );
             }
 
@@ -582,7 +582,7 @@ export class DialogContext {
                 if (!dialog) {
                     throw new DialogContextError(
                         `DialogContext.repromptDialog(): Can't find a dialog with an id of '${instance.id}'.`,
-                        this
+                        this,
                     );
                 }
 
@@ -615,7 +615,6 @@ export class DialogContext {
         // eslint-disable-next-line @typescript-eslint/no-this-alias
         let dc: DialogContext = this;
         if (fromLeaf) {
-            // eslint-disable-next-line no-constant-condition
             while (true) {
                 const childDc = dc.child;
                 if (childDc != undefined) {

diff --git a/libraries/botbuilder-dialogs/src/dialogContextError.ts b/libraries/botbuilder-dialogs/src/dialogContextError.ts
@@ -24,7 +24,10 @@ export class DialogContextError extends Error {
      * @param {Error | string} error Source error or error message.
      * @param {DialogContext} dialogContext Dialog context that is the source of the error.
      */
-    constructor(public readonly error: Error | string, dialogContext: DialogContext) {
+    constructor(
+        readonly error: Error | string,
+        dialogContext: DialogContext,
+    ) {
         super();
 
         if (!(error instanceof Error) && typeof error !== 'string') {

diff --git a/libraries/botbuilder-dialogs/src/dialogHelper.ts b/libraries/botbuilder-dialogs/src/dialogHelper.ts
@@ -36,7 +36,7 @@ import {
 export async function runDialog(
     dialog: Dialog,
     context: TurnContext,
-    accessor: StatePropertyAccessor<DialogState>
+    accessor: StatePropertyAccessor<DialogState>,
 ): Promise<void> {
     if (!dialog) {
         throw new Error('runDialog(): missing dialog');
@@ -76,7 +76,7 @@ export async function internalRun(
     context: TurnContext,
     dialogId: string,
     dialogContext: DialogContext,
-    dialogStateManagerConfiguration?: DialogStateManagerConfiguration
+    dialogStateManagerConfiguration?: DialogStateManagerConfiguration,
 ): Promise<DialogTurnResult> {
     // map TurnState into root dialog context.services
     context.turnState.forEach((service, key) => {
@@ -122,7 +122,7 @@ export async function internalRun(
 async function innerRun(
     context: TurnContext,
     dialogId: string,
-    dialogContext: DialogContext
+    dialogContext: DialogContext,
 ): Promise<DialogTurnResult> {
     // Handle EoC and Reprompt event from a parent bot (can be root bot to skill or skill to skill)
     if (isFromParentToSkill(context)) {
@@ -197,9 +197,8 @@ export function shouldSendEndOfConversationToParent(context: TurnContext, turnRe
     if (claimIdentity && SkillValidation.isSkillClaim(claimIdentity.claims)) {
         // EoC Activities returned by skills are bounced back to the bot by SkillHandler.
         // In those cases we will have a SkillConversationReference instance in state.
-        const skillConversationReference: SkillConversationReference = context.turnState.get(
-            SkillConversationReferenceKey
-        );
+        const skillConversationReference: SkillConversationReference =
+            context.turnState.get(SkillConversationReferenceKey);
         if (skillConversationReference) {
             // If the skillConversationReference.OAuthScope is for one of the supported channels, we are at the root and we should not send an EoC.
             return (
@@ -259,7 +258,7 @@ const sendStateSnapshotTrace = async (dialogContext: DialogContext): Promise<voi
         'BotState',
         'https://www.botframework.com/schemas/botState',
         snapshot,
-        traceLabel
+        traceLabel,
     );
     await dialogContext.context.sendActivity(traceActivity);
 };
diff --git a/libraries/botbuilder-dialogs/src/dialogSet.ts b/libraries/botbuilder-dialogs/src/dialogSet.ts
@@ -145,7 +145,7 @@ export class DialogSet {
             // If we are adding a new dialog with a conflicting name, add a suffix to avoid
             // dialog name collisions.
             let nextSuffix = 2;
-            // eslint-disable-next-line no-constant-condition
+
             while (true) {
                 const suffixId = dialog.id + nextSuffix.toString();
                 if (!Object.prototype.hasOwnProperty.call(this.dialogs, suffixId)) {
@@ -166,8 +166,8 @@ export class DialogSet {
         this.dialogs[dialog.id] = dialog;
 
         // Automatically add any child dependencies the dialog might have
-        if (typeof ((dialog as any) as DialogDependencies).getDependencies == 'function') {
-            ((dialog as any) as DialogDependencies).getDependencies().forEach((child: Dialog): void => {
+        if (typeof (dialog as any as DialogDependencies).getDependencies == 'function') {
+            (dialog as any as DialogDependencies).getDependencies().forEach((child: Dialog): void => {
                 this.add(child);
             });
         }
@@ -184,7 +184,7 @@ export class DialogSet {
     async createContext(context: TurnContext): Promise<DialogContext> {
         if (!this.dialogState) {
             throw new Error(
-                'DialogSet.createContext(): the dialog set was not bound to a stateProperty when constructed.'
+                'DialogSet.createContext(): the dialog set was not bound to a stateProperty when constructed.',
             );
         }
         const state: DialogState = await this.dialogState.get(context, { dialogStack: [] } as DialogState);

diff --git a/libraries/botbuilder-dialogs/src/dialogsBotComponent.ts b/libraries/botbuilder-dialogs/src/dialogsBotComponent.ts
@@ -51,7 +51,7 @@ export class DialogsBotComponent extends BotComponent {
                 new ClassMemoryScope(),
                 new ThisMemoryScope(),
                 new ConversationMemoryScope(),
-                new UserMemoryScope()
+                new UserMemoryScope(),
             );
         });
 
@@ -61,8 +61,8 @@ export class DialogsBotComponent extends BotComponent {
                 new HashPathResolver(),
                 new AtAtPathResolver(),
                 new AtPathResolver(),
-                new PercentPathResolver()
-            )
+                new PercentPathResolver(),
+            ),
         );
     }
 }
diff --git a/libraries/botbuilder-dialogs/src/dialogsComponentRegistration.ts b/libraries/botbuilder-dialogs/src/dialogsComponentRegistration.ts
@@ -16,7 +16,8 @@ import { ComponentMemoryScopes, ComponentPathResolvers, MemoryScope, PathResolve
  */
 export class DialogsComponentRegistration
     extends ComponentRegistration
-    implements ComponentMemoryScopes, ComponentPathResolvers {
+    implements ComponentMemoryScopes, ComponentPathResolvers
+{
     private readonly services = new ServiceCollection({
         memoryScopes: [],
         pathResolvers: [],

diff --git a/libraries/botbuilder-dialogs/src/i18n.ts b/libraries/botbuilder-dialogs/src/i18n.ts
@@ -6,7 +6,7 @@
  * Licensed under the MIT License.
  */
 
-/* eslint-disable @typescript-eslint/no-var-requires */
+/* eslint-disable @typescript-eslint/no-require-imports */
 const Chinese = require('../vendor/cldr-data/main/zh/numbers.json');
 const English = require('../vendor/cldr-data/main/en/numbers.json');
 const French = require('../vendor/cldr-data/main/fr/numbers.json');

diff --git a/libraries/botbuilder-dialogs/src/memory/componentPathResolvers.ts b/libraries/botbuilder-dialogs/src/memory/componentPathResolvers.ts
@@ -18,7 +18,7 @@ export interface ComponentPathResolvers {
 
 const componentPathResolvers = z.custom<ComponentPathResolvers>(
     (val: any) => typeof val.getPathResolvers === 'function',
-    { message: 'ComponentPathResolvers' }
+    { message: 'ComponentPathResolvers' },
 );
 
 /**