npm - simplified-shopify-cli - Versions diffs - 0.1.0 → 0.1.1 - Mend

simplified-shopify-cli 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (3) hide show

package/README.md CHANGED Viewed

@@ -1,271 +1,162 @@
 # Simplified Shopify CLI
-Short Shopify theme commands with store aliases you configure in a JSON dotfile.
-Installing the package provides **`sd`, `sp`, `sl`, `si`, `spl`, `spa`, `sc`, `sf`,
-and `lo` directly**. The `sshop` command remains available for compatibility.
+Short commands for Shopify themes: `sd` to develop, `sp` to pull, and `sl` to list themes.
-This is the **0.1.0 release**, licensed under MIT, with no runtime
-dependencies. Source: [deanschulz4/Shopify-CLI-Simplified](https://github.com/deanschulz4/Shopify-CLI-Simplified).
+[Download the one-page cheat sheet (PDF)](https://github.com/deanschulz4/Shopify-CLI-Simplified/raw/refs/heads/main/output/pdf/shopify-command-cheat-sheet.pdf)
-Install from npm using the instructions below. See [release notes and verification](docs/RELEASING.md).
+## 1. Install
-## Install
-Requires Node.js 22.12+ and Shopify CLI on your PATH. Authentication remains
-managed by Shopify CLI. Install Shopify CLI if you do not already have it:
-```sh
-npm install -g @shopify/cli
-```
-Install the published package (including zsh on macOS):
+Install **Node.js 22.12 or newer**, then run:
 ```sh
-npm install -g simplified-shopify-cli
-shelp
+npm install -g @shopify/cli simplified-shopify-cli
 ```
-To install from a source checkout instead, run `npm install -g .` from the project directory.
+Works on macOS, Linux, and Windows. No extra setup for macOS/zsh.
-Or try it without a global installation:
+**PowerShell:** use `npm.cmd` and commands such as `si.cmd` and `sp.cmd`,
+or enable [short commands](#shell-setup).
-```sh
-node bin/sshop.js --help
-node bin/sshop.js --config examples/sshop.example.json sd demo "My Theme" --dry-run
-```
-## Configure your stores
-Create a personal config usable from any project:
+## 2. Add your store
 ```sh
-sshop init --global
-sshop stores add demo example-store --global
-sshop stores add sandbox example-sandbox.myshopify.com --global
-sshop stores
-```
-This creates `~/.sshop.json`. For project-specific configuration, run the same
-commands without `--global` from the project root. Example:
-```json
-{
-  "version": 1,
-  "stores": {
-    "demo": "example-store.myshopify.com",
-    "sandbox": "example-sandbox.myshopify.com"
-  },
-  "defaultStore": "sandbox",
-  "defaults": {
-    "nodelete": true,
-    "themeEditorSync": true
-  }
-}
+sinit -g
+sstores add demo example-store -g
 ```
-Store values accept Shopify store prefixes, full `myshopify.com` domains, or
-their HTTPS URLs. Custom storefront domains are not accepted. Config is data;
-it cannot contain shell commands. Keep authentication tokens in Shopify's normal
-authentication flow or environment variables, outside this file.
-### Config precedence
-1. Built-in defaults: preserve unmatched local files during pull; enable Theme Editor sync during dev.
-2. Personal `~/.sshop.json`.
-3. The nearest `.sshop.json`, searching upward from your current directory.
-Project aliases override personal aliases with the same name. Other aliases
-remain available. Set `defaultStore` to `null` to clear an inherited default.
-With no configured default or explicit store, Shopify resolves its own store.
-`sshop --config /path/to/config.json …` or `SSHOP_CONFIG` selects a single isolated
-config instead of merging. An explicit missing config is an error.
-`sshop config` shows the effective settings and exact source files.
+- `demo`: your chosen store abbreviation.
+- `example-store`: the prefix of your `example-store.myshopify.com` address.
+- Repeat `sstores add` for each store.
-Writes always target the current directory, or the personal file with `--global`,
-or the explicitly selected file. They never silently modify an ancestor's config.
-`init` refuses to overwrite an existing file. `stores add` explicitly replaces
-an existing alias; `stores remove ALIAS` removes it only from the selected file.
-Removing a project override can expose the personal alias again.
+`-g` saves settings for all projects. Skip `sinit -g` if already configured.
-Add `.sshop.json` to each theme project's `.gitignore` if it contains personal
-store mappings. This package excludes local configuration and legacy source
-from its distributable archive.
+## 3. Start working
-## Shopify command cheat sheet
+Open your theme project folder in a terminal, then select your store:
-### Rules
-- Run theme commands from your theme project folder.
-- Replace `<store_abr>` with your configured store abbreviation.
-- Select the current store once with `si <store_abr>`. After it succeeds, omit `<store_abr>` in commands such as `sl`, `sd "My Theme"`, `sp -p`, `sp -d`, and `si -j`.
-- Run `si` to check the current store; specify another abbreviation to switch.
-- Store aliases are still required when adding or removing aliases.
-### Flags
+```sh
+si demo
+```
-- `-g` = `--global` for `sinit`, `sstores add/remove`, and `simport`.
-- `-d` = `--development` for `sp`, `spl`, `spa`, and `si`.
-- Both long and short forms work.
+Log in if prompted. Then omit the store abbreviation:
-### Important
+```sh
+sl
+sd "My Theme"
+```
-- A configured `defaultStore` overrides the remembered Shopify store. `si` does not change `defaultStore`; clear it or set it to the intended store.
-- The selected store is not permanently bound to your project.
-- `si --dry-run` does not select a store.
-- `sinit` creates configuration only.
+Use `si` to check the store or `si another-alias` to switch.
+**Check the store when switching projects.** A configured `defaultStore` overrides
+the remembered store; see [configuration](#configuration).
-This follows Shopify's [connecting-to-a-store behavior](https://shopify.dev/docs/storefronts/themes/tools/cli#connecting-to-a-store).
+## Command cheat sheet
-### Commands
+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 the current Shopify store and show theme information; omit `<store_abr>` in later theme commands |
-| `sl` | List all themes |
-| `sd "Theme Name"` or `sd Theme_Name` | Start development on a named theme with editor sync |
-| `sd` | Start development using a Shopify development theme |
-| `sp "Theme Name"` or `sp theme_name` | Pull a named theme; preserve unmatched local files |
-| `sp` | Pull the live theme; preserve unmatched local files |
+| `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 only template/config JSON from a named theme |
-| `spa` | Pull the live theme; may delete unmatched local files |
+| `spl "My Theme"` | Pull named theme template/config JSON |
 | `sp -d` | Pull the development theme |
-| `sc` | Check theme code for issues |
-| `sf` | Automatically fix supported theme issues |
+| `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 |
-### Store aliases and setup
+### Options
-| Command | What it does |
-| --- | --- |
-| `sstores` | List available store aliases |
-| `sstores add <store_abr> example-store -g` | Add/update a personal store alias |
-| `sstores remove <store_abr> -g` | Remove a personal store alias |
-| `sconfig` | Show effective settings and config locations |
-| `sinit` | Create a project-specific config |
-| `sinit -g` | Create a personal config; refuses to overwrite |
-| `simport ./base_custom_cli.sh -g` | Import aliases from the original file |
-| `shelp` | Show command help |
-### Useful options
-| Example | What it does |
-| --- | --- |
-| `sd "My Theme" --dry-run` | Preview the command without running Shopify |
-| `sd -s <store_abr> -t "My Theme"` | Explicitly select store and theme |
-| `sd -p 9293` | Use a different development port |
-| `sl -j` | Return the theme list as JSON |
-| `sd --config "./custom.json"` | Use a specific configuration file |
-### Remember
-- Quotes are required for theme names containing spaces. Use straight quotes (`"`) when copying commands into your terminal.
-- Pull (`sp`) overwrites matching local files. Preserving unmatched files does not prevent existing files from being overwritten.
-- Dev (`sd`) uploads and continuously syncs changes to the selected remote theme.
-- `sd <store_abr> -p 9293` sets the development port; `sp <store_abr> -p` pulls only template/config JSON.
-- `si <store_abr> -j` returns theme information as JSON; `sl <store_abr> -j` returns the theme list as JSON.
-- `sf` modifies local files. Use `--dry-run` to inspect command targeting before running Shopify.
-### Argument handling and compatibility
-All commands above work without an `sshop` prefix. The prefixed equivalents
-remain supported, for example `sshop dev`, `sshop pull`, and `sshop sd`.
-A single positional argument to `sd`/`sp` is a store if it matches a configured
-alias or looks like a URL/domain; otherwise it is a theme. With two positional
-arguments, they mean store and theme. Use `--store` for an unmapped prefix with
-no theme; use `--theme` when a theme name matches an alias.
-Wrapper flags use separate values (`--store demo`, not `--store=demo`). Additional
-Shopify flags go after `--`. Put targeting flags and `--dry-run` before `--`.
-The original `sd -- --port 9293` and `sl -- --json` forms remain supported;
-`--port` and `--json` also work directly. Nodelete/editor-sync defaults are
-configured in the dotfile.
-`--dry-run` prints the command without starting Shopify and redacts password
-values. Arguments are forwarded as an array, without `eval` or shell expansion.
-Normal commands inherit Shopify's interactive terminal and exit code.
-Shopify's live-theme protections remain in place.
+| 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 |
-## Shell setup
+**Before running commands:** `sp` overwrites matching local files; `spa` can also
+delete unmatched files. `sd` uploads and continuously syncs changes to the selected
+remote theme. `sf` changes local code. Use `--dry-run` to check your target first.
-### macOS / Bash / Zsh
+## Manage your stores
-No shell setup is needed for the installed executable commands. If you still load
-old aliases/functions from `base_custom_cli.sh`, they take precedence over
-executables. Remove the old Shopify definitions, or load the compatibility
-functions after the old file using `eval "$(sshop shell)"` in your shell profile.
-Restart the shell. General helpers in the original file are unaffected.
+| 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 |
-### Windows Command Prompt and PowerShell
+`sinit` creates config. `si` selects a store.
+Keep credentials out of `.sshop.json`. Keep personal project configs out of Git.
-Install with `npm.cmd install -g simplified-shopify-cli`. Command Prompt can use `sd`, `sp`, etc.
-In PowerShell, use `sd.cmd`, `sp.cmd`, `sl.cmd`, etc. to avoid conflicts with
-built-in aliases and npm PowerShell script execution policy restrictions:
+## Shell setup
-```powershell
-sinit.cmd --global
-sstores.cmd add demo example-store --global
-sd.cmd demo "My Theme" --dry-run
-```
+<details>
+<summary>Windows PowerShell: use commands without .cmd</summary>
-For exactly `sd`, `sp`, `sl`, etc. in PowerShell, add this one-time setup to your
-PowerShell profile (provided profile scripts are permitted in your environment):
+If your PowerShell profile allows scripts, add:
 ```powershell
 . ([scriptblock]::Create((sshop.cmd shell powershell | Out-String)))
 ```
-It replaces matching PowerShell aliases with functions forwarding to the installed
-`.cmd` commands. This includes `sp`, `sl`, and `si`; their normal PowerShell
-meanings will change in that session. Remove the profile line and restart to
-restore the original behavior. No execution-policy changes are made by this package.
+This replaces PowerShell aliases such as `sp`, `sl`, and `si`.
+To undo, remove the line and restart PowerShell.
-Personal config on Windows is `%USERPROFILE%\.sshop.json`. Shopify CLI must be
-installed globally with npm. In WSL, install Node and both CLIs inside WSL and
-follow the Bash instructions.
+Command Prompt needs no setup. For WSL, install Node and both CLIs inside WSL.
-**Verification:** the [initial CI run](https://github.com/deanschulz4/Shopify-CLI-Simplified/actions/runs/34994515508)
-passed the Node 22/24 matrix on macOS, Linux, and Windows, including installed
-commands, real Shopify CLI help invocation, and Windows PowerShell shortcuts.
-Each subsequent change must pass its own CI run. Live Shopify login/pull/dev
-workflows remain a separate pre-release check.
+</details>
-## Migrate the original file
+<details>
+<summary>macOS/zsh or Bash: replace older Shopify aliases</summary>
+If old Shopify aliases override these commands, remove them or add this
+after them in your shell profile:
 ```sh
-sshop import ./base_custom_cli.sh --global
+eval "$(sshop shell)"
 ```
-Import reads literal entries from `map_store()` without sourcing the shell file.
-Identical duplicate mappings are collapsed; conflicting duplicates or existing
-aliases with different destinations stop the import. Other shell logic is ignored.
-Use a local import first if you want to inspect the result before changing your
-personal config.
+Restart your terminal.
-The original file stays unchanged as a local reference. General terminal,
-Node/nvm, BigCommerce, and NopCommerce helpers remain there; this first package
-focuses on Shopify. The old `sync` helper remains there too: its hard-coded
-`origin/master` merge and checkout behavior needs a separate configurable design.
-It is not installed by this package. The old `fix` permissions alias and `gitfix`
-are also not exported. `clis` is still the ordinary Shopify installation command.
+</details>
-## Development and verification
+## Configuration
-```sh
-npm run release:check
-npm pack
-```
+<details>
+<summary>Optional settings</summary>
+- Personal config: `~/.sshop.json` (macOS/Linux) or `%USERPROFILE%\.sshop.json` (Windows).
+- Project config: `.sshop.json`; overrides personal settings. Omit `-g` to edit it.
+- Run `sconfig` to see your settings.
+Set `defaultStore` to an alias for a fixed store, or `null` to use the remembered
+store. `si` does not change this setting. [Example config](examples/sshop.example.json).
-Tests cover config resolution, migration, argument handling, shell forwarding,
-and subprocess exit codes using a fake Shopify executable. They do not contact
-stores. The CI workflow checks Node 22/24 on macOS, Linux, and Windows and runs
-`npm run release:check` to inspect and install the actual npm archive.
-Native Windows dispatch supports the global npm installation of Shopify CLI.
+Use `sd --config "./custom.json"` to load a specific config file.
-Shopify command behavior follows the official [theme pull](https://shopify.dev/docs/api/shopify-cli/theme/theme-pull)
-and [theme dev](https://shopify.dev/docs/api/shopify-cli/theme/theme-dev) documentation.
+If a theme name matches a store alias, use `-t "Theme Name"`.
+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
@@ -273,9 +164,6 @@ and [theme dev](https://shopify.dev/docs/api/shopify-cli/theme/theme-dev) docume
 npm uninstall -g simplified-shopify-cli
 ```
-Remove the optional shell startup line and restart your shell. Config files stay
-in place for reuse; remove them yourself when no longer needed.
-## License
+Remove any optional shell profile line too. Your config files are kept.
-[MIT](LICENSE). The copyright attribution is public; personal store configuration is excluded from the npm package.
+[MIT License](LICENSE)

package/docs/RELEASING.md CHANGED Viewed

@@ -1,3 +1,9 @@
+# Release 0.1.1
+Documentation update: simpler setup instructions, shorter command descriptions,
+and a downloadable one-page PDF cheat sheet linked from the README.
+CLI behavior is unchanged. The PDF is hosted in the GitHub repository.
 # Release 0.1.0
 Initial release: configurable store aliases, personal/project JSON configuration,

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "simplified-shopify-cli",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Configurable store aliases and shortcuts for Shopify theme development",
   "type": "module",
   "license": "MIT",