@codedrifters/configulator 0.0.174 → 0.0.176

package/lib/index.mjs

@@ -271,12 +271,16 @@ var awsCdkBundle = {
         "## Filename / Class Name Matching",
         "",
         "- Kebab-case filenames must mirror PascalCase class names (e.g., `my-construct.ts` \u2192 `MyConstruct`)",
+        "- Name props interfaces `ClassNameProps` (e.g., `MyConstructProps`)",
         "- One primary construct per file; supporting types (props interface, enums) live in the same file",
         "- Test files follow the same pattern: `my-construct.spec.ts`",
+        "- When renaming, prefer renaming the class to match the filename",
         "",
         "## Cross-Stack Lookup Patterns",
         "",
-        "- Lookups live on **service classes**, not component/construct classes",
+        "- Lookups live on **service classes**, not component/construct classes \u2014 do not add `fromConstruct()` or similar lookup methods to component classes",
+        "- Use `*.of(this)` for stack or service references where the pattern exists in the codebase",
+        "- Within services, prefer creating resources in protected methods; expose retrieval via static methods on the owning service",
         "- Use static methods for cross-stack lookups so consumers don't need an instance:",
         "",
         "```typescript",
@@ -302,6 +306,11 @@ var awsCdkBundle = {
         "- Use SSM parameters for cross-stack references when needed",
         "- Do not pass values between stacks; use SSM parameters instead",
         "",
+        "## Lambda Handlers (NodejsFunction)",
+        "",
+        "- When adding a `NodejsFunction` with a bundled handler, ensure the `entry` path is explicitly configured",
+        "- Verify the entry is included in the build tool config (e.g., tsup entry list) so the runtime can find the handler",
+        "",
         "## CDK Testing",
         "",
         "- Mock `Code.fromAsset` in any test file that synthesizes CDK stacks",
@@ -463,12 +472,31 @@ var baseBundle = {
     },
     {
       name: "cursor-projen-restrictions",
-      description: "Cursor must not run projen or package-manager install commands",
+      description: "Cursor must not run projen, build, test, or package-manager commands",
       scope: AGENT_RULE_SCOPE.ALWAYS,
       content: [
-        "# Projen Restrictions",
+        "# Projen & Development Command Restrictions",
+        "",
+        "**Never** run any of the following commands. Instead, tell the user which commands to run and why.",
+        "",
+        "## Prohibited Commands",
+        "",
+        "- `npx projen` \u2014 synthesize project files",
+        "- `pnpm install` / `pnpm i` \u2014 install dependencies",
+        "- `pnpm build` / `pnpm build:all` \u2014 build the project",
+        "- `pnpm test` / `pnpm --filter ... test` \u2014 run tests",
+        "- `pnpm eslint` / `pnpm --filter ... eslint` \u2014 run linting",
+        "- `pnpm compile` / `pnpm --filter ... compile` \u2014 compile packages",
+        "- `pnpm reset` / `pnpm reset:all` \u2014 reset build artifacts",
+        "- Any `vitest`, `tsup`, `rollup`, or `turbo` commands",
+        "",
+        "## What to Do Instead",
+        "",
+        "After making changes that need validation, tell the user the specific commands to run:",
         "",
-        "- **Do not run `npx projen`, `pnpm install`, or `pnpm i`** \u2014 after modifying Projen configuration, the user should run these commands locally."
+        "1. **After projen config changes** \u2014 tell the user to run `npx projen && pnpm install`",
+        "2. **After source code changes** \u2014 tell the user to run `pnpm --filter @codedrifters/<package> test`",
+        "3. **After multi-package changes** \u2014 tell the user to run `pnpm build:all`"
       ].join("\n"),
       platforms: {
         claude: { exclude: true }
@@ -522,7 +550,7 @@ var baseBundle = {
         "## Code Formatting",
         "",
         "- Use **Prettier** for formatting (runs automatically on save in VS Code)",
-        "- Always use curly braces for control flow, even single-line statements",
+        "- Always use curly braces for control flow, even single-line statements; use multi-line format for complex conditionals",
         "- Prefer `const` over `let`; avoid `var`",
         "- Use trailing commas in multi-line objects/arrays",
         "",
@@ -536,13 +564,15 @@ var baseBundle = {
         "",
         "## Import Conventions",
         "",
-        "- **Always use ES modules** (`import`/`export`), never `require()`",
+        "- **Always use ES modules** (`import`/`export`), never `require()` (exception: `.projenrc.ts` files where `require` is allowed)",
         "- Import order:",
         "  1. Built-in Node.js modules (e.g., `node:path`, `node:fs`)",
         "  2. External dependencies (alphabetically sorted)",
         "  3. Internal imports (relative paths)",
         "- Group imports with blank lines between groups",
         "- Alphabetize imports within each group (case-insensitive)",
+        "- Use absolute imports from package root when possible",
+        "- Avoid duplicate imports (`import/no-duplicates`); all imports must be resolvable (`import/no-unresolved`)",
         "",
         "## Error Handling",
         "",
@@ -774,13 +804,15 @@ var githubWorkflowBundle = {
         "",
         "When the user says **open a PR** (or similar), follow these steps exactly:",
         "",
-        "1. **Check for uncommitted changes** \u2014 if any exist, commit them with a conventional commit message",
-        "2. **Pull and rebase from the default branch** \u2014 run `git pull origin {{repository.defaultBranch}} --rebase` to incorporate the latest changes and resolve any conflicts before pushing",
-        "3. **Push the branch** to origin: `git push -u origin <branch>`",
-        "4. **Create the PR** using `gh pr create`:",
+        "1. **Regenerate project files** \u2014 run `npx projen` then `pnpm install` to ensure all generated files are up to date. Check `git diff` \u2014 if there are changes, commit them before proceeding.",
+        "2. **Run the full monorepo build** \u2014 run `pnpm build:all` to compile, lint, and test all packages (mirrors the CI pipeline). This command requires the user to be authenticated to AWS on the prod account used for Turborepo remote caching (`readonlyaccess-prod-525259625215-us-east-1` profile). If the command fails due to AWS credentials, ask the user to authenticate first. If the build produces changes to turbo inputs (typically snapshot files or ESLint auto-fixes), commit those changes and run `pnpm build:all` again \u2014 the build must complete cleanly with no uncommitted changes.",
+        "3. **Check for uncommitted changes** \u2014 if any exist, commit them with a conventional commit message",
+        "4. **Pull and rebase from the default branch** \u2014 run `git pull origin {{repository.defaultBranch}} --rebase` to incorporate the latest changes and resolve any conflicts before pushing",
+        "5. **Push the branch** to origin: `git push -u origin <branch>`",
+        "6. **Create the PR** using `gh pr create`:",
         "   - **Title**: use a conventional commit style title (e.g., `feat(scope): short description`)",
         "   - **Body**: include `Closes #<issue-number>` (derived from the branch name) and a brief summary of changes",
-        "5. **Enable auto-merge with squash** \u2014 use `gh pr merge --auto --squash` with the merge commit message:",
+        "7. **Enable auto-merge with squash** \u2014 use `gh pr merge --auto --squash` with the merge commit message:",
         "",
         "```",
         "gh pr merge --auto --squash --subject '<conventional-commit-title>' --body '<extended-description>'",
@@ -1012,6 +1044,185 @@ var projenBundle = {
   description: "Projen conventions, synthesis workflow, .projenrc.ts patterns",
   appliesWhen: (project) => hasDep(project, "projen"),
   rules: [
+    {
+      name: "development-commands",
+      description: "Projen development commands for building, testing, linting, and validating changes",
+      scope: AGENT_RULE_SCOPE.ALWAYS,
+      content: [
+        "# Development Commands",
+        "",
+        "This project uses Projen to manage configuration and Turborepo to orchestrate builds across the monorepo. Run all commands from the **repository root** unless otherwise noted.",
+        "",
+        "## Synthesizing Projen Configuration",
+        "",
+        "After modifying any file in `projenrc/` or `.projenrc.ts`, regenerate project files:",
+        "",
+        "```sh",
+        "npx projen",
+        "pnpm install",
+        "```",
+        "",
+        "Both steps are required \u2014 `npx projen` regenerates files, `pnpm install` updates the lockfile to match.",
+        "",
+        "## Building",
+        "",
+        "**Full monorepo build** (compile + test + package, all sub-packages via Turborepo):",
+        "",
+        "```sh",
+        "pnpm build:all",
+        "```",
+        "",
+        "**Root project only** (synthesize + compile + lint):",
+        "",
+        "```sh",
+        "pnpm build",
+        "```",
+        "",
+        "**Single sub-package** (compile only):",
+        "",
+        "```sh",
+        "pnpm --filter @codedrifters/<package> compile",
+        "```",
+        "",
+        "Replace `<package>` with `configulator`, `constructs`, or `utils`.",
+        "",
+        "## Testing",
+        "",
+        "**Run tests for a single sub-package:**",
+        "",
+        "```sh",
+        "pnpm --filter @codedrifters/<package> test",
+        "```",
+        "",
+        "This runs ESLint + Vitest for the specified package.",
+        "",
+        "**Run only Vitest (skip lint) in a sub-package:**",
+        "",
+        "```sh",
+        "cd packages/@codedrifters/<package>",
+        "pnpm exec vitest run",
+        "```",
+        "",
+        "**Run a specific test file:**",
+        "",
+        "```sh",
+        "cd packages/@codedrifters/<package>",
+        "pnpm exec vitest run src/path/to/file.test.ts",
+        "```",
+        "",
+        "## Linting",
+        "",
+        "**Lint the root project:**",
+        "",
+        "```sh",
+        "pnpm eslint",
+        "```",
+        "",
+        "**Lint a single sub-package:**",
+        "",
+        "```sh",
+        "pnpm --filter @codedrifters/<package> eslint",
+        "```",
+        "",
+        "## Resetting Build Artifacts",
+        "",
+        "**Reset everything** (all packages + root):",
+        "",
+        "```sh",
+        "pnpm reset:all",
+        "```",
+        "",
+        "**Reset root only:**",
+        "",
+        "```sh",
+        "pnpm reset",
+        "```",
+        "",
+        "## Validating Changes Are Complete",
+        "",
+        "After finishing implementation work, validate that changes are correct by running the appropriate commands depending on what was changed:",
+        "",
+        "1. **Projen config changes** (`projenrc/`, `.projenrc.ts`):",
+        "   - Run `npx projen` then `pnpm install`",
+        "   - Verify no unexpected generated file changes with `git diff`",
+        "",
+        "2. **Source code changes** (in a sub-package):",
+        "   - Compile: `pnpm --filter @codedrifters/<package> compile`",
+        "   - Test: `pnpm --filter @codedrifters/<package> test`",
+        "",
+        "3. **Changes spanning multiple packages**:",
+        "   - Run `pnpm build:all` to validate the full monorepo build",
+        "",
+        "4. **Root-level changes** (projenrc, root config):",
+        "   - Run `pnpm build` to validate root synthesis + compilation + lint",
+        "",
+        "## Command Reference",
+        "",
+        "| Task | Command |",
+        "|------|---------|",
+        "| Synthesize projen | `npx projen` |",
+        "| Install deps | `pnpm install` |",
+        "| Full monorepo build | `pnpm build:all` |",
+        "| Root build only | `pnpm build` |",
+        "| Compile one package | `pnpm --filter @codedrifters/<pkg> compile` |",
+        "| Test one package | `pnpm --filter @codedrifters/<pkg> test` |",
+        "| Lint one package | `pnpm --filter @codedrifters/<pkg> eslint` |",
+        "| Lint root | `pnpm eslint` |",
+        "| Reset all artifacts | `pnpm reset:all` |"
+      ].join("\n"),
+      tags: ["workflow"]
+    },
+    {
+      name: "agent-rules-customization",
+      description: "How to customize agent rules for this repo via the Projen project definition",
+      scope: AGENT_RULE_SCOPE.FILE_PATTERN,
+      filePatterns: [
+        "projenrc/**/*.ts",
+        ".projenrc.ts",
+        ".claude/rules/*.md",
+        ".cursor/rules/*.mdc",
+        "CLAUDE.md"
+      ],
+      content: [
+        "# Customizing Agent Rules",
+        "",
+        "Agent rules for Claude and Cursor are **generated** by configulator's `AgentConfig` component. The generated output files (`.claude/rules/`, `.cursor/rules/`, `CLAUDE.md`) must not be edited directly \u2014 they are overwritten on every `npx projen` run.",
+        "",
+        "## Adding Repo-Specific Rules",
+        "",
+        "Rules that only apply to this repository should be added to the `agentConfig.rules` array in the Projen project definition (`.projenrc.ts` or `projenrc/*.ts`):",
+        "",
+        "```typescript",
+        "agentConfig: {",
+        "  rules: [",
+        "    {",
+        "      name: 'my-repo-rule',",
+        "      description: 'What this rule does',",
+        "      scope: AGENT_RULE_SCOPE.ALWAYS, // or FILE_PATTERN with filePatterns",
+        "      content: '# My Rule\\n\\n- Guideline 1\\n- Guideline 2',",
+        "    },",
+        "  ],",
+        "}",
+        "```",
+        "",
+        "## Extending Existing Bundle Rules",
+        "",
+        "To append repo-specific content to a rule provided by a configulator bundle (without replacing it), use `agentConfig.ruleExtensions`:",
+        "",
+        "```typescript",
+        "agentConfig: {",
+        "  ruleExtensions: {",
+        "    'typescript-conventions': '## Additional Guidelines\\n\\n- My custom guideline',",
+        "  },",
+        "}",
+        "```",
+        "",
+        "## After Any Change",
+        "",
+        "Run `npx projen` then `pnpm install` to regenerate the output files."
+      ].join("\n"),
+      tags: ["workflow"]
+    },
     {
       name: "projen-conventions",
       description: "Projen configuration patterns and best practices",
@@ -1096,6 +1307,46 @@ var projenBundle = {
   ]
 };
 
+// src/agent/bundles/slack.ts
+var slackBundle = {
+  name: "slack",
+  description: "Slack MCP message formatting and best practices",
+  appliesWhen: () => false,
+  rules: [
+    {
+      name: "slack-message-formatting",
+      description: "Format Slack messages with explicit links so bullets and labels render correctly",
+      scope: AGENT_RULE_SCOPE.ALWAYS,
+      content: [
+        "# Slack Message Formatting",
+        "",
+        "When composing or sending messages to Slack (e.g., via Slack MCP tools like `slack_send_message`), use formatting that Slack's mrkdwn parser renders correctly.",
+        "",
+        "## Rules",
+        "",
+        "1. **Use Slack's explicit link syntax** for any link in a message:",
+        "   - Format: `<https://example.com|display text>`",
+        "   - Text outside the angle brackets (bullets, labels) stays separate and won't merge into the link",
+        "",
+        "2. **Do not rely on auto-linkification** when the message has bullets or labels before URLs \u2014 auto-linked URLs can break or merge with surrounding text",
+        "",
+        "3. **Put each list item on its own line** with a newline between items so list structure is clear",
+        "",
+        "4. **Example \u2014 preferred:**",
+        "   ```",
+        "   Status update:",
+        "",
+        "   \u2022 Feature A: <https://github.com/org/repo/pull/1|repo#1>",
+        "   \u2022 Feature B: <https://github.com/org/repo/pull/2|repo#2>",
+        "   ```",
+        "",
+        "5. **Avoid:** Plain URLs immediately after a bullet/label on the same line (e.g., `\u2022 Feature A: https://github.com/...`) when sending via API, as it can render with bullets inside or between links"
+      ].join("\n"),
+      tags: ["workflow"]
+    }
+  ]
+};
+
 // src/turbo/turbo-repo.ts
 import { Component as Component3, FileBase, JsonFile } from "projen/lib";
 import { JobPermission } from "projen/lib/github/workflows-model";
@@ -1676,7 +1927,8 @@ var BUILT_IN_BUNDLES = [
   pnpmBundle,
   awsCdkBundle,
   projenBundle,
-  githubWorkflowBundle
+  githubWorkflowBundle,
+  slackBundle
 ];
 
 // src/projects/project-metadata.ts
@@ -4119,6 +4371,7 @@ export {
   pnpmBundle,
   projenBundle,
   resolveTemplateVariables,
+  slackBundle,
   turborepoBundle,
   typescriptBundle,
   vitestBundle