@adbayb/stack 3.3.0 → 3.4.0-next.1790510648211.1f8a8d0
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/dist/index.js
CHANGED
package/package.json
CHANGED
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
# AGENTS.md
|
|
2
|
+
|
|
3
|
+
This repo is `{{projectName}}` — {{projectDescription}}.
|
|
4
|
+
Scaffolded with `@adbayb/stack`. All workflow scripts delegate to the `stack` binary.
|
|
5
|
+
|
|
6
|
+
> Extend `Layout` and `Conventions` as packages are added and project-specific rules emerge.
|
|
7
|
+
|
|
8
|
+
## Project
|
|
9
|
+
|
|
10
|
+
- `{{projectName}}` — {{projectDescription}}.
|
|
11
|
+
- Repository: `{{projectUrl}}` (`{{repoId}}`).
|
|
12
|
+
- Public packages live in `libraries/*` (entry `src/index.ts`, built to `dist/**` with `quickbundle`); runnable apps live in `applications/*`.
|
|
13
|
+
- Playground: `examples/*` (private, excluded from `build`/`check` orchestration).
|
|
14
|
+
|
|
15
|
+
## Bootstrap (order matters)
|
|
16
|
+
|
|
17
|
+
- Requires Node `{{nodeVersion}}` and pnpm `{{pnpmVersion}}` (`devEngines` in root `package.json`).
|
|
18
|
+
- After `stack create`: `pnpm install --frozen-lockfile`, then `stack install`.
|
|
19
|
+
- `stack install` writes `.git/hooks/pre-commit` (`stack fix <changed-files> && git add -A`) and `commit-msg` (`stack check --filter commit`). Re-run it if hooks are missing.
|
|
20
|
+
|
|
21
|
+
## Commands — always use these, not raw tools
|
|
22
|
+
|
|
23
|
+
Root scripts (`package.json`) are thin wrappers around `stack`, which wraps turbo / oxlint / oxfmt / commitlint / changesets / quickbundle:
|
|
24
|
+
|
|
25
|
+
- `pnpm build` (`stack build` → `turbo run build`, cached, outputs `dist/**`, builder is `quickbundle build`)
|
|
26
|
+
- `pnpm check` (`stack check`: builds first excluding examples, then dependency + formatting + code + commit checks)
|
|
27
|
+
- `pnpm fix` (`stack fix`: auto-fixable oxlint `--fix-dangerously` + oxfmt `--write`)
|
|
28
|
+
- `pnpm test` (`stack test` → `turbo run test`, `dependsOn: build`, so build runs first)
|
|
29
|
+
- `pnpm clean` (`stack clean`: deletes `git clean -fdXn` output, preserves `node_modules`, plus `node_modules/.cache`)
|
|
30
|
+
- Release via changesets: `pnpm release:changelog` (`--changelog`), `release:version` (`--bump`), `release:snapshot` (`--snapshot`), `release:publish` (`--publish`)
|
|
31
|
+
|
|
32
|
+
Focused verification: `stack check --filter <code|formatting|dependency|commit> [files...]` and `stack fix [files...]`. CI order (`.github/workflows/workflow.yml`) is `install --frozen-lockfile` → `build` → `check` → `test`.
|
|
33
|
+
|
|
34
|
+
## Layout
|
|
35
|
+
|
|
36
|
+
- `libraries/*/`: publishable packages (`src/index.ts` entry, `src/*.test.ts` colocated tests via `vitest`, `package.json` `exports` point to `dist/**`). The initial one is `libraries/{{projectName}}/`.
|
|
37
|
+
- `applications/*/`: runnable apps depending on `libraries/*` via `workspace:`.
|
|
38
|
+
- `examples/*/`: private playground apps (excluded from build/check orchestration).
|
|
39
|
+
- `tools/*/`: private local tooling packages.
|
|
40
|
+
- Root configs (`oxlint.config.ts`, `oxfmt.config.ts`, `tsconfig.json`, `turbo.json`) just re-export `@adbayb/stack` shared presets — extend, don't replace.
|
|
41
|
+
- pnpm workspace members: `applications/*`, `libraries/*`, `examples/*`, `tools/*` (`pnpm-workspace.yaml`, `saveExact: true`).
|
|
42
|
+
|
|
43
|
+
## Conventions / gotchas
|
|
44
|
+
|
|
45
|
+
- No direct `oxlint`/`oxfmt`/`turbo`/`tsc` calls — go through `stack check|fix|test` so shared presets and turbo orchestration apply.
|
|
46
|
+
- Conventional Commits enforced (commitlint + `commit-msg` hook); `stack check` without `--filter commit` also triggers a build.
|
|
47
|
+
- `stack clean` is git-aware: untracked-but-ignored files are removed, `node_modules` is kept. Don't hand-delete `dist/` per package; use it.
|
|
48
|
+
- `saveExact: true` — pin versions, no `^` in new deps (except `workspace:` ranges).
|
|
49
|
+
- Cross-package imports only via workspace package names — no relative imports across `applications`/`libraries` boundaries.
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# AGENTS.md
|
|
2
|
+
|
|
3
|
+
This repo is `{{projectName}}` — {{projectDescription}}.
|
|
4
|
+
Scaffolded with `@adbayb/stack`. All workflow scripts delegate to the `stack` binary.
|
|
5
|
+
|
|
6
|
+
> Extend `Layout` and `Conventions` as packages are added and project-specific rules emerge.
|
|
7
|
+
|
|
8
|
+
## Project
|
|
9
|
+
|
|
10
|
+
- `{{projectName}}` — {{projectDescription}}.
|
|
11
|
+
- Repository: `{{projectUrl}}` (`{{repoId}}`).
|
|
12
|
+
- Public package: `{{projectName}}` (`./{{projectName}}/src/index.ts` is the entry point, built to `dist/**` with `quickbundle`).
|
|
13
|
+
- Playground: `examples/*` (private, excluded from `build`/`check` orchestration).
|
|
14
|
+
|
|
15
|
+
## Bootstrap (order matters)
|
|
16
|
+
|
|
17
|
+
- Requires Node `{{nodeVersion}}` and pnpm `{{pnpmVersion}}` (`devEngines` in root `package.json`).
|
|
18
|
+
- After `stack create`: `pnpm install --frozen-lockfile`, then `stack install`.
|
|
19
|
+
- `stack install` writes `.git/hooks/pre-commit` (`stack fix <changed-files> && git add -A`) and `commit-msg` (`stack check --filter commit`). Re-run it if hooks are missing.
|
|
20
|
+
|
|
21
|
+
## Commands — always use these, not raw tools
|
|
22
|
+
|
|
23
|
+
Root scripts (`package.json`) are thin wrappers around `stack`, which wraps turbo / oxlint / oxfmt / commitlint / changesets / quickbundle:
|
|
24
|
+
|
|
25
|
+
- `pnpm build` (`stack build` → `turbo run build`, cached, outputs `dist/**`, builder is `quickbundle build`)
|
|
26
|
+
- `pnpm check` (`stack check`: builds first excluding examples, then dependency + formatting + code + commit checks)
|
|
27
|
+
- `pnpm fix` (`stack fix`: auto-fixable oxlint `--fix-dangerously` + oxfmt `--write`)
|
|
28
|
+
- `pnpm test` (`stack test` → `turbo run test`, `dependsOn: build`, so build runs first)
|
|
29
|
+
- `pnpm clean` (`stack clean`: deletes `git clean -fdXn` output, preserves `node_modules`, plus `node_modules/.cache`)
|
|
30
|
+
- Release via changesets: `pnpm release:changelog` (`--changelog`), `release:version` (`--bump`), `release:snapshot` (`--snapshot`), `release:publish` (`--publish`)
|
|
31
|
+
|
|
32
|
+
Focused verification: `stack check --filter <code|formatting|dependency|commit> [files...]` and `stack fix [files...]`. CI order (`.github/workflows/workflow.yml`) is `install --frozen-lockfile` → `build` → `check` → `test`.
|
|
33
|
+
|
|
34
|
+
## Layout
|
|
35
|
+
|
|
36
|
+
- `{{projectName}}/`: the publishable package (`src/index.ts` entry, `src/*.test.ts` colocated tests via `vitest`, `package.json` `exports` point to `dist/**`).
|
|
37
|
+
- `examples/*/`: private playground apps consuming `{{projectName}}` via `workspace:` (excluded from build/check orchestration).
|
|
38
|
+
- `tools/*/`: private local tooling packages.
|
|
39
|
+
- Root configs (`oxlint.config.ts`, `oxfmt.config.ts`, `tsconfig.json`, `turbo.json`) just re-export `@adbayb/stack` shared presets — extend, don't replace.
|
|
40
|
+
- pnpm workspace members: `{{projectName}}`, `examples/*`, `tools/*` (`pnpm-workspace.yaml`, `saveExact: true`).
|
|
41
|
+
|
|
42
|
+
## Conventions / gotchas
|
|
43
|
+
|
|
44
|
+
- No direct `oxlint`/`oxfmt`/`turbo`/`tsc` calls — go through `stack check|fix|test` so shared presets and turbo orchestration apply.
|
|
45
|
+
- Conventional Commits enforced (commitlint + `commit-msg` hook); `stack check` without `--filter commit` also triggers a build.
|
|
46
|
+
- `stack clean` is git-aware: untracked-but-ignored files are removed, `node_modules` is kept. Don't hand-delete `dist/` per package; use it.
|
|
47
|
+
- `saveExact: true` — pin versions, no `^` in new deps (except `workspace:` ranges).
|