Docs: "Using Vite+" page, and the entries the repo's rules require

Aperta
  • Qualcosa non va?
#16 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
38/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
angular, typescript, vite
Ambito
documentation

Direzione di ricerca

Read CLAUDE.md, docs/decisions.md, and docs/design.md first, then inspect the referenced content files, site/src/app/docs.ts, and the repository’s current Vite+ migration spike for verified details. Run pnpm docs:check and pnpm site:build after writing; done means the new guide and all listed cross references, status, changelog, README, decisions, and design entries are complete and both commands pass.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

documentation

Part of #13. Labels: documentation.

New page site/content/vite-plus.md, titled "Using Vite+", in the Guide section of DOCS in site/src/app/docs.ts, after Getting started. Written in Clarity style for one reader: an Angular developer who already has vp installed, or an existing plugin user who wants vp. Every command on the page is run before it's published; no number that wasn't measured.

Sections

  1. What Vite+ is, in one paragraph, and what it changes for an Angular app: one CLI (vp) that wraps Vite, Vitest, Oxlint, Oxfmt and tsdown, defineConfig from vite-plus, and vite as an alias of @voidzero-dev/vite-plus-core. Link to viteplus.dev; don't restate its docs.
  2. Create a new app: vp create @push-based/ngp my-app, what the prompts ask, what the generated project contains, the unattended form vp create @push-based/ngp -- --no-interactive --template app. Then vp dev, vp build, vp test, vp check.
  3. Move an existing app built with the plugin: vp migrate, exactly what it rewrote in the spike (scripts, vite/vitest pins to catalog:, imports to vite-plus and vite-plus/test, lazyPlugins, fmt/lint/staged blocks, AGENTS.md, .vite-hooks), and what to check afterwards. The vite alias requirement, stated once, with why.
  4. Move an ng build app: follow Migrating from ng build first, then section 3. What vp migrate leaves alone: angular.json, Husky (left with a warning), ng scripts.
  5. The toolchain with Angular: vp test (Vitest 5.1, vite-plus/test imports, the TestBed setup unchanged), vp check (Oxfmt defaults vs Angular's single quotes and how to set fmt.singleQuote; Oxlint on decorators and signals, no Angular-specific rules; tsgo type errors vs the plugin's template type-check), vp lint and .gitignore, vp staged, vpx for ngp-extract-i18n.
  6. Server rendering under Vite+: ngp({ssr: true}) with vp dev and vp build, the app-ssr template, running server.mjs with vp node or node.
  7. Limits: no row in vp create --list yet, peer warning on npm/yarn, Windows untested, vp pack (tsdown) is for libraries and the plugin doesn't build libraries, Nx workspaces not tried under vp.

Other files, per CLAUDE.md

  • site/content/getting-started.md: a two-line note at the top for Vite+ users pointing at the new page.
  • site/content/status.md: a "Vite+" row under What works, with what was checked and the alias caveat.
  • site/content/changelog.md: one line under the release date linking the page.
  • site/content/server-rendering.md and testing.md: one sentence each pointing at the Vite+ section that applies.
  • README.md: vp create @push-based/ngp next to the install snippet in Try it, and the new package in the "What's in this repo" table.
  • docs/decisions.md: an entry for the package name (@push-based/create-ngp, scoped like the plugin, and why there's no org-wide @push-based/create), the plain-Vite output, and the vite alias.
  • docs/design.md: a paragraph on what the template guarantees and where versions come from.
  • pnpm docs:check and pnpm site:build pass.
Lingua principale
TypeScript
Stelle
7
Fork
0
Merge medio
12h 24m
PR unite (30g)
13

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di push-based/vite-plugin-ngp

Tutte le issue di push-based/vite-plugin-ngp

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.