climaybe 2.1.0 → 2.2.1

package/README.md

@@ -245,6 +245,19 @@ When enabled, `init` validates required theme files and exits with an error if a
 | `reusable-build.yml` | workflow_call | Runs Node build + Tailwind compile, then commits compiled assets when changed |
 | `create-release.yml` | Push tag `v*` | Builds release archive and creates GitHub Release using `release-notes.md` |
 
+### Optional theme dev kit package
+
+During `climaybe init`, you can enable the Electric Maybe theme dev kit (default: yes). This installs local
+dev scripts/config defaults (`nodemon.json`, `.theme-check.yml`, `.shopifyignore`, `.prettierrc`,
+`.lighthouserc.js`), merges matching `package.json` scripts/dependencies, appends a managed `.gitignore` block,
+and optionally adds `.vscode/tasks.json` (default: yes).
+
+If these files already exist, `init` warns that they will be replaced.
+
+You can install/update this later with:
+
+`climaybe add-dev-kit` (or `climaybe theme add-dev-kit`)
+
 ## Versioning
 
 - **Version format**: Always three-part (e.g. `v3.2.0`). No version in code or PR title; the system infers from tags.

package/bin/version.txt

@@ -1 +1 @@
-2.1.0
+2.2.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "climaybe",
-  "version": "2.1.0",
+  "version": "2.2.1",
   "description": "Shopify CLI — theme CI/CD (workflows, branches, stores) and app repo helpers; also: commitlint and Cursor rules/skills",
   "type": "module",
   "bin": {

package/src/commands/add-dev-kit.js

@@ -0,0 +1,36 @@
+import prompts from 'prompts';
+import pc from 'picocolors';
+import { readConfig, writeConfig } from '../lib/config.js';
+import { getDevKitExistingFiles, scaffoldThemeDevKit } from '../lib/theme-dev-kit.js';
+import { promptVSCodeDevTasks } from '../lib/prompts.js';
+
+export async function addDevKitCommand() {
+  console.log(pc.bold('\n  climaybe — Add theme dev kit\n'));
+
+  const includeVSCodeTasks = await promptVSCodeDevTasks();
+  const existing = getDevKitExistingFiles({ includeVSCodeTasks });
+  if (existing.length > 0) {
+    console.log(pc.yellow('  Some dev kit files already exist and will be replaced:'));
+    for (const path of existing) console.log(pc.yellow(`    - ${path}`));
+    const { ok } = await prompts({
+      type: 'confirm',
+      name: 'ok',
+      message: 'Replace these files?',
+      initial: true,
+    });
+    if (!ok) {
+      console.log(pc.dim('  Cancelled.\n'));
+      return;
+    }
+  }
+
+  const config = readConfig() || {};
+  scaffoldThemeDevKit({
+    includeVSCodeTasks,
+    defaultStoreDomain: config.default_store || '',
+  });
+  writeConfig({ dev_kit: true, vscode_tasks: includeVSCodeTasks });
+
+  console.log(pc.green('  Theme dev kit installed.'));
+  console.log(pc.dim('  Added scripts/configs for local serve/watch/lint and ignore defaults.\n'));
+}

package/src/commands/init.js

@@ -4,6 +4,8 @@ import {
   promptStoreLoop,
   promptPreviewWorkflows,
   promptBuildWorkflows,
+  promptDevKit,
+  promptVSCodeDevTasks,
   promptCommitlint,
   promptCursorSkills,
   promptConfigureCISecrets,
@@ -18,6 +20,7 @@ import { createStoreDirectories } from '../lib/store-sync.js';
 import { scaffoldCommitlint } from '../lib/commit-tooling.js';
 import { scaffoldCursorBundle } from '../lib/cursor-bundle.js';
 import { getMissingBuildWorkflowRequirements, getBuildScriptRelativePath } from '../lib/build-workflows.js';
+import { getDevKitExistingFiles, scaffoldThemeDevKit } from '../lib/theme-dev-kit.js';
 import {
   isGhAvailable,
   hasGitHubRemote,
@@ -43,6 +46,8 @@ async function runInitFlow() {
   const mode = stores.length > 1 ? 'multi' : 'single';
   const enablePreviewWorkflows = await promptPreviewWorkflows();
   const enableBuildWorkflows = await promptBuildWorkflows();
+  const enableDevKit = await promptDevKit();
+  const enableVSCodeTasks = enableDevKit ? await promptVSCodeDevTasks() : false;
   const enableCommitlint = await promptCommitlint();
   const enableCursorSkills = await promptCursorSkills();
 
@@ -69,6 +74,8 @@ async function runInitFlow() {
     default_store: stores[0].domain,
     preview_workflows: enablePreviewWorkflows,
     build_workflows: enableBuildWorkflows,
+    dev_kit: enableDevKit,
+    vscode_tasks: enableVSCodeTasks,
     commitlint: enableCommitlint,
     cursor_skills: enableCursorSkills,
     stores: {},
@@ -122,6 +129,19 @@ async function runInitFlow() {
     }
   }
 
+  if (enableDevKit) {
+    const existing = getDevKitExistingFiles({ includeVSCodeTasks: enableVSCodeTasks });
+    if (existing.length > 0) {
+      console.log(pc.yellow('  Theme dev kit will replace existing files:'));
+      for (const path of existing) console.log(pc.yellow(`    - ${path}`));
+    }
+    scaffoldThemeDevKit({
+      includeVSCodeTasks: enableVSCodeTasks,
+      defaultStoreDomain: stores[0]?.domain || '',
+    });
+    console.log(pc.green('  Theme dev kit installed (scripts/watch/lint + ignore defaults).'));
+  }
+
   // Done
   console.log(pc.bold(pc.green('\n  Setup complete!\n')));
 
@@ -137,6 +157,10 @@ 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(`  Theme dev kit: ${enableDevKit ? 'enabled' : 'disabled'}`));
+  if (enableDevKit) {
+    console.log(pc.dim(`  VS Code tasks: ${enableVSCodeTasks ? 'enabled' : 'disabled'}`));
+  }
   console.log(pc.dim(`  commitlint + Husky: ${enableCommitlint ? 'enabled' : 'disabled'}`));
   console.log(pc.dim(`  Cursor rules + skills: ${enableCursorSkills ? 'installed' : 'skipped'}`));
 

package/src/index.js

@@ -7,6 +7,7 @@ import { updateWorkflowsCommand } from './commands/update-workflows.js';
 import { ensureBranchesCommand } from './commands/ensure-branches.js';
 import { setupCommitlintCommand } from './commands/setup-commitlint.js';
 import { addCursorSkillCommand } from './commands/add-cursor-skill.js';
+import { addDevKitCommand } from './commands/add-dev-kit.js';
 import { appInitCommand } from './commands/app-init.js';
 
 /**
@@ -41,6 +42,11 @@ function registerThemeCommands(cmd) {
     .description('Sync root JSON files back to a store directory')
     .action(syncCommand);
 
+  cmd
+    .command('add-dev-kit')
+    .description('Install/update local theme dev kit files (scripts, lint, ignores, optional VS Code tasks)')
+    .action(addDevKitCommand);
+
   cmd
     .command('update-workflows')
     .description('Refresh GitHub Actions workflows from latest bundled templates')

package/src/lib/prompts.js

@@ -148,6 +148,35 @@ export async function promptBuildWorkflows() {
   return !!enableBuildWorkflows;
 }
 
+/**
+ * Ask whether to scaffold the local theme dev kit files (scripts, lint, ignores, editor tasks).
+ */
+export async function promptDevKit() {
+  const { enableDevKit } = await prompts({
+    type: 'confirm',
+    name: 'enableDevKit',
+    message:
+      'Install Electric Maybe theme dev kit? (local scripts/watch/lint configs, ignores, and optional VS Code tasks)',
+    initial: true,
+  });
+
+  return !!enableDevKit;
+}
+
+/**
+ * Ask whether to scaffold VS Code tasks for local serve/watch.
+ */
+export async function promptVSCodeDevTasks() {
+  const { enableVSCodeTasks } = await prompts({
+    type: 'confirm',
+    name: 'enableVSCodeTasks',
+    message: 'Add VS Code tasks.json to auto-run Shopify + Tailwind local dev tasks?',
+    initial: true,
+  });
+
+  return !!enableVSCodeTasks;
+}
+
 /**
  * Ask whether to set up commitlint + Husky (conventional commits enforced on git commit).
  */

package/src/lib/theme-dev-kit.js

@@ -0,0 +1,199 @@
+import { existsSync, mkdirSync, readFileSync, writeFileSync } from 'node:fs';
+import { join, dirname } from 'node:path';
+import { readPkg, writePkg } from './config.js';
+
+const DEV_KIT_FILES = {
+  'nodemon.json': `{
+  "watch": ["_scripts"],
+  "ext": "js",
+  "exec": "npm run scripts:build --silent",
+  "quiet": true,
+  "no-colours": true,
+  "ignore": ["node_modules/**/*", "assets/**/*", "**/*.min.js"],
+  "delay": "500",
+  "polling": false,
+  "legacyWatch": false,
+  "restartable": "rs"
+}
+`,
+  '.theme-check.yml': `root: .
+
+extends: :nothing
+
+ignore:
+  - node_modules/*
+  - _styles/
+`,
+  '.shopifyignore': `_styles
+_scripts
+.cursorrules
+.config
+.backups
+.github
+.vscode
+node_modules
+.gitignore
+LICENSE
+package.json
+package-lock.json
+yarn-error.log
+yarn.lock
+*.md
+`,
+  '.prettierrc': `{
+  "tabWidth": 2,
+  "useTabs": false,
+  "plugins": ["@shopify/prettier-plugin-liquid"]
+}
+`,
+  '.lighthouserc.js': `module.exports = {
+  ci: {
+    collect: {
+      url: ['http://localhost:9292'],
+      startServerCommand: 'shopify theme serve',
+      startServerReadyPattern: 'Preview your theme',
+      startServerReadyTimeout: 60000,
+    },
+    assert: {
+      assertions: {
+        'categories:performance': ['warn', { minScore: 0.9 }],
+        'categories:accessibility': ['warn', { minScore: 0.9 }],
+        'categories:best-practices': ['warn', { minScore: 0.9 }],
+        'categories:seo': ['warn', { minScore: 0.9 }],
+      },
+    },
+    upload: {
+      target: 'temporary-public-storage',
+    },
+  },
+};
+`,
+};
+
+const VSCODE_TASKS_FILE = '.vscode/tasks.json';
+const VSCODE_TASKS_CONTENT = `{
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "Shopify",
+      "type": "shell",
+      "command": "yarn shopify:serve",
+      "isBackground": true,
+      "presentation": {
+        "echo": true,
+        "reveal": "always",
+        "focus": true,
+        "panel": "new",
+        "group": "develop",
+        "showReuseMessage": false,
+        "clear": true
+      },
+      "problemMatcher": []
+    },
+    {
+      "label": "Tailwind",
+      "type": "shell",
+      "command": "yarn tailwind:watch",
+      "isBackground": true,
+      "presentation": {
+        "echo": true,
+        "reveal": "always",
+        "focus": false,
+        "panel": "new",
+        "group": "develop",
+        "showReuseMessage": false,
+        "clear": true
+      },
+      "problemMatcher": []
+    },
+    {
+      "label": "Run Both Consoles",
+      "dependsOn": ["Shopify", "Tailwind"],
+      "runOptions": {
+        "runOn": "folderOpen"
+      }
+    }
+  ]
+}
+`;
+
+const GITIGNORE_BLOCK = `# climaybe: theme dev kit (managed)
+.vscode
+assets/style.css
+assets/index.js
+.shopify
+.vercel
+`;
+
+const PACKAGE_MERGES = {
+  scripts: {
+    'shopify:serve': 'shopify theme dev --theme-editor-sync --store=$npm_package_config_store',
+    'shopify:populate': 'shopify populate --store=$npm_package_config_store',
+    'scripts:build': 'node build-scripts.js',
+    'scripts:watch': 'nodemon',
+    'tailwind:watch':
+      `concurrently --kill-others --max-restarts 3 "NODE_ENV=production NODE_OPTIONS='--max-old-space-size=512' ` +
+      `npx @tailwindcss/cli -i _styles/main.css -o assets/style.css --watch" "NODE_OPTIONS='--max-old-space-size=256' ` +
+      `npm run scripts:watch" "npx -y @shopify/dev-mcp@latest"`,
+    'tailwind:build': 'NODE_ENV=production npx @tailwindcss/cli -i _styles/main.css -o assets/style.css --minify && npm run scripts:build',
+    'lint:liquid': 'shopify theme check',
+    'lint:js': 'eslint ./assets/*.js --config .config/eslint.config.mjs',
+    'lint:css': 'node_modules/.bin/stylelint ./assets/*.css --config .config/.stylelintrc.json',
+    release: 'node .sys/scripts/release.js',
+  },
+  devDependencies: {
+    '@shopify/prettier-plugin-liquid': '^1.6.3',
+    '@tailwindcss/cli': '^4.1.17',
+    concurrently: '^8.2.2',
+    nodemon: '^3.0.2',
+    prettier: '^3.4.2',
+    stylelint: '^16.9.0',
+    eslint: '^9.11.0',
+  },
+};
+
+function ensureParent(path) {
+  mkdirSync(dirname(path), { recursive: true });
+}
+
+function mergeGitignore(cwd = process.cwd()) {
+  const path = join(cwd, '.gitignore');
+  if (!existsSync(path)) {
+    writeFileSync(path, GITIGNORE_BLOCK, 'utf-8');
+    return;
+  }
+  const current = readFileSync(path, 'utf-8');
+  if (current.includes('# climaybe: theme dev kit (managed)')) return;
+  const next = `${current.trimEnd()}\n\n${GITIGNORE_BLOCK}`;
+  writeFileSync(path, `${next}\n`, 'utf-8');
+}
+
+function mergePackageJson(defaultStoreDomain = '', cwd = process.cwd()) {
+  const pkg = readPkg(cwd) || { name: 'shopify-theme', version: '1.0.0', private: true };
+  pkg.config = { ...(pkg.config || {}) };
+  if (!pkg.config.store && defaultStoreDomain) pkg.config.store = defaultStoreDomain;
+  pkg.scripts = { ...(pkg.scripts || {}), ...PACKAGE_MERGES.scripts };
+  pkg.devDependencies = { ...(pkg.devDependencies || {}), ...PACKAGE_MERGES.devDependencies };
+  writePkg(pkg, cwd);
+}
+
+export function getDevKitExistingFiles({ includeVSCodeTasks = true, cwd = process.cwd() } = {}) {
+  const paths = Object.keys(DEV_KIT_FILES);
+  if (includeVSCodeTasks) paths.push(VSCODE_TASKS_FILE);
+  return paths.filter((p) => existsSync(join(cwd, p)));
+}
+
+export function scaffoldThemeDevKit({ includeVSCodeTasks = true, defaultStoreDomain = '', cwd = process.cwd() } = {}) {
+  for (const [rel, content] of Object.entries(DEV_KIT_FILES)) {
+    const dest = join(cwd, rel);
+    ensureParent(dest);
+    writeFileSync(dest, content, 'utf-8');
+  }
+  if (includeVSCodeTasks) {
+    const dest = join(cwd, VSCODE_TASKS_FILE);
+    ensureParent(dest);
+    writeFileSync(dest, VSCODE_TASKS_CONTENT, 'utf-8');
+  }
+  mergeGitignore(cwd);
+  mergePackageJson(defaultStoreDomain, cwd);
+}

package/src/workflows/build/build-scripts.js

@@ -1,5 +1,6 @@
 const fs = require('fs');
 const path = require('path');
+const ROOT_DIR = process.cwd();
 
 function extractImports(content) {
   const importRegex = /import\s+['"]([^'"]+)['"];?/g;
@@ -20,7 +21,7 @@ function processScriptFile(filePath, processedFiles = new Set()) {
 
   processedFiles.add(filePath);
 
-  const fullPath = path.join(__dirname, '_scripts', filePath);
+  const fullPath = path.join(ROOT_DIR, '_scripts', filePath);
 
   if (!fs.existsSync(fullPath)) {
     console.warn(`Warning: File ${filePath} not found`);
@@ -51,12 +52,12 @@ function buildScripts() {
   try {
     if (global.gc) global.gc();
 
-    const mainPath = path.join(__dirname, '_scripts', 'main.js');
+    const mainPath = path.join(ROOT_DIR, '_scripts', 'main.js');
     fs.readFileSync(mainPath, 'utf8');
 
     const processedFiles = new Set();
     const finalContent = processScriptFile('main.js', processedFiles);
-    const outputPath = path.join(__dirname, 'assets', 'index.js');
+    const outputPath = path.join(ROOT_DIR, 'assets', 'index.js');
     fs.writeFileSync(outputPath, finalContent.trim() + '\n');
 
     const fileCount = processedFiles.size;

package/src/workflows/build/reusable-build.yml

@@ -47,6 +47,6 @@ jobs:
           if git diff --staged --quiet; then
             echo "No changes to commit"
           else
-            git commit -m "🔧 chore(assets): update compiled javascript and css"
+            git commit -m "chore(assets): update compiled javascript and css"
             git push origin "$BRANCH_NAME"
           fi