Upstream to vite-plus: a bare `ngp` shorthand, a `vp create --list` entry, and two create-path gaps

Open
  • Is something wrong?
#19 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Clearly specified
Activity status
Active
Tech stack
typescript, vite
Domain
cli, developer-experience

Research direction

Read packages/cli/src/create/discovery.ts and bin.ts for the shorthand and --list entry. First resolve blockers #14 and #18, then file the three requested issues on voidzero-dev/vite-plus with the epic’s reproduction and link them here. Done when the issues are linked and the Vite+ docs Limits section is updated as changes land.

Written by the indexing model from the issue text.

Description

feature

Part of #13. Labels: feature. Blocked by #14 and #18.

Once @push-based/create-ngp is on npm and vp create @push-based/ngp works unattended:

  1. Ask for a bare ngp shorthand: a special case in expandCreateShorthand (packages/cli/src/create/discovery.ts) mapping ngp → @push-based/create-ngp, the way svelte → sv and @tanstack/start → @tanstack/cli are mapped, plus a line in the "Popular Templates (shorthand)" list printed by vp create --list (bin.ts). Svelte got in through #857 and PR #982. Until then the documented command is vp create @push-based/ngp, which needs no upstream change. Whether to ask for angular too is a separate conversation: the name implies the Angular team's blessing, and Analog has a claim as well. Proposal: ask for ngp only, mention angular as open.
  2. Report that templates can't tell they run under vp. The child gets process.env plus PATH; only Bingo generators get VP_CREATE_INTERACTIVE. A VP_CREATE=1 (or passing the same --no-interactive vp consumed) would let templates skip install prompts and "Done. Now run:" lines that vp then contradicts.
  3. Report that the target directory isn't prepended for npm templates, while it is for vite:application and GitHub URLs, so vp create @push-based/ngp (no directory) runs the scaffolder with no arguments and the template prompts for a name vp already asked for in other paths.

File these as issues on voidzero-dev/vite-plus with the reproduction from the epic, and link them here. Update the Vite+ docs page's Limits section when any of them lands.

Dominant language
TypeScript
Stars
7
Forks
1
Avg merge
12h 24m
Merged PRs (30d)
13

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from push-based/vite-plugin-ngp

All issues in push-based/vite-plugin-ngp

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.