spell 0.8.7 → 0.8.9
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/README-epics.md +149 -49
- package/app/package.json +25 -1
- package/app/spaces/@spell/guides/SpellUI/SpellUI.spellml +486 -486
- package/app/spaces/@spell/sites/SpellApp/SpellApp.spellml +50 -124
- package/dist/app/app/pages/SiteBoardView.css +5 -5
- package/dist/app/app/pages/SiteBoardView.js +1 -1
- package/dist/app/app/pages/SiteEditorPage.js +6 -3
- package/dist/app/app/pages/SiteEdits.js +27 -10
- package/dist/app/app/pages/SiteWrites.js +11 -0
- package/dist/app/app/runner/spellRuntime.js +1 -0
- package/dist/cli/publish/PublishedPackage.d.ts +2 -1
- package/dist/cli/publish/PublishedPackage.js +6 -3
- package/dist/cli/publish/ScratchInstall.d.ts +14 -3
- package/dist/cli/publish/ScratchInstall.js +69 -8
- package/dist/epic/cli/EpicProgram.js +20 -5
- package/dist/epic/cli/epicGroups.js +7 -1
- package/dist/epic/command/BaseBranch.d.ts +35 -0
- package/dist/epic/command/BaseBranch.js +58 -0
- package/dist/epic/command/EpicCheckout.d.ts +1 -1
- package/dist/epic/command/EpicCheckout.js +4 -4
- package/dist/epic/command/EpicGuide.js +3 -2
- package/dist/epic/command/EpicTools.d.ts +5 -0
- package/dist/epic/command/EpicTools.js +14 -3
- package/dist/epic/command/MainMerge.d.ts +26 -15
- package/dist/epic/command/MainMerge.js +60 -16
- package/dist/epic/command/PullRequest.d.ts +45 -0
- package/dist/epic/command/PullRequest.js +100 -0
- package/dist/epic/command/RepoInit.d.ts +196 -39
- package/dist/epic/command/RepoInit.js +481 -60
- package/dist/epic/command/Requests.d.ts +1 -0
- package/dist/epic/command/Requests.js +7 -1
- package/dist/epic/command/SessionMoves.js +2 -1
- package/dist/epic/command/SkillsCheck.js +3 -2
- package/dist/epic/command/Stock.js +3 -1
- package/dist/epic/command/TurnEnd.d.ts +1 -1
- package/dist/epic/command/TurnEnd.js +4 -3
- package/dist/epic/command/Worktrees.d.ts +20 -3
- package/dist/epic/command/Worktrees.js +39 -7
- package/dist/epic/command/command.types.d.ts +3 -0
- package/dist/epic/components/__pack/epics.entry.js +43 -43
- package/dist/epic/components/__pack/epics.pack.js +36 -12794
- package/dist/epic/config/CodeHost.d.ts +96 -0
- package/dist/epic/config/CodeHost.js +89 -0
- package/dist/epic/config/EngineFiles.mjs +60 -0
- package/dist/epic/config/EpicConfig.d.ts +20 -3
- package/dist/epic/config/EpicConfig.js +25 -1
- package/dist/epic/config/EpicRepo.js +1 -1
- package/dist/epic/config/GitHub.d.ts +75 -3
- package/dist/epic/config/GitHub.js +106 -5
- package/dist/epic/config/GitLab.d.ts +138 -0
- package/dist/epic/config/GitLab.js +297 -0
- package/dist/epic/config/LayeredSettings.js +3 -2
- package/dist/epic/server/EpicServer.d.ts +1 -1
- package/dist/epic/server/EpicServer.js +26 -12
- package/dist/epic/tool/InboxPoller.mjs +2 -1
- package/dist/epic/tool/MigrateCommands.js +6 -8
- package/dist/epic/tool/PlanCommits.d.ts +7 -4
- package/dist/epic/tool/PlanCommits.js +7 -5
- package/dist/epic/tool/PlanDocCommands.js +3 -4
- package/dist/epic/tool/PlanDocFiles.d.ts +3 -1
- package/dist/epic/tool/PlanDocFiles.js +13 -5
- package/dist/epic/tool/ServedFolders.d.ts +1 -1
- package/dist/epic/tool/ServedFolders.js +4 -4
- package/dist/epic/tools/PageInboxes.js +3 -3
- package/dist/epic/tools/_assets/commands.entry.js +149 -68
- package/dist/epic/tools/_assets/commands.js +20 -2073
- package/dist/epic/tools/_assets/core-reference.entry.js +244 -124
- package/dist/epic/tools/_assets/core-reference.js +20 -2142
- package/dist/epic/tools/_assets/emoji/cldr/0.js +2 -2
- package/dist/epic/tools/_assets/emoji/cldr/a.js +2 -2
- package/dist/epic/tools/_assets/emoji/cldr/b.js +2 -2
- package/dist/epic/tools/_assets/emoji/cldr/c.js +2 -2
- package/dist/epic/tools/_assets/emoji/cldr/d.js +2 -2
- package/dist/epic/tools/_assets/emoji/cldr/e.js +2 -2
- package/dist/epic/tools/_assets/emoji/cldr/f.js +2 -2
- package/dist/epic/tools/_assets/emoji/cldr/g.js +2 -2
- package/dist/epic/tools/_assets/emoji/cldr/h.js +2 -2
- package/dist/epic/tools/_assets/emoji/cldr/i.js +2 -2
- package/dist/epic/tools/_assets/emoji/cldr/j.js +2 -2
- package/dist/epic/tools/_assets/emoji/cldr/k.js +2 -2
- package/dist/epic/tools/_assets/emoji/cldr/l.js +2 -2
- package/dist/epic/tools/_assets/emoji/cldr/m.js +2 -2
- package/dist/epic/tools/_assets/emoji/cldr/n.js +2 -2
- package/dist/epic/tools/_assets/emoji/cldr/o.js +2 -2
- package/dist/epic/tools/_assets/emoji/cldr/p.js +2 -2
- package/dist/epic/tools/_assets/emoji/cldr/r.js +2 -2
- package/dist/epic/tools/_assets/emoji/cldr/s.js +2 -2
- package/dist/epic/tools/_assets/emoji/cldr/t.js +2 -2
- package/dist/epic/tools/_assets/emoji/cldr/u.js +2 -2
- package/dist/epic/tools/_assets/emoji/cldr/v.js +2 -2
- package/dist/epic/tools/_assets/emoji/cldr/w.js +2 -2
- package/dist/epic/tools/_assets/emoji/cldr/x.js +2 -2
- package/dist/epic/tools/_assets/emoji/cldr/y.js +2 -2
- package/dist/epic/tools/_assets/emoji/cldr/z.js +2 -2
- package/dist/epic/tools/_assets/emoji/fomantic/0.js +2 -2
- package/dist/epic/tools/_assets/emoji/fomantic/a.js +2 -2
- package/dist/epic/tools/_assets/emoji/fomantic/b.js +2 -2
- package/dist/epic/tools/_assets/emoji/fomantic/c.js +2 -2
- package/dist/epic/tools/_assets/emoji/fomantic/d.js +2 -2
- package/dist/epic/tools/_assets/emoji/fomantic/e.js +2 -2
- package/dist/epic/tools/_assets/emoji/fomantic/f.js +2 -2
- package/dist/epic/tools/_assets/emoji/fomantic/g.js +2 -2
- package/dist/epic/tools/_assets/emoji/fomantic/h.js +2 -2
- package/dist/epic/tools/_assets/emoji/fomantic/i.js +2 -2
- package/dist/epic/tools/_assets/emoji/fomantic/j.js +2 -2
- package/dist/epic/tools/_assets/emoji/fomantic/k.js +2 -2
- package/dist/epic/tools/_assets/emoji/fomantic/l.js +2 -2
- package/dist/epic/tools/_assets/emoji/fomantic/m.js +2 -2
- package/dist/epic/tools/_assets/emoji/fomantic/n.js +2 -2
- package/dist/epic/tools/_assets/emoji/fomantic/o.js +2 -2
- package/dist/epic/tools/_assets/emoji/fomantic/p.js +2 -2
- package/dist/epic/tools/_assets/emoji/fomantic/q.js +2 -2
- package/dist/epic/tools/_assets/emoji/fomantic/r.js +2 -2
- package/dist/epic/tools/_assets/emoji/fomantic/s.js +2 -2
- package/dist/epic/tools/_assets/emoji/fomantic/t.js +2 -2
- package/dist/epic/tools/_assets/emoji/fomantic/u.js +2 -2
- package/dist/epic/tools/_assets/emoji/fomantic/v.js +2 -2
- package/dist/epic/tools/_assets/emoji/fomantic/w.js +2 -2
- package/dist/epic/tools/_assets/emoji/fomantic/x.js +2 -2
- package/dist/epic/tools/_assets/emoji/fomantic/y.js +2 -2
- package/dist/epic/tools/_assets/emoji/fomantic/z.js +2 -2
- package/dist/epic/tools/_assets/goals-live.js +318 -210
- package/dist/epic/tools/_assets/highlight.min.js +5764 -5269
- package/dist/epic/tools/_assets/lazy/code-engine.js +5 -1270
- package/dist/epic/tools/_assets/lazy/markdown-engine.js +67 -1513
- package/dist/epic/tools/_assets/lazy/markdown-sanitizer.js +3 -753
- package/dist/epic/tools/_assets/spell-comments.entry.js +282 -159
- package/dist/epic/tools/_assets/spell-comments.js +24 -3716
- package/dist/epic/tools/_assets/spell-doc-comments.js +1243 -816
- package/dist/epic/tools/_assets/spell-doc-helpers.js +298 -165
- package/dist/epic/tools/_assets/spell-doc-runtime.js +2760 -1415
- package/dist/epic/tools/_assets/spell-doc-toolbar.js +396 -227
- package/dist/epic/tools/_assets/spell-syntax.entry.js +505 -285
- package/dist/epic/tools/_assets/spell-syntax.js +22 -2916
- package/dist/epic/tools/_assets/spell-ui-sources.js +102 -60
- package/dist/epic/tools/_assets/spell-ui.entry.js +108 -40
- package/dist/epic/tools/_assets/spell-ui.js +3131 -46465
- package/dist/epic/tools/pages.d.ts +5 -6
- package/dist/epic/tools/pages.js +7 -6
- package/dist/epic/window.mjs +2 -3
- package/dist/parser/core/classes/View.d.ts +20 -0
- package/dist/parser/core/classes/View.js +91 -17
- package/dist/parser/core/core.declarations.json5 +18 -0
- package/dist/parser/core/core.scopes.js +5 -0
- package/dist/parser/core/sites.d.ts +10 -0
- package/dist/parser/core/sites.js +12 -0
- package/dist/parser/parser/tokenizer/Tokenizer.d.ts +9 -1
- package/dist/parser/parser/tokenizer/Tokenizer.js +43 -5
- package/dist/parser/parser/tokenizer/Tokens.d.ts +4 -0
- package/dist/parser/parser/tokenizer/Tokens.js +4 -0
- package/dist/parser/parser/tokenizer/tokenizer.types.d.ts +5 -0
- package/dist/parser/parser/tokenizer/tokenizer.types.js +2 -0
- package/dist/parser/py/core/spell_core/apps.py +2 -0
- package/dist/parser/spell/PARSING.md +21 -0
- package/dist/parser/spell/SpellParser.d.ts +2 -0
- package/dist/parser/spell/SpellParser.js +58 -3
- package/dist/parser/spell/SpellxTokenizer.js +2 -1
- package/dist/parser/spell/SpellxTwin.d.ts +4 -1
- package/dist/parser/spell/SpellxTwin.js +10 -3
- package/dist/parser/spell/builtinTypes.js +24 -1
- package/dist/parser/spell/ingest/PlaceIngest.js +3 -1
- package/dist/parser/spell/languages/Language.d.ts +11 -2
- package/dist/parser/spell/languages/en/words.js +3 -2
- package/dist/parser/spell/languages/es/words.js +7 -4
- package/dist/parser/spell/rules/Statement.js +1 -1
- package/dist/parser/spell/rules/classes/DrawSlot.js +6 -1
- package/dist/parser/spell/rules/sites/SitePage.d.ts +3 -3
- package/dist/parser/spell/rules/sites/SitePage.js +2 -2
- package/dist/parser/spell/rules/sites/sites.en.js +1 -1
- package/dist/parser/spell/rules/sites/sites.es.js +1 -1
- package/dist/parser/spell/rules/sites/sites.shared.d.ts +2 -2
- package/dist/parser/spell/spell.types.d.ts +7 -0
- package/dist/parser/spell/spellSyntax.es.json +6 -6
- package/dist/parser/spell/spellSyntax.json +6 -6
- package/dist/parser/spellx/SpellxView.js +2 -1
- package/dist/ui/components/ui-accordion/UIAccordion.d.ts +1 -0
- package/dist/ui/components/ui-ad/UIAd.d.ts +1 -0
- package/dist/ui/components/ui-breadcrumbs/UIBreadcrumb.d.ts +1 -0
- package/dist/ui/components/ui-breadcrumbs/UIBreadcrumbs.d.ts +1 -0
- package/dist/ui/components/ui-button/UIButton.d.ts +8 -3
- package/dist/ui/components/ui-button/UIButton.fallback.d.ts +8 -3
- package/dist/ui/components/ui-button/UIButtons.d.ts +1 -0
- package/dist/ui/components/ui-button/UIOr.d.ts +1 -0
- package/dist/ui/components/ui-calendar/UICalendar.d.ts +6 -0
- package/dist/ui/components/ui-calendar/UICalendar.fallback.d.ts +6 -0
- package/dist/ui/components/ui-card/UICards.d.ts +31 -0
- package/dist/ui/components/ui-checkbox/UICheckbox.d.ts +7 -0
- package/dist/ui/components/ui-checkbox/UICheckbox.fallback.d.ts +7 -0
- package/dist/ui/components/ui-comment/UIComment.d.ts +1 -0
- package/dist/ui/components/ui-comment/UIComments.d.ts +1 -0
- package/dist/ui/components/ui-components/UIComponents.d.ts +1 -0
- package/dist/ui/components/ui-dimmer/UIDimmer.d.ts +1 -0
- package/dist/ui/components/ui-divider/UIDivider.d.ts +2 -0
- package/dist/ui/components/ui-dropdown/UIDropdown.d.ts +6 -0
- package/dist/ui/components/ui-dropdown/UIDropdown.fallback.d.ts +6 -0
- package/dist/ui/components/ui-embed/UIEmbed.d.ts +1 -0
- package/dist/ui/components/ui-emoji/UIEmoji.d.ts +1 -0
- package/dist/ui/components/ui-feed/UIFeed.d.ts +1 -0
- package/dist/ui/components/ui-feed/UIFeedEvent.d.ts +1 -0
- package/dist/ui/components/ui-flag/UIFlag.d.ts +1 -0
- package/dist/ui/components/ui-flyout/UIFlyout.d.ts +1 -0
- package/dist/ui/components/ui-form/UIFields.d.ts +1 -0
- package/dist/ui/components/ui-form/UIRepeat.d.ts +1 -0
- package/dist/ui/components/ui-grid/UIColumn.d.ts +1 -0
- package/dist/ui/components/ui-grid/UIGrid.d.ts +1 -0
- package/dist/ui/components/ui-grid/UIRow.d.ts +1 -0
- package/dist/ui/components/ui-icon/UIIcon.d.ts +3 -2
- package/dist/ui/components/ui-icon/UIIcons.d.ts +1 -0
- package/dist/ui/components/ui-icon-picker/UIIconPicker.d.ts +6 -0
- package/dist/ui/components/ui-icon-picker/UIIconPicker.fallback.d.ts +6 -0
- package/dist/ui/components/ui-image/UIImages.d.ts +1 -0
- package/dist/ui/components/ui-include/UIInclude.d.ts +1 -0
- package/dist/ui/components/ui-input/UIInput.fallback.d.ts +9 -2
- package/dist/ui/components/ui-items/UIItems.d.ts +1 -0
- package/dist/ui/components/ui-keys/UIKeys.d.ts +1 -0
- package/dist/ui/components/ui-label/UILabel.d.ts +2 -0
- package/dist/ui/components/ui-label/UILabels.d.ts +1 -0
- package/dist/ui/components/ui-list/UIList.d.ts +2 -0
- package/dist/ui/components/ui-loader/UILoader.d.ts +1 -0
- package/dist/ui/components/ui-message/UIMessage.d.ts +2 -0
- package/dist/ui/components/ui-modal/UIModal.d.ts +1 -0
- package/dist/ui/components/ui-nag/UINag.d.ts +1 -0
- package/dist/ui/components/ui-page/UIPage.d.ts +15 -0
- package/dist/ui/components/ui-page/UIPage.es.d.ts +1 -0
- package/dist/ui/components/ui-parts/UIActions.d.ts +1 -0
- package/dist/ui/components/ui-parts/UIAuthor.d.ts +1 -0
- package/dist/ui/components/ui-parts/UIAvatar.d.ts +1 -0
- package/dist/ui/components/ui-parts/UIContent.d.ts +1 -0
- package/dist/ui/components/ui-parts/UIDate.d.ts +1 -0
- package/dist/ui/components/ui-parts/UIDescription.d.ts +1 -0
- package/dist/ui/components/ui-parts/UIDetail.d.ts +1 -0
- package/dist/ui/components/ui-parts/UIExtra.d.ts +1 -0
- package/dist/ui/components/ui-parts/UIHeader.d.ts +15 -3
- package/dist/ui/components/ui-parts/UIHeader.en.d.ts +5 -2
- package/dist/ui/components/ui-parts/UIHeader.en.js +6 -3
- package/dist/ui/components/ui-parts/UIHeader.js +45 -5
- package/dist/ui/components/ui-parts/UIMeta.d.ts +1 -0
- package/dist/ui/components/ui-parts/UIParts.css +18 -0
- package/dist/ui/components/ui-parts/UIParts.css.inline.js +1 -1
- package/dist/ui/components/ui-parts/UIParts.types.d.ts +15 -1
- package/dist/ui/components/ui-parts/UISummary.d.ts +1 -0
- package/dist/ui/components/ui-parts/UITitle.d.ts +1 -0
- package/dist/ui/components/ui-parts/UIValue.d.ts +1 -0
- package/dist/ui/components/ui-placeholder/UIPlaceholder.d.ts +1 -0
- package/dist/ui/components/ui-placeholder/UIPlaceholderHeader.d.ts +1 -0
- package/dist/ui/components/ui-placeholder/UIPlaceholderImage.d.ts +1 -0
- package/dist/ui/components/ui-placeholder/UIPlaceholderLine.d.ts +1 -0
- package/dist/ui/components/ui-placeholder/UIPlaceholderParagraph.d.ts +1 -0
- package/dist/ui/components/ui-progress/UIProgress.d.ts +2 -0
- package/dist/ui/components/ui-quote/UIQuote.d.ts +1 -0
- package/dist/ui/components/ui-rail/UIRail.d.ts +1 -0
- package/dist/ui/components/ui-rating/UIRating.d.ts +6 -0
- package/dist/ui/components/ui-rating/UIRating.fallback.d.ts +6 -0
- package/dist/ui/components/ui-reveal/UIReveal.d.ts +1 -0
- package/dist/ui/components/ui-search/UISearch.fallback.d.ts +13 -1
- package/dist/ui/components/ui-section/UISections.d.ts +1 -0
- package/dist/ui/components/ui-segment/UISegment.d.ts +2 -0
- package/dist/ui/components/ui-segment/UISegments.d.ts +1 -0
- package/dist/ui/components/ui-select/UISelect.d.ts +6 -0
- package/dist/ui/components/ui-select/UISelect.fallback.d.ts +6 -0
- package/dist/ui/components/ui-shape/UISide.d.ts +4 -0
- package/dist/ui/components/ui-sidebar/UIPushable.d.ts +1 -0
- package/dist/ui/components/ui-sidebar/UIPusher.d.ts +1 -0
- package/dist/ui/components/ui-sidebar/UISidebar.d.ts +1 -0
- package/dist/ui/components/ui-sides/UISides.d.ts +6 -0
- package/dist/ui/components/ui-sides/UISides.fallback.d.ts +6 -0
- package/dist/ui/components/ui-slider/UISlider.d.ts +7 -0
- package/dist/ui/components/ui-slider/UISlider.fallback.d.ts +7 -0
- package/dist/ui/components/ui-space/UISpace.d.ts +1 -0
- package/dist/ui/components/ui-statistic/UIStatistic.d.ts +1 -0
- package/dist/ui/components/ui-statistic/UIStatistics.d.ts +1 -0
- package/dist/ui/components/ui-step/UIStep.d.ts +1 -0
- package/dist/ui/components/ui-step/UISteps.d.ts +1 -0
- package/dist/ui/components/ui-table/UICell.d.ts +1 -0
- package/dist/ui/components/ui-terms/UITerm.d.ts +1 -0
- package/dist/ui/components/ui-terms/UITerms.d.ts +1 -0
- package/dist/ui/components/ui-theme-editor/UIColorChip.d.ts +1 -0
- package/dist/ui/components/ui-theme-editor/UIThemeToken.d.ts +1 -0
- package/dist/ui/components/ui-toast/UIToast.d.ts +1 -0
- package/dist/ui/components/ui-toc/UIToc.d.ts +1 -0
- package/dist/ui/components/ui-transition/UITransition.d.ts +1 -0
- package/dist/ui/components/ui-video/UIAudio.d.ts +1 -0
- package/dist/ui/components/ui-video/UIVideo.d.ts +1 -0
- package/dist/ui/components/ui-visibility/UIVisibility.d.ts +1 -0
- package/dist/ui/components/ui-zoom/UIZoom.d.ts +1 -0
- package/dist/ui/jsx.d.ts +4 -4
- package/dist/ui/vocabulary/defaults.generated.js +1 -1
- package/dist/util/spell/constants.js +1 -1
- package/epic/.claude-plugin/plugin.json +1 -1
- package/epic/.codex-plugin/plugin.json +1 -1
- package/epic/hooks/handoff.mjs +4 -3
- package/epic/hooks/worktree.mjs +22 -3
- package/epic/package.json +41 -2
- package/epic/skills/details/SKILL.md +2 -1
- package/epic/skills/epic/SKILL.md +7 -1
- package/epic/skills/epic/guide.md +3 -0
- package/epic/skills/isolate/SKILL.md +53 -20
- package/epic/src/AGENTS.md +11 -2
- package/epic/templates/durable.html +1 -1
- package/epic/vscode/package.json +1 -1
- package/epic/vscode/spell-epic.vsix +0 -0
- package/package.json +1 -1
- package/parser/package.json +1 -1
- package/ui/package.json +15 -2
package/README-epics.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
```sh
|
|
4
4
|
git clone git@github.com:ana/my-app.git && cd my-app
|
|
5
|
-
|
|
5
|
+
npx spell@next epic init
|
|
6
6
|
```
|
|
7
7
|
|
|
8
8
|
<details>
|
|
@@ -72,9 +72,9 @@ and you mark it up when you have time.
|
|
|
72
72
|
What that's like, and why: [the epic engine's front page](epic/README.md).
|
|
73
73
|
|
|
74
74
|
Three things to know before you start:
|
|
75
|
-
- **Sharing works
|
|
76
|
-
`epic init` makes the team's epic repo with
|
|
77
|
-
|
|
75
|
+
- **Sharing works with GitHub and GitLab.**
|
|
76
|
+
`epic init` makes the team's epic repo with the host's own command: `gh`, or `glab` ([On GitLab](#on-gitlab)).
|
|
77
|
+
Bitbucket or a bare git server work too, but you make the repo by hand and pass its address
|
|
78
78
|
(`epic init --remote <address>`).
|
|
79
79
|
- **Claude Code first, Codex beside it.**
|
|
80
80
|
The skills run in both, from one copy; the moves between worktrees and windows are Claude Code's,
|
|
@@ -136,24 +136,11 @@ beside the main checkout rather than inside it.
|
|
|
136
136
|
|
|
137
137
|
## Setting it up: one command, and an extension
|
|
138
138
|
|
|
139
|
-
You need Claude Code, VS Code, git, Node 24.11 or later, and
|
|
139
|
+
You need Claude Code, VS Code, git, Node 24.11 or later, and your code host's command: GitHub's `gh`, or GitLab's `glab`
|
|
140
|
+
([On GitLab](#on-gitlab)).
|
|
140
141
|
These steps are for the FIRST person on a team; everyone after them: "A teammate joins", below.
|
|
141
142
|
|
|
142
|
-
### 1.
|
|
143
|
-
|
|
144
|
-
The epic tools run from a clone, once per machine, and the VS Code extension is built in it:
|
|
145
|
-
|
|
146
|
-
```sh
|
|
147
|
-
git clone https://github.com/spell-app/spell.git ~/www/spell
|
|
148
|
-
cd ~/www/spell
|
|
149
|
-
corepack enable
|
|
150
|
-
yarn install
|
|
151
|
-
```
|
|
152
|
-
|
|
153
|
-
- `~/www/spell` is only the convention these pages use: anywhere will do, and the commands below follow it.
|
|
154
|
-
- `corepack: command not found`, and the rest of a first setup: [Setup from zero](README.md#setup-from-zero).
|
|
155
|
-
|
|
156
|
-
### 2. GitHub's command, logged in
|
|
143
|
+
### 1. GitHub's command, logged in
|
|
157
144
|
|
|
158
145
|
`epic init` uses it to make the team's epic repo, so install it first.
|
|
159
146
|
On macOS, with Homebrew:
|
|
@@ -169,13 +156,13 @@ gh auth login
|
|
|
169
156
|
- Without it, `epic init` still sets everything else up, and says how to get it.
|
|
170
157
|
Run `epic init` again once you're logged in: it makes the epic repo then.
|
|
171
158
|
|
|
172
|
-
###
|
|
159
|
+
### 2. `epic init`, in your repo
|
|
173
160
|
|
|
174
161
|
From any folder of your repo, a git repo with at least one commit:
|
|
175
162
|
|
|
176
163
|
```sh
|
|
177
164
|
cd ~/www/my-app
|
|
178
|
-
|
|
165
|
+
npx spell@next epic init
|
|
179
166
|
```
|
|
180
167
|
|
|
181
168
|
<details>
|
|
@@ -242,10 +229,11 @@ _Ana's first `epic init`, against the same stand-in for GitHub as the top of thi
|
|
|
242
229
|
then a summary, then each step; a gray line before each slow one (GitHub, the push, the server).
|
|
243
230
|
The settings it wrote are in the file, not printed._
|
|
244
231
|
|
|
245
|
-
- That
|
|
232
|
+
- That fetches Spell's package and runs its `spell epic`, which runs the epic tool installed beside it.
|
|
246
233
|
Once `epic` is on your `PATH` (its plugin step puts it there), `epic init` is the same thing.
|
|
247
|
-
-
|
|
248
|
-
|
|
234
|
+
- `epic` and the plugin then run from npm's cache (`~/.npm/_npx`):
|
|
235
|
+
after `npm cache clean`, run this line again.
|
|
236
|
+
- Your project doesn't need yarn: an npm repo works, and yarn, pnpm and bun repos are found by their lock files.
|
|
249
237
|
|
|
250
238
|
In a terminal, it asks every question FIRST but the commit, each `? ` and the question in yellow, then sums up the
|
|
251
239
|
answers (`> Your name : Ana`, the values bold) before it does anything.
|
|
@@ -279,8 +267,8 @@ Then, in order, each step under a bold heading, the files in a gray table, a gra
|
|
|
279
267
|
A file already there is kept as it is.
|
|
280
268
|
3. Makes the epic folder, `../<repo>.epics`, a git repo of its own.
|
|
281
269
|
It holds the four folders, a README, and a `.gitignore` for what's never committed.
|
|
282
|
-
4. Makes the epic repo on GitHub: private unless you said public, under your account,
|
|
283
|
-
or under the organization your code repo is on.
|
|
270
|
+
4. Makes the epic repo on GitHub or GitLab: private unless you said public, under your account,
|
|
271
|
+
or under the organization or group your code repo is on.
|
|
284
272
|
It pushes the epic repo there, and writes its address in the config, `contentRemote`.
|
|
285
273
|
5. Links each of the four folders in at the checkout's root; every new worktree gets the same links.
|
|
286
274
|
6. Lists the links in a block of your `.gitignore`.
|
|
@@ -344,6 +332,25 @@ Gemfile.lock bundle install
|
|
|
344
332
|
|
|
345
333
|
</details>
|
|
346
334
|
|
|
335
|
+
<details>
|
|
336
|
+
<summary>npm or yarn: what your repo needs</summary>
|
|
337
|
+
|
|
338
|
+
Your repo doesn't need yarn.
|
|
339
|
+
A plain npm repo, with a `package-lock.json`, works:
|
|
340
|
+
- `epic init` writes `npm install` as the install command, and every new worktree runs it.
|
|
341
|
+
- `epic worktree merge-main` rewrites a `package-lock.json` that both sides changed with
|
|
342
|
+
`npm install --package-lock-only`, then installs.
|
|
343
|
+
`pnpm-lock.yaml`, `yarn.lock` and `bun.lock` get their own tools the same way.
|
|
344
|
+
- Vitest snapshots are updated with your repo's own runner: `npx vitest run ... --update` for npm.
|
|
345
|
+
With no Vitest in your `package.json` (Jest, say), nothing runs, and a snapshot both sides changed is an ordinary
|
|
346
|
+
conflict, for you to resolve or to list in `.epic/generators.json5`.
|
|
347
|
+
|
|
348
|
+
Yarn is on your machine for one reason: the clone of Spell that `epic` runs from uses it,
|
|
349
|
+
in its own folder, for its own install and to format pages.
|
|
350
|
+
No command runs yarn in your repo.
|
|
351
|
+
|
|
352
|
+
</details>
|
|
353
|
+
|
|
347
354
|
Then check that `epic` answers:
|
|
348
355
|
|
|
349
356
|
```sh
|
|
@@ -362,18 +369,14 @@ epic ... (...) .../epic
|
|
|
362
369
|
- `--version` names the code that answers: its commit, its branch and the folder it's in.
|
|
363
370
|
- `~/.local/bin`, where the plugin step links `epic`, may not be on your `PATH`: put the link wherever yours looks.
|
|
364
371
|
|
|
365
|
-
🌱 Planned: the plugin from Claude Code's marketplace,
|
|
366
|
-
The marketplace entry exists, but the plugin's `epic` command needs a clone's install to run.
|
|
372
|
+
🌱 Planned: the plugin from Claude Code's marketplace, without `npx`.
|
|
367
373
|
|
|
368
374
|
### And the extension
|
|
369
375
|
|
|
370
376
|
The Review tab, where you mark up a page, and the moves between windows need Spell's VS Code extension:
|
|
371
377
|
the same one in VS Code or Cursor, which runs VS Code's extensions.
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
- build it in the clone's `epic/vscode/` folder
|
|
375
|
-
- install the `.vsix`
|
|
376
|
-
- reload your windows
|
|
378
|
+
`epic init` installs it, from the package: reload your windows when it says so (**Developer: Reload Window**).
|
|
379
|
+
From a clone of Spell instead: [the extension's README](epic/README-vscode.md#install-it--three-commands-and-a-reload).
|
|
377
380
|
|
|
378
381
|
In Cursor, the epic tools use `cursor` where VS Code's take `code`: they tell from the window they run in.
|
|
379
382
|
- Say it outright with `editor` in `.epic/config.json5` (below), or for one machine `SPELL_EPIC_EDITOR=cursor`.
|
|
@@ -403,17 +406,17 @@ and CLONES it, beside the code repo:
|
|
|
403
406
|
|
|
404
407
|
```sh
|
|
405
408
|
git clone git@github.com:ana/my-app.git && cd my-app
|
|
406
|
-
|
|
409
|
+
npx spell@next epic init
|
|
407
410
|
```
|
|
408
411
|
|
|
409
412
|
- What it printed: the top of this page.
|
|
410
|
-
-
|
|
413
|
+
- The plugin and the extension are set up on their machine by the same line.
|
|
411
414
|
- It asks your name and your colour, as it asked the first person, from any folder of the code repo:
|
|
412
415
|
it finds the repo's main checkout from wherever it runs.
|
|
413
|
-
- The epic repo is private, unless the first person chose public: they add each teammate to it on GitHub,
|
|
416
|
+
- The epic repo is private, unless the first person chose public: they add each teammate to it on GitHub or GitLab,
|
|
414
417
|
with write access, since every turn pushes.
|
|
415
|
-
- Joining needs no `gh`: plain git clones the epic repo.
|
|
416
|
-
With
|
|
418
|
+
- Joining needs no `gh` or `glab`: plain git clones the epic repo.
|
|
419
|
+
With one logged in, though, your short name defaults to your login there.
|
|
417
420
|
- The plugin step and the extension are once per machine, so a teammate does those too.
|
|
418
421
|
|
|
419
422
|
### Who you are
|
|
@@ -520,6 +523,102 @@ A comment you leave on a page is shared with the plans, the moment the turn's sy
|
|
|
520
523
|
in the page's review inbox, a file never committed.
|
|
521
524
|
What your agent makes of a mark lands in the epic page, under your name, which everyone shares.
|
|
522
525
|
|
|
526
|
+
## <a id="when-main-takes-only-pull-requests"></a>When main takes only pull requests
|
|
527
|
+
|
|
528
|
+
Plenty of GitHub orgs and GitLab groups refuse direct pushes to `main`.
|
|
529
|
+
Below, "pull request" means a GitLab merge request too; on GitLab, `epic` says "merge request".
|
|
530
|
+
Tell the repo so with one setting, and nothing `epic` does tries to land there:
|
|
531
|
+
|
|
532
|
+
```sh
|
|
533
|
+
epic init --protected-base
|
|
534
|
+
```
|
|
535
|
+
|
|
536
|
+
`baseBranchProtected` in `.epic/config.json5` says the base branch can't be pushed to,
|
|
537
|
+
and work reaches it only through a pull request.
|
|
538
|
+
|
|
539
|
+
**You usually don't have to say so.**
|
|
540
|
+
With `gh` or `glab` logged in, `epic init` asks the host whether the branch takes only requests
|
|
541
|
+
(GitHub: a ruleset's `pull_request` rule and, if you're allowed to read it, classic branch protection;
|
|
542
|
+
GitLab: the project's protected branches: nobody allowed to push, or a push level above yours),
|
|
543
|
+
turns the setting on, and says so in one line.
|
|
544
|
+
If it can't find out, it carries on without it.
|
|
545
|
+
A config that already says `false` stays `false`, and `epic init` tells you how to change it.
|
|
546
|
+
|
|
547
|
+
**Setting up the repo goes through a pull request too.**
|
|
548
|
+
`epic init` never commits on `main`:
|
|
549
|
+
- `.epic/config.json5` and `.gitignore` go on a new branch, `epic-setup`, which it pushes.
|
|
550
|
+
- It opens the pull request with `gh` or `glab`, or prints exactly what to run without one.
|
|
551
|
+
- Your local `main` is left clean: the two files aren't in it until the merge.
|
|
552
|
+
- Epics start working in the repo once it's merged and you've run `git pull`.
|
|
553
|
+
Teammates can join then.
|
|
554
|
+
|
|
555
|
+
Ran `epic init` before the rule existed, and its push was refused?
|
|
556
|
+
It left a commit on your local `main`, and it says what to do:
|
|
557
|
+
`epic init --protected-base` takes that commit back and moves it onto `epic-setup`.
|
|
558
|
+
|
|
559
|
+
**The epic repo is the exception, and it has to stay one.**
|
|
560
|
+
Your plans live in `<repo>.epics`, and every turn pushes straight to its main branch.
|
|
561
|
+
An org-wide rule requiring pull requests must leave that repo out, or the plans stop syncing.
|
|
562
|
+
The setting changes nothing about it.
|
|
563
|
+
|
|
564
|
+
**What changes with the setting on:**
|
|
565
|
+
|
|
566
|
+
| Where | What it does instead |
|
|
567
|
+
| --- | --- |
|
|
568
|
+
| `epic merge <name>` | refuses, in one line saying to open a pull request |
|
|
569
|
+
| `/epic done`, `/isolate done` | no "Merge now": "Push and open a pull request", or "Leave it" |
|
|
570
|
+
| a standing epic's phase | pushed and put in a pull request, rather than merged at once |
|
|
571
|
+
| a new worktree, `epic worktree merge-main` | fast-forward your local `main` from `origin` first |
|
|
572
|
+
| `epic worktree remove --branches` | a branch whose pull request the code host merged counts as merged, a squash included |
|
|
573
|
+
|
|
574
|
+
Local `main` only moves when you pull, so those fast-forwards keep it from going stale.
|
|
575
|
+
They happen only when it's safe: fast-forward only, nothing uncommitted.
|
|
576
|
+
Offline, or with `main` diverged, they carry on from what you have, and say so.
|
|
577
|
+
|
|
578
|
+
A branch is deleted only if all its commits are in `main`,
|
|
579
|
+
or a merged pull request holds its last commit: a commit made after the merge keeps the branch.
|
|
580
|
+
Asking the host takes `gh` or `glab`; without it, the branch stays, and the line says why.
|
|
581
|
+
|
|
582
|
+
To push a branch and open its pull request by hand: `epic pr <name>` ([the CLI page](epic/README-cli.md)).
|
|
583
|
+
|
|
584
|
+
**After a pull request merges,** in the main checkout:
|
|
585
|
+
|
|
586
|
+
```sh
|
|
587
|
+
git pull
|
|
588
|
+
epic worktree remove <name> --branches
|
|
589
|
+
```
|
|
590
|
+
|
|
591
|
+
## <a id="on-gitlab"></a>On GitLab
|
|
592
|
+
|
|
593
|
+
`epic init` works on GitLab, self-hosted too, as it does on GitHub: the shared epic repo made, and a setup merge request
|
|
594
|
+
where `main` is protected.
|
|
595
|
+
**So far this has run only against a stand-in `glab`**: a script that answers as GitLab's API documents,
|
|
596
|
+
with real `git` pushes to a local repo whose hook refuses `main`.
|
|
597
|
+
No real GitLab has been tried yet, so expect rough edges and tell us.
|
|
598
|
+
|
|
599
|
+
You need GitLab's command, `glab`, logged in:
|
|
600
|
+
|
|
601
|
+
```sh
|
|
602
|
+
brew install glab # other systems: https://gitlab.com/gitlab-org/cli
|
|
603
|
+
glab auth login # gitlab.com
|
|
604
|
+
glab auth login --hostname git.acme.com # your own GitLab
|
|
605
|
+
```
|
|
606
|
+
|
|
607
|
+
- **Which host:** `codeHost` in `.epic/config.json5`, `"github"` or `"gitlab"`.
|
|
608
|
+
Left out, it's read off the `origin` address each time: a host with `gitlab` in it is GitLab, `github.com` GitHub,
|
|
609
|
+
anything else GitHub.
|
|
610
|
+
- **A self-hosted GitLab whose address doesn't say so** (`git.acme.com`): `epic init --host gitlab`.
|
|
611
|
+
In a terminal it asks; with no terminal it stays on GitHub and says so in one line.
|
|
612
|
+
- **Groups and subgroups:** the epic repo goes under the group your code is in (`group/sub/my-app.epics`),
|
|
613
|
+
else your own namespace.
|
|
614
|
+
- **The epic repo must take pushes from teammates, every turn.**
|
|
615
|
+
GitLab protects a new project's default branch, so Developers can't push.
|
|
616
|
+
`epic init` unprotects it right after the first push.
|
|
617
|
+
If it can't (no right to), it says so in one line: unprotect it in the project's
|
|
618
|
+
Settings › Repository › Protected branches, or nobody else can sync.
|
|
619
|
+
An epic repo you made yourself (`--remote`) is yours to open up.
|
|
620
|
+
- **Commit links** on the epic pages go to GitLab's `/-/commit/<sha>`.
|
|
621
|
+
|
|
523
622
|
## <a id="with-codex"></a>With Codex (or another agent)
|
|
524
623
|
|
|
525
624
|
```sh
|
|
@@ -692,6 +791,8 @@ It's ONE file per repo, `.epic/config.json5` in the main checkout, read by
|
|
|
692
791
|
| `contentFolder` | `"../<repo>.epics"` | the epic repo: epics, sagas, guides, pages |
|
|
693
792
|
| `contentRemote` | the epic repo's address, once it's made (or `--remote`); `""` until then | where every turn pulls the epic repo from and pushes it to, and what a teammate's `epic init` clones; `""`: the plans stay on this machine |
|
|
694
793
|
| `baseBranch` | from git: the remote's default branch, else `main` or `master`, else the branch the main checkout is on | the branch worktrees start from and merge into |
|
|
794
|
+
| `codeHost` | the value it settled on: `--host`, else the `origin` address's, else GitHub; left out, worked out from `origin` each time | where the code is hosted, `"github"` or `"gitlab"`: picks `gh` or `glab` ([On GitLab](#on-gitlab)) |
|
|
795
|
+
| `baseBranchProtected` | `false`, unless `--protected-base` or the code host says otherwise | the base branch can't be pushed to, and work reaches it only through a pull request ([below](#when-main-takes-only-pull-requests)) |
|
|
695
796
|
| `worktreesFolder` | `"../<repo>.worktrees"` | where new worktrees go, one folder each, `<worktreesFolder>/<name>` |
|
|
696
797
|
| `installCommand` | from the lock file; `""` with none | what makes a new worktree ready to run, from its root; `""`: nothing to install |
|
|
697
798
|
| `installOnCreate` | `true` with an install | whether the worktree hook runs the install before it hands the worktree over |
|
|
@@ -842,12 +943,12 @@ epic server url ~/www/my-app.epics/epics/seo/seo.plan.html
|
|
|
842
943
|
|
|
843
944
|
What you'd trip on today, roughly in the order you'd meet it.
|
|
844
945
|
|
|
845
|
-
1. **
|
|
846
|
-
`epic init`
|
|
847
|
-
|
|
848
|
-
|
|
849
|
-
`epic init` makes the epic repo only through GitHub's `gh`;
|
|
946
|
+
1. **Everything runs from npm's cache.**
|
|
947
|
+
`npx spell@next epic init` installs nothing permanent: after `npm cache clean`, run it again.
|
|
948
|
+
2. **Sharing needs GitHub or GitLab.**
|
|
949
|
+
`epic init` makes the epic repo through `gh` or `glab`;
|
|
850
950
|
anywhere else, make it by hand and pass `--remote <address>`.
|
|
951
|
+
GitLab has run only against a stand-in `glab`, not a real server ([On GitLab](#on-gitlab)).
|
|
851
952
|
3. **The review controls reach the DEFAULT repo only.**
|
|
852
953
|
A second repo's pages draw, but their buttons, comments and details pages talk to the default repo's inbox.
|
|
853
954
|
`epic repos default <name>` picks which repo that is.
|
|
@@ -856,7 +957,6 @@ What you'd trip on today, roughly in the order you'd meet it.
|
|
|
856
957
|
5. **A few skills reach for Spell's own tools.**
|
|
857
958
|
Where a skill wants the repo's house style or text-rewriting skill, its example is Spell's.
|
|
858
959
|
- Saved prompts go to `~/.spell/prompts/`.
|
|
859
|
-
- `epic worktree merge-main` updates Vitest snapshots with Spell's own command, `yarn vp test run --update`.
|
|
860
960
|
6. **Claude Code first.**
|
|
861
961
|
The skills run in Codex too, but five stay Claude Code's, and so do waking a session from the page, session
|
|
862
962
|
titles and window moves ([With Codex](#with-codex)); any other agent follows `epic guide`.
|
|
@@ -892,15 +992,15 @@ What you'd trip on today, roughly in the order you'd meet it.
|
|
|
892
992
|
- `spell rename imports` renames in the peers `repos.json5` names, so never in your project
|
|
893
993
|
- `spell publish` publishes only the kit's folders that have a `"spellPublish"`
|
|
894
994
|
|
|
895
|
-
**Real today:** a repo that isn't Spell, set up with one command, its plans shared by a team through GitHub
|
|
995
|
+
**Real today:** a repo that isn't Spell, set up with one command, its plans shared by a team through GitHub
|
|
996
|
+
(GitLab is built, and tried only against a stand-in `glab`),
|
|
896
997
|
its epics planned, built in worktrees and reviewed on their pages, each reply and comment under its writer's name,
|
|
897
998
|
every comment seen by the team and answered by its writer's own agent, Claude Code or Codex.
|
|
898
999
|
**Not yet:**
|
|
899
|
-
- setting up without a clone: `npx spell@next epic init` needs a `spell@next` with `spell epic` in it, which isn't
|
|
900
|
-
published yet, and the VS Code extension is built in a clone
|
|
901
1000
|
- Cursor tried by a person: its windows, the Review tab's place, a move between windows
|
|
902
1001
|
- Send waking an agent other than Claude Code, and the Codex side tried with a real Codex
|
|
903
|
-
- a
|
|
1002
|
+
- a real GitLab, gitlab.com or self-hosted: `glab`'s flags are from its documentation, not a run against a server
|
|
1003
|
+
- a host other than GitHub or GitLab, without making the epic repo by hand
|
|
904
1004
|
- two repos reviewed from one server
|
|
905
1005
|
- the keys added since the first outside run, tried anywhere but Spell's own repos:
|
|
906
1006
|
- `app`
|
package/app/package.json
CHANGED
|
@@ -1,10 +1,34 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "spell-app",
|
|
3
|
-
"version": "0.8.
|
|
3
|
+
"version": "0.8.9",
|
|
4
4
|
"private": true,
|
|
5
5
|
"type": "module",
|
|
6
6
|
"spell": {
|
|
7
7
|
"commands": "../dist/app/cli/commands.js",
|
|
8
8
|
"hooks": "../dist/app/cli/hooks.js"
|
|
9
|
+
},
|
|
10
|
+
"pageServer": {
|
|
11
|
+
"routes": [
|
|
12
|
+
"../dist/app/spaces/server/node/routes/appRoutes.js"
|
|
13
|
+
],
|
|
14
|
+
"pageScripts": [
|
|
15
|
+
{
|
|
16
|
+
"src": "/element/spell-language.js",
|
|
17
|
+
"file": "app/dist-element/spell-language.js",
|
|
18
|
+
"skip": [
|
|
19
|
+
"/components/"
|
|
20
|
+
]
|
|
21
|
+
}
|
|
22
|
+
],
|
|
23
|
+
"componentSets": {
|
|
24
|
+
"app": {
|
|
25
|
+
"name": "App UI",
|
|
26
|
+
"dir": "app/docs",
|
|
27
|
+
"assets": "../ui/site/_assets"
|
|
28
|
+
}
|
|
29
|
+
},
|
|
30
|
+
"engineRoutes": {
|
|
31
|
+
"/element/": "app/dist-element"
|
|
32
|
+
}
|
|
9
33
|
}
|
|
10
34
|
}
|