@email-kit/cli 0.0.0-stage → 1.0.0

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.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 email-kit contributors
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,3 +1,25 @@
1
- # Temporary Holding Version
1
+ # @email-kit/cli
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ The `email-kit` command: set up a project, compile TSX email templates to HTML and plain text,
4
+ and check them against email-client, accessibility and copy rules.
5
+
6
+ > **1.0.** Stable for transactional email. Not yet: marketing email
7
+ > (unsubscribe links, multi-column layouts), testing in real email clients (classic Outlook
8
+ > especially), and the preview studio. See [what 1.0
9
+ > covers](https://github.com/email-kit/email-kit#status).
10
+
11
+ ```sh
12
+ npx @email-kit/cli init # or: npm create email-kit
13
+ npx email-kit compile # templates → a typed module your server imports
14
+ npx email-kit check # the checks, for CI (exit 1 on errors)
15
+ ```
16
+
17
+ | Command | Does |
18
+ |---|---|
19
+ | `init` | Adds a config, an `email-kit/` folder and a welcome template to the project it runs in. Asks before each change to an existing file; `--yes` for CI |
20
+ | `new <id>` | Adds a template, with messages in every locale |
21
+ | `compile` | Writes HTML, text, JSON Schema and a dependency-free module (`--watch`, `--verbose`) |
22
+ | `check` | Runs the checks on the compiled emails, renders of every fixture, the sources and the theme (`--json`, `--reporter github`) |
23
+ | `tokens` | Prints the theme's colour roles in light and dark with their contrast |
24
+
25
+ Requires Node.js 22.12 or later. MIT licensed; third-party notices in `THIRD_PARTY_NOTICES.md`.
@@ -0,0 +1,83 @@
1
+ # Third-party notices
2
+
3
+ `@email-kit/cli` is MIT licensed (see LICENSE). It includes material from the projects below.
4
+
5
+ ## Unicode CLDR
6
+
7
+ `dist/cli.js` bundles data from the Unicode Common Locale Data Repository (CLDR) 47, through the
8
+ `cldr-core` package: plural rules (`supplemental/plurals.json`), parent locales
9
+ (`supplemental/parentLocales.json`) and likely subtags (`supplemental/likelySubtags.json`). Modules
10
+ that `email-kit compile` generates contain plural-rule functions and locale data derived from it.
11
+
12
+ ```
13
+ UNICODE LICENSE V3
14
+
15
+ COPYRIGHT AND PERMISSION NOTICE
16
+
17
+ Copyright © 2004-2025 Unicode, Inc.
18
+
19
+ NOTICE TO USER: Carefully read the following legal agreement. BY
20
+ DOWNLOADING, INSTALLING, COPYING OR OTHERWISE USING DATA FILES, AND/OR
21
+ SOFTWARE, YOU UNEQUIVOCALLY ACCEPT, AND AGREE TO BE BOUND BY, ALL OF THE
22
+ TERMS AND CONDITIONS OF THIS AGREEMENT. IF YOU DO NOT AGREE, DO NOT
23
+ DOWNLOAD, INSTALL, COPY, DISTRIBUTE OR USE THE DATA FILES OR SOFTWARE.
24
+
25
+ Permission is hereby granted, free of charge, to any person obtaining a
26
+ copy of data files and any associated documentation (the "Data Files") or
27
+ software and any associated documentation (the "Software") to deal in the
28
+ Data Files or Software without restriction, including without limitation
29
+ the rights to use, copy, modify, merge, publish, distribute, and/or sell
30
+ copies of the Data Files or Software, and to permit persons to whom the
31
+ Data Files or Software are furnished to do so, provided that either (a)
32
+ this copyright and permission notice appear with all copies of the Data
33
+ Files or Software, or (b) this copyright and permission notice appear in
34
+ associated Documentation.
35
+
36
+ THE DATA FILES AND SOFTWARE ARE PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
37
+ KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
38
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF
39
+ THIRD PARTY RIGHTS.
40
+
41
+ IN NO EVENT SHALL THE COPYRIGHT HOLDER OR HOLDERS INCLUDED IN THIS NOTICE
42
+ BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL INDIRECT OR CONSEQUENTIAL DAMAGES,
43
+ OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
44
+ WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
45
+ ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THE DATA
46
+ FILES OR SOFTWARE.
47
+
48
+ Except as contained in this notice, the name of a copyright holder shall
49
+ not be used in advertising or otherwise to promote the sale, use or other
50
+ dealings in these Data Files or Software without prior written
51
+ authorization of the copyright holder.
52
+
53
+ SPDX-License-Identifier: Unicode-3.0
54
+ ```
55
+
56
+ ## shadcn/ui
57
+
58
+ The built-in default theme adapts the colour values of shadcn/ui's neutral theme
59
+ (https://github.com/shadcn-ui/ui), and `email-kit` reads shadcn theme files.
60
+
61
+ ```
62
+ MIT License
63
+
64
+ Copyright (c) 2023 shadcn
65
+
66
+ Permission is hereby granted, free of charge, to any person obtaining a copy
67
+ of this software and associated documentation files (the "Software"), to deal
68
+ in the Software without restriction, including without limitation the rights
69
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
70
+ copies of the Software, and to permit persons to whom the Software is
71
+ furnished to do so, subject to the following conditions:
72
+
73
+ The above copyright notice and this permission notice shall be included in all
74
+ copies or substantial portions of the Software.
75
+
76
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
77
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
78
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
79
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
80
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
81
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
82
+ SOFTWARE.
83
+ ```