climaybe 1.7.2 → 1.8.0

package/README.md

@@ -5,7 +5,7 @@ Shopify CI/CD CLI — scaffolds GitHub Actions workflows, branch strategy, and s
 **Commit linting and AI-assisted commits are available as optional setup steps:**
 
 - **Conventional commit linting:** During `climaybe init`, you can choose to automatically install and configure [commitlint](https://commitlint.js.org/) and [Husky](https://typicode.github.io/husky) to enforce [Conventional Commits](https://www.conventionalcommits.org/) in your theme repository.
-- **Cursor AI commit skill:** You can also opt-in to installing the [Cursor AI commit skill](https://cursor.so/) (`.cursor/skills/commit/SKILL.md`) for AI-assisted, conventional commit message support in your project.
+- **Cursor rules + skills:** You can opt in to installing Electric Maybe’s bundled [Cursor](https://cursor.com/) project rules and agent skills under `.cursor/rules/` and `.cursor/skills/` (Liquid, JS, a11y, commits, changelog, Linear, etc.).
 
 Both options streamline commit message quality and team workflows but are fully optional during setup.
 
@@ -42,12 +42,12 @@ Interactive setup that configures your repo for CI/CD.
 4. Asks whether to enable optional **preview + cleanup** workflows (default: yes)
 5. Asks whether to enable optional **build + Lighthouse** workflows (default: yes)
 6. Asks whether to enable **commitlint + Husky** (enforce [conventional commits](https://www.conventionalcommits.org/) on `git commit`)
-7. Asks whether to add **Cursor commit skill** to the project (`.cursor/skills/commit/SKILL.md`) for AI-assisted conventional commits
+7. Asks whether to install **Cursor rules + skills** (`.cursor/rules/`, `.cursor/skills/`) — Electric Maybe conventions for themes and AI workflows
 8. Based on store count, sets up **single-store** or **multi-store** mode
 9. Writes `package.json` config
 10. Scaffolds GitHub Actions workflows
 11. Creates git branches and store directories (multi-store)
-12. Optionally installs commitlint, Husky, and the Cursor skill
+12. Optionally installs commitlint, Husky, and the Cursor bundle (rules + skills)
 
 ### `climaybe add-store`
 
@@ -109,14 +109,16 @@ Set up **only** commitlint + Husky (conventional commits enforced on `git commit
 npx climaybe setup-commitlint
 ```
 
-### `climaybe add-cursor-skill`
+### `climaybe add-cursor`
 
-Add **only** the Cursor commit skill to this project (`.cursor/skills/commit/SKILL.md`). Use this if you skipped it at init or want to add it later.
+Install Electric Maybe **Cursor rules and skills** into `.cursor/rules/` and `.cursor/skills/`. Use this if you skipped the bundle at init or want to refresh from the version of climaybe you have installed.
 
 ```bash
-npx climaybe add-cursor-skill
+npx climaybe add-cursor
 ```
 
+The previous command name `add-cursor-skill` still works as an alias. Re-running replaces the bundled rule and skill files with the copies shipped by your installed climaybe version (same idea as `update-workflows`).
+
 ## Configuration
 
 The CLI writes config into the `config` field of your `package.json`:
@@ -288,7 +290,7 @@ Add the following secrets to your GitHub repository (or use **GitLab CI/CD varia
 
 - **Branch:** Single default branch `main`. Feature branches open as PRs into `main`.
 - **Versioning:** [SemVer](https://semver.org/). Versions are **bumped automatically** when PRs are merged to `main` using [conventional commits](https://www.conventionalcommits.org/): `fix:` → patch, `feat:` → minor, `BREAKING CHANGE` or `feat!:` → major.
-- **Flow:** Merge to `main` → [Release version](.github/workflows/release-version.yml) runs semantic-release (bumps `package.json`, pushes tag) → tag push triggers [Release](.github/workflows/release.yml) (tests + publish to npm). Requires `NPM_TOKEN` secret for npm publish. Do not create tags manually; only the Release version workflow creates tags so that tag and package version stay in sync.
+- **Flow:** Merge to `main` → [Release version](.github/workflows/release-version.yml) runs semantic-release (bumps `package.json`, publishes to npm, pushes tag). Optional: tag push runs [Verify release tag](.github/workflows/verify-release-tag.yml) for an extra test pass and tag vs `package.json` check (no publish). Prefer [npm Trusted Publisher](https://docs.npmjs.com/trusted-publishers) (workflow file `release-version.yml`) so no long-lived `NPM_TOKEN` is needed for CI; see [CONTRIBUTING.md](CONTRIBUTING.md). Do not create tags manually; only the Release version workflow creates tags so that tag and package version stay in sync.
 - **CI:** Every PR and push to `main` runs tests on Node 20 and 22 ([CI workflow](.github/workflows/ci.yml)).
 
 See [CONTRIBUTING.md](CONTRIBUTING.md) for branch, PR, and conventional-commit details.

package/bin/version.txt

@@ -1 +1 @@
-1.7.2
+1.8.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "climaybe",
-  "version": "1.7.2",
+  "version": "1.8.0",
   "description": "Shopify CI/CD CLI — scaffolds workflows, branch strategy, and store config for single-store and multi-store theme repos",
   "type": "module",
   "bin": {
@@ -29,6 +29,10 @@
   },
   "bugs": "https://github.com/electricmaybe/climaybe/issues",
   "homepage": "https://github.com/electricmaybe/climaybe#readme",
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
   "scripts": {
     "test": "node scripts/run-tests.js 2>&1 | tee test.log",
     "prepare": "husky",
@@ -56,12 +60,7 @@
         }
       ],
       "@semantic-release/release-notes-generator",
-      [
-        "@semantic-release/npm",
-        {
-          "npmPublish": false
-        }
-      ],
+      "@semantic-release/npm",
       [
         "@semantic-release/git",
         {

package/src/commands/add-cursor-skill.js

@@ -1,17 +1,22 @@
 import pc from 'picocolors';
 import { writeConfig } from '../lib/config.js';
-import { scaffoldCursorCommitSkill } from '../lib/commit-tooling.js';
+import { scaffoldCursorBundle } from '../lib/cursor-bundle.js';
 
 /**
- * Add only the Cursor commit skill to this project (.cursor/skills/commit/SKILL.md).
- * Can be run standalone or after init without having chosen Cursor skills at init.
+ * Install Electric Maybe Cursor rules and skills (.cursor/rules, .cursor/skills).
+ * Can be run standalone or after init if Cursor bundle was skipped.
  */
 export async function addCursorSkillCommand() {
-  console.log(pc.bold('\n  climaybe — Add Cursor commit skill\n'));
+  console.log(pc.bold('\n  climaybe — Add Cursor rules + skills\n'));
 
   writeConfig({ cursor_skills: true });
 
-  scaffoldCursorCommitSkill();
-  console.log(pc.green('  Cursor commit skill added to .cursor/skills/commit/SKILL.md'));
-  console.log(pc.dim('  Use "commit" or "group and commit" in Cursor to get conventional-commit assistance.\n'));
+  const ok = scaffoldCursorBundle();
+  if (ok) {
+    console.log(pc.green('  Installed .cursor/rules and .cursor/skills from climaybe bundle.'));
+    console.log(pc.dim('  See .cursor/rules/00-rule-index.mdc for which rules apply when.\n'));
+  } else {
+    console.log(pc.red('  Cursor bundle not found in this climaybe install.'));
+    console.log(pc.dim('  Reinstall climaybe or report an issue.\n'));
+  }
 }

package/src/commands/init.js

@@ -15,7 +15,8 @@ import { readConfig, writeConfig } from '../lib/config.js';
 import { ensureGitRepo, ensureInitialCommit, ensureStagingBranch, createStoreBranches, getSuggestedTagForRelease } from '../lib/git.js';
 import { scaffoldWorkflows } from '../lib/workflows.js';
 import { createStoreDirectories } from '../lib/store-sync.js';
-import { scaffoldCommitlint, scaffoldCursorCommitSkill } from '../lib/commit-tooling.js';
+import { scaffoldCommitlint } from '../lib/commit-tooling.js';
+import { scaffoldCursorBundle } from '../lib/cursor-bundle.js';
 import {
   isGhAvailable,
   hasGitHubRemote,
@@ -87,7 +88,7 @@ async function runInitFlow() {
     includeBuild: enableBuildWorkflows,
   });
 
-  // 7. Optional commitlint + Husky and Cursor commit skill
+  // 7. Optional commitlint + Husky and Cursor rules + skills bundle
   if (enableCommitlint) {
     console.log(pc.dim('  Setting up commitlint + Husky...'));
     if (scaffoldCommitlint()) {
@@ -97,8 +98,12 @@ async function runInitFlow() {
     }
   }
   if (enableCursorSkills) {
-    scaffoldCursorCommitSkill();
-    console.log(pc.green('  Cursor commit skill added to .cursor/skills/commit/SKILL.md'));
+    const cursorOk = scaffoldCursorBundle();
+    if (cursorOk) {
+      console.log(pc.green('  Electric Maybe Cursor rules + skills → .cursor/rules, .cursor/skills'));
+    } else {
+      console.log(pc.yellow('  Cursor bundle not found in package (skipped).'));
+    }
   }
 
   // Done
@@ -117,7 +122,7 @@ async function runInitFlow() {
   console.log(pc.dim(`  Preview workflows: ${enablePreviewWorkflows ? 'enabled' : 'disabled'}`));
   console.log(pc.dim(`  Build workflows: ${enableBuildWorkflows ? 'enabled' : 'disabled'}`));
   console.log(pc.dim(`  commitlint + Husky: ${enableCommitlint ? 'enabled' : 'disabled'}`));
-  console.log(pc.dim(`  Cursor commit skill: ${enableCursorSkills ? 'added' : 'skipped'}`));
+  console.log(pc.dim(`  Cursor rules + skills: ${enableCursorSkills ? 'installed' : 'skipped'}`));
 
   const suggestedTag = getSuggestedTagForRelease();
   const tagLabel = suggestedTag === 'v1.0.0' ? 'Tag your first release' : 'Tag your next release';

package/src/cursor/rules/00-rule-index.mdc

@@ -0,0 +1,24 @@
+---
+description: Index of project rules — read the relevant rule file when performing the listed activities
+globs:
+  - "**/*"
+alwaysApply: true
+---
+# Rule Index
+
+When you perform any of the following, **read and apply** the corresponding rule file from `.cursor/rules/`:
+
+- **Git commits, commit messages** → `commit-rules.mdc`
+- **Accessibility, a11y, focus, WCAG, UI behavior** → `accessibility-rules.mdc`
+- **JavaScript, web components, _scripts/, *.js** → `javascript-standards.mdc`
+- **Tailwind CSS, theme tokens, Liquid/CSS classes, _styles/** → `tailwindcss-rules.mdc`
+- **Liquid syntax and usage** → `liquid.mdc`
+- **Section files (sections/*.liquid)** → `sections.mdc`
+- **Snippets (snippets/*.liquid)** → `snippets.mdc`
+- **Schema definitions (section/layout schemas)** → `schemas.mdc`
+- **Liquid documentation comments** → `liquid-doc-rules.mdc`
+- **JS refactor tasks / current refactoring work** → `js-refactor-tasks.mdc`
+- **Adding or editing Cursor rules** → `cursor-rule-template.mdc`
+- **Overview of global rules and sync** → `global-rules-reference.mdc` (optional)
+
+Use the Read tool to load the relevant rule file when the task matches one of the above. Project overview and this index are always in context; other rules are applied when their scope applies.