Scripts, lint, and config cleanup

.eslintrc.js

@@ -0,0 +1,60 @@
+module.exports = {
+  root: true,
+  parser: "@typescript-eslint/parser",
+  plugins: ["@typescript-eslint"],
+  extends: [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:import/errors",
+    "plugin:import/warnings",
+    "plugin:import/typescript",
+    "prettier", // disable rules that are redundant with prettier
+  ],
+  parserOptions: {
+    ecmaVersion: 2020,
+    sourceType: "module",
+  },
+  ignorePatterns: ["**/node_modules/**", "**/lib/**", "**/*.js"],
+  rules: {
+    "@typescript-eslint/no-shadow": ["error", { ignoreTypeValueShadow: true }],
+    "@typescript-eslint/explicit-module-boundary-types": "error",
+    "prefer-const": ["error", { destructuring: "all" }],
+
+    "@typescript-eslint/no-var-requires": "off",
+    "@typescript-eslint/interface-name-prefix": "off",
+    "@typescript-eslint/no-explicit-any": "off",
+    "@typescript-eslint/camelcase": "off",
+    "no-prototype-builtins": "off",
+    "@typescript-eslint/consistent-type-assertions": "off",
+    "import/namespace": "off",
+    "import/order": "warn",
+    "import/no-unresolved": "off",
+    "import/default": "off",
+  },
+  overrides: [
+    {
+      files: ["**/*.test.ts"],
+      rules: {
+        "no-restricted-properties": [
+          "error",
+          ...["describe", "it", "test"]
+            .map((func) => [
+              {
+                object: func,
+                property: "only",
+                message: "Do not commit .only() tests",
+              },
+              {
+                object: func,
+                property: "skip",
+                message:
+                  "Do not commit .skip() tests (disable this rule if needed)",
+              },
+            ])
+            .flat(),
+        ],
+      },
+    },
+  ],
+};

.github/workflows/CI.yml

@@ -42,12 +42,12 @@ jobs:
         if: ${{ matrix.os == 'ubuntu-latest' }}
         run: yarn syncpack:check
 
+      - run: yarn format:check
+        if: ${{ matrix.os == 'ubuntu-latest' }}
+
       - run: yarn build
 
       - run: yarn lint
         if: ${{ matrix.os == 'ubuntu-latest' }}
 
-      - run: yarn format:check
-        if: ${{ matrix.os == 'ubuntu-latest' }}
-
       - run: yarn test

.vscode/launch.json

@@ -13,7 +13,7 @@
       "request": "launch",
       "program": "${workspaceRoot}/tools/debugTests.js",
       "cwd": "${fileDirname}",
-      "args": ["--runInBand", "--watch", "${fileBasename}"],
+      "args": ["${fileBasename}"],
       "sourceMaps": true,
       "outputCapture": "std",
       "console": "integratedTerminal"

change/change-229f3af9-c39b-4355-be59-58895bb8bd4e.json

@@ -0,0 +1,46 @@
+{
+  "changes": [
+    {
+      "type": "none",
+      "comment": "Simplify build script",
+      "packageName": "backfill",
+      "email": "elcraig@microsoft.com",
+      "dependentChangeType": "none"
+    },
+    {
+      "type": "patch",
+      "comment": "Move logic out of index file (no behavior change)",
+      "packageName": "backfill-cache",
+      "email": "elcraig@microsoft.com",
+      "dependentChangeType": "patch"
+    },
+    {
+      "type": "none",
+      "comment": "Simplify build script",
+      "packageName": "backfill-config",
+      "email": "elcraig@microsoft.com",
+      "dependentChangeType": "none"
+    },
+    {
+      "type": "minor",
+      "comment": "Improve internal structure and remove excess exports. If you were using exports besides Hasher, please file an issue.",
+      "packageName": "backfill-hasher",
+      "email": "elcraig@microsoft.com",
+      "dependentChangeType": "patch"
+    },
+    {
+      "type": "none",
+      "comment": "Simplify build script",
+      "packageName": "backfill-logger",
+      "email": "elcraig@microsoft.com",
+      "dependentChangeType": "none"
+    },
+    {
+      "type": "none",
+      "comment": "Simplify build script",
+      "packageName": "backfill-utils-dotenv",
+      "email": "elcraig@microsoft.com",
+      "dependentChangeType": "none"
+    }
+  ]
+}

package.json

@@ -36,6 +36,7 @@
     "**/@azure/core-util": "~1.12.0",
     "**/@azure/core-xml": "~1.4.5",
     "**/@azure/logger": "~1.2.0",
+    "**/syncpack/minimatch": "^6.0.0",
     "**/cache-base/union-value/set-value": "^2.0.0"
   },
   "devDependencies": {
@@ -74,11 +75,14 @@
   },
   "rationale": {
     "resolutions": {
-      "@azure/*": "Node 18 compatibility"
+      "@azure/*": "Node 18 compatibility",
+      "syncpack/minimatch": "Unpin minimatch due to security issue. Should match original major version."
     }
   },
   "syncpack": {
-    "peer": false,
+    "prod": true,
+    "dev": true,
+    "peer": true,
     "workspace": false,
     "resolutions": false
   }

packages/backfill/package.json

@@ -13,8 +13,7 @@
     "backfill": "./bin/backfill.js"
   },
   "scripts": {
-    "build": "yarn compile",
-    "compile": "tsc -b",
+    "build": "tsc -b --pretty",
     "test": "jest",
     "watch": "tsc -b -w"
   },
@@ -33,7 +32,7 @@
     "yargs": "^16.1.1"
   },
   "devDependencies": {
-    "@types/fs-extra": "^9.0.13",
+    "@types/fs-extra": "^8.0.0",
     "@types/jest": "^30.0.0",
     "@types/node": "^14.18.36",
     "@types/yargs": "^15.0.15",

packages/backfill/src/__tests__/cli.test.ts

@@ -6,11 +6,16 @@ import { makeLogger } from "backfill-logger";
 
 import { createBuildCommand } from "../commandRunner";
 
-const logger = makeLogger("mute");
+const muteLogger = makeLogger("mute");
 
 describe("createBuildCommand", () => {
   it("runs a command successfully", async () => {
-    const buildCommand = createBuildCommand(["echo foo"], false, [""], logger);
+    const buildCommand = createBuildCommand(
+      ["echo foo"],
+      false,
+      [""],
+      muteLogger
+    );
 
     const buildResult = await buildCommand();
 
@@ -20,7 +25,7 @@ describe("createBuildCommand", () => {
   });
 
   it("resolves if no command can be found", async () => {
-    const buildCommand = createBuildCommand([""], false, [""], logger);
+    const buildCommand = createBuildCommand([""], false, [""], muteLogger);
 
     await expect(buildCommand()).rejects.toThrow("Command not provided");
   });
@@ -65,7 +70,7 @@ describe("createBuildCommand", () => {
       ["echo foo"],
       true,
       [path.join(fixtureLocation, "lib/**").replace(/\\/g, "/")],
-      logger
+      muteLogger
     );
 
     const index_js_ExistsBeforeBuild = await fs.pathExists(

packages/backfill/src/__tests__/helper.ts

@@ -1,7 +1,7 @@
 import path from "path";
 import findUp from "find-up";
 
-export async function findPathToBackfill() {
+export async function findPathToBackfill(): Promise<string> {
   const commandPath = await findUp(path.join("bin", "backfill.js"), {
     cwd: __dirname,
   });

packages/backfill/src/api.ts

@@ -86,8 +86,7 @@ export async function fetch(
     cwd,
     incrementalCaching
   );
-  const fetch = await cacheStorage.fetch(hash);
-  return fetch;
+  return await cacheStorage.fetch(hash);
 }
 
 export async function put(

packages/backfill/src/audit.ts

@@ -37,7 +37,7 @@ export function initializeWatcher(
   logFolder: string,
   outputGlob: string[],
   logger: Logger
-) {
+): void {
   // Trying to find the git root and using it as an approximation of code boundary
   const repositoryRoot = getGitRepositoryRoot(packageRoot);
 
@@ -95,7 +95,7 @@ async function delay(time: number) {
   });
 }
 
-export async function closeWatcher(logger: Logger) {
+export async function closeWatcher(logger: Logger): Promise<void> {
   // Wait for one second before closing, giving time for file changes to propagate
   await delay(1000);
 

packages/cache/package.json

@@ -10,8 +10,7 @@
   },
   "main": "lib/index.js",
   "scripts": {
-    "build": "yarn compile",
-    "compile": "tsc -b",
+    "build": "tsc -b --pretty",
     "test": "jest",
     "watch": "tsc -b -w"
   },
@@ -26,7 +25,7 @@
     "tar-fs": "^2.1.0"
   },
   "devDependencies": {
-    "@types/fs-extra": "^9.0.13",
+    "@types/fs-extra": "^8.0.0",
     "@types/jest": "^30.0.0",
     "@types/node": "^14.18.36",
     "@types/tar-fs": "^2.0.1",

packages/cache/src/NpmCacheStorage.ts

@@ -86,7 +86,7 @@ export class NpmCacheStorage extends CacheStorage {
     return true;
   }
 
-  protected async _put(hash: string, filesToCache: string[]) {
+  protected async _put(hash: string, filesToCache: string[]): Promise<void> {
     const { npmPackageName, registryUrl, npmrcUserconfig } = this.options;
 
     const temporaryNpmOutputFolder = path.resolve(

packages/cache/src/__tests__/LocalCacheStorage.test.ts

@@ -5,7 +5,7 @@ import { makeLogger } from "backfill-logger";
 import { setupFixture } from "backfill-utils-test";
 import { CacheStorageConfig } from "backfill-config";
 
-import { getCacheStorageProvider } from "../index";
+import { getCacheStorageProvider } from "../getCacheStorageProvider";
 
 const setupCacheStorage = async (fixtureName: string) => {
   const fixtureLocation = await setupFixture(fixtureName);

packages/cache/src/__tests__/getCacheStorageProvider.test.ts

@@ -1,5 +1,6 @@
 import { Logger, makeLogger } from "backfill-logger";
-import { getCacheStorageProvider, ICacheStorage } from "..";
+import { getCacheStorageProvider } from "../getCacheStorageProvider";
+import type { ICacheStorage } from "../CacheStorage";
 import { AzureBlobCacheStorage } from "../AzureBlobCacheStorage";
 import { LocalCacheStorage } from "../LocalCacheStorage";