simplified-shopify-cli 0.1.2 → 0.1.4

package/README.md

@@ -17,18 +17,36 @@ Works on macOS, Linux, and Windows. No extra setup for macOS/zsh.
 **PowerShell:** use `npm.cmd` and commands such as `si.cmd` and `sp.cmd`,
 or enable [short commands](#shell-setup).
 
-## 2. Add your store
+## 2. Store Abreviations Mapping
 
-```sh
-sinit -g
-sstores add demo example-store -g
+Personal config is created automatically on install at `~/.sshop.json`.
+
+
+| Command                       | Description                     |
+| ----------------------------- | ------------------------------- |
+| `sstores add <alias> <store>` | Add or update a store alias     |
+| `sstores remove <alias>`      | Remove a store alias            |
+| `sstores .`                   | Edit stores in your config file |
+
+
+Example `~/.sshop.json`:
+
+```jsonc
+{
+  "version": 1,
+  "stores": {
+    "sto": "example-store.myshopify.com",
+    "san": "example-sandbox.myshopify.com"
+  },
+  "defaultStore": "san",
+  "defaults": {
+    "nodelete": true, // keep local files when pulling
+    "themeEditorSync": true // sync Theme Editor changes during dev
+  }
+}
 ```
 
-- `demo`: your chosen store abbreviation.
-- `example-store`: the prefix of your `example-store.myshopify.com` address.
-- Repeat `sstores add` for each store.
 
-`-g` saves settings for all projects. Skip `sinit -g` if already configured.
 
 ## 3. Start working
 
@@ -52,37 +70,43 @@ the remembered store; see [configuration](#configuration).
 ## Command cheat sheet
 
 Run theme commands from your theme project folder. Put quotes around theme names
-with spaces. `<store_abr>` means the short name you configured, such as `demo`.
-
-| Command | What it does |
-| --- | --- |
-| `si <store_abr>` | Select a store |
-| `si` | Show current store and theme |
-| `sl` | List themes |
-| `sd` | Start a development theme |
-| `sd "My Theme"` | Develop a named theme with editor sync |
-| `sp` | Pull the live theme |
-| `sp "My Theme"` | Pull a named theme |
-| `sp -p` | Pull only live template/config JSON |
-| `spl "My Theme"` | Pull named theme template/config JSON |
-| `sp -d` | Pull the development theme |
-| `spa` | Pull live; may delete unmatched local files |
-| `sc` | Check theme code |
-| `sf` | Fix supported code issues |
-| `lo` | Log out of Shopify |
-| `shelp` | Show help |
+with spaces. `<store_abr>` means the short name you configured, such as `san`.
+
+
+| Command          | What it does                                |
+| ---------------- | ------------------------------------------- |
+| `si <store_abr>` | Select a store                              |
+| `si`             | Show current store and theme                |
+| `sl`             | List themes                                 |
+| `sd`             | Start a development theme                   |
+| `sd "My Theme"`  | Develop a named theme with editor sync      |
+| `sp`             | Pull the live theme                         |
+| `sp "My Theme"`  | Pull a named theme                          |
+| `sp -p`          | Pull only live template/config JSON         |
+| `spl "My Theme"` | Pull named theme template/config JSON       |
+| `sp -d`          | Pull the development theme                  |
+| `spa`            | Pull live; may delete unmatched local files |
+| `sc`             | Check theme code                            |
+| `sf`             | Fix supported code issues                   |
+| `lo`             | Log out of Shopify                          |
+| `shelp`          | Show help                                   |
+
+
+
 
 ### Options
 
-| Option | Example | Meaning |
-| --- | --- | --- |
-| `-g` / `--global` | `sinit -g` | Personal config (setup commands) |
-| `-d` / `--development` | `sp -d` | Development theme (`sp`, `spl`, `spa`, `si`) |
-| `-p PORT` / `--port PORT` | `sd -p 9293` | Change the development port |
-| `-p` / `--json-only` | `sp -p` | Pull only template/config JSON |
-| `-j` / `--json` | `sl -j` | JSON output (`sl`, `si`) |
-| `--dry-run` | `sd "My Theme" --dry-run` | Preview without running |
-| `-s` and `-t` | `sd -s demo -t "My Theme"` | Choose store and theme |
+
+| Option                    | Example                    | Meaning                                                            |
+| ------------------------- | -------------------------- | ------------------------------------------------------------------ |
+| `-g` / `--global`         | `sinit -g`                 | Personal config (`sinit`, `simport`; `sstores` defaults to global) |
+| `-d` / `--development`    | `sp -d`                    | Development theme (`sp`, `spl`, `spa`, `si`)                       |
+| `-p PORT` / `--port PORT` | `sd -p 9293`               | Change the development port                                        |
+| `-p` / `--json-only`      | `sp -p`                    | Pull only template/config JSON                                     |
+| `-j` / `--json`           | `sl -j`                    | JSON output (`sl`, `si`)                                           |
+| `--dry-run`               | `sd "My Theme" --dry-run`  | Preview without running                                            |
+| `-s` and `-t`             | `sd -s demo -t "My Theme"` | Choose store and theme                                             |
+
 
 **Before running commands:** `sp` overwrites matching local files; `spa` can also
 delete unmatched files. `sd` uploads and continuously syncs changes to the selected
@@ -90,23 +114,25 @@ remote theme. `sf` changes local code. Use `--dry-run` to check your target firs
 
 ## Manage your stores
 
-| Command | What it does |
-| --- | --- |
-| `sstores` | List store aliases |
-| `sstores add <store_abr> example-store -g` | Add or update an alias |
-| `sstores remove <store_abr> -g` | Remove an alias |
-| `sconfig` | Show settings and config locations |
-| `sinit` | Create a project config |
-| `sinit -g` | Create personal config (never overwrites) |
-| `simport ./base_custom_cli.sh -g` | Import legacy store aliases |
+
+| Command                                 | What it does                              |
+| --------------------------------------- | ----------------------------------------- |
+| `sstores`                               | List store aliases                        |
+| `sstores add <store_abr> example-store` | Add or update an alias                    |
+| `sstores remove <store_abr>`            | Remove an alias                           |
+| `sconfig`                               | Show settings and config locations        |
+| `sstores .`                             | Open your personal stores config          |
+| `sinit`                                 | Create a project config                   |
+| `sinit -g`                              | Create personal config (never overwrites) |
+| `simport ./base_custom_cli.sh -g`       | Import legacy store aliases               |
+
 
 `sinit` creates config. `si` selects a store.
 Keep credentials out of `.sshop.json`. Keep personal project configs out of Git.
 
 ## Shell setup
 
-<details>
-<summary>Windows PowerShell: use commands without .cmd</summary>
+Windows PowerShell: use commands without .cmd
 
 If your PowerShell profile allows scripts, add:
 
@@ -119,10 +145,7 @@ To undo, remove the line and restart PowerShell.
 
 Command Prompt needs no setup. For WSL, install Node and both CLIs inside WSL.
 
-</details>
-
-<details>
-<summary>macOS/zsh or Bash: replace older Shopify aliases</summary>
+macOS/zsh or Bash: replace older Shopify aliases
 
 If old Shopify aliases override these commands, remove them or add this
 after them in your shell profile:
@@ -133,12 +156,9 @@ eval "$(sshop shell)"
 
 Restart your terminal.
 
-</details>
-
 ## Configuration
 
-<details>
-<summary>Optional settings</summary>
+Optional settings
 
 - Personal config: `~/.sshop.json` (macOS/Linux) or `%USERPROFILE%\.sshop.json` (Windows).
 - Project config: `.sshop.json`; overrides personal settings. Omit `-g` to edit it.
@@ -155,9 +175,6 @@ Use `-s STORE` for an unconfigured store prefix.
 Put extra Shopify options after `--`: `sd -- --verbose`.
 Keep store/theme options and `--dry-run` before `--`.
 
-
-</details>
-
 ## Uninstall
 
 ```sh
@@ -166,4 +183,4 @@ npm uninstall -g simplified-shopify-cli
 
 Remove any optional shell profile line too. Your config files are kept.
 
-[MIT License](LICENSE)
+[MIT License](LICENSE)

package/docs/RELEASING.md

@@ -1,3 +1,13 @@
+# Release 0.1.4
+
+README fix: use `jsonc` for the config example so inline default comments preview correctly.
+
+# Release 0.1.3
+
+Store setup improvements: `sstores` defaults to global config, `sstores .` opens the
+personal config file, install creates `~/.sshop.json` automatically, and the
+cheat sheet PDF was regenerated.
+
 # Release 0.1.2
 
 README update
@@ -17,6 +27,9 @@ alias import, dry-run output, development port shorthand (`sd -p`), JSON output
 
 ## Verification
 
+- Regenerate `output/pdf/shopify-command-cheat-sheet.pdf` with
+  `npm run generate:pdf` when command docs change (requires Python 3 and
+  `reportlab`).
 - Node 22/24 CI on macOS, Linux, and Windows checks the installed archive,
   command entry points, real Shopify CLI help, and PowerShell shortcuts.
 - `npm run release:check` checks syntax, runs tests, builds and installs an

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "simplified-shopify-cli",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "description": "Configurable store aliases and shortcuts for Shopify theme development",
   "type": "module",
   "license": "MIT",
@@ -27,6 +27,7 @@
   "files": [
     "bin/",
     "src/",
+    "scripts/postinstall.js",
     "shell/",
     "examples/",
     "docs/",
@@ -35,7 +36,9 @@
   ],
   "scripts": {
     "test": "node --test",
-    "check": "node --check bin/sshop.js && node --check src/cli.js && node --check src/config.js && node --check src/commands.js",
+    "check": "node --check bin/sshop.js && node --check src/cli.js && node --check src/config.js && node --check src/commands.js && node --check scripts/postinstall.js",
+    "postinstall": "node scripts/postinstall.js",
+    "generate:pdf": "python3 scripts/generate-cheat-sheet.py",
     "prepack": "npm run check && npm test",
     "release:check": "npm run check && npm test && node scripts/check-package.js"
   },

package/scripts/postinstall.js

@@ -0,0 +1,11 @@
+#!/usr/bin/env node
+import fs from 'node:fs';
+import os from 'node:os';
+import path from 'node:path';
+import { filename, writeConfig } from '../src/config.js';
+
+const file = path.join(os.homedir(), filename);
+if (!fs.existsSync(file)) {
+  writeConfig(file, { version: 1, stores: {}, defaults: { nodelete: true, themeEditorSync: true } }, { create: true });
+  console.log(`Created ${file}`);
+}

package/src/cli.js

@@ -13,6 +13,7 @@ Usage: sshop [--config FILE] COMMAND [arguments]
   stores                            List merged store aliases
   stores add ALIAS STORE [--global]  Add/update a store in the selected config
   stores remove ALIAS [--global]     Remove a store from the selected config
+  stores . [--global]                Open the stores config file in your editor
   import FILE [--global]             Import literal map_store aliases
   config                            Show effective config and source files
   shell [powershell]                Print shell functions (optional)
@@ -32,7 +33,7 @@ Dev options: --port/-p PORT (example: sd demo -p 9293)
 List/info options: --json/-j (example: sl demo -j)
 Pull options: --live, --development/-d, --json-only/-p
 Info options: --development/-d
-Config writes: --global/-g (init, stores add/remove, import)
+Config writes: --global/-g (init, import; stores add/remove/. default to global)
 Additional Shopify flags go after -- (example: -- --port 9293).
 Select the current store with si STORE; then omit STORE on later theme commands.
 A configured defaultStore overrides the remembered Shopify store. Use si to check.
@@ -43,7 +44,7 @@ Direct commands: sd, sp, sl, si, spl, spa, sc, sf, lo.
 Setup commands: sinit, sstores, sconfig, simport, shelp.
 `;
 
-export async function main(argv) {
+export async function main(argv, { open = openPath } = {}) {
   const args = [...argv];
   let explicit = process.env.SSHOP_CONFIG;
   if (args[0] === '--config') {
@@ -94,13 +95,26 @@ export async function main(argv) {
     }
     console.log(`Saved ${file}`); return 0;
   }
+  if (command === 'stores' && args[0] === '.') {
+    const normalized = args.map(arg => arg === '-g' ? '--global' : arg);
+    const useGlobal = normalized.includes('--global');
+    if (normalized.filter(arg => arg !== '--global' && arg !== '.').length) throw new Error('Usage: sshop stores . [--global]');
+    if (useGlobal && explicit) throw new Error('Choose --global or --config, not both.');
+    const file = explicit ? path.resolve(explicit) : path.join(useGlobal ? os.homedir() : process.cwd(), filename);
+    if (!fs.existsSync(file)) {
+      writeConfig(file, { version: 1, stores: {}, defaults: { nodelete: true, themeEditorSync: true } }, { create: true });
+      console.log(`Created ${file}`);
+    }
+    await open(file);
+    return 0;
+  }
   const loaded = loadConfig({ explicit });
   if (command === 'config') {
     if (args.length) throw new Error('Usage: sshop config');
     console.log(JSON.stringify(loaded, null, 2)); return 0;
   }
   if (command === 'stores') {
-    if (args.length && !(args.length === 1 && args[0] === 'list')) throw new Error('Usage: sshop stores [list|add|remove]');
+    if (args.length && !(args.length === 1 && args[0] === 'list')) throw new Error('Usage: sshop stores [list|add|remove|.]');
     const entries = Object.entries(loaded.config.stores).sort(([a], [b]) => a.localeCompare(b));
     console.log(entries.length ? entries.map(([alias, store]) => `${alias}\t${normalizeStore(store)}`).join('\n') : 'No store aliases yet. Run: sshop stores add demo example-store');
     return 0;
@@ -110,6 +124,17 @@ export async function main(argv) {
   return runShopify(built.args);
 }
 
+export async function openPath(target, { platform = process.platform } = {}) {
+  const opener = platform === 'darwin' ? ['open', target]
+    : platform === 'win32' ? ['cmd', '/c', 'start', '', target]
+    : ['xdg-open', target];
+  return new Promise((resolve, reject) => {
+    const child = spawn(opener[0], opener.slice(1), { stdio: 'ignore', shell: platform === 'win32' });
+    child.once('error', error => reject(new Error(error.code === 'ENOENT' ? `Could not open ${target}. Set EDITOR or open the file manually.` : error.message)));
+    child.once('exit', code => code === 0 ? resolve() : reject(new Error(`Could not open ${target}.`)));
+  });
+}
+
 export async function runShopify(args, { platform = process.platform } = {}) {
   // Use argument arrays, never eval or a shell command string.
   // Windows npm exposes shopify.cmd; invoke the package's JS entry with Node instead.

package/src/entry.js

@@ -1,9 +1,16 @@
 import { main } from './cli.js';
 
+function usesGlobalStoresConfig(command, args) {
+  return command === 'stores' && ['add', 'remove', '.'].includes(args[0]);
+}
+
 export async function runEntry(command, input = process.argv.slice(2)) {
   const args = [...input];
   const global = [];
   if (args[0] === '--config') global.push(...args.splice(0, 2));
+  if (usesGlobalStoresConfig(command, args) && !global.length && !args.some(arg => arg === '-g' || arg === '--global')) {
+    args.push('-g');
+  }
   try {
     process.exitCode = await main([...global, ...(['--help', '-h', '--version'].includes(args[0]) ? args : [command, ...args])]);
   } catch (error) {