@m2s2/cli 0.1.0 → 0.1.14
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/CHANGELOG.md +107 -0
- package/README.md +69 -7
- package/npm-shrinkwrap.json +2 -2
- package/package.json +2 -2
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes to this project will be documented in this file.
|
|
4
|
+
|
|
5
|
+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
6
|
+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
|
+
|
|
8
|
+
## [Unreleased]
|
|
9
|
+
|
|
10
|
+
## [0.1.14](https://github.com/M2S2-Engineering-Group/m2s2-cli/compare/v0.1.13...v0.1.14) - 2026-05-27
|
|
11
|
+
|
|
12
|
+
### Fixed
|
|
13
|
+
|
|
14
|
+
- publish semantics
|
|
15
|
+
|
|
16
|
+
## [0.1.13](https://github.com/M2S2-Engineering-Group/m2s2-cli/compare/v0.1.12...v0.1.13) - 2026-05-27
|
|
17
|
+
|
|
18
|
+
### Fixed
|
|
19
|
+
|
|
20
|
+
- allow dirty flag
|
|
21
|
+
|
|
22
|
+
## [0.1.12](https://github.com/M2S2-Engineering-Group/m2s2-cli/compare/v0.1.11...v0.1.12) - 2026-05-27
|
|
23
|
+
|
|
24
|
+
### Fixed
|
|
25
|
+
|
|
26
|
+
- updates to publish workflows
|
|
27
|
+
|
|
28
|
+
## [0.1.11](https://github.com/M2S2-Engineering-Group/m2s2-cli/compare/v0.1.10...v0.1.11) - 2026-05-27
|
|
29
|
+
|
|
30
|
+
### Fixed
|
|
31
|
+
|
|
32
|
+
- sync template dependencies to latest @m2s2 releases
|
|
33
|
+
|
|
34
|
+
## [0.1.10](https://github.com/M2S2-Engineering-Group/m2s2-cli/compare/v0.1.9...v0.1.10) - 2026-05-22
|
|
35
|
+
|
|
36
|
+
### Fixed
|
|
37
|
+
|
|
38
|
+
- template updates
|
|
39
|
+
- pipeline fix
|
|
40
|
+
|
|
41
|
+
## [0.1.9](https://github.com/M2S2-Engineering-Group/m2s2-cli/compare/v0.1.8...v0.1.9) - 2026-05-21
|
|
42
|
+
|
|
43
|
+
### Added
|
|
44
|
+
|
|
45
|
+
- updated content of templates
|
|
46
|
+
|
|
47
|
+
## [0.1.8](https://github.com/M2S2-Engineering-Group/m2s2-cli/compare/v0.1.7...v0.1.8) - 2026-05-21
|
|
48
|
+
|
|
49
|
+
### Added
|
|
50
|
+
|
|
51
|
+
- update broken workflows before releasing 1.0
|
|
52
|
+
|
|
53
|
+
## [0.1.7](https://github.com/M2S2-Engineering-Group/m2s2-cli/compare/v0.1.6...v0.1.7) - 2026-05-21
|
|
54
|
+
|
|
55
|
+
### Added
|
|
56
|
+
|
|
57
|
+
- autodetect shell and update source script
|
|
58
|
+
|
|
59
|
+
## [0.1.6](https://github.com/M2S2-Engineering-Group/m2s2-cli/compare/v0.1.5...v0.1.6) - 2026-05-20
|
|
60
|
+
|
|
61
|
+
### Added
|
|
62
|
+
|
|
63
|
+
- adding completions
|
|
64
|
+
|
|
65
|
+
## [0.1.5](https://github.com/M2S2-Engineering-Group/m2s2-cli/compare/v0.1.4...v0.1.5) - 2026-05-20
|
|
66
|
+
|
|
67
|
+
### Fixed
|
|
68
|
+
|
|
69
|
+
- deps fix
|
|
70
|
+
|
|
71
|
+
## [0.1.4](https://github.com/M2S2-Engineering-Group/m2s2-cli/compare/v0.1.3...v0.1.4) - 2026-05-20
|
|
72
|
+
|
|
73
|
+
### Added
|
|
74
|
+
|
|
75
|
+
- add vue templates and project creation
|
|
76
|
+
|
|
77
|
+
### Other
|
|
78
|
+
|
|
79
|
+
- formatting 2
|
|
80
|
+
- formatting
|
|
81
|
+
|
|
82
|
+
## [0.1.3](https://github.com/M2S2-Engineering-Group/m2s2-cli/compare/v0.1.2...v0.1.3) - 2026-05-19
|
|
83
|
+
|
|
84
|
+
### Other
|
|
85
|
+
|
|
86
|
+
- new semantic operator for ts
|
|
87
|
+
|
|
88
|
+
## [0.1.2](https://github.com/M2S2-Engineering-Group/m2s2-cli/compare/v0.1.1...v0.1.2) - 2026-05-18
|
|
89
|
+
|
|
90
|
+
### Fixed
|
|
91
|
+
|
|
92
|
+
- typescript dep failure fix
|
|
93
|
+
|
|
94
|
+
### Other
|
|
95
|
+
|
|
96
|
+
- formatting
|
|
97
|
+
|
|
98
|
+
## [0.1.1](https://github.com/M2S2-Engineering-Group/m2s2-cli/compare/v0.1.0...v0.1.1) - 2026-05-18
|
|
99
|
+
|
|
100
|
+
### Fixed
|
|
101
|
+
|
|
102
|
+
- sponsors and fix for dep drift
|
|
103
|
+
|
|
104
|
+
### Other
|
|
105
|
+
|
|
106
|
+
- another format fix
|
|
107
|
+
- formatting
|
package/README.md
CHANGED
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
# m2s2-cli
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
[](https://github.com/sponsors/mgmaster24)
|
|
4
|
+
|
|
5
|
+
The official CLI for scaffolding and working with [M²S²](https://github.com/M2S2-Engineering-Group) design system projects. Create new React, Angular, or Vue applications pre-wired with M²S² components, generate components, and keep your installation up to date — all from the terminal.
|
|
4
6
|
|
|
5
7
|
## Table of Contents
|
|
6
8
|
|
|
@@ -9,6 +11,7 @@ The official CLI for scaffolding and working with [M²S²](https://github.com/M2
|
|
|
9
11
|
- [new](#m2s2-new)
|
|
10
12
|
- [generate component](#m2s2-generate-component)
|
|
11
13
|
- [upgrade](#m2s2-upgrade)
|
|
14
|
+
- [completions](#m2s2-completions)
|
|
12
15
|
- [Building from Source](#building-from-source)
|
|
13
16
|
- [Testing](#testing)
|
|
14
17
|
- [Project Structure](#project-structure)
|
|
@@ -76,7 +79,7 @@ m2s2 new <name> [OPTIONS]
|
|
|
76
79
|
|
|
77
80
|
| Flag | Description |
|
|
78
81
|
|------|-------------|
|
|
79
|
-
| `--framework <react\|angular>` | Framework to scaffold. Prompted interactively if omitted. |
|
|
82
|
+
| `--framework <react\|angular\|vue>` | Framework to scaffold. Prompted interactively if omitted. |
|
|
80
83
|
| `--skip-install` | Skip running `npm install` after writing project files. |
|
|
81
84
|
|
|
82
85
|
**Examples**
|
|
@@ -88,6 +91,7 @@ m2s2 new my-app
|
|
|
88
91
|
# Explicit framework
|
|
89
92
|
m2s2 new my-app --framework react
|
|
90
93
|
m2s2 new my-app --framework angular
|
|
94
|
+
m2s2 new my-app --framework vue
|
|
91
95
|
|
|
92
96
|
# Skip npm install (useful in CI or offline environments)
|
|
93
97
|
m2s2 new my-app --framework react --skip-install
|
|
@@ -129,6 +133,20 @@ my-app/
|
|
|
129
133
|
└── .gitignore
|
|
130
134
|
```
|
|
131
135
|
|
|
136
|
+
*Vue*
|
|
137
|
+
```
|
|
138
|
+
my-app/
|
|
139
|
+
├── src/
|
|
140
|
+
│ ├── main.ts # createApp with @m2s2/vue-lib styles
|
|
141
|
+
│ ├── App.vue # Navbar + Footer wired with M²S² configs
|
|
142
|
+
│ └── App.scss
|
|
143
|
+
├── index.html
|
|
144
|
+
├── package.json # @m2s2/vue-lib, @m2s2/tokens, Vite, TypeScript
|
|
145
|
+
├── vite.config.ts
|
|
146
|
+
├── tsconfig.json
|
|
147
|
+
└── .gitignore
|
|
148
|
+
```
|
|
149
|
+
|
|
132
150
|
---
|
|
133
151
|
|
|
134
152
|
### `m2s2 generate component`
|
|
@@ -151,7 +169,7 @@ Run this command from your project root. The framework is detected automatically
|
|
|
151
169
|
|
|
152
170
|
| Flag | Description |
|
|
153
171
|
|------|-------------|
|
|
154
|
-
| `--framework <react\|angular>` | Override framework detection. |
|
|
172
|
+
| `--framework <react\|angular\|vue>` | Override framework detection. |
|
|
155
173
|
| `--path <dir>` | Override the output directory. A subdirectory named after the component is always created inside `<dir>`. |
|
|
156
174
|
|
|
157
175
|
**Examples**
|
|
@@ -167,7 +185,7 @@ m2s2 generate component hero-section
|
|
|
167
185
|
m2s2 generate component HeroSection --path src/features
|
|
168
186
|
|
|
169
187
|
# Override framework
|
|
170
|
-
m2s2 generate component HeroSection --framework
|
|
188
|
+
m2s2 generate component HeroSection --framework vue
|
|
171
189
|
```
|
|
172
190
|
|
|
173
191
|
**What gets generated**
|
|
@@ -188,6 +206,48 @@ src/app/components/hero-section/
|
|
|
188
206
|
└── hero-section.component.scss # Scoped class stub (.hero-section)
|
|
189
207
|
```
|
|
190
208
|
|
|
209
|
+
*Vue* — written to `src/components/<Name>/`
|
|
210
|
+
```
|
|
211
|
+
src/components/HeroSection/
|
|
212
|
+
├── HeroSection.vue # <script setup> SFC with slot and scoped SCSS
|
|
213
|
+
├── HeroSection.scss # Scoped class stub (.hero-section)
|
|
214
|
+
└── index.ts # Barrel re-export
|
|
215
|
+
```
|
|
216
|
+
|
|
217
|
+
---
|
|
218
|
+
|
|
219
|
+
### `m2s2 completions`
|
|
220
|
+
|
|
221
|
+
Install shell completions for `m2s2`. Auto-detects your shell from `$SHELL` and writes a completion script to your home directory, then patches your shell's rc file to source it automatically.
|
|
222
|
+
|
|
223
|
+
```bash
|
|
224
|
+
m2s2 completions [shell]
|
|
225
|
+
```
|
|
226
|
+
|
|
227
|
+
**Arguments**
|
|
228
|
+
|
|
229
|
+
| Argument | Description |
|
|
230
|
+
|----------|-------------|
|
|
231
|
+
| `[shell]` | Shell to generate completions for. Auto-detected from `$SHELL` if omitted. One of: `bash`, `zsh`, `fish`, `elvish`, `powershell`. |
|
|
232
|
+
|
|
233
|
+
**Examples**
|
|
234
|
+
|
|
235
|
+
```bash
|
|
236
|
+
# Auto-detect shell and install
|
|
237
|
+
m2s2 completions
|
|
238
|
+
|
|
239
|
+
# Explicit shell
|
|
240
|
+
m2s2 completions zsh
|
|
241
|
+
```
|
|
242
|
+
|
|
243
|
+
After running, reload your shell or source your rc file:
|
|
244
|
+
|
|
245
|
+
```bash
|
|
246
|
+
source ~/.zshrc # zsh
|
|
247
|
+
source ~/.bashrc # bash
|
|
248
|
+
# fish sources completions automatically — no reload needed
|
|
249
|
+
```
|
|
250
|
+
|
|
191
251
|
---
|
|
192
252
|
|
|
193
253
|
### `m2s2 upgrade`
|
|
@@ -246,9 +306,11 @@ All scaffold and generate templates live under `templates/` and are embedded int
|
|
|
246
306
|
templates/
|
|
247
307
|
├── react/ # m2s2 new --framework react
|
|
248
308
|
├── angular/ # m2s2 new --framework angular
|
|
309
|
+
├── vue/ # m2s2 new --framework vue
|
|
249
310
|
└── generate/
|
|
250
311
|
├── react/ # m2s2 generate component (React)
|
|
251
|
-
|
|
312
|
+
├── angular/ # m2s2 generate component (Angular)
|
|
313
|
+
└── vue/ # m2s2 generate component (Vue)
|
|
252
314
|
```
|
|
253
315
|
|
|
254
316
|
---
|
|
@@ -332,9 +394,9 @@ Keeps scaffold template dependencies in sync with the latest published M²S² li
|
|
|
332
394
|
|
|
333
395
|
Triggers:
|
|
334
396
|
- **Weekly** — every Monday at 08:00 UTC.
|
|
335
|
-
- **`repository_dispatch`** — fired automatically by the design system CI whenever
|
|
397
|
+
- **`repository_dispatch`** — fired automatically by the design system CI whenever any `@m2s2` library publishes a new release.
|
|
336
398
|
|
|
337
|
-
When a version change is detected, the workflow opens a pull request updating the pinned package versions in `templates/react/package.json.hbs` and `templates/
|
|
399
|
+
When a version change is detected, the workflow opens a pull request updating the pinned package versions in `templates/react/package.json.hbs`, `templates/angular/package.json.hbs`, and `templates/vue/package.json.hbs`. Merging that PR flows through the normal release pipeline.
|
|
338
400
|
|
|
339
401
|
### Required Repository Secrets
|
|
340
402
|
|
package/npm-shrinkwrap.json
CHANGED
|
@@ -23,7 +23,7 @@
|
|
|
23
23
|
"hasInstallScript": true,
|
|
24
24
|
"license": "MIT",
|
|
25
25
|
"name": "@m2s2/cli",
|
|
26
|
-
"version": "0.1.
|
|
26
|
+
"version": "0.1.14"
|
|
27
27
|
},
|
|
28
28
|
"node_modules/@isaacs/cliui": {
|
|
29
29
|
"engines": {
|
|
@@ -542,5 +542,5 @@
|
|
|
542
542
|
}
|
|
543
543
|
},
|
|
544
544
|
"requires": true,
|
|
545
|
-
"version": "0.1.
|
|
545
|
+
"version": "0.1.14"
|
|
546
546
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"artifactDownloadUrls": [
|
|
3
|
-
"https://github.com/M2S2-Engineering-Group/m2s2-cli/releases/download/v0.1.
|
|
3
|
+
"https://github.com/M2S2-Engineering-Group/m2s2-cli/releases/download/v0.1.14"
|
|
4
4
|
],
|
|
5
5
|
"author": "M²S² Engineering Group <contact@m2s2.io>",
|
|
6
6
|
"bin": {
|
|
@@ -95,7 +95,7 @@
|
|
|
95
95
|
"zipExt": ".tar.xz"
|
|
96
96
|
}
|
|
97
97
|
},
|
|
98
|
-
"version": "0.1.
|
|
98
|
+
"version": "0.1.14",
|
|
99
99
|
"volta": {
|
|
100
100
|
"node": "18.14.1",
|
|
101
101
|
"npm": "9.5.0"
|