feat: config refactor (#87)

* feat: internal refactor + configuration revamp

* fix: incorrect path

* feat: scope workspaces to "packages/"

* fix: better feedback for failed integrity check

* fix: add missing await

* fix: changeset formatting

* fix: run checks in parallel

* fix: log integrity check errors

Author: n1ru4l

.changeset/ten-panthers-play.md

@@ -0,0 +1,29 @@
+---
+"bob-the-bundler": major
+---
+
+Remove the global config. Please add `bob: false` to the individual `package.json` workspaces that should not be processed by bob.
+
+This is the new config format for bob.
+
+```ts
+type BobConfig =
+  /** completely disable bob for this package. */
+  | false
+  | {
+      /** Whether the package should be built. */
+      build?:
+        | false
+        | {
+            /** Files to copy from the package root to dist */
+            copy?: Array<string>;
+          };
+      /** Whether the package should be checked. */
+      check?:
+        | false
+        | {
+            /** Exports within the package that should not be checked. */
+            skip?: Array<string>;
+          };
+    };
+```

README.md

@@ -1,85 +1,67 @@
-# Bob (The Bundler)
+# Bob (The ~~Bundler~~ Butler)
 
-There's no documentation yet but you can check [GraphQL Code Generator](https://github.com/dotansimha/graphql-code-generator) repository to see how to use Bob.
+Bob is the TypeScript build, bundle and verification tool used by almost all [The Guild](https://the-guild.dev) open source projects.
+
+Scope:
+
+- **Build**: Build ESM and CommonJS compatible npm packages
+- **Verify**: Ensure all ESM and CommonJS imports within a npm package are usable
+- **Bundle**: Build a single executable for an application (experimental)
 
 ## Requirements
 
-- Supports only scoped packages (same scope)
-- Yarn Workspaces
-- TypeScript with Paths
+- Yarn workspace or single package project
+- TypeScript
 - It's so strict you shouldn't use it!
 
+## Setup
+
+Setting up bob is currently undocumented. You can check [GraphQL Code Generator](https://github.com/dotansimha/graphql-code-generator) repository (or any other The Guild repository).
+
 ## Configuration
 
-Bob only accepts `bob.config.js` in root directory:
+You can add a `bob` key to each `package.json`.
+
+**Disable bob for a single package**
 
 ```js
-module.exports = {
-  scope: "@graphql-codegen", // Scope of organization
-  ignore: ["@graphql-codegen/website", "@graphql-codegen/live-demo"], // ignored packages
-  track: [
-    // files in root that mark the entire workspace as dirty
-    "bob.config.js", // we could include it in Bob itself but we decided to turn your life into hell :)
-    "jest.config.js",
-    "jest-project.js",
-    "package.json",
-    "tsconfig.json",
-    // files in packages that mark the package as dirty
-    "<project>/src/**",
-    "<project>/jest.config.js",
-    "<project>/package.json",
-    "<project>/tsconfig.json",
-  ],
-  base: "origin/master", // we need to compare against something
-  commands: {
-    test: {
-      track: ["<project>/tests/**"],
-      run(affected) {
-        // {
-        //   paths: string[] <- ['packages/core', 'packages/cli']
-        //   names: string[] <- ['@foo/core', '@foo/cli']
-        // }
-
-        // why such a weird syntax? We use spawn, so you have too
-        return [`yarn`, ["test", ...affected.paths]];
-      },
-    },
-    build: {
-      run() {
-        return [`yarn`, ["build"]];
-      },
-    },
-  },
-};
+{
+  "name": "graphql-lfg",
+  "bob": false // exclude a single package from all things bob related
+}
 ```
 
-## Build Options
-
-In your `<project>/package.json`:
+**Disable build for a single package**
 
-```json
+```js
 {
-  "buildOptions": {
-    "external": ["simple-git/promise"], // Marks nested imports as external
-    "bin": {
-      "cli": {
-        "input": "src/cli.ts" // Entry point for `cli` command
-      }
-    }
+  "name": "graphql-lfg",
+  "bob": {
+    "build": false
   }
 }
 ```
 
-## Support for Node ES Modules
+**Disable check for a single package**
 
-In your `<project>/package.json`, just add `"exports"` like this:
+```js
+{
+  "name": "graphql-lfg",
+  "bob": {
+    "check": false
+  }
+}
+```
 
-```json
+**Disable check for a single export in a package**
+
+```js
 {
-  "main": "dist/index.cjs.js",
-  "exports": {
-    "require": "dist/index.cjs.js", // should match "main"
-    "default": "dist/index.mjs" // should ends with ".mjs" extension
+  "name": "graphql-lfg",
+  "bob": {
+    "check": {
+      "skip": ["./foo"]
+    }
   }
 }
 ```
@@ -88,12 +70,10 @@ In your `<project>/package.json`, just add `"exports"` like this:
 
 ```bash
 
-$ bob affected test
-$ bob affected build
-
 $ bob build
-$ bob prepack
+$ bob check
 
+# only use this command if you know the secret sauce
 $ bob runify
 
 ```

package.json

@@ -27,7 +27,6 @@
     "@vercel/ncc": "^0.34.0",
     "builtins": "^5.0.1",
     "consola": "^2.15.3",
-    "cosmiconfig": "^7.0.1",
     "cross-spawn": "^7.0.3",
     "dependency-graph": "^0.11.0",
     "fs-extra": "^10.1.0",

src/command.ts

@@ -1,11 +1,9 @@
 import { CommandModule } from "yargs";
-import { BobConfig } from "./config";
 import { Consola } from "consola";
 
 export { CommandModule as Command };
 
 export interface CommandAPI {
-  config: BobConfig;
   reporter: Consola;
 }
 

src/commands/bootstrap.ts

@@ -1,7 +1,12 @@
 import globby from "globby";
 import pLimit from "p-limit";
+import * as path from "path";
 import * as fse from "fs-extra";
 import { createCommand } from "../command";
+import { buildArtifactDirectories } from "../constants";
+import { getRootPackageJSON } from "../utils/get-root-package-json";
+import { getWorkspaces } from "../utils/get-workspaces";
+import { getWorkspacePackagePaths } from "../utils/get-workspace-package-paths";
 
 /** The default bob fields that should be within a package.json */
 export const presetFields = Object.freeze({
@@ -60,11 +65,11 @@ function transformModuleImports(fileContents: string) {
   );
 }
 
-async function applyESMModuleTransform(distDirs: Array<string>) {
+async function applyESMModuleTransform(cwd: string) {
   const files = await globby("**/*.ts", {
-    cwd: process.cwd(),
+    cwd,
     absolute: true,
-    ignore: ["**/node_modules/**", ...distDirs],
+    ignore: ["**/node_modules/**", ...buildArtifactDirectories],
   });
 
   const limit = pLimit(20);
@@ -89,7 +94,7 @@ async function applyPackageJSONPresetConfig(
 
 const limit = pLimit(20);
 
-export const bootstrapCommand = createCommand<{}, {}>((api) => {
+export const bootstrapCommand = createCommand<{}, {}>(() => {
   return {
     command: "bootstrap",
     describe:
@@ -98,48 +103,35 @@ export const bootstrapCommand = createCommand<{}, {}>((api) => {
       return yargs.options({});
     },
     async handler() {
-      const { config } = api;
-
-      const [rootPackageJSONPath] = await globby("package.json", {
-        cwd: process.cwd(),
-        absolute: true,
-      });
-
-      if (rootPackageJSONPath === undefined) {
-        throw new Error("Must be executed within a (monorepo-)package root.");
-      }
-
-      const rootPackageJSON: Record<string, unknown> = await fse.readJSON(
-        rootPackageJSONPath
-      );
-      const isSinglePackage =
-        Array.isArray(rootPackageJSON.workspaces) === false;
-
-      const distDirs =
-        config.dists?.map(({ distDir }) => `**/${distDir}/**`) ?? [];
+      const cwd = process.cwd();
+      const rootPackageJSON = await getRootPackageJSON(cwd);
+      const workspaces = getWorkspaces(rootPackageJSON);
+      const isSinglePackage = workspaces === null;
 
       // Make sure all modules are converted to ESM
-      await applyESMModuleTransform(distDirs);
 
       if (isSinglePackage) {
+        await applyESMModuleTransform(cwd);
         await applyPackageJSONPresetConfig(
-          rootPackageJSONPath,
+          path.join(cwd, "package.json"),
           rootPackageJSON
         );
         return;
       }
 
-      const packageJSONPaths = await globby("packages/**/package.json", {
-        cwd: process.cwd(),
-        absolute: true,
-        ignore: ["**/node_modules/**", ...distDirs],
-      });
+      const workspacePackagePaths = await getWorkspacePackagePaths(
+        cwd,
+        workspaces
+      );
+
       await Promise.all(
-        packageJSONPaths.map((packageJSONPath) =>
+        workspacePackagePaths.map((packagePath) =>
           limit(async () => {
+            const packageJSONPath = path.join(packagePath, "package.json");
             const packageJSON: Record<string, unknown> = await fse.readJSON(
               packageJSONPath
             );
+            await applyESMModuleTransform(packagePath);
             await applyPackageJSONPresetConfig(packageJSONPath, packageJSON);
           })
         )