@emailshepherd/cli 0.1.26 → 0.1.35

package/templates/AGENTS.md

@@ -1,163 +0,0 @@
-# EmailShepherd Email Design System
-
-This project defines an Email Design System (EDS) for the EmailShepherd platform. An EDS powers the drag-and-drop email builder with reusable components.
-
-## Core Commands
-
-```bash
-# Typecheck - run after any changes
-npm run typecheck
-
-# Validate EDS structure
-npx emailshepherd validate
-
-# Starts a development server with hot reload. Output is accessible in the browser at http://localhost:5173/
-# or dist/index.html to read the output.
-npx emailshepherd dev
-
-# Create a new component (creates via API and generates local files)
-npx emailshepherd create-component --name "component_name" --label "Component Label"
-
-# See all available CLI commands
-npx emailshepherd --help
-```
-
-**Always run `npm run typecheck` and `npx emailshepherd validate` after making changes.**
-
-## Project Structure
-
-```
-src/
-├── eds.ts              # Main EDS configuration (required)
-├── design_tokens.ts    # Global design tokens
-├── custom_styles.ts    # Rich text custom styles
-└── components/
-    └── <component>/
-        ├── template.liquid  # HTML + Liquid template
-        └── index.ts         # Field definitions & config
-```
-
-## Component Anatomy
-
-Each component needs:
-
-- `template.liquid` - HTML with Liquid syntax for field references
-- `index.ts` - Exports label, name, and field definitions
-
-### Template Example
-
-```html
-<table style="background-color: {{bg_color}}">
-  <tr>
-    <td>
-      <p>{{headline}}</p>
-      {% if show_cta %}
-        <a href="{{cta_url}}">{{cta_text}}</a>
-      {% endif %}
-    </td>
-  </tr>
-</table>
-```
-
-### Referencing Fields
-
-| Scope | Syntax |
-|-------|--------|
-| Local field | `{{field_name}}` |
-| Global field (container) | `{{global_fields.field_name}}` |
-| Design token | `{{render_context.design_tokens.colors.primary}}` |
-| Email subject | `{{render_context.email.content.subject}}` |
-| Email preheader | `{{render_context.email.content.preheader}}` |
-
-## Field Types Reference
-
-| Type | Default Value Format | Notes |
-|------|---------------------|-------|
-| `text` | string | Simple text input |
-| `number` | integer or float | Numeric input |
-| `boolean` | `true` or `false` | Toggle switch |
-| `color` | HEX value e.g. `#007bff` | Color picker |
-| `enum` | One of defined options | Dropdown menu |
-| `image` | URL string | Image picker/uploader |
-| `rich_text` | HTML string | WYSIWYG editor |
-| `code` | string | Code editor |
-| `url` | URL string | URL input with preview |
-
-### Field Attributes
-
-Required: `label`, `type`, `liquid-variable`
-
-Optional: `hint`, `visible-if`, `default-value`, validation rules
-
-### Field Visibility
-
-Use `visible-if` with Liquid expressions (without `{% %}` tags):
-
-```
-visible-if: show_image == true
-```
-
-## Container Component
-
-The container is special - it wraps all emails. Its template **must** include:
-
-```html
-{{children}}
-```
-
-Container fields become global fields, referenced as `{{global_fields.your_field}}`.
-
-## Rich Text Styling Classes
-
-When styling rich text output, target these:
-
-| Element | Tag | CSS Class |
-|---------|-----|-----------|
-| Paragraph | `<p>` | `es-paragraph` |
-| Bold | `<strong>` | `es-bold` |
-| Italic | `<em>` | `es-italic` |
-| Bullet list | `<ul>` | `es-bullet-list` |
-| Ordered list | `<ol>` | `es-ordered-list` |
-| List item | `<li>` | `es-list-item` |
-| Link | `<a>` | `es-link` |
-
-## Liquid Tips
-
-```html
-<!-- Filters -->
-{{headline | capitalize}}
-{{price | money}}
-
-<!-- Loops -->
-{% assign items = csv_list | split: ',' %}
-{% for item in items %}
-  <p>{{item}}</p>
-{% endfor %}
-
-<!-- Conditionals -->
-{% if show_image %}
-  <img src="{{image_src}}" />
-{% endif %}
-```
-
-Full Liquid reference: <https://shopify.dev/docs/storefronts/themes/liquid/reference>
-
-## Do
-
-- Check type definitions before defining field metadata
-- Run typecheck and validate after every change
-- Use design tokens for colors, spacing, typography (keeps things consistent)
-- Use `visible-if` to hide irrelevant fields
-- Add validation rules to enforce brand guidelines
-- Use semantic field names that match their liquid variables
-
-## Don't
-
-- Manually create component directories - use `npx emailshepherd create-component` instead (components must exist in the API first)
-- Delete or rename a field's `liquid-variable` (stored values will be lost)
-- Reference fields from other components (each template is isolated - the exception being global fields which are accessible to all components)
-- Hardcode colors/spacing that should be design tokens
-
-## Documentation
-
-Full EDS documentation: <https://emailshepherd.com/docs/articles/email_design_systems/component_builder/>

package/templates/README.md

@@ -1,115 +0,0 @@
-# {{PROJECT_NAME}}
-
-This project lets you edit your EmailShepherd Email Design System locally. You can make changes to your components and templates, preview them in your browser, and then sync your changes back to EmailShepherd.
-
-## Development Environment
-
-This project is written in TypeScript. For this reason we recommend using an IDE that supports TypeScript, such as VSCode, Cursor, or any other IDE that supports TypeScript. This way you will get autocomplete and error highlighting built in to help you avoid making mistakes in your component definitions.
-
-For the best editing experience with `.liquid` files, install the [Shopify Liquid extension](https://marketplace.visualstudio.com/items?itemName=Shopify.theme-check-vscode) for VS Code or Cursor, or any VSCode based IDE. This gives you syntax highlighting and autocomplete for Liquid tags.
-
-## Project Structure
-
-```
-src/
-├── eds.ts                # Main configuration file
-├── design_tokens.ts      # Colors, fonts, spacing, and other design values
-├── custom_styles.ts      # Custom styles for rich text fields
-├── container_component/  # The outer wrapper for all emails
-│   ├── index.ts          # Component settings and field definitions
-│   └── template.liquid   # The HTML template with Liquid tags
-└── components/           # Your email components
-    └── <component-name>/
-        ├── index.ts
-        └── template.liquid
-```
-
-## Getting Started
-
-First, install the project dependencies:
-
-```bash
-npm install
-```
-
-This only needs to be done once, or when dependencies change.
-
-## Previewing Your Changes
-
-To see your EDS in the browser while you work:
-
-```bash
-npx emailshepherd dev
-```
-
-This starts a local development server at <http://localhost:5173>. The page automatically refreshes whenever you save a file, so you can see your changes instantly.
-
-You can also access the fully rendered HTML file in `dist/index.html`. This is useful for uploading to your client preview device testing tool.
-
-## Checking for Errors
-
-Before saving your changes to EmailShepherd, it's a good idea to check for errors:
-
-```bash
-# Check for TypeScript errors (typos, wrong field types, etc.)
-npm run typecheck
-
-# Check that your EDS structure is valid
-npx emailshepherd validate
-```
-
-If either command shows errors, fix them before saving.
-
-## Saving Your Changes
-
-Once you're happy with your changes, you can save them back to EmailShepherd.
-
-To save a single component:
-
-```bash
-npx emailshepherd save-component --by-name "component_name"
-
-# OR
-
-npx emailshepherd save-component --by-id "123"
-```
-
-To save the design tokens and custom styles:
-
-```bash
-npx emailshepherd save-eds
-```
-
-To save everything at once (all components + the design tokens and custom styles):
-
-```bash
-npx emailshepherd save-all
-```
-
-## Creating New Components
-
-To add a new component to your Email Design System, use the CLI:
-
-```bash
-npx emailshepherd create-component --name "component_name" --label "Component Label"
-```
-
-This creates the component in EmailShepherd and generates the local files in `src/components/`. **Do not manually create component directories** - components must be created via the API first.
-
-## CLI
-
-To view all available commands:
-
-```bash
-npx emailshepherd --help
-```
-
-## Automated Deployments (CI/CD)
-
-If you're using GitHub Actions or another CI/CD system, you can automatically save changes when code is pushed to your main branch. Just run `npx emailshepherd save-all` as part of your deployment pipeline.
-
-## Using AI Coding Agents
-
-This project works well with AI coding agents like Claude Code, Cursor, GitHub Copilot, Goose, and others.
-
-Because everything is written in TypeScript, agents get clear type information about your components and fields. When something is wrong, `npm run typecheck` and `npx emailshepherd validate` give agents immediate feedback so they can fix issues themselves. This means you can describe what you want in plain English and let the agent handle the implementation details.

package/templates/claude/CLAUDE.md

@@ -1 +0,0 @@
-see @AGENTS.md in the project root for instructions.

package/templates/claude/settings.local.json

@@ -1,8 +0,0 @@
-{
-  "permissions": {
-    "allow": [
-      "Bash(npm run typecheck:*)",
-      "Bash(npx emailshepherd:*)"
-    ]
-  }
-}

package/templates/gitignore

@@ -1,6 +0,0 @@
-node_modules/
-dist/
-.env
-.DS_Store
-
-.claude/settings.local.json

package/templates/package.json

@@ -1,13 +0,0 @@
-{
-  "name": "{{PROJECT_NAME}}",
-  "version": "1.0.0",
-  "type": "module",
-  "private": true,
-  "scripts": {
-    "typecheck": "tsc --noEmit"
-  },
-  "devDependencies": {
-    "@emailshepherd/cli": "^0.1.0",
-    "typescript": "^5.9.3"
-  }
-}

package/templates/src/vite-env.d.ts

@@ -1,6 +0,0 @@
-/// <reference types="vite/client" />
-
-declare module '*.liquid?raw' {
-  const content: string;
-  export default content;
-}

package/templates/tsconfig.json

@@ -1,12 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ES2022",
-    "module": "ESNext",
-    "moduleResolution": "bundler",
-    "strict": true,
-    "esModuleInterop": true,
-    "skipLibCheck": true,
-    "noEmit": true
-  },
-  "include": ["src/**/*"]
-}