@emailens/cli 0.3.3 → 0.3.4

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 (2) hide show
  1. package/README.md +34 -2
  2. package/package.json +70 -70
package/README.md CHANGED
@@ -1,6 +1,11 @@
1
1
  # @emailens/cli
2
2
 
3
- CLI tool for email compatibility analysis — preview how HTML emails render across 12 email clients (Gmail, Outlook, Apple Mail, Yahoo, Samsung, Thunderbird, HEY, Superhuman).
3
+ [![npm](https://img.shields.io/npm/v/@emailens/cli)](https://www.npmjs.com/package/@emailens/cli)
4
+ [![MCP](https://img.shields.io/badge/MCP-Server-blue)](https://github.com/emailens/mcp)
5
+
6
+ CLI tool for email compatibility analysis — preview how HTML emails render across 15 email clients (Gmail, Outlook, Apple Mail, Yahoo, Samsung, Thunderbird, HEY, Superhuman).
7
+
8
+ > **Prefer AI?** Use the [MCP server](https://github.com/emailens/mcp) — same engine, works with Claude, Cursor, and any MCP client.
4
9
 
5
10
  ## Install
6
11
 
@@ -113,9 +118,36 @@ src/emails/newsletter.html
113
118
  2 files | 1 error | 1 warning
114
119
  ```
115
120
 
121
+ #### CI / GitHub Actions
122
+
123
+ Drop this into `.github/workflows/email-lint.yml` to fail PRs that introduce broken email CSS, spam triggers, or accessibility regressions:
124
+
125
+ ```yaml
126
+ name: Email lint
127
+
128
+ on:
129
+ pull_request:
130
+ paths:
131
+ - 'emails/**'
132
+ - 'src/emails/**'
133
+
134
+ jobs:
135
+ lint:
136
+ runs-on: ubuntu-latest
137
+ steps:
138
+ - uses: actions/checkout@v4
139
+ - uses: actions/setup-node@v4
140
+ with:
141
+ node-version: 22
142
+ - name: Lint emails
143
+ run: npx -y @emailens/cli lint 'emails/**/*.{html,tsx,mjml}' --fail-on-warning
144
+ ```
145
+
146
+ For React Email / MJML / Maizzle source files, the CLI auto-detects the format from the extension. Want full preview reports (with screenshots and shareable links) on every PR? Use the [Emailens GitHub Action](https://github.com/marketplace/actions/emailens-email-preview-check) instead — it wraps the same engine.
147
+
116
148
  ### `emailens clients`
117
149
 
118
- List all 12 supported email clients.
150
+ List all 15 supported email clients.
119
151
 
120
152
  ```bash
121
153
  emailens clients
package/package.json CHANGED
@@ -1,71 +1,71 @@
1
- {
2
- "name": "@emailens/cli",
3
- "version": "0.3.3",
4
- "description": "CLI tool for email compatibility analysis — analyze, preview, and export email rendering across 12 email clients.",
5
- "type": "module",
6
- "bin": {
7
- "emailens": "./dist/index.js"
8
- },
9
- "exports": {
10
- ".": {
11
- "types": "./dist/index.d.ts",
12
- "import": "./dist/index.js"
13
- }
14
- },
15
- "main": "./dist/index.js",
16
- "types": "./dist/index.d.ts",
17
- "files": [
18
- "dist",
19
- "LICENSE"
20
- ],
21
- "scripts": {
22
- "build": "tsup",
23
- "dev": "tsup --watch",
24
- "start": "bun run dist/index.js",
25
- "typecheck": "tsc --noEmit",
26
- "test": "bun test",
27
- "prepublishOnly": "bun run build"
28
- },
29
- "dependencies": {
30
- "@emailens/engine": "^0.8.6",
31
- "citty": "^0.1.6",
32
- "cli-table3": "^0.6.5",
33
- "ora": "^8.2.0",
34
- "picocolors": "^1.1.1"
35
- },
36
- "optionalDependencies": {
37
- "@anthropic-ai/sdk": "^0.52.0",
38
- "playwright-core": "^1.52.0"
39
- },
40
- "devDependencies": {
41
- "@types/mjml": "^4.7.4",
42
- "@types/node": "^25.3.0",
43
- "bun-types": "^1.3.9",
44
- "tsup": "^8.4.0",
45
- "typescript": "^5.9.3"
46
- },
47
- "keywords": [
48
- "email",
49
- "html-email",
50
- "css",
51
- "compatibility",
52
- "cli",
53
- "gmail",
54
- "outlook",
55
- "apple-mail",
56
- "email-testing",
57
- "dark-mode"
58
- ],
59
- "license": "MIT",
60
- "repository": {
61
- "type": "git",
62
- "url": "git+https://github.com/emailens/cli.git"
63
- },
64
- "engines": {
65
- "node": ">=18"
66
- },
67
- "homepage": "https://github.com/emailens/cli#readme",
68
- "bugs": {
69
- "url": "https://github.com/emailens/cli/issues"
70
- }
1
+ {
2
+ "name": "@emailens/cli",
3
+ "version": "0.3.4",
4
+ "description": "CLI tool for email compatibility analysis — analyze, preview, and export email rendering across 15 email clients.",
5
+ "type": "module",
6
+ "bin": {
7
+ "emailens": "./dist/index.js"
8
+ },
9
+ "exports": {
10
+ ".": {
11
+ "types": "./dist/index.d.ts",
12
+ "import": "./dist/index.js"
13
+ }
14
+ },
15
+ "main": "./dist/index.js",
16
+ "types": "./dist/index.d.ts",
17
+ "files": [
18
+ "dist",
19
+ "LICENSE"
20
+ ],
21
+ "scripts": {
22
+ "build": "tsup",
23
+ "dev": "tsup --watch",
24
+ "start": "bun run dist/index.js",
25
+ "typecheck": "tsc --noEmit",
26
+ "test": "bun test",
27
+ "prepublishOnly": "bun run build"
28
+ },
29
+ "dependencies": {
30
+ "@emailens/engine": "^0.8.6",
31
+ "citty": "^0.1.6",
32
+ "cli-table3": "^0.6.5",
33
+ "ora": "^8.2.0",
34
+ "picocolors": "^1.1.1"
35
+ },
36
+ "optionalDependencies": {
37
+ "@anthropic-ai/sdk": "^0.52.0",
38
+ "playwright-core": "^1.52.0"
39
+ },
40
+ "devDependencies": {
41
+ "@types/mjml": "^4.7.4",
42
+ "@types/node": "^25.3.0",
43
+ "bun-types": "^1.3.9",
44
+ "tsup": "^8.4.0",
45
+ "typescript": "^5.9.3"
46
+ },
47
+ "keywords": [
48
+ "email",
49
+ "html-email",
50
+ "css",
51
+ "compatibility",
52
+ "cli",
53
+ "gmail",
54
+ "outlook",
55
+ "apple-mail",
56
+ "email-testing",
57
+ "dark-mode"
58
+ ],
59
+ "license": "MIT",
60
+ "repository": {
61
+ "type": "git",
62
+ "url": "git+https://github.com/emailens/cli.git"
63
+ },
64
+ "engines": {
65
+ "node": ">=18"
66
+ },
67
+ "homepage": "https://github.com/emailens/cli#readme",
68
+ "bugs": {
69
+ "url": "https://github.com/emailens/cli/issues"
70
+ }
71
71
  }