create-meith 0.37.2 → 0.37.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.
- package/dist/bin.mjs +117 -473
- package/package.json +1 -1
- package/src/bin.ts +1 -1
- package/src/scaffold-extension.ts +8 -9
- package/src/scaffold.ts +108 -463
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "create-meith",
|
|
3
|
-
"version": "0.37.
|
|
3
|
+
"version": "0.37.4",
|
|
4
4
|
"description": "Scaffold a Meith board, plugin or theme — npx create-meith <name> writes a deployable board workspace; --plugin and --theme write extension workspaces built on the published kits.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"repository": {
|
package/src/bin.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
2
|
import { run } from './cli'
|
|
3
3
|
|
|
4
|
-
const result = await run(process.argv.slice(2), '0.37.
|
|
4
|
+
const result = await run(process.argv.slice(2), '0.37.4')
|
|
5
5
|
for (const line of result.lines) {
|
|
6
6
|
if (result.code === 0) console.log(line)
|
|
7
7
|
else console.error(line)
|
|
@@ -178,7 +178,7 @@ exercised once, each easy to delete.
|
|
|
178
178
|
npm test
|
|
179
179
|
|
|
180
180
|
\`src/plugin.tsx\` is the plugin. What a plugin may and may not do is
|
|
181
|
-
documented in the meith repository under \`docs/
|
|
181
|
+
documented in the meith repository under \`docs/extensions/plugins.md\`;
|
|
182
182
|
every hook and payload is listed in \`docs/reference/plugin-hooks.md\`.
|
|
183
183
|
|
|
184
184
|
## Run it inside a board
|
|
@@ -192,8 +192,7 @@ Scaffold a board next to this directory if you do not have one
|
|
|
192
192
|
npm installs a local directory as a symlink, so edits here are picked up by
|
|
193
193
|
the board's next build without reinstalling.
|
|
194
194
|
|
|
195
|
-
Register the plugin in the board's \`meith.plugins.ts
|
|
196
|
-
the top of that file shows the shape:
|
|
195
|
+
Register the plugin in the board's \`meith.plugins.ts\`, keeping its existing entries:
|
|
197
196
|
|
|
198
197
|
import { messages as ${camel}Messages, plugin as ${camel}Plugin } from '${name}'
|
|
199
198
|
|
|
@@ -201,12 +200,12 @@ the top of that file shows the shape:
|
|
|
201
200
|
{ key: '${name}', enabled: true, plugin: ${camel}Plugin, messages: ${camel}Messages },
|
|
202
201
|
]
|
|
203
202
|
|
|
204
|
-
and add the matching entry to \`board.plugins.json
|
|
203
|
+
and add the matching entry to \`board.plugins.json\`, keeping its existing plugins:
|
|
205
204
|
|
|
206
205
|
{ "plugins": [{ "key": "${name}", "package": "${name}", "enabled": true }] }
|
|
207
206
|
|
|
208
|
-
|
|
209
|
-
migration,
|
|
207
|
+
Run \`npm run meith -- upgrade\` against your development database to apply
|
|
208
|
+
the plugin migration, then rebuild with \`npm run build\`. The plugin appears under
|
|
210
209
|
**Admin → Plugins**.
|
|
211
210
|
|
|
212
211
|
## Publish and list it
|
|
@@ -216,7 +215,7 @@ migration, run \`npx meith migrate\`. The plugin then appears under
|
|
|
216
215
|
finish \`listing.json\` (its \`repository\` field starts as a placeholder),
|
|
217
216
|
add the screenshot it names, and open a pull request against the meith
|
|
218
217
|
repository — the submission process and the review bar are documented there
|
|
219
|
-
in \`docs/
|
|
218
|
+
in \`docs/extensions/marketplace.md\`.
|
|
220
219
|
`
|
|
221
220
|
}
|
|
222
221
|
|
|
@@ -235,7 +234,7 @@ tokens) plus a single slot override, the footer.
|
|
|
235
234
|
|
|
236
235
|
\`src/theme.ts\` declares the theme, \`src/tokens.ts\` carries the palette,
|
|
237
236
|
and slots live in \`src/slots/\`. What a theme may and may not do is
|
|
238
|
-
documented in the meith repository under \`docs/
|
|
237
|
+
documented in the meith repository under \`docs/extensions/themes.md\`;
|
|
239
238
|
every slot and view model is listed in \`docs/reference/theme-slots.md\`.
|
|
240
239
|
|
|
241
240
|
## Run it inside a board
|
|
@@ -276,7 +275,7 @@ on the appearance screen and to administrators under **Admin → Themes**.
|
|
|
276
275
|
finish \`listing.json\` (its \`repository\` field starts as a placeholder),
|
|
277
276
|
add the screenshot it names, and open a pull request against the meith
|
|
278
277
|
repository — the submission process and the review bar are documented there
|
|
279
|
-
in \`docs/
|
|
278
|
+
in \`docs/extensions/marketplace.md\`.
|
|
280
279
|
`
|
|
281
280
|
}
|
|
282
281
|
|