Skip to content

Commit e899e0e

Browse files
brandtambrandtam
committed
Initial public release v2.2.3
CLI for contextual development and automated shop management for multi-shop Shopify themes. Features: - Contextual development adapts to branch context - Automated shop syncing with content detection safeguards - Security audit command (multi-shop audit) - 543 comprehensive tests (90.9% branch coverage) - 291 security tests - Complete documentation (25,000+ words) - Cross-platform support (Windows, macOS, Linux)
0 parents  commit e899e0e

101 files changed

Lines changed: 30956 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
name: Bug Report
3+
about: Report a bug or issue with multi-shop CLI
4+
title: '[Bug] '
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
## Bug Description
10+
11+
A clear description of what the bug is.
12+
13+
## Steps to Reproduce
14+
15+
1. Run `pnpm run shop`
16+
2. Select '...'
17+
3. See error
18+
19+
## Expected Behavior
20+
21+
What you expected to happen.
22+
23+
## Actual Behavior
24+
25+
What actually happened (include error messages).
26+
27+
## Environment
28+
29+
- **OS:** [e.g., macOS 14.0, Windows 11, Ubuntu 22.04]
30+
- **Node version:** [e.g., 20.10.0 - run `node --version`]
31+
- **Package version:** [e.g., 2.2.1 - run `npx multi-shop --version`]
32+
- **pnpm version:** [e.g., 9.0.0 - run `pnpm --version`]
33+
- **Shopify CLI version:** [e.g., 3.50.0 - run `shopify version`]
34+
35+
## Configuration
36+
37+
```json
38+
// Your shop config (remove sensitive info):
39+
{
40+
"shopId": "example-shop",
41+
"name": "Example Shop",
42+
...
43+
}
44+
```
45+
46+
## Logs/Output
47+
48+
```
49+
Paste relevant error output or logs here
50+
```
51+
52+
## Additional Context
53+
54+
Add any other context, screenshots, or information about the problem.
55+
56+
**Have you:**
57+
- [ ] Checked existing issues for duplicates?
58+
- [ ] Verified all dependencies are installed? (`pnpm install`)
59+
- [ ] Tried with latest version? (`pnpm add -D @shopdevs/multi-shop-cli@latest`)
60+
- [ ] Run `pnpm run validate` to check for issues?

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
name: 🐛 Bug Report
2+
description: Create a report to help us improve
3+
title: "[Bug]: "
4+
labels: ["bug", "needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to report a bug! Please fill out the information below to help us resolve the issue quickly.
10+
11+
- type: textarea
12+
id: what-happened
13+
attributes:
14+
label: What happened?
15+
description: A clear and concise description of what the bug is.
16+
placeholder: Describe what went wrong...
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: expected
22+
attributes:
23+
label: What did you expect to happen?
24+
description: A clear and concise description of what you expected to happen.
25+
placeholder: Describe what should have happened...
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: steps
31+
attributes:
32+
label: Steps to reproduce
33+
description: Steps to reproduce the behavior
34+
placeholder: |
35+
1. Run command `npm run shop`
36+
2. Select 'Create New Shop'
37+
3. Enter shop details...
38+
4. See error
39+
validations:
40+
required: true
41+
42+
- type: textarea
43+
id: environment
44+
attributes:
45+
label: Environment
46+
description: Please provide your environment details
47+
value: |
48+
- OS: [e.g. macOS 13.1, Windows 11, Ubuntu 22.04]
49+
- Node.js version: [e.g. 18.17.0]
50+
- Package version: [e.g. 1.2.3]
51+
- Shopify CLI version: [e.g. 3.84.0]
52+
- Theme type: [e.g. Dawn, Horizon, Custom]
53+
validations:
54+
required: true
55+
56+
- type: textarea
57+
id: logs
58+
attributes:
59+
label: Error logs
60+
description: Please include any relevant error messages or logs
61+
placeholder: Paste error messages or log output here...
62+
render: shell
63+
64+
- type: textarea
65+
id: config
66+
attributes:
67+
label: Shop configuration (sanitized)
68+
description: Please share your shop configuration with sensitive data removed
69+
placeholder: |
70+
{
71+
"shopId": "my-shop",
72+
"name": "My Shop",
73+
"shopify": {
74+
"stores": {
75+
"production": { "domain": "my-shop.myshopify.com" },
76+
"staging": { "domain": "staging-my-shop.myshopify.com" }
77+
}
78+
}
79+
}
80+
render: json
81+
82+
- type: checkboxes
83+
id: terms
84+
attributes:
85+
label: Security acknowledgment
86+
description: By submitting this issue, you acknowledge that
87+
options:
88+
- label: I have removed any sensitive information (tokens, passwords, domains) from this report
89+
required: true
90+
- label: I understand this is a public repository and this issue will be visible to everyone
91+
required: true

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
name: Feature Request
3+
about: Suggest a new feature or enhancement
4+
title: '[Feature] '
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
## Feature Description
10+
11+
Clear, concise description of the feature you'd like to see.
12+
13+
## Problem This Solves
14+
15+
Explain the problem or pain point this feature would address.
16+
17+
**Example:**
18+
"As a developer managing 10 shops, I want [feature] so that I can [benefit]."
19+
20+
## Proposed Solution
21+
22+
How you envision this working.
23+
24+
```bash
25+
# Example usage:
26+
pnpm run shop → [Your proposed feature]
27+
```
28+
29+
## Alternatives Considered
30+
31+
What other approaches have you thought about?
32+
33+
## Additional Context
34+
35+
- Any examples from other tools?
36+
- Mockups or wireframes?
37+
- Related issues or PRs?
38+
- Would you be willing to contribute this feature?
39+
40+
## Use Case Details
41+
42+
- **Team size:** [e.g., Solo developer, 5-person team]
43+
- **Number of shops:** [e.g., 2, 10, 50+]
44+
- **Workflow type:** [e.g., Feature development, Campaign management]
45+
46+
## Acceptance Criteria
47+
48+
What would make this feature complete?
49+
50+
- [ ] Criterion 1
51+
- [ ] Criterion 2
52+
- [ ] Documentation updated
53+
- [ ] Tests added

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
name: 💡 Feature Request
2+
description: Suggest a new feature or enhancement
3+
title: "[Feature]: "
4+
labels: ["enhancement", "needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for suggesting a new feature! Please provide as much detail as possible to help us understand your needs.
10+
11+
- type: textarea
12+
id: problem
13+
attributes:
14+
label: What problem are you trying to solve?
15+
description: Describe the problem or pain point you're experiencing
16+
placeholder: I'm frustrated when...
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: solution
22+
attributes:
23+
label: What solution would you like?
24+
description: A clear and concise description of what you want to happen
25+
placeholder: I would like to be able to...
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: alternatives
31+
attributes:
32+
label: What alternatives have you considered?
33+
description: Any alternative solutions or features you've considered
34+
placeholder: I've considered...
35+
36+
- type: dropdown
37+
id: feature-area
38+
attributes:
39+
label: Which area does this feature relate to?
40+
multiple: true
41+
options:
42+
- CLI commands and interface
43+
- Shop configuration and management
44+
- Contextual development workflow
45+
- Branch operations and Git integration
46+
- Campaign and promo management
47+
- Testing and quality assurance
48+
- Security and credential management
49+
- Performance and monitoring
50+
- Documentation and examples
51+
- GitHub integration and automation
52+
53+
- type: dropdown
54+
id: priority
55+
attributes:
56+
label: How important is this feature to you?
57+
options:
58+
- Nice to have
59+
- Would be helpful
60+
- Important for my workflow
61+
- Critical for adoption
62+
63+
- type: textarea
64+
id: use-case
65+
attributes:
66+
label: Describe your use case
67+
description: Help us understand how you would use this feature
68+
placeholder: |
69+
I manage 5 Shopify stores and need to...
70+
My team of 10 developers would use this to...
71+
For our e-commerce client, this would enable...
72+
73+
- type: textarea
74+
id: additional-context
75+
attributes:
76+
label: Additional context
77+
description: Add any other context, screenshots, or examples about the feature request
78+
placeholder: Any additional information that might help us understand your needs...

‎.github/pull_request_template.md‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Pull Request
2+
3+
## Description
4+
5+
Brief description of changes and why they're needed.
6+
7+
Fixes # (issue number, if applicable)
8+
9+
## Type of Change
10+
11+
- [ ] Bug fix (non-breaking change fixing an issue)
12+
- [ ] New feature (non-breaking change adding functionality)
13+
- [ ] Breaking change (fix or feature causing existing functionality to change)
14+
- [ ] Documentation update
15+
- [ ] Performance improvement
16+
- [ ] Code refactoring
17+
18+
## How Has This Been Tested?
19+
20+
Describe the tests you ran to verify your changes.
21+
22+
- [ ] Unit tests added/updated
23+
- [ ] Integration tests added/updated
24+
- [ ] Tested on macOS
25+
- [ ] Tested on Linux
26+
- [ ] Tested on Windows
27+
- [ ] Manual testing completed
28+
29+
## Test Results
30+
31+
```bash
32+
# Paste output from:
33+
pnpm test
34+
```
35+
36+
## Checklist
37+
38+
- [ ] My code follows the project's style guidelines
39+
- [ ] I have performed a self-review of my code
40+
- [ ] I have commented my code, particularly in hard-to-understand areas
41+
- [ ] I have made corresponding changes to the documentation
42+
- [ ] My changes generate no new warnings
43+
- [ ] I have added tests that prove my fix is effective or that my feature works
44+
- [ ] New and existing unit tests pass locally with my changes
45+
- [ ] Any dependent changes have been merged and published
46+
47+
## Quality Gates
48+
49+
- [ ] `pnpm run lint` passes (0 errors)
50+
- [ ] `pnpm run typecheck` passes
51+
- [ ] `pnpm test` passes (all tests)
52+
- [ ] `pnpm run build` succeeds
53+
- [ ] `pnpm run validate` passes (full quality check)
54+
55+
## Documentation
56+
57+
- [ ] README.md updated (if user-facing changes)
58+
- [ ] CHANGELOG.md updated in [Unreleased] section
59+
- [ ] API docs updated (if API changes)
60+
- [ ] Examples updated (if workflow changes)
61+
62+
## Breaking Changes
63+
64+
If this PR introduces breaking changes, describe:
65+
66+
- What breaks?
67+
- Migration path for users?
68+
- Updated version (should be MAJOR bump)?
69+
70+
---
71+
72+
**Additional Notes:**
73+
74+
Add any other context, screenshots, or information about the PR.

0 commit comments

Comments
 (0)