Fix bux linting warnings (#2683)

* Fix or suppress linting warnings

Note this required reworking translation-functions a little to add
stricter type checking

* Workspace lint/clean runs on bux

Author: dpwatrous

util/bux/__tests__/cli.spec.ts

@@ -4,6 +4,15 @@ import { createEnglishTranslations } from "../translation-functions";
 import * as fs from "fs";
 
 describe("CLI", () => {
+    beforeEach(() => {
+        // Suppress expected console warnings
+        jest.spyOn(console, "warn").mockImplementation(() => {
+            // no-op
+        });
+    });
+
+    afterEach(() => jest.resetAllMocks());
+
     /* At present, Jest won't allow us to mock methods for reading and writing
      * JSON files because support of ES modules is lacking.
      */
@@ -75,18 +84,16 @@ describe("CLI", () => {
     // Localization method should throw error due to duplicate keys
     // in files in the source directory
     test("Localization method should throw error", async () => {
-        const throwThis = createEnglishTranslations(
-            "./__tests__/loc-source-2",
-            "./build/test-results/loc-results-3",
-            "./build/test-results/loc-results-3"
-        );
-
-        await expect(throwThis).rejects.toThrow(Error);
+        await expect(
+            createEnglishTranslations(
+                "./__tests__/loc-source-2",
+                "./build/test-results/loc-results-3",
+                "./build/test-results/loc-results-3"
+            )
+        ).rejects.toThrow(Error);
 
         // expect destination directory to be empty due to error
-        fs.readdir("./build/test-results/loc-results-3", (err, files) => {
-            expect(err).toBeFalsy();
-            expect(files.length).toBe(0);
-        });
+        const files = fs.readdirSync("./build/test-results/loc-results-3");
+        expect(files.length).toBe(0);
     });
 });

util/bux/__tests__/loc-source-2/nest/list-base.i18n.yml

@@ -1,3 +1,4 @@
 account-summary-card:
+  url: This is a conflict
   filterApplied: New filter applied, results
   filterCleared: Filter cleared, results

util/bux/check-cli-path.js

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/no-var-requires */
 const shelljs = require("shelljs");
 const color = require("cli-color");
 

util/bux/package.json

@@ -26,6 +26,9 @@
     "prepack": "npm run build:clean",
     "test": "jest",
     "test:watch": "npm test -- --watch",
+    "workspace:clean": "npm run clean",
+    "workspace:lint": "npm run lint",
+    "workspace:lint:fix": "npm run lint:fix",
     "workspace:test:all": "npm run build:clean && npm test"
   },
   "dependencies": {

util/bux/translation-functions.ts

@@ -1,6 +1,4 @@
-// generate.ts
-// eslint-disable no-console
-//import "../../src/client/init";
+/* eslint-disable no-console */
 
 import * as fs from "fs";
 import { EOL } from "os";
@@ -11,6 +9,7 @@ import * as util from "util";
 import * as path from "path";
 
 type StringMap<V> = { [key: string]: V };
+type NestedStringMap<V> = StringMap<V> | StringMap<StringMap<V>>;
 
 const writeFile = promisify(fs.writeFile);
 
@@ -115,31 +114,34 @@ export class DevTranslationsLoader {
     ) {
         const content = await readFile(path);
         this._mergeTranslations(
-            this._flatten(jsyaml.load(content.toString())),
+            this._flatten(
+                jsyaml.load(content.toString()) as NestedStringMap<string>
+            ),
             path,
             duplicateCallback
         );
     }
 
-    private _flatten(translations: unknown): StringMap<string> {
-        const output: StringMap<any> = {};
+    private _flatten(translations: NestedStringMap<string>): StringMap<string> {
+        const output: StringMap<string> = {};
 
         function step(
-            object: any,
+            object: NestedStringMap<string>,
             prev: string | null = null,
             currentDepth: number = 0
         ) {
             currentDepth = currentDepth || 1;
             for (const key of Object.keys(object)) {
-                const value = object[key];
-                const isString = typeof value === "string";
-
                 const newKey = prev ? prev + "." + key : key;
-
-                if (!isString && Object.keys(value).length) {
-                    output[newKey] = step(value, newKey, currentDepth + 1);
-                } else {
+                const value = object[key];
+                if (typeof value === "string") {
                     output[newKey] = value;
+                } else if (value instanceof Object) {
+                    if (Object.keys(value).length > 0) {
+                        step(value, newKey, currentDepth + 1);
+                    }
+                } else {
+                    throw new Error(`Invalid translation value for ${newKey}`);
                 }
             }
         }
@@ -150,7 +152,7 @@ export class DevTranslationsLoader {
     }
 
     private _mergeTranslations(
-        translations: StringMap<any>,
+        translations: StringMap<string>,
         source: string,
         duplicateCallback: DuplicateCallback
     ) {

util/bux/util.ts

@@ -33,6 +33,7 @@ export const error = (...args: string[]) => console.error(color.red(...args));
 
 export function readJsonOrDefault(filename: string, defaultJson = {}) {
     if (fs.existsSync(filename)) {
+        // eslint-disable-next-line security/detect-non-literal-require
         return require(filename);
     }
     return defaultJson;
@@ -253,7 +254,7 @@ function printInfo(name: string, repoPath?: string): void {
 }
 
 async function printLinkStatus(): Promise<void> {
-    let linkChecks: boolean[] = [];
+    const linkChecks: boolean[] = [];
     await runLinkageTask((opts: LinkOptions) => {
         let isLinked = false;
 

util/common-config/.eslintrc-common.json

@@ -86,6 +86,7 @@
     ],
     "security/detect-object-injection": "off",
     "security/detect-unsafe-regex": "off",
+    "security/detect-non-literal-fs-filename": "off",
     "semi": ["error", "always"]
   }
 }