sequelize-typescript-generator 13.0.0 → 13.1.0
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/README.md +7 -7
- package/build/bin/utils.js +1 -1
- package/build/builders/ModelBuilder.js +26 -5
- package/build/builders/NativeModelRenderer.js +10 -2
- package/build/builders/generatedFile.js +5 -0
- package/build/builders/jsonSupport.d.ts +62 -0
- package/build/builders/jsonSupport.js +82 -0
- package/build/builders/utils.d.ts +20 -2
- package/build/builders/utils.js +39 -5
- package/build/dialects/Dialect.d.ts +1 -0
- package/build/dialects/DialectMariaDB.d.ts +11 -0
- package/build/dialects/DialectMariaDB.js +45 -0
- package/build/dialects/DialectMySQL.js +2 -1
- package/build/dialects/DialectPostgres.d.ts +3 -1
- package/build/dialects/DialectPostgres.js +38 -7
- package/build/dialects/dataTypes.d.ts +18 -4
- package/build/dialects/dataTypes.js +21 -4
- package/build/dialects/mariadbJson.d.ts +39 -0
- package/build/dialects/mariadbJson.js +52 -0
- package/package.json +5 -2
- package/.github/FUNDING.yml +0 -1
- package/.github/workflows/ci.yml +0 -224
- package/.vscode/launch.json +0 -212
- package/.vscode/tasks.json +0 -95
- package/CHANGELOG.md +0 -47
- package/CLAUDE.md +0 -13
- package/CONTEXT.md +0 -67
- package/docker-compose.yml +0 -65
- package/docs/adr/0001-esm-only-package.md +0 -36
- package/docs/adr/0002-native-default-output-format.md +0 -41
- package/docs/agents/domain.md +0 -51
- package/docs/agents/issue-tracker.md +0 -45
- package/docs/agents/triage-labels.md +0 -15
- package/docs/migration/12-to-13.md +0 -248
- package/docs/plans/v13-phase5-association-discovery.md +0 -168
- package/docs/plans/v13-phase6-native-emitter.md +0 -537
- package/docs/plans/v13-upgrade-plan.md +0 -137
- package/jest.config.cjs +0 -31
- package/scripts/check-no-sequelize-typescript.cjs +0 -68
- package/tsconfig.json +0 -22
package/.vscode/tasks.json
DELETED
|
@@ -1,95 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"version": "2.0.0",
|
|
3
|
-
"tasks": [
|
|
4
|
-
{
|
|
5
|
-
// Bring the postgres container up (idempotent) and wait until it accepts connections.
|
|
6
|
-
"label": "db: postgres (up + wait)",
|
|
7
|
-
"type": "shell",
|
|
8
|
-
"command": "docker compose --profile postgres up -d && TEST_DB_DIALECT=postgres TEST_DB_HOST=localhost TEST_DB_PORT=1234 npx tsx src/tests/integration/wait-for-db.ts",
|
|
9
|
-
"problemMatcher": []
|
|
10
|
-
},
|
|
11
|
-
{
|
|
12
|
-
// Bring the mysql container up (idempotent) and wait until it accepts connections.
|
|
13
|
-
"label": "db: mysql (up + wait)",
|
|
14
|
-
"type": "shell",
|
|
15
|
-
"command": "docker compose --profile mysql up -d && TEST_DB_DIALECT=mysql TEST_DB_HOST=localhost TEST_DB_PORT=1234 npx tsx src/tests/integration/wait-for-db.ts",
|
|
16
|
-
"problemMatcher": []
|
|
17
|
-
},
|
|
18
|
-
{
|
|
19
|
-
// Bring the mariadb container up (idempotent) and wait until it accepts connections.
|
|
20
|
-
"label": "db: mariadb (up + wait)",
|
|
21
|
-
"type": "shell",
|
|
22
|
-
"command": "docker compose --profile mariadb up -d && TEST_DB_DIALECT=mariadb TEST_DB_HOST=localhost TEST_DB_PORT=1234 npx tsx src/tests/integration/wait-for-db.ts",
|
|
23
|
-
"problemMatcher": []
|
|
24
|
-
},
|
|
25
|
-
{
|
|
26
|
-
// Bring the mssql container up (idempotent) and wait until it accepts connections.
|
|
27
|
-
"label": "db: mssql (up + wait)",
|
|
28
|
-
"type": "shell",
|
|
29
|
-
"command": "docker compose --profile mssql up -d && TEST_DB_DIALECT=mssql TEST_DB_HOST=localhost TEST_DB_PORT=1234 npx tsx src/tests/integration/wait-for-db.ts",
|
|
30
|
-
"problemMatcher": []
|
|
31
|
-
},
|
|
32
|
-
{
|
|
33
|
-
// Tear down every dialect container and remove its volumes.
|
|
34
|
-
"label": "db: down (all)",
|
|
35
|
-
"type": "shell",
|
|
36
|
-
"command": "docker compose --profile postgres --profile mysql --profile mariadb --profile mssql down -v",
|
|
37
|
-
"problemMatcher": []
|
|
38
|
-
},
|
|
39
|
-
{
|
|
40
|
-
// Full postgres integration cycle: up, wait, jest, down.
|
|
41
|
-
"label": "Integration: postgres (like CI)",
|
|
42
|
-
"type": "npm",
|
|
43
|
-
"script": "test:postgres",
|
|
44
|
-
"problemMatcher": []
|
|
45
|
-
},
|
|
46
|
-
{
|
|
47
|
-
// Full mysql integration cycle: up, wait, jest, down.
|
|
48
|
-
"label": "Integration: mysql (like CI)",
|
|
49
|
-
"type": "npm",
|
|
50
|
-
"script": "test:mysql",
|
|
51
|
-
"problemMatcher": []
|
|
52
|
-
},
|
|
53
|
-
{
|
|
54
|
-
// Full mariadb integration cycle: up, wait, jest, down.
|
|
55
|
-
"label": "Integration: mariadb (like CI)",
|
|
56
|
-
"type": "npm",
|
|
57
|
-
"script": "test:mariadb",
|
|
58
|
-
"problemMatcher": []
|
|
59
|
-
},
|
|
60
|
-
{
|
|
61
|
-
// Full mssql integration cycle: up, wait, jest, down.
|
|
62
|
-
// Requires Node <= 23 locally — tedious/SlowBuffer is broken on Node >= 24.
|
|
63
|
-
"label": "Integration: mssql (like CI)",
|
|
64
|
-
"type": "npm",
|
|
65
|
-
"script": "test:mssql",
|
|
66
|
-
"problemMatcher": []
|
|
67
|
-
},
|
|
68
|
-
{
|
|
69
|
-
// Run every dialect SEQUENTIALLY: all Docker dialects share host port 1234, and each
|
|
70
|
-
// wrapper tears its container down before the next starts, so they cannot overlap.
|
|
71
|
-
"label": "Integration: all dialects (like CI)",
|
|
72
|
-
"type": "shell",
|
|
73
|
-
"command": "npm run test:postgres && npm run test:mysql && npm run test:mariadb && npm run test:mssql && npm run test:sqlite",
|
|
74
|
-
"group": {
|
|
75
|
-
"kind": "test",
|
|
76
|
-
"isDefault": true
|
|
77
|
-
},
|
|
78
|
-
"problemMatcher": []
|
|
79
|
-
},
|
|
80
|
-
{
|
|
81
|
-
// Run the unit test suite.
|
|
82
|
-
"label": "Test: unit",
|
|
83
|
-
"type": "npm",
|
|
84
|
-
"script": "test:unit",
|
|
85
|
-
"problemMatcher": []
|
|
86
|
-
},
|
|
87
|
-
{
|
|
88
|
-
// Run the sqlite integration suite (no container needed).
|
|
89
|
-
"label": "Test: sqlite",
|
|
90
|
-
"type": "npm",
|
|
91
|
-
"script": "test:sqlite",
|
|
92
|
-
"problemMatcher": []
|
|
93
|
-
}
|
|
94
|
-
]
|
|
95
|
-
}
|
package/CHANGELOG.md
DELETED
|
@@ -1,47 +0,0 @@
|
|
|
1
|
-
# Change Log
|
|
2
|
-
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
### 13.0.0
|
|
6
|
-
#### Breaking changes:
|
|
7
|
-
* Native is now the default output format; pass `--format decorators` for the old `sequelize-typescript` decorators output.
|
|
8
|
-
* ESM-only package; Node `>=22.13.0` required.
|
|
9
|
-
* SQLite driver switched to `@vscode/sqlite3` (`sqlite3` is no longer supported).
|
|
10
|
-
* Associations are discovered from foreign keys by default; `--no-associations` restores the old behaviour.
|
|
11
|
-
* `--lint-file` accepts flat config files only; legacy `.eslintrc*` files fail fast.
|
|
12
|
-
* Deep imports under `build/` are closed by the package `exports` map (root entry only).
|
|
13
|
-
|
|
14
|
-
#### Minor changes and bug fixes:
|
|
15
|
-
* New `--paranoid` flag: emit paranoid table options for tables with a `deleted_at`/`deletedAt` column (requires `--timestamps`).
|
|
16
|
-
* `createDialect` factory exported from the package root.
|
|
17
|
-
* SQL Server `schema` in table options and `hasTrigger` detection.
|
|
18
|
-
* See `docs/migration/12-to-13.md` for the full migration guide.
|
|
19
|
-
|
|
20
|
-
---
|
|
21
|
-
|
|
22
|
-
### 10.1.0
|
|
23
|
-
#### Breaking changes:
|
|
24
|
-
|
|
25
|
-
#### Minor changes and bug fixes:
|
|
26
|
-
* Libraries update
|
|
27
|
-
* Changed node.js version to v14.21.3 to test latest versions of `typescript` using `jest`
|
|
28
|
-
|
|
29
|
-
---
|
|
30
|
-
|
|
31
|
-
### 10.0.0
|
|
32
|
-
#### Breaking changes:
|
|
33
|
-
* Typescript: `4.9.4` -> `5.0.2`
|
|
34
|
-
* MySQL driver: `mysql2@2.3.3` -> `mysql2@3.2.0`
|
|
35
|
-
|
|
36
|
-
#### Minor changes and bug fixes:
|
|
37
|
-
* Added change log file
|
|
38
|
-
|
|
39
|
-
---
|
|
40
|
-
|
|
41
|
-
### 9.0.3
|
|
42
|
-
#### Breaking changes:
|
|
43
|
-
* NA
|
|
44
|
-
#### Minor changes and bug fixes:
|
|
45
|
-
* NA
|
|
46
|
-
|
|
47
|
-
---
|
package/CLAUDE.md
DELETED
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
## Agent skills
|
|
2
|
-
|
|
3
|
-
### Issue tracker
|
|
4
|
-
|
|
5
|
-
Issues are tracked in this repo's GitHub Issues via the `gh` CLI. See `docs/agents/issue-tracker.md`.
|
|
6
|
-
|
|
7
|
-
### Triage labels
|
|
8
|
-
|
|
9
|
-
Default triage vocabulary (`needs-triage`, `needs-info`, `ready-for-agent`, `ready-for-human`, `wontfix`). See `docs/agents/triage-labels.md`.
|
|
10
|
-
|
|
11
|
-
### Domain docs
|
|
12
|
-
|
|
13
|
-
Single-context: `CONTEXT.md` + `docs/adr/` at the repo root. See `docs/agents/domain.md`.
|
package/CONTEXT.md
DELETED
|
@@ -1,67 +0,0 @@
|
|
|
1
|
-
# sequelize-typescript-generator
|
|
2
|
-
|
|
3
|
-
Domain glossary for the tool that generates TypeScript Sequelize models directly from an existing database schema.
|
|
4
|
-
|
|
5
|
-
## Language
|
|
6
|
-
|
|
7
|
-
### Source
|
|
8
|
-
|
|
9
|
-
**Dialect**:
|
|
10
|
-
One supported database engine (Postgres, MySQL, MariaDB, SQL Server, SQLite) together with the adapter that inspects its schema metadata: tables, columns, indexes, foreign keys, and views.
|
|
11
|
-
_Avoid_: Engine, database type
|
|
12
|
-
|
|
13
|
-
**Driver**:
|
|
14
|
-
The Node package Sequelize loads to talk to a database (`pg`, `mysql2`, `tedious`, `@vscode/sqlite3`), installed by the user in their own project and never bundled by the generator. For SQLite the generator resolves `@vscode/sqlite3` from the user's project and passes it to Sequelize as `dialectModule`; the `sqlite3` package is no longer documented or tested.
|
|
15
|
-
_Avoid_: Client, connector, dialect module
|
|
16
|
-
|
|
17
|
-
### Output
|
|
18
|
-
|
|
19
|
-
**Model**:
|
|
20
|
-
The generated TypeScript class representing one table or view.
|
|
21
|
-
_Avoid_: Entity, class, DAO
|
|
22
|
-
|
|
23
|
-
**Format**:
|
|
24
|
-
The output style of the generated models. Has exactly two values, native and decorators, selected with the `--format` option.
|
|
25
|
-
_Avoid_: Style, mode, flavour
|
|
26
|
-
|
|
27
|
-
**Native format**:
|
|
28
|
-
Models written as plain Sequelize classes with declared fields and an initialisation call, without any decorator library. Ships with a wiring file. The default format.
|
|
29
|
-
_Avoid_: Plain format, classic format
|
|
30
|
-
|
|
31
|
-
**Decorators format**:
|
|
32
|
-
Models written with sequelize-typescript decorators. Requires the consuming project to install sequelize-typescript.
|
|
33
|
-
_Avoid_: Annotated format, decorator mode
|
|
34
|
-
|
|
35
|
-
**Wiring file**:
|
|
36
|
-
The file generated in native format that initialises every model against a Sequelize instance and declares all associations between them.
|
|
37
|
-
_Avoid_: Index file, bootstrap file, registry
|
|
38
|
-
|
|
39
|
-
**Strict mode**:
|
|
40
|
-
The mode in which a model's attributes are typed by a generated attributes interface. Applies to decorators format only; in native format the class typing already carries the attributes.
|
|
41
|
-
_Avoid_: Typed mode
|
|
42
|
-
|
|
43
|
-
**Case**:
|
|
44
|
-
The naming convention applied to model names and column names: underscore, camel, upper, lower, pascal, or const.
|
|
45
|
-
_Avoid_: Casing, naming style
|
|
46
|
-
|
|
47
|
-
### Associations
|
|
48
|
-
|
|
49
|
-
**Association**:
|
|
50
|
-
A relationship between two models: one-to-one, one-to-many, or many-to-many.
|
|
51
|
-
_Avoid_: Relation, relationship, link
|
|
52
|
-
|
|
53
|
-
**Alias**:
|
|
54
|
-
The name under which an association is exposed on a model, used both as the class property and in queries that include the related model.
|
|
55
|
-
_Avoid_: Association name, relation name, property name
|
|
56
|
-
|
|
57
|
-
**Junction table**:
|
|
58
|
-
A table whose rows link two other tables to express a many-to-many association.
|
|
59
|
-
_Avoid_: Join table, pivot table, through table, bridge table
|
|
60
|
-
|
|
61
|
-
**Associations file**:
|
|
62
|
-
The CSV file a user supplies to declare associations explicitly.
|
|
63
|
-
_Avoid_: Relations file, mapping file
|
|
64
|
-
|
|
65
|
-
**Association discovery**:
|
|
66
|
-
Automatic derivation of one-to-one and one-to-many associations from foreign keys found in the schema.
|
|
67
|
-
_Avoid_: Auto-associations, inference
|
package/docker-compose.yml
DELETED
|
@@ -1,65 +0,0 @@
|
|
|
1
|
-
# Local integration database services, one profile per dialect.
|
|
2
|
-
# Credentials and ports match the defaults in src/tests/environment.ts so the
|
|
3
|
-
# test suites run unchanged. Start a single dialect with, for example:
|
|
4
|
-
# docker compose --profile postgres up -d
|
|
5
|
-
# The npm run test:<dialect> scripts drive these profiles automatically.
|
|
6
|
-
|
|
7
|
-
services:
|
|
8
|
-
postgres:
|
|
9
|
-
profiles: ["postgres"]
|
|
10
|
-
image: postgres:18
|
|
11
|
-
environment:
|
|
12
|
-
POSTGRES_DB: testdb
|
|
13
|
-
POSTGRES_USER: sa
|
|
14
|
-
POSTGRES_PASSWORD: Passw0rd88!
|
|
15
|
-
ports:
|
|
16
|
-
- "1234:5432"
|
|
17
|
-
healthcheck:
|
|
18
|
-
test: ["CMD-SHELL", "pg_isready -U sa -d testdb"]
|
|
19
|
-
interval: 5s
|
|
20
|
-
timeout: 5s
|
|
21
|
-
retries: 20
|
|
22
|
-
|
|
23
|
-
mysql:
|
|
24
|
-
profiles: ["mysql"]
|
|
25
|
-
image: mysql:9.7
|
|
26
|
-
environment:
|
|
27
|
-
MYSQL_DATABASE: testdb
|
|
28
|
-
MYSQL_USER: sa
|
|
29
|
-
MYSQL_PASSWORD: Passw0rd88!
|
|
30
|
-
MYSQL_ROOT_PASSWORD: Passw0rd88!
|
|
31
|
-
ports:
|
|
32
|
-
- "1234:3306"
|
|
33
|
-
healthcheck:
|
|
34
|
-
test: ["CMD-SHELL", "mysqladmin ping -h 127.0.0.1 -u root -pPassw0rd88!"]
|
|
35
|
-
interval: 5s
|
|
36
|
-
timeout: 5s
|
|
37
|
-
retries: 30
|
|
38
|
-
|
|
39
|
-
mariadb:
|
|
40
|
-
profiles: ["mariadb"]
|
|
41
|
-
image: mariadb:12.3
|
|
42
|
-
environment:
|
|
43
|
-
MARIADB_DATABASE: testdb
|
|
44
|
-
MARIADB_USER: sa
|
|
45
|
-
MARIADB_PASSWORD: Passw0rd88!
|
|
46
|
-
MARIADB_ROOT_PASSWORD: Passw0rd88!
|
|
47
|
-
ports:
|
|
48
|
-
- "1234:3306"
|
|
49
|
-
healthcheck:
|
|
50
|
-
test: ["CMD-SHELL", "healthcheck.sh --connect --innodb_initialized"]
|
|
51
|
-
interval: 5s
|
|
52
|
-
timeout: 5s
|
|
53
|
-
retries: 30
|
|
54
|
-
|
|
55
|
-
mssql:
|
|
56
|
-
profiles: ["mssql"]
|
|
57
|
-
image: mcr.microsoft.com/mssql/server:2025-latest
|
|
58
|
-
# The SQL Server image ships amd64 only; on Apple Silicon it runs under Rosetta emulation.
|
|
59
|
-
platform: linux/amd64
|
|
60
|
-
environment:
|
|
61
|
-
ACCEPT_EULA: "Y"
|
|
62
|
-
SA_PASSWORD: Passw0rd88!
|
|
63
|
-
MSSQL_SA_PASSWORD: Passw0rd88!
|
|
64
|
-
ports:
|
|
65
|
-
- "1234:1433"
|
|
@@ -1,36 +0,0 @@
|
|
|
1
|
-
# 0001. ESM-only package
|
|
2
|
-
|
|
3
|
-
- Status: Accepted
|
|
4
|
-
- Date: 2026-09-09
|
|
5
|
-
|
|
6
|
-
## Context
|
|
7
|
-
|
|
8
|
-
The package previously shipped CommonJS. Version 13 moves the toolchain to
|
|
9
|
-
TypeScript 6 with `module: nodenext` and raises the runtime floor to Node
|
|
10
|
-
`>=22.13.0`. That Node version supports `require()` of ESM modules that have no
|
|
11
|
-
top-level await, so CommonJS consumers can still load an ESM-only package. The
|
|
12
|
-
surrounding ecosystem is ESM-first: yargs and the ESLint 10 flat-config stack
|
|
13
|
-
are shipped primarily as ES modules.
|
|
14
|
-
|
|
15
|
-
## Decision
|
|
16
|
-
|
|
17
|
-
Ship the package as ESM only:
|
|
18
|
-
|
|
19
|
-
- `"type": "module"` in `package.json`.
|
|
20
|
-
- A single root `exports` entry plus `./package.json`; no other subpaths.
|
|
21
|
-
- A plain `tsc` build to `build/`, with no bundler and no dual CommonJS output.
|
|
22
|
-
- `.js` suffixes on relative imports, as `module: nodenext` requires.
|
|
23
|
-
- No top-level `await` in the shipped entry, so `require()` of the package from
|
|
24
|
-
CommonJS keeps working. A test loads the root entry with `require()` from a
|
|
25
|
-
CommonJS script to verify this.
|
|
26
|
-
|
|
27
|
-
## Consequences
|
|
28
|
-
|
|
29
|
-
- Consumers on Node `<22.13` are unsupported.
|
|
30
|
-
- No dual build to maintain.
|
|
31
|
-
- Deep imports into `build/` are not supported; the `exports` map exposes the
|
|
32
|
-
root entry only.
|
|
33
|
-
- Generated model files are unchanged by this decision. Adding a `.js` suffix to
|
|
34
|
-
relative imports in generated code, for strict Node ESM consumers, is a
|
|
35
|
-
post-13 backlog item in the v13 upgrade plan
|
|
36
|
-
(`docs/plans/v13-upgrade-plan.md`).
|
|
@@ -1,41 +0,0 @@
|
|
|
1
|
-
# 0002. Native default output format
|
|
2
|
-
|
|
3
|
-
- Status: Accepted
|
|
4
|
-
- Date: 2026-09-10
|
|
5
|
-
|
|
6
|
-
## Context
|
|
7
|
-
|
|
8
|
-
Every version before 13 emitted a single output style: `sequelize-typescript`
|
|
9
|
-
decorated classes, which require the consuming project to install
|
|
10
|
-
`sequelize-typescript` and `reflect-metadata`. Version 13 (issue #80) adds a
|
|
11
|
-
framework-free native emitter that produces plain `sequelize` classes: attributes
|
|
12
|
-
typed with `InferAttributes` / `InferCreationAttributes`, `declare`d fields wrapped
|
|
13
|
-
with `CreationOptional`, `ForeignKey` and `NonAttribute`, a `static initModel`
|
|
14
|
-
method per model, and an `initModels` wiring file plus an `index.ts` barrel. With
|
|
15
|
-
two formats available the generator needs a default.
|
|
16
|
-
|
|
17
|
-
## Decision
|
|
18
|
-
|
|
19
|
-
Make the native format the default:
|
|
20
|
-
|
|
21
|
-
- `--format native` is the default; `--format decorators` is opt-in.
|
|
22
|
-
- The programmatic `IConfig.format` option defaults to `'native'` when unset.
|
|
23
|
-
- `strict` applies to the decorators format only. It is ignored under native, where
|
|
24
|
-
attributes are always typed with `InferAttributes`; combining `--no-strict` with
|
|
25
|
-
native prints a notice and does nothing else.
|
|
26
|
-
|
|
27
|
-
## Consequences
|
|
28
|
-
|
|
29
|
-
- Breaking change for existing consumers: anyone relying on the previous decorators
|
|
30
|
-
output must now pass `--format decorators` (or set `format: 'decorators'`).
|
|
31
|
-
- Native models depend on `sequelize` alone; `sequelize-typescript` and
|
|
32
|
-
`reflect-metadata` are needed only for the decorators format. When the decorators
|
|
33
|
-
format is selected and `sequelize-typescript` cannot be resolved from the output
|
|
34
|
-
directory, a warning is emitted; the generator never throws for this.
|
|
35
|
-
- SQLite-specific quirk: SQLite reports `notnull=0` for an integer rowid primary
|
|
36
|
-
key, so native types such a primary key as `CreationOptional<number | null>`. The
|
|
37
|
-
init options stay correct (`primaryKey` and `autoIncrement` set, `allowNull`
|
|
38
|
-
omitted). Dialects that report `notnull=1` for their generated primary key emit
|
|
39
|
-
`CreationOptional<number>`.
|
|
40
|
-
|
|
41
|
-
See issue #80 and `docs/plans/v13-phase6-native-emitter.md`.
|
package/docs/agents/domain.md
DELETED
|
@@ -1,51 +0,0 @@
|
|
|
1
|
-
# Domain Docs
|
|
2
|
-
|
|
3
|
-
How the engineering skills should consume this repo's domain documentation when exploring the codebase.
|
|
4
|
-
|
|
5
|
-
## Before exploring, read these
|
|
6
|
-
|
|
7
|
-
- **`CONTEXT.md`** at the repo root, or
|
|
8
|
-
- **`CONTEXT-MAP.md`** at the repo root if it exists: it points at one `CONTEXT.md` per context. Read each one relevant to the topic.
|
|
9
|
-
- **`docs/adr/`**: read ADRs that touch the area you're about to work in. In multi-context repos, also check `src/<context>/docs/adr/` for context-scoped decisions.
|
|
10
|
-
|
|
11
|
-
If any of these files don't exist, **proceed silently**. Don't flag their absence; don't suggest creating them upfront. The `/domain-modeling` skill (reached via `/grill-with-docs` and `/improve-codebase-architecture`) creates them lazily when terms or decisions actually get resolved.
|
|
12
|
-
|
|
13
|
-
## File structure
|
|
14
|
-
|
|
15
|
-
Single-context repo (most repos):
|
|
16
|
-
|
|
17
|
-
```
|
|
18
|
-
/
|
|
19
|
-
├── CONTEXT.md
|
|
20
|
-
├── docs/adr/
|
|
21
|
-
│ ├── 0001-event-sourced-orders.md
|
|
22
|
-
│ └── 0002-postgres-for-write-model.md
|
|
23
|
-
└── src/
|
|
24
|
-
```
|
|
25
|
-
|
|
26
|
-
Multi-context repo (presence of `CONTEXT-MAP.md` at the root):
|
|
27
|
-
|
|
28
|
-
```
|
|
29
|
-
/
|
|
30
|
-
├── CONTEXT-MAP.md
|
|
31
|
-
├── docs/adr/ ← system-wide decisions
|
|
32
|
-
└── src/
|
|
33
|
-
├── ordering/
|
|
34
|
-
│ ├── CONTEXT.md
|
|
35
|
-
│ └── docs/adr/ ← context-specific decisions
|
|
36
|
-
└── billing/
|
|
37
|
-
├── CONTEXT.md
|
|
38
|
-
└── docs/adr/
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
## Use the glossary's vocabulary
|
|
42
|
-
|
|
43
|
-
When your output names a domain concept (in an issue title, a refactor proposal, a hypothesis, a test name), use the term as defined in `CONTEXT.md`. Don't drift to synonyms the glossary explicitly avoids.
|
|
44
|
-
|
|
45
|
-
If the concept you need isn't in the glossary yet, that's a signal: either you're inventing language the project doesn't use (reconsider) or there's a real gap (note it for `/domain-modeling`).
|
|
46
|
-
|
|
47
|
-
## Flag ADR conflicts
|
|
48
|
-
|
|
49
|
-
If your output contradicts an existing ADR, surface it explicitly rather than silently overriding:
|
|
50
|
-
|
|
51
|
-
> _Contradicts ADR-0007 (event-sourced orders), but worth reopening because…_
|
|
@@ -1,45 +0,0 @@
|
|
|
1
|
-
# Issue tracker: GitHub
|
|
2
|
-
|
|
3
|
-
Issues and specs for this repo live as GitHub issues. Use the `gh` CLI for all operations.
|
|
4
|
-
|
|
5
|
-
## Conventions
|
|
6
|
-
|
|
7
|
-
- **Create an issue**: `gh issue create --title "..." --body "..."`. Use a heredoc for multi-line bodies.
|
|
8
|
-
- **Read an issue**: `gh issue view <number> --comments`, filtering comments by `jq` and also fetching labels.
|
|
9
|
-
- **List issues**: `gh issue list --state open --json number,title,body,labels,comments --jq '[.[] | {number, title, body, labels: [.labels[].name], comments: [.comments[].body]}]'` with appropriate `--label` and `--state` filters.
|
|
10
|
-
- **Comment on an issue**: `gh issue comment <number> --body "..."`
|
|
11
|
-
- **Apply / remove labels**: `gh issue edit <number> --add-label "..."` / `--remove-label "..."`
|
|
12
|
-
- **Close**: `gh issue close <number> --comment "..."`
|
|
13
|
-
|
|
14
|
-
Infer the repo from `git remote -v`; `gh` does this automatically when run inside a clone.
|
|
15
|
-
|
|
16
|
-
## Pull requests as a triage surface
|
|
17
|
-
|
|
18
|
-
**PRs as a request surface: no.** _(Set to `yes` if this repo treats external PRs as feature requests; `/triage` reads this flag.)_
|
|
19
|
-
|
|
20
|
-
When set to `yes`, PRs run through the same labels and states as issues, using the `gh pr` equivalents:
|
|
21
|
-
|
|
22
|
-
- **Read a PR**: `gh pr view <number> --comments` and `gh pr diff <number>` for the diff.
|
|
23
|
-
- **List external PRs for triage**: `gh pr list --state open --json number,title,body,labels,author,authorAssociation,comments` then keep only `authorAssociation` of `CONTRIBUTOR`, `FIRST_TIME_CONTRIBUTOR`, or `NONE` (drop `OWNER`/`MEMBER`/`COLLABORATOR`).
|
|
24
|
-
- **Comment / label / close**: `gh pr comment`, `gh pr edit --add-label`/`--remove-label`, `gh pr close`.
|
|
25
|
-
|
|
26
|
-
GitHub shares one number space across issues and PRs, so a bare `#42` may be either: resolve with `gh pr view 42` and fall back to `gh issue view 42`.
|
|
27
|
-
|
|
28
|
-
## When a skill says "publish to the issue tracker"
|
|
29
|
-
|
|
30
|
-
Create a GitHub issue.
|
|
31
|
-
|
|
32
|
-
## When a skill says "fetch the relevant ticket"
|
|
33
|
-
|
|
34
|
-
Run `gh issue view <number> --comments`.
|
|
35
|
-
|
|
36
|
-
## Wayfinding operations
|
|
37
|
-
|
|
38
|
-
Used by `/wayfinder`. The **map** is a single issue with **child** issues as tickets.
|
|
39
|
-
|
|
40
|
-
- **Map**: a single issue labelled `wayfinder:map`, holding the Notes / Decisions-so-far / Fog body. `gh issue create --label wayfinder:map`.
|
|
41
|
-
- **Child ticket**: an issue linked to the map as a GitHub sub-issue (`gh api` on the sub-issues endpoint). Where sub-issues aren't enabled, add the child to a task list in the map body and put `Part of #<map>` at the top of the child body. Labels: `wayfinder:<type>` (`research`/`prototype`/`grilling`/`task`). Once claimed, the ticket is assigned to the driving dev.
|
|
42
|
-
- **Blocking**: GitHub's **native issue dependencies**, the canonical, UI-visible representation. Add an edge with `gh api --method POST repos/<owner>/<repo>/issues/<child>/dependencies/blocked_by -F issue_id=<blocker-db-id>`, where `<blocker-db-id>` is the blocker's numeric **database id** (`gh api repos/<owner>/<repo>/issues/<n> --jq .id`, _not_ the `#number` or `node_id`). GitHub reports `issue_dependencies_summary.blocked_by` (open blockers only, the live gate). Where dependencies aren't available, fall back to a `Blocked by: #<n>, #<n>` line at the top of the child body. A ticket is unblocked when every blocker is closed.
|
|
43
|
-
- **Frontier query**: list the map's open children (`gh issue list --state open`, scoped to the map's sub-issues / task list), drop any with an open blocker (`issue_dependencies_summary.blocked_by > 0`, or an open issue in the `Blocked by` line) or an assignee; first in map order wins.
|
|
44
|
-
- **Claim**: `gh issue edit <n> --add-assignee @me`, the session's first write.
|
|
45
|
-
- **Resolve**: `gh issue comment <n> --body "<answer>"`, then `gh issue close <n>`, then append a context pointer (gist + link) to the map's Decisions-so-far.
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
# Triage Labels
|
|
2
|
-
|
|
3
|
-
The skills speak in terms of five canonical triage roles. This file maps those roles to the actual label strings used in this repo's issue tracker.
|
|
4
|
-
|
|
5
|
-
| Label in mattpocock/skills | Label in our tracker | Meaning |
|
|
6
|
-
| -------------------------- | -------------------- | ---------------------------------------- |
|
|
7
|
-
| `needs-triage` | `needs-triage` | Maintainer needs to evaluate this issue |
|
|
8
|
-
| `needs-info` | `needs-info` | Waiting on reporter for more information |
|
|
9
|
-
| `ready-for-agent` | `ready-for-agent` | Fully specified, ready for an AFK agent |
|
|
10
|
-
| `ready-for-human` | `ready-for-human` | Requires human implementation |
|
|
11
|
-
| `wontfix` | `wontfix` | Will not be actioned |
|
|
12
|
-
|
|
13
|
-
When a skill mentions a role (e.g. "apply the AFK-ready triage label"), use the corresponding label string from this table.
|
|
14
|
-
|
|
15
|
-
Edit the right-hand column to match whatever vocabulary you actually use.
|