Document that scripts is flat with no subfolders or index files
Check / check (pull_request) Successful in 39s
Check / check (pull_request) Successful in 39s
This commit is contained in:
@@ -55,3 +55,20 @@ so they never reach package consumers.
|
||||
|
||||
Relative imports inside one directory (`./sibling.ts`) are fine, with the
|
||||
`.ts` extension written out.
|
||||
|
||||
## `scripts/` is flat (user rule, 2026-10-16)
|
||||
|
||||
- `scripts/` has no subfolders and no `index.ts`. Barrels and `index.ts`
|
||||
entries exist only inside `src/`; delete any `index.ts` outside it.
|
||||
- Each tool is one file, `scripts/<name>.ts`, imported directly by file:
|
||||
`import { decorators } from "./scripts/decorators.ts";` in
|
||||
`vite.config.ts`.
|
||||
- Code in a former `scripts/<tool>/` folder is merged or renamed into flat
|
||||
`scripts/<name>.ts` files. Non-TS assets (HTML, images, fixtures) move to
|
||||
where they belong (next to the tool's output, `.agents/`, or a gitignored
|
||||
scratch dir). A subfolder that is really an app moves under `src/` as an
|
||||
aliased folder.
|
||||
- import-check 0.10.0+ checks folder layout only where the importer or the
|
||||
target sits in a `#`-aliased folder, so `vite.config.ts` →
|
||||
`./scripts/x.ts` passes without any override. Remove overrides that only
|
||||
dodged import-check.
|
||||
|
||||
Reference in New Issue
Block a user