Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,11 @@ You can customize the component type, name and folder by providing additional op
- `--name`: Specify the component name.
- `--folder`: Specify the components folder (default is `_components`).

## Tested With

- [Skeleton Theme](https://github.com/Shopify/skeleton-theme)
- [Horizon Theme](https://github.com/Shopify/horizon)
Copy link

Copilot AI Jan 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The GitHub repository URL for "Horizon Theme" appears to reference a repository that may not exist. Shopify's official reference theme is typically "Dawn" (https://github.com/Shopify/dawn). Please verify that this repository exists and is the correct reference.

Suggested change
- [Horizon Theme](https://github.com/Shopify/horizon)
- [Dawn Theme](https://github.com/Shopify/dawn)

Copilot uses AI. Check for mistakes.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image


## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
Expand All @@ -137,7 +142,8 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
- [x] Run the tailwind build process automatically.
- [x] Add Stimulus JS support.
- [x] Create a command to build an example component with all the files.
- [ ] Decompile existing Shopify files into components structure (?).
- [ ] Investigate if it's possible to use import maps instead of a single file for Stimulus controllers.
- [ ] Decompile existing Shopify files into components structure (Is it really needed?).

## Contributing

Expand Down
4 changes: 3 additions & 1 deletion generators/%type%.liquid.tt
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
<h1><%= name %> <%= type %></h1>
<div data-controller="<%= name.parameterize %>">
<h1><%= name %> <%= type %></h1>
</div>
6 changes: 2 additions & 4 deletions generators/controller.js.tt
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
class <%= name.camelize.delete(" ") %>Controller extends Controller {
Stimulus.register("<%= name.parameterize %>", class extends Controller {
connect() {
console.log("Hello, Stimulus!", this.element)
}
}

Stimulus.register("<%= name.parameterize %>", <%= name.camelize.delete(" ") %>Controller)
})
2 changes: 1 addition & 1 deletion generators/index.js.tt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
console.info("Hello from the <%= name %> <%= type %>")
console.log("Hello from the <%= name %> <%= type %>")