@codedrifters/configulator 0.0.314 → 0.0.316

package/lib/index.mjs

@@ -27576,16 +27576,32 @@ var _TurboRepo = class _TurboRepo extends Component4 {
       this.globalEnv.push(name);
     }
   }
-  /**
-   * Sets GIT_BRANCH_NAME so root tasks (e.g. build:all) pass the current branch.
-   * Value must be exactly $(...) so Projen's task runtime expands it; the shell
-   * then expands ${GIT_BRANCH_NAME:-$(git rev-parse --abbrev-ref HEAD)}.
-   */
-  activateBranchNameEnvVar() {
-    this.addGlobalEnvVar(
-      "GIT_BRANCH_NAME",
-      '$(echo "${GIT_BRANCH_NAME:-$(git rev-parse --abbrev-ref HEAD)}")'
+  activateBranchNameEnvVar(options) {
+    const value = '$(echo "${GIT_BRANCH_NAME:-$(git rev-parse --abbrev-ref HEAD)}")';
+    if (options === void 0) {
+      this.project.logger.warn(
+        "TurboRepo.activateBranchNameEnvVar() with no arguments is deprecated. It writes GIT_BRANCH_NAME to the root `globalEnv`, which forces every task in the monorepo to miss cache on every branch switch. Pass `{ tasks: [...] }` and name only the tasks that actually consume the branch (e.g. CDK synth/package) to preserve cross-branch cache hits for everything else."
+      );
+      this.addGlobalEnvVar("GIT_BRANCH_NAME", value);
+      return;
+    }
+    const knownTaskNames = this.tasks.map((task) => task.name);
+    const unknown = options.tasks.filter(
+      (name) => !knownTaskNames.includes(name)
     );
+    if (unknown.length > 0) {
+      throw new Error(
+        `TurboRepo.activateBranchNameEnvVar: unknown task name(s) ${JSON.stringify(
+          unknown
+        )}. Known tasks on this TurboRepo: ${JSON.stringify(knownTaskNames)}.`
+      );
+    }
+    for (const name of options.tasks) {
+      const task = this.tasks.find((t) => t.name === name);
+      if (task && !task.env.includes("GIT_BRANCH_NAME")) {
+        task.env.push("GIT_BRANCH_NAME");
+      }
+    }
   }
   preSynthesize() {
     let nextDependsOn = this.project.deps.all.filter((d) => d.version === "workspace:*").map((d) => [d.name, ROOT_TURBO_TASK_NAME].join("#"));
@@ -27619,7 +27635,6 @@ var _TurboRepo = class _TurboRepo extends Component4 {
         ui: this.isRootProject ? this.ui : void 0,
         dangerouslyDisablePackageManagerCheck: this.isRootProject ? this.dangerouslyDisablePackageManagerCheck : void 0,
         cacheDir: this.isRootProject ? this.cacheDir : void 0,
-        daemon: this.isRootProject ? this.daemon : void 0,
         envMode: this.isRootProject ? this.envMode : void 0,
         /**
          * All tasks
@@ -34008,6 +34023,92 @@ var MonorepoProject = class extends TypeScriptAppProject {
   }
 };
 
+// src/typescript/tsdoc-config.ts
+import { Component as Component18, JsonFile as JsonFile6 } from "projen";
+var STANDARD_MODIFIER_TAGS = [
+  "@default",
+  "@defaultValue",
+  "@experimental",
+  "@internal"
+];
+var ALWAYS_ON_SCOPES = ["@codedrifters"];
+var TsdocConfig = class _TsdocConfig extends Component18 {
+  /**
+   * Derive a workspace scope from a scoped package name (`@scope/name`).
+   * Returns `undefined` when the name is unscoped.
+   *
+   * @internal
+   */
+  static scopeFromPackageName(packageName) {
+    if (!packageName || !packageName.startsWith("@")) {
+      return void 0;
+    }
+    const slash = packageName.indexOf("/");
+    if (slash <= 1) {
+      return void 0;
+    }
+    return packageName.slice(0, slash);
+  }
+  constructor(project, options = {}) {
+    super(project);
+    const scopeFromName = _TsdocConfig.scopeFromPackageName(
+      project.package.packageName
+    );
+    const scopeSet = /* @__PURE__ */ new Set([
+      ...ALWAYS_ON_SCOPES,
+      ...scopeFromName ? [scopeFromName] : [],
+      ...options.workspaceScopes ?? []
+    ]);
+    const tagSet = /* @__PURE__ */ new Set([
+      ...STANDARD_MODIFIER_TAGS,
+      ...Array.from(scopeSet),
+      ...options.additionalModifierTags ?? []
+    ]);
+    const tagDefinitions = Array.from(tagSet).sort((a, b) => a.localeCompare(b)).map((tagName) => ({
+      tagName,
+      syntaxKind: "modifier",
+      allowMultiple: true
+    }));
+    new JsonFile6(project, "tsdoc.json", {
+      obj: {
+        $schema: "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
+        tagDefinitions
+      }
+    });
+    project.addPackageIgnore("tsdoc.json");
+  }
+};
+
+// src/typescript/typescript-config.ts
+import { relative as relative7 } from "path";
+import { Component as Component19 } from "projen";
+import { ensureRelativePathStartsWithDot } from "projen/lib/util/path";
+var TypeScriptConfig = class extends Component19 {
+  constructor(project) {
+    super(project);
+    let tsPaths = {};
+    const workspaceDeps = project.deps.all.filter(
+      (d) => d.version === "workspace:*"
+    );
+    workspaceDeps.forEach((dep) => {
+      const subproject = project.root.subprojects.find((p) => p.package.packageName === dep.name);
+      if (!subproject) {
+        throw new Error(`Could not find subproject ${dep.name} in monorepo.`);
+      }
+      tsPaths = {
+        ...tsPaths,
+        [dep.name]: [
+          ensureRelativePathStartsWithDot(
+            relative7(project.outdir, subproject.outdir)
+          )
+        ]
+      };
+    });
+    project.tsconfig?.file.addOverride("compilerOptions.paths", tsPaths);
+    project.tsconfigDev?.file.addOverride("compilerOptions.paths", tsPaths);
+  }
+};
+
 // src/projects/typescript-project.ts
 var TestRunner = {
   JEST: "jest",
@@ -34143,34 +34244,46 @@ var TypeScriptProject = class extends typescript.TypeScriptProject {
     this.eslint?.addRules({
       "tsdoc/syntax": "warn"
     });
-    this.eslint?.addOverride({
-      files: ["src/**/*.ts"],
-      excludedFiles: ["**/*.test.*", "**/*.spec.*", "**/*.generated.ts"],
-      rules: {
-        "jsdoc/require-jsdoc": [
-          "warn",
-          {
-            publicOnly: true,
-            require: {
-              FunctionDeclaration: true,
-              ClassDeclaration: true
-            },
-            contexts: [
-              "ExportNamedDeclaration > FunctionDeclaration",
-              "ExportNamedDeclaration > ClassDeclaration",
-              "ExportNamedDeclaration > VariableDeclaration",
-              "ExportNamedDeclaration > TSInterfaceDeclaration",
-              "ExportNamedDeclaration > TSTypeAliasDeclaration",
-              "ExportNamedDeclaration > TSEnumDeclaration"
-            ],
-            checkConstructors: false,
-            checkGetters: false,
-            checkSetters: false,
-            enableFixer: false
-          }
-        ]
-      }
-    });
+    const requireJsdoc = options.requireJsdoc ?? "off";
+    if (requireJsdoc !== "off") {
+      const publicOnly = requireJsdoc === "public";
+      this.eslint?.addOverride({
+        files: ["src/**/*.ts"],
+        excludedFiles: ["**/*.test.*", "**/*.spec.*", "**/*.generated.ts"],
+        rules: {
+          "jsdoc/require-jsdoc": [
+            "warn",
+            {
+              publicOnly,
+              require: {
+                FunctionDeclaration: true,
+                ClassDeclaration: true
+              },
+              ...publicOnly ? {
+                contexts: [
+                  "ExportNamedDeclaration > FunctionDeclaration",
+                  "ExportNamedDeclaration > ClassDeclaration",
+                  "ExportNamedDeclaration > VariableDeclaration",
+                  "ExportNamedDeclaration > TSInterfaceDeclaration",
+                  "ExportNamedDeclaration > TSTypeAliasDeclaration",
+                  "ExportNamedDeclaration > TSEnumDeclaration"
+                ]
+              } : {},
+              checkConstructors: false,
+              checkGetters: false,
+              checkSetters: false,
+              enableFixer: false
+            }
+          ]
+        }
+      });
+    }
+    if (options.tsdocConfig !== false) {
+      new TsdocConfig(
+        this,
+        typeof options.tsdocConfig === "object" ? options.tsdocConfig : {}
+      );
+    }
     if (options.apiExtractor !== false) {
       new ApiExtractor(
         this,
@@ -34362,12 +34475,12 @@ import { merge as merge4 } from "ts-deepmerge";
 
 // src/workflows/aws-deploy-workflow.ts
 var import_utils11 = __toESM(require_lib());
-import { Component as Component18 } from "projen";
+import { Component as Component20 } from "projen";
 import { BuildWorkflow } from "projen/lib/build";
 import { GitHub as GitHub4, WorkflowSteps as WorkflowSteps2 } from "projen/lib/github";
 import { JobPermission as JobPermission5 } from "projen/lib/github/workflows-model";
 var PROD_DEPLOY_NAME = "prod-deploy";
-var AwsDeployWorkflow = class _AwsDeployWorkflow extends Component18 {
+var AwsDeployWorkflow = class _AwsDeployWorkflow extends Component20 {
   constructor(project, options = {}) {
     super(project);
     this.project = project;
@@ -34631,7 +34744,7 @@ var AwsDeployWorkflow = class _AwsDeployWorkflow extends Component18 {
 };
 
 // src/workflows/aws-teardown-workflow.ts
-import { Component as Component19 } from "projen";
+import { Component as Component21 } from "projen";
 import { GitHub as GitHub5, GithubWorkflow } from "projen/lib/github";
 import { JobPermission as JobPermission6 } from "projen/lib/github/workflows-model";
 var DEFAULT_TEARDOWN_BRANCH_PATTERNS = [
@@ -34653,7 +34766,7 @@ var resolveBranchPatterns = (explicit, targets) => {
   }
   return [...DEFAULT_TEARDOWN_BRANCH_PATTERNS];
 };
-var AwsTeardownWorkflow = class extends Component19 {
+var AwsTeardownWorkflow = class extends Component21 {
   constructor(rootProject, options) {
     super(rootProject);
     this.rootProject = rootProject;
@@ -35470,36 +35583,6 @@ export const collections = {
   docs: defineCollection({ loader: docsLoader(), schema: docsSchema() }),
 };
 `;
-
-// src/typescript/typescript-config.ts
-import { relative as relative7 } from "path";
-import { Component as Component20 } from "projen";
-import { ensureRelativePathStartsWithDot } from "projen/lib/util/path";
-var TypeScriptConfig = class extends Component20 {
-  constructor(project) {
-    super(project);
-    let tsPaths = {};
-    const workspaceDeps = project.deps.all.filter(
-      (d) => d.version === "workspace:*"
-    );
-    workspaceDeps.forEach((dep) => {
-      const subproject = project.root.subprojects.find((p) => p.package.packageName === dep.name);
-      if (!subproject) {
-        throw new Error(`Could not find subproject ${dep.name} in monorepo.`);
-      }
-      tsPaths = {
-        ...tsPaths,
-        [dep.name]: [
-          ensureRelativePathStartsWithDot(
-            relative7(project.outdir, subproject.outdir)
-          )
-        ]
-      };
-    });
-    project.tsconfig?.file.addOverride("compilerOptions.paths", tsPaths);
-    project.tsconfigDev?.file.addOverride("compilerOptions.paths", tsPaths);
-  }
-};
 export {
   AGENT_MODEL,
   AGENT_PLATFORM,
@@ -35612,6 +35695,7 @@ export {
   TIER_AWARE_BUNDLE_NAMES,
   TestRunner,
   TsDocCoverageKind,
+  TsdocConfig,
   TurboRepo,
   TurboRepoTask,
   TypeScriptConfig,