Skip to content

Commit 1a7468d

Browse files
matteobrunimatteobruni
authored
Merge pull request #102 from tsparticles/dev
3.2.1
2 parents 27a42e6 + 49c1b98 commit 1a7468d

28 files changed

+607
-565
lines changed

‎.planning/PROJECT.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# New Project
2+
3+
## What This Is
4+
5+
An initialized project workspace for planning and execution. This project represents the CLI tooling and templates found in this repository and is intended to be used as the basis for planning feature work or packaging improvements.
6+
7+
## Core Value
8+
9+
Make the CLI and project templates reliable and easy to extend so maintainers and downstream projects can scaffold consistent plugins and shapes quickly.
10+
11+
## Requirements
12+
13+
### Validated
14+
15+
(None yet — this is a planning initialization for future work)
16+
17+
### Active
18+
19+
- [ ] Improve CLI build reliability and developer experience
20+
- [ ] Create clear scaffolding templates for plugins and shapes
21+
22+
### Out of Scope
23+
24+
- Large runtime application features unrelated to CLI scaffolding
25+
26+
## Context
27+
28+
This repository contains a TypeScript-based CLI (`src/`), template projects under `files/`, and CI workflows under `.github/`. The codebase map will be created to infer existing capabilities.
29+
30+
## Constraints
31+
32+
- **Timeline**: TBD — planning stage
33+
- **Tech**: TypeScript + Node.js CLI tooling
34+
35+
## Key Decisions
36+
37+
| Decision | Rationale | Outcome |
38+
| ----------------------------- | --------------------------------- | --------- |
39+
| Initialize planning artifacts | Begin structured project planning | — Pending |
40+
41+
---
42+
43+
_Last updated: [date]_

‎.planning/REQUIREMENTS.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Requirements: CLI Project
2+
3+
**Defined:** [date]
4+
**Core Value:** Make the CLI and templates reliable and easy to extend
5+
6+
## v1 Requirements
7+
8+
### CLI
9+
10+
- [ ] **CLI-01**: CLI can scaffold a plugin using `create plugin` command
11+
- [ ] **CLI-02**: CLI build scripts pass locally (TypeScript compiles)
12+
- [ ] **CLI-03**: Tests run with `pnpm test` and pass in CI
13+
14+
### Templates
15+
16+
- [ ] **TPL-01**: Plugin template under `files/create-plugin/` generates a working plugin
17+
- [ ] **TPL-02**: Shape template under `files/create-shape/` generates a working shape
18+
19+
## v2 Requirements
20+
21+
- **DOC-01**: Add CONTRIBUTING.md with dev setup
22+
23+
## Out of Scope
24+
25+
| Feature | Reason |
26+
| -------------------------- | ------------------------------ |
27+
| Large runtime app features | Not related to CLI scaffolding |
28+
29+
## Traceability
30+
31+
| Requirement | Phase | Status |
32+
| ----------- | ------- | ------- |
33+
| CLI-01 | Phase 1 | Pending |
34+
| CLI-02 | Phase 1 | Pending |
35+
| CLI-03 | Phase 1 | Pending |
36+
| TPL-01 | Phase 1 | Pending |
37+
| TPL-02 | Phase 1 | Pending |
38+
39+
---
40+
41+
_Requirements defined: [date]_

‎.planning/ROADMAP.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# ROADMAP
2+
3+
## Overview
4+
5+
Phases derived from v1 requirements. All v1 requirements are covered across the phases below.
6+
7+
| # | Phase | Goal | Requirements |
8+
| --- | -------------------- | --------------------------------------------- | ------------------------------ |
9+
| 1 | Core CLI & Templates | Ensure CLI scaffolding and build are reliable | CLI-01, CLI-02, TPL-01, TPL-02 |
10+
| 2 | Tests & CI | Ensure tests run and CI is healthy | CLI-03 |
11+
| 3 | Docs & Developer UX | Improve contributor onboarding and docs | DOC-01 |
12+
13+
## Phase Details
14+
15+
### Phase 1: Core CLI & Templates
16+
17+
Goal: Users can scaffold plugins and shapes and build the codebase locally.
18+
Requirements: CLI-01, CLI-02, TPL-01, TPL-02
19+
Success criteria:
20+
21+
1. `create plugin` generates a working plugin scaffold
22+
2. TypeScript build completes without errors
23+
3. Templates include README and basic tests
24+
25+
### Phase 2: Tests & CI
26+
27+
Goal: Ensure tests run locally and in CI, coverage tracked.
28+
Requirements: CLI-03
29+
Success criteria:
30+
31+
1. Vitest runs and reports passing tests locally
32+
2. CI workflow runs tests and reports status
33+
34+
### Phase 3: Docs & Developer UX
35+
36+
Goal: Improve onboarding and developer docs
37+
Requirements: DOC-01
38+
Success criteria:
39+
40+
1. CONTRIBUTING.md created with setup steps
41+
2. Quickstart added to README

‎.planning/STATE.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
## Project Reference
2+
3+
See: .planning/PROJECT.md (initialized)
4+
5+
**Core value:** Make the CLI and templates reliable and easy to extend
6+
**Current focus:** Phase 1 — Core CLI & Templates

‎.planning/codebase/ARCHITECTURE.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
Architecture Overview
2+
- CLI entrypoint: src/cli.ts
3+
- Feature modules: src/create, src/build

‎.planning/codebase/CONCERNS.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
Concerns
2+
- Some build scripts may lack tests
3+
- CI secrets should be reviewed

‎.planning/codebase/CONVENTIONS.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
Conventions
2+
- TypeScript + Prettier + ESLint
3+
- Organize by feature

‎.planning/codebase/INTEGRATIONS.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
External Integrations
2+
- GitHub Actions for CI
3+
- npm registry for publishing

‎.planning/codebase/STACK.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
Project Technology Stack
2+
3+
Languages & Runtimes
4+
- TypeScript (src/)
5+
- Node.js for CLI
6+
7+
Tools
8+
- Vitest, tsc, pnpm
9+
10+
Config locations
11+
- package.json, tsconfig.json

‎.planning/codebase/STRUCTURE.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
Structure
2+
- src/, files/, .github/
3+
- templates in files/

0 commit comments

Comments
 (0)