feat: bundled Piskel web editor (serve) and English-first documentation#3
Merged
Merged
Conversation
Add piskel-cli serve to serve vendor/piskel-prod over HTTP and open a browser, with optional project load via a session URL and ?load= bridge injected into index.html. Include sync-piskel-vendor and assert-vendor scripts so maintainers can refresh upstream builds and npm publish fails if the static bundle is missing. Document usage in README and ship vendor/piskel-prod in-repo for clone and npm pack consumers. Handle missing xdg-open on Linux/WSL by trying wslview, gio, and sensible-browser before printing a manual-open hint. Made-with: Cursor
…pm paths - Make docs/commands.md the primary English reference; add docs/commands.zh-CN.md. - Add README.zh-CN.md and cross-links from README.md; extend package files for docs. - Rewrite reference-plan-format.md in English; keep skill workflow in SKILL.md. - Point SKILL.md at offline paths under @ne9roni/piskel-cli (node_modules / npm root -g) for docs/commands.md and plan format, instead of relative repo or CDN URLs. Made-with: Cursor
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit 0fdf571. Configure here.
npm pkg fix: use dist/src/cli.js without leading ./ so publish does not strip the bin entry. Made-with: Cursor
decodeURIComponent on url.pathname can throw URIError for invalid sequences (e.g. /%ZZ). Return 400 instead of crashing the request handler. Add tryDecodeUriPathname helper and unit tests. Made-with: Cursor
|
You have used all of your free Bugbot PR reviews. To receive reviews on all of your PRs, visit the Cursor dashboard to activate Pro and start your 14-day free trial. |
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 free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
piskel-cli serve: local HTTP server for the bundled Piskel production build undervendor/piskel-prod, optional open in browser, session URL for loading a.piskelfile.sync-piskel-vendor/assert-vendorso publishes include static assets; browser open fallbacks whenxdg-openis missing (WSL/Linux).docs/commands.mdas the primary English command reference;docs/commands.zh-CN.md;README.zh-CN.md; npmfilesincludesdocs/.SKILL.md: references package-local paths (node_modules/@ne9roni/piskel-cli/...) for offline use.Test plan
npm run build && npm testnode dist/src/cli.js serveand open editorMade with Cursor
Note
Medium Risk
Adds a new long-running local HTTP server path (
serve) and ships large static vendor assets in the npm package, which could introduce packaging/runtime issues and platform-specific browser-launch edge cases.Overview
Adds a new
piskel-cli servecommand that hosts the bundled Piskel production build over a local HTTP server, optionally opens a.piskelvia a one-time tokenized__/__piskel/open/<token>URL, supports--host/--port/--no-open/--json, and returnsVENDOR_MISSINGwhen the editor assets are absent.Updates publishing/packaging to include
vendor/piskel-prodand addssync-piskel-vendor+assert-vendorscripts (enforced inprepublishOnly) to ensure the npm package always ships a workingserve.Reworks documentation to be English-first (
docs/commands.md) with new Chinese counterparts (README.zh-CN.md,docs/commands.zh-CN.md) and updates the AI skill docs to reference offline, package-local command references.Reviewed by Cursor Bugbot for commit 0fdf571. Bugbot is set up for automated code reviews on this repo. Configure here.