Uh oh!
There was an error while loading. Please reload this page.
[KZN-17594] - Scaffolding Improvements - #20
Merged
Conversation
…es something buildable and useful
There was a problem hiding this comment.
Pull request overview
Improves create so generated plugins are buildable, publish-ready, and usable in interactive or headless workflows.
Changes:
- Adds headless flags and interactive artifact selection.
- Scaffolds starter artifacts, a thumbnail, and Copilot guidance.
- Adds raw-template bundling and expanded validation tests.
Reviewed changes
Copilot reviewed 41 out of 42 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
vitest.config.ts | Enables raw CSS template imports. |
tsup.config.ts | Adds raw-file bundling support. |
src/ui/CreateUI.tsx | Adds artifact selection and environment-aware creation. |
src/templates/github/instructions/version-discipline.instructions.md | Adds manifest version guidance. |
src/templates/github/instructions/security.instructions.md | Adds generated security guidance. |
src/templates/github/copilot-instructions.md | Adds generated repository guidance. |
src/templates/artifacts/toolbarItems/helloToolbarItem/script.js | Adds toolbar behavior. |
src/templates/artifacts/toolbarItems/helloToolbarItem/config.json | Configures the toolbar item. |
src/templates/artifacts/pages/helloPage/styles.css | Styles the starter page. |
src/templates/artifacts/pages/helloPage/script.js | Adds page initialization. |
src/templates/artifacts/pages/helloPage/eventScripts/greet.js | Adds page interactions. |
src/templates/artifacts/pages/helloPage/config.json | Configures the starter page. |
src/templates/artifacts/objectSettingsItems/helloObjectSettingsItem/script.js | Adds settings-item behavior. |
src/templates/artifacts/objectSettingsItems/helloObjectSettingsItem/config.json | Configures the settings item. |
src/templates/artifacts/floatingFrames/helloFrame/styles.css | Styles the starter frame. |
src/templates/artifacts/floatingFrames/helloFrame/script.js | Adds frame UI. |
src/templates/artifacts/floatingFrames/helloFrame/config.json | Configures the starter frame. |
src/templates/artifacts/dataAdornments/helloAdornment/script.js | Adds adornment behavior. |
src/templates/artifacts/dataAdornments/helloAdornment/config.json | Configures the adornment. |
src/templates/artifacts/blocks/helloBlock/styles.css | Styles the starter block. |
src/templates/artifacts/blocks/helloBlock/script.js | Adds block UI. |
src/templates/artifacts/blocks/helloBlock/config.json | Configures the starter block. |
src/templates/artifacts/actions/helloAction/script.js | Adds action behavior. |
src/templates/artifacts/actions/helloAction/config.json | Configures the starter action. |
src/program.test.ts | Verifies new create flags. |
src/lib/runBuild.test.ts | Tests complete scaffold packaging. |
src/lib/createThumbnail.ts | Generates placeholder PNG thumbnails. |
src/lib/createThumbnail.test.ts | Validates PNG generation. |
src/lib/createPlugin.ts | Writes expanded scaffold contents. |
src/lib/createPlugin.test.ts | Tests manifests and generated files. |
src/lib/createHeadless.ts | Implements non-interactive creation. |
src/lib/createHeadless.test.ts | Tests headless behavior. |
src/lib/createForm.ts | Adds required descriptions and artifact toggling. |
src/lib/createForm.test.ts | Tests updated form helpers. |
src/lib/createCopilotFiles.ts | Maps Copilot templates into scaffolds. |
src/lib/createArtifacts.ts | Defines scaffoldable artifacts. |
src/lib/createArtifacts.test.ts | Validates artifact file generation. |
src/commands/create.ts | Wires flags and headless execution. |
src/assets.d.ts | Types raw imports. |
src/__snapshots__/program.test.ts.snap | Updates CLI help snapshot. |
eslint.config.mjs | Excludes runtime templates from linting. |
.prettierignore | Preserves authored template Markdown. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| .option('-a, --api-name <name>', 'plugin api_name (inferred from --name when omitted)') | ||
| .option('-d, --description <text>', 'plugin description') | ||
| .option('-l, --external-link <url>', 'external link shown on the plugin listing') | ||
| .option('-b, --business-id <id>', 'developer business id (defaults to saved credentials)') |
| }; | ||
| export const REQUIRED_FIELDS: readonly FieldName[] = ['name', 'apiName']; | ||
| export const REQUIRED_FIELDS: readonly FieldName[] = ['name', 'apiName', 'description']; |
Comment on lines
+32
to
+36
| /** | ||
| * Artifact types to scaffold under `src/`. An empty list (the default) | ||
| * reproduces the old behaviour of an empty `src/`, which builds to a plugin | ||
| * with no artifacts at all. | ||
| */ |
| @@ -0,0 +1,64 @@ | |||
| --- | |||
| applyTo: "src/**/*.js" | |||
| <Box flexDirection="column" gap={0}> | ||
| <Text bold>Artifacts</Text> | ||
| {phase.artifacts.length === 0 ? ( | ||
| <Text dimColor>{' '}none — src/ will be empty</Text> |
Uh oh!
There was an error while loading. Please reload this page.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR updates the scaffolding command via
createso that it creates something buildable out of the box, and so that the scaffolded plugin is actually useful in its initial state.