linear-sdk-cli 0.1.2 → 0.2.1
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/.claude-plugin/marketplace.json +1 -1
- package/.claude-plugin/plugin.json +1 -1
- package/CHANGELOG.md +89 -56
- package/COVERAGE.md +5 -5
- package/MIGRATING.md +71 -69
- package/README.md +115 -90
- package/package.json +6 -7
- package/skills/README.md +15 -0
- package/skills/linear-sdk-cli/SKILL.md +27 -3
- package/skills/linear-sdk-cli/references/api.md +9 -9
- package/skills/linear-sdk-cli/references/auth.md +18 -0
- package/skills/linear-sdk-cli/references/commands.md +2 -2
- package/skills/linear-sdk-cli/references/comment.md +9 -6
- package/skills/linear-sdk-cli/references/config.md +9 -11
- package/skills/linear-sdk-cli/references/issue.md +72 -18
- package/skills/linear-sdk-cli/references/open.md +29 -0
- package/skills/linear-sdk-cli/references/team.md +16 -0
- package/skills/linear-sdk-cli/scripts/generate-docs.ts +6 -2
- package/skills/linear-sdk-cli-maintenance/SKILL.md +93 -0
- package/src/bin/linear.ts +16 -6
- package/src/cli.ts +3 -1
- package/src/commands/agent-session.ts +13 -5
- package/src/commands/api.ts +15 -9
- package/src/commands/attach.ts +15 -4
- package/src/commands/comment.ts +50 -11
- package/src/commands/completion.ts +2 -6
- package/src/commands/cycle.ts +6 -1
- package/src/commands/discover.ts +6 -2
- package/src/commands/document.ts +4 -1
- package/src/commands/initiative.ts +5 -1
- package/src/commands/issue.ts +392 -91
- package/src/commands/meta.ts +139 -31
- package/src/commands/milestone.ts +4 -1
- package/src/commands/notification.ts +15 -6
- package/src/commands/open.ts +84 -0
- package/src/commands/project.ts +17 -4
- package/src/commands/team.ts +13 -0
- package/src/commands/user.ts +2 -2
- package/src/commands/webhook.ts +12 -2
- package/src/config.ts +501 -184
- package/src/context.ts +13 -4
- package/src/git.ts +28 -3
- package/src/lib/body.ts +26 -2
- package/src/lib/errors.ts +33 -8
- package/src/lib/introspect.ts +76 -7
- package/src/lib/keyring.ts +51 -9
- package/src/lib/mentions.ts +49 -0
- package/src/lib/open.ts +32 -0
- package/src/lib/options.ts +108 -12
- package/src/lib/output-shapes.ts +81 -9
- package/src/lib/pagination.ts +50 -17
- package/src/lib/resolve.ts +40 -7
- package/src/lib/shape.ts +16 -12
- package/src/lib/upload.ts +3 -1
- package/src/output/color.ts +52 -0
- package/src/output/format.ts +96 -18
- package/src/output/markdown.ts +133 -0
- package/src/output/pager.ts +131 -0
- package/src/output/sanitize.ts +1 -1
- package/src/output/table.ts +7 -7
- package/src/services/agent-session.ts +11 -3
- package/src/services/attachment.ts +14 -5
- package/src/services/comment.ts +37 -9
- package/src/services/cycle.ts +11 -4
- package/src/services/document.ts +29 -10
- package/src/services/favorite.ts +15 -9
- package/src/services/initiative-update.ts +16 -15
- package/src/services/initiative.ts +15 -10
- package/src/services/issue.ts +263 -19
- package/src/services/label.ts +12 -2
- package/src/services/milestone.ts +8 -5
- package/src/services/notification.ts +16 -2
- package/src/services/organization.ts +23 -18
- package/src/services/project.ts +55 -34
- package/src/services/roadmap.ts +7 -6
- package/src/services/state.ts +9 -3
- package/src/services/team.ts +67 -24
- package/src/services/user.ts +2 -2
- package/src/services/webhook.ts +28 -17
package/CHANGELOG.md
CHANGED
|
@@ -4,10 +4,38 @@ All notable changes to this project are documented here. The format is based on
|
|
|
4
4
|
[Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to
|
|
5
5
|
[Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
6
6
|
|
|
7
|
+
## [0.2.1](https://github.com/zhendalf/linear-sdk-cli/compare/v0.2.0...v0.2.1) (2026-08-24)
|
|
8
|
+
|
|
9
|
+
### Bug Fixes
|
|
10
|
+
|
|
11
|
+
- format generated release notes ([3bab1dd](https://github.com/zhendalf/linear-sdk-cli/commit/3bab1dda627cd83d1feb8a2e1c0a7da37bee10db))
|
|
12
|
+
|
|
13
|
+
## [0.2.0](https://github.com/zhendalf/linear-sdk-cli/compare/v0.1.3...v0.2.0) (2026-08-24)
|
|
14
|
+
|
|
15
|
+
### Features
|
|
16
|
+
|
|
17
|
+
- expand CLI workflows and terminal UX ([0fe31cc](https://github.com/zhendalf/linear-sdk-cli/commit/0fe31cca7e71d0fa6eee2b7c1461ecaf0a01103f))
|
|
18
|
+
|
|
19
|
+
### Bug Fixes
|
|
20
|
+
|
|
21
|
+
- **ci:** give release dispatch repository context ([#15](https://github.com/zhendalf/linear-sdk-cli/issues/15)) ([e3f51e6](https://github.com/zhendalf/linear-sdk-cli/commit/e3f51e600102416f3bd3212578b364a13a452e49))
|
|
22
|
+
|
|
23
|
+
## [0.1.3](https://github.com/zhendalf/linear-sdk-cli/compare/v0.1.2...v0.1.3) (2026-08-24)
|
|
24
|
+
|
|
25
|
+
### Bug Fixes
|
|
26
|
+
|
|
27
|
+
- **ci:** grant OIDC to automated publisher ([#7](https://github.com/zhendalf/linear-sdk-cli/issues/7)) ([acc6e4b](https://github.com/zhendalf/linear-sdk-cli/commit/acc6e4b9c4ab485ce39eeec7eb2c835892016e59))
|
|
28
|
+
|
|
7
29
|
## [Unreleased]
|
|
8
30
|
|
|
9
31
|
### Added
|
|
10
32
|
|
|
33
|
+
- **Explicit, notification-capable comment mentions (`--mention`, TES-738).** Ordinary `@name`
|
|
34
|
+
text remains literal Markdown. Comment-writing commands now accept repeatable
|
|
35
|
+
`--mention <name|email|me|id>`, resolve each user exactly, deduplicate repeats, and prepend real
|
|
36
|
+
Linear mention tokens as their own paragraph. The option is available on `issue comment`,
|
|
37
|
+
`comment add`, `comment reply`, and `comment update`, including the shared
|
|
38
|
+
`issue comment add/update` mounts.
|
|
11
39
|
- **Every command declares its `--json` output, and `linear commands <path>` prints it (TES-610).**
|
|
12
40
|
An agent driving the CLI cold guessed key names and filed false bugs (`.user` read as `.author`,
|
|
13
41
|
`.parent` as `.parentId`); the field names were knowable only from the source. Each node of
|
|
@@ -16,7 +44,7 @@ All notable changes to this project are documented here. The format is based on
|
|
|
16
44
|
`completion`), `fields` (key → `"string"`, `"number|null"`, `["string"]`, nested `{…}`,
|
|
17
45
|
`{nullable: {…}}` for a relation that may be null, `"comments?"` for a key present only
|
|
18
46
|
sometimes) and `variants` (the whole shape under `--web`, `--start`, `op=list`, …). New `linear
|
|
19
|
-
|
|
47
|
+
commands <path...>` describes one command — a bare object under `--json` (`.output.fields`),
|
|
20
48
|
or usage, options and one `key: type` line per field for a human, plus its subcommands for a
|
|
21
49
|
group; an unknown path is `not_found` (exit 3) with the nearest paths. The shapes are declared
|
|
22
50
|
beside the interfaces they describe (`shape<IssueRow>({…})`, `src/lib/shape.ts`), where a field
|
|
@@ -61,9 +89,9 @@ All notable changes to this project are documented here. The format is based on
|
|
|
61
89
|
TES-642).** `initiative add-project <initiative> <project>` (`--sort-order`) and
|
|
62
90
|
`remove-project` (confirmed; finds the link on the project's side, so no workspace-wide paging)
|
|
63
91
|
and `initiative unarchive <id>` (resolves among archived initiatives, refuses a live one). `initiative
|
|
64
|
-
|
|
92
|
+
list` gains `--status`, `--owner`, `--archived` — the list stays every-status by default, and
|
|
65
93
|
the reference CLI's `--all-statuses` is accepted as the no-op it is here. `initiative
|
|
66
|
-
|
|
94
|
+
create/update` take `--icon`/`--color`, and `initiative view` shows `icon`, `archivedAt` and
|
|
67
95
|
the linked `projects` (`{id, name, status}`).
|
|
68
96
|
- **`project list --all-teams`, `team create --private`, health-only status updates (TES-642).**
|
|
69
97
|
`project list` is scoped to the default team and the only way out was the accidental
|
|
@@ -104,7 +132,7 @@ All notable changes to this project are documented here. The format is based on
|
|
|
104
132
|
a repository; `--path` to choose), taking `--team` or offering the workspace's teams in a prompt;
|
|
105
133
|
it refuses to replace an existing file without `--force`. `config set <key> <value>` changes one
|
|
106
134
|
of `team`, `workspace`, `sort`, `vcs` in the project config discovery would actually read — a
|
|
107
|
-
schpet-written `.config/linear.toml` included, in
|
|
135
|
+
schpet-written `.config/linear.toml` included, in _its_ spelling (`team_id`, `issue_sort`), so no
|
|
108
136
|
second competing key appears — or, with `--user`, in `~/.config/linear/config.toml`. The edit is
|
|
109
137
|
textual, one line replaced or appended before the first table, so comments and layout survive;
|
|
110
138
|
the result is parsed back to prove it, falling back to a full re-serialize only if a layout we
|
|
@@ -125,7 +153,7 @@ All notable changes to this project are documented here. The format is based on
|
|
|
125
153
|
in exactly one state, so intersecting them would build a filter that can never match. A single
|
|
126
154
|
`--team`/`--state` sends the exact filter it always did (`key: { eq }` / `type: { eq }`);
|
|
127
155
|
several send `key: { in: [...] }` and an `or` of state clauses. `--state` keeps taking a state
|
|
128
|
-
|
|
156
|
+
_name_ or a state _type_, mixed freely: names stay individual `eqIgnoreCase` clauses because
|
|
129
157
|
`in` is exact-case, so `--state 'in progress'` still matches "In Progress".
|
|
130
158
|
`--team` is repeatable **only on the three issue queries**. It is a global option that ~135
|
|
131
159
|
commands use for something other than filtering — the team an issue is created in, the team a
|
|
@@ -139,7 +167,7 @@ All notable changes to this project are documented here. The format is based on
|
|
|
139
167
|
ISO 8601. The date is validated locally first: `new Date()` accepts "1", "March 2024" and
|
|
140
168
|
"yesterday", and a garbage bound is not an API error but an empty result set — a filter that
|
|
141
169
|
silently matches nothing looks exactly like a query with no matches.
|
|
142
|
-
- **`--project-label`** — every issue whose
|
|
170
|
+
- **`--project-label`** — every issue whose _project_ carries a label, matched case-insensitively
|
|
143
171
|
(`--project-label backend` finds the "Backend" label). Mutually exclusive with `--project`:
|
|
144
172
|
one names a single project, the other a set of them.
|
|
145
173
|
- **`--search-comments`** (`issue search` only) — match comment bodies as well as titles and
|
|
@@ -152,7 +180,7 @@ All notable changes to this project are documented here. The format is based on
|
|
|
152
180
|
only changes precision: with `--project` the name is resolved to a milestone id inside that
|
|
153
181
|
project, without it the milestone is matched by name across projects. A transplanted command
|
|
154
182
|
always passes `--project` and behaves identically either way.
|
|
155
|
-
- **`issue update --team <key>` now actually moves the issue between teams** (
|
|
183
|
+
- **`issue update --team <key>` now actually moves the issue between teams** (the flag
|
|
156
184
|
was accepted and silently dropped — alone it produced a misleading "Nothing to update", and
|
|
157
185
|
alongside another flag it moved nothing at all). Everything team-scoped in the same command is
|
|
158
186
|
resolved against the **destination** team, so `issue update TES-42 --team ENG --state 'In Review'`
|
|
@@ -172,12 +200,12 @@ All notable changes to this project are documented here. The format is based on
|
|
|
172
200
|
- **Short flags.** `-j` for the global `--json` (the reference's most-used flag, on 17 of its
|
|
173
201
|
commands) and `-w` for `--web` on `issue view` / `issue pull-request`. Both letters were
|
|
174
202
|
free in our tree, so neither costs an existing meaning — we still hold one meaning per
|
|
175
|
-
letter everywhere, which is exactly why we are
|
|
176
|
-
(
|
|
203
|
+
letter everywhere, which is exactly why we are _not_ adopting their `-t`/`-p`/`-a`/`-l`/`-s`
|
|
204
|
+
(their own tree spells `-t` as both `--title` and `--team`).
|
|
177
205
|
- **Long-flag spellings.** `--due-date` (`issue create`/`update`), `--target-date` (`project`,
|
|
178
206
|
`milestone`, `initiative` create/update), `--start-date` (`project create`/`update`),
|
|
179
207
|
`--search` (`issue list`/`mine`), and `--all-states` on `issue list`, where it is the
|
|
180
|
-
no-op it describes — `list` already spans every state. Aliases are registered
|
|
208
|
+
no-op it describes — `list` already spans every state. Aliases are registered _hidden_, so
|
|
181
209
|
`--help` and `linear commands --json` keep advertising exactly one spelling per flag; the
|
|
182
210
|
full mapping lives in README's "Coming from linear-cli". Passing both spellings at once is a
|
|
183
211
|
usage error rather than a silent pick: `--due 2026-01-01 --due-date 2026-02-01` is not a typo
|
|
@@ -196,12 +224,12 @@ All notable changes to this project are documented here. The format is based on
|
|
|
196
224
|
`issue comment` gained `add`/`list`/`update`/`delete` subcommands mounted on the same
|
|
197
225
|
handlers as the top-level `comment` group, so there is one implementation, not two.
|
|
198
226
|
`issue comment <id> <body>` is unchanged — commander only dispatches to a subcommand when
|
|
199
|
-
the
|
|
227
|
+
the _first_ operand is one of those four names, which is the one behavior this touches: a
|
|
200
228
|
lone `linear issue comment add` used to mean "comment the word 'add' on the branch's issue"
|
|
201
229
|
and now reaches the subcommand (and says so loudly). The short aliases `ls`/`edit`/`rm` are
|
|
202
230
|
deliberately not registered under `issue comment`, to keep that collision at four words.
|
|
203
231
|
- **`issue mine` — your unstarted work.** The reference `linear-cli` makes this its
|
|
204
|
-
|
|
232
|
+
_default_ listing (`issue list` there is an alias of `mine`), so a script or a habit carried
|
|
205
233
|
over from it silently saw only your own unstarted issues. We keep `list` general — a command
|
|
206
234
|
named "list" should list — and add `mine` next to it with the reference's defaults: the
|
|
207
235
|
viewer's issues, restricted to `unstarted` states, widened by `--all-states`. It takes the same
|
|
@@ -266,9 +294,9 @@ All notable changes to this project are documented here. The format is based on
|
|
|
266
294
|
resolved by name (a team template outranks a shared one of the same name; a miss lists what
|
|
267
295
|
there is), sent as `templateId`; every value you pass alongside overrides what the template
|
|
268
296
|
fills. **The team's default template is now applied**, as Linear's own new-issue form and the
|
|
269
|
-
reference CLI do: the API applies it
|
|
297
|
+
reference CLI do: the API applies it _only when asked_ (verified live — a plain `issueCreate` on
|
|
270
298
|
a team with a default template returns an issue with no description), so `useDefaultTemplate:
|
|
271
|
-
|
|
299
|
+
true` is sent unless `--no-default-template` (also accepted under the reference's spelling,
|
|
272
300
|
`--no-use-default-template`); an explicit `--template` replaces it rather than stacking. A
|
|
273
301
|
`--parent` child now **joins its parent's project** unless `--project` says otherwise — the
|
|
274
302
|
sub-issues we created landed outside the project their parent was in — and `--milestone` can
|
|
@@ -280,13 +308,18 @@ All notable changes to this project are documented here. The format is based on
|
|
|
280
308
|
|
|
281
309
|
### Changed
|
|
282
310
|
|
|
311
|
+
- **Development linting now uses Oxlint instead of ESLint.** The migrated configuration preserves
|
|
312
|
+
the existing recommended JavaScript and TypeScript checks and underscore-prefixed unused-variable
|
|
313
|
+
exceptions while reducing the lint dependency tree and execution time.
|
|
314
|
+
- **TypeScript 7 now powers type-checking.** The native compiler replaces TypeScript 6 without
|
|
315
|
+
source or configuration compatibility changes in this project.
|
|
283
316
|
- **`--fields`, `--limit` and `--all` are refused on commands that never read them** (TES-637 (2),
|
|
284
317
|
TES-596). All twelve globals are registered on every command so they can sit anywhere on the
|
|
285
|
-
line, but `--fields` projects a
|
|
286
|
-
cap or exhaust a
|
|
287
|
-
|
|
318
|
+
line, but `--fields` projects a _rendered_ result (a table or a detail block) and `--limit`/`--all`
|
|
319
|
+
cap or exhaust a _paged_ query; on the ~90 commands that print a receipt (every mutation, `issue
|
|
320
|
+
id`, `commands`, …) all three used to vanish without a word. That silence cost data: schpet's `-f`
|
|
288
321
|
is `--description-file` on `project create`, so `linear project create --name X -f desc.md`
|
|
289
|
-
parsed `-f` as
|
|
322
|
+
parsed `-f` as _our_ `--fields`, created the project with **no description**, and exited 0. Now a
|
|
290
323
|
root `preAction` hook (`assertGlobalsApply` in `lib/options.ts`, driven by two applicability
|
|
291
324
|
tables keyed by command path — `FIELDS_COMMANDS`, `LIMIT_COMMANDS`) rejects them before the
|
|
292
325
|
action runs, with a usage error that names the command and, where the command has one, the flag
|
|
@@ -295,7 +328,7 @@ All notable changes to this project are documented here. The format is based on
|
|
|
295
328
|
`project create -n 5` gets "-n is --limit here; the name is --name". Every renderer and paged
|
|
296
329
|
query is unchanged; the tables are pinned against the real program tree so a rename shows up
|
|
297
330
|
in the tests, and a renderer missing from the table fails loudly (its `--fields` is refused),
|
|
298
|
-
never quietly. `--team` is deliberately
|
|
331
|
+
never quietly. `--team` is deliberately _not_ guarded this way: `alias lin='linear -t TES'` is a
|
|
299
332
|
real usage pattern and must keep working on workspace-scoped commands. Not adopted: a local
|
|
300
333
|
`-f = --description-file` on the four commands — one letter, two meanings (see MIGRATING.md §5).
|
|
301
334
|
- **`project create -t/--team` collects, as `--teams` does** (TES-637 (3)). The global `--team` is
|
|
@@ -303,7 +336,7 @@ All notable changes to this project are documented here. The format is based on
|
|
|
303
336
|
`--team A --team B` created the project in **B alone**. `--team` is now declared locally there,
|
|
304
337
|
repeatable and comma-separated, one list with `--teams`; both flags at once is a usage error
|
|
305
338
|
("Pass either --teams or --team, not both"). `project update --team` stays refused (that list
|
|
306
|
-
|
|
339
|
+
_replaces_ the project's teams; the message points at `--teams`).
|
|
307
340
|
- **`user list --all` / `team members --all` say what `--all` did not do** (TES-637 (1)). schpet's
|
|
308
341
|
`--all` there means "include inactive members"; ours is the global "exhaust pagination", and
|
|
309
342
|
deactivated users are `--include-disabled`. Same line, both exit 0, different rows. `--all` keeps
|
|
@@ -321,17 +354,17 @@ All notable changes to this project are documented here. The format is based on
|
|
|
321
354
|
the PR `ID Title` and stops copying the issue description into GitHub** (TES-637 (5)).
|
|
322
355
|
`describe` used to print `Title`, a blank line, `Fixes ID`; it now prints `ID Title`, a blank
|
|
323
356
|
line, `Linear-issue: Fixes ID`, `Linear-issue-url: <url>` — git trailers that `git
|
|
324
|
-
|
|
357
|
+
interpret-trailers` / `git log --format=%(trailers:key=Linear-issue)` and jj's `trailers`
|
|
325
358
|
template read back, while Linear still sees the magic word directly before the id
|
|
326
359
|
(linear.app/docs/github lists `fixes` and `references` among the recognized words) and links
|
|
327
360
|
and closes the issue. `-r/--references` swaps the word. `--json` gains `url` and `message` (the
|
|
328
361
|
full text as printed). `pull-request`: title `<ID> <title>` (a custom `--title` is prefixed the
|
|
329
362
|
same way, as there); body the same two trailers — schpet sends the bare URL and relies on the
|
|
330
363
|
branch name for the link, the `Fixes` line keeps the link (and auto-close) when the branch was
|
|
331
|
-
renamed. The issue
|
|
364
|
+
renamed. The issue _description_ is no longer pasted into the PR body: a GitHub PR is a wider
|
|
332
365
|
audience than a Linear issue, and Linear links from the trailer, not the prose.
|
|
333
366
|
- **A team-scoped listing with no team says it is listing every team's** (TES-637 (8)). `issue
|
|
334
|
-
|
|
367
|
+
list`/`mine`/`search` and `project list` with no `--team`, no configured team and no
|
|
335
368
|
`--all-teams` list the whole workspace — by design; schpet errors there ("No default team…"), so
|
|
336
369
|
someone arriving from it could read the workspace as the team. One `info` line on stderr ("No
|
|
337
370
|
default team configured; listing every team's. Pass --team <KEY> …"), silenced by `--quiet`,
|
|
@@ -378,7 +411,7 @@ All notable changes to this project are documented here. The format is based on
|
|
|
378
411
|
model has no `team`/`cycle` getter (both `[Internal]` in the schema, though they work with a
|
|
379
412
|
plain API key), and the previous view spent three lazy fetches on what one query selects.
|
|
380
413
|
- **Repeating `--label` now narrows instead of broadening.** `--label bug --label regression`
|
|
381
|
-
used to return issues carrying
|
|
414
|
+
used to return issues carrying _either_ label; it now returns only those carrying _both_.
|
|
382
415
|
Every other repeatable filter in this CLI narrows, the reference CLI narrows, and the broadening
|
|
383
416
|
reading was the surprising one — a ported script got a superset of what it asked for and no
|
|
384
417
|
error to notice. A single `--label` is unchanged, and both forms stay case-insensitive.
|
|
@@ -389,7 +422,7 @@ All notable changes to this project are documented here. The format is based on
|
|
|
389
422
|
workflow state **ascending** (active work above the backlog), then priority descending
|
|
390
423
|
(no-priority last), then manual ascending. Membership is unchanged; only the ordering moved.
|
|
391
424
|
`--sort updated` and `--sort created` (which the reference lacks) are untouched.
|
|
392
|
-
The reference CLI hardcodes state
|
|
425
|
+
The reference CLI hardcodes state _descending_ for this flag, which the API answers with Backlog
|
|
393
426
|
**before** In Progress — a Low-priority backlog item outranks an Urgent in-progress one there.
|
|
394
427
|
We match the intent (state-grouped, UI-like) rather than that payload; verified against the API.
|
|
395
428
|
- **`issue search` takes filters, and is now team-scoped by default.** Linear's `searchIssues`
|
|
@@ -434,7 +467,7 @@ All notable changes to this project are documented here. The format is based on
|
|
|
434
467
|
|
|
435
468
|
- **`issue list`/`mine`/`search` rows omitted `milestone` and `cycle`** (TES-652). The list
|
|
436
469
|
query selected project and labels but neither relation, so `issue list --project X --json | jq
|
|
437
|
-
|
|
470
|
+
'group_by(.milestone.name)'` put every issue in the null bucket while `issue view` showed the
|
|
438
471
|
milestone. Rows now carry `milestone: {id, name} | null` and `cycle: {id, number, name} | null`
|
|
439
472
|
— the detail's exact object shapes, from the one existing query (two selections, no extra
|
|
440
473
|
request; `LIST_QUERY` and `SEARCH_QUERY` share the relation block so they cannot drift again).
|
|
@@ -455,7 +488,7 @@ All notable changes to this project are documented here. The format is based on
|
|
|
455
488
|
Non-interactively, `comment update <id>` with no body is a usage error, not an editor.
|
|
456
489
|
- **`issue comment "<body>"` on a matching branch failed** (TES-619) — the README's headline
|
|
457
490
|
example. `issue comment [id] [body]` read a lone operand as the id, so `linear issue comment
|
|
458
|
-
|
|
491
|
+
'shipped'` on `tes-615-…` produced "No comment body provided" (and, in a terminal, opened
|
|
459
492
|
`$EDITOR` for the body first and only then rejected `'shipped'` as an id — work lost).
|
|
460
493
|
`assign` and `state` already disambiguated a lone operand; `comment` now does the same: one
|
|
461
494
|
operand that looks like an issue id is the id (body from `--body-file` or the editor), anything
|
|
@@ -485,7 +518,7 @@ All notable changes to this project are documented here. The format is based on
|
|
|
485
518
|
`--help`; a bare group shows its help** (TES-633). The root has an action (bare `linear` shows the
|
|
486
519
|
branch's issue) and `issue` has a default subcommand (`view`), so commander's own "unknown
|
|
487
520
|
command" never fired for either: `linear issues list` was `too many arguments. Expected 0
|
|
488
|
-
|
|
521
|
+
arguments but got 2: issues, list.` and `linear issue lst` was `'lst' is not a valid issue id`.
|
|
489
522
|
Now: `Unknown command 'issues'. Did you mean 'issue'? Run 'linear --help' to see the commands.`
|
|
490
523
|
and `'lst' is not a valid issue id (…). Did you mean 'linear issue list'?` — a prefix (`proj`),
|
|
491
524
|
a small typo (`lable`, `isue`) or an alias (`docs`, `notif`) is close enough; two-letter aliases
|
|
@@ -503,7 +536,7 @@ All notable changes to this project are documented here. The format is based on
|
|
|
503
536
|
window-title rewrite into a title, and every teammate's `linear issue list` ran it — verified live
|
|
504
537
|
on a `clitest-esc` issue whose title carried `\e[31m` and an OSC-8 link. Every string that
|
|
505
538
|
reaches a person now passes through one function (`sanitizeForTerminal`, `src/output/sanitize.ts`)
|
|
506
|
-
that strips
|
|
539
|
+
that strips _whole_ sequences — CSI, OSC (BEL- or ST-terminated), DCS/SOS/PM/APC, other `ESC`
|
|
507
540
|
sequences, and their 8-bit C1 spellings — so `\e[31m` vanishes rather than leaving `[31m`
|
|
508
541
|
behind, then whatever C0/C1/DEL and bidi-override characters remain (`\n` and `\t` stay: a
|
|
509
542
|
description is multi-line). It is applied in `cell()` (every table cell and detail value) and in
|
|
@@ -520,7 +553,7 @@ All notable changes to this project are documented here. The format is based on
|
|
|
520
553
|
resolves the name inside that project (names are unique per project only, the same rule
|
|
521
554
|
`issue update --milestone` applies); a name without `--project` is a usage error that says so:
|
|
522
555
|
`'…' is not a milestone id; pass --project <name|id> to look a milestone up by name.` `state view
|
|
523
|
-
|
|
556
|
+
<name-or-type>` resolves against `--team` or the configured default team, exactly as
|
|
524
557
|
`issue create --state` does, and says to pass `--team` when there is neither. UUIDs still go
|
|
525
558
|
straight through.
|
|
526
559
|
- **`milestone list`/`view` printed progress ×100 — `3846%`** (TES-648, found while fixing the
|
|
@@ -528,7 +561,7 @@ All notable changes to this project are documented here. The format is based on
|
|
|
528
561
|
`Project.progress`, which is a fraction; the milestone renderers multiplied it by 100 anyway. The
|
|
529
562
|
human output now reads `38%`; the JSON value stays as the API sends it.
|
|
530
563
|
- **Detail views are one request each, not six to sixteen** (TES-622). Lists have always used a
|
|
531
|
-
tailored GraphQL query, but every
|
|
564
|
+
tailored GraphQL query, but every _detail_ path awaited the SDK model's lazy relation getters,
|
|
532
565
|
each its own HTTP round-trip. Measured live with a fetch counter before/after:
|
|
533
566
|
`getIssueDetail(TES-601)` **8 → 1**; `getProjectDetail(linear-sdk-cli)` **7 → 1**;
|
|
534
567
|
`getMilestoneDetail` with 13 issues **16 → 1** (it awaited `issue.state` per issue, so `-n 50`
|
|
@@ -554,14 +587,14 @@ All notable changes to this project are documented here. The format is based on
|
|
|
554
587
|
- **Rate-limit waits are announced through the Context's `Output`** rather than a bare stderr
|
|
555
588
|
writer, so the "rate limited; retrying in Ns" line honours `--quiet` like every other status line
|
|
556
589
|
and can never land on the JSON stdout a script is parsing.
|
|
557
|
-
- **Mutations could report a success the API never gave
|
|
590
|
+
- **Mutations could report a success the API never gave.** Every Linear mutation
|
|
558
591
|
answers with a payload carrying `success: Boolean!`, and almost nothing here read it. The
|
|
559
|
-
create/update paths did have a guard, but it tested whether the
|
|
592
|
+
create/update paths did have a guard, but it tested whether the _entity_ came back, not whether
|
|
560
593
|
the write happened — so a `{success: false}` that still carried an entity walked through it — and
|
|
561
594
|
the deletes, archives, subscribes and notification writes discarded the payload unread. Driven
|
|
562
595
|
against a client whose every write is refused, **50 of the 51 mutating service entry points
|
|
563
596
|
resolved happily**; `comment delete` was the single one that checked. The sharpest case was
|
|
564
|
-
`issue update`, which fell back to the issue it had resolved
|
|
597
|
+
`issue update`, which fell back to the issue it had resolved _before_ the mutation, so a
|
|
565
598
|
`{success: false, issue: null}` printed `Updated TES-1` and exited **0** — the shell would run the
|
|
566
599
|
`&&` side of a command that changed nothing. All of it now goes through one helper
|
|
567
600
|
(`unwrapMutation` / `assertMutation`, `src/lib/mutation.ts`) that requires `success === true` and,
|
|
@@ -576,27 +609,27 @@ All notable changes to this project are documented here. The format is based on
|
|
|
576
609
|
to print `✓ Marked … read` and `{"read": true}` whatever the payload said.
|
|
577
610
|
|
|
578
611
|
- **`notification read-all` claimed every notification was marked read.** It hardcoded
|
|
579
|
-
`success: true` and reported the number of
|
|
612
|
+
`success: true` and reported the number of _unread_ notifications it found, not the number it
|
|
580
613
|
actually marked, so a batch where some writes were refused looked identical to one where none
|
|
581
614
|
were. It now derives the aggregate: `count` is how many really went through, `attempted` how many
|
|
582
615
|
it tried, and `failed` lists the ones that did not with the API's reason. A single refusal no
|
|
583
616
|
longer aborts the rest — it is reported instead of hidden, and the human output names each one.
|
|
584
617
|
|
|
585
|
-
- **`milestone view` reported `issuesTruncated: false` while hiding issues
|
|
586
|
-
truncation check read `pageInfo.hasNextPage` off the connection
|
|
618
|
+
- **`milestone view` reported `issuesTruncated: false` while hiding issues.** The
|
|
619
|
+
truncation check read `pageInfo.hasNextPage` off the connection _after_ collecting from it, and
|
|
587
620
|
`fetchNext()` mutates that connection in place — so the flag described the last page fetched
|
|
588
621
|
rather than the issues the limit hid. With 180 issues at `--limit 150` it returned 150 and said
|
|
589
622
|
nothing was hidden, suppressing the `… more (use --all)` notice at exactly the moment it was
|
|
590
623
|
needed. Truncation is now a fact rather than an inference: one extra item is requested (in the
|
|
591
624
|
same page, so it costs no round-trip) and its presence is the answer. The unit test that shipped
|
|
592
|
-
alongside the bug passed because its mock's `fetchNext()` returned a
|
|
625
|
+
alongside the bug passed because its mock's `fetchNext()` returned a _fresh object_ instead of
|
|
593
626
|
mutating — every faked connection in the suite now comes from one faithful builder
|
|
594
627
|
(`test/unit/_fakes.ts`) that appends in place and returns `this`, as the SDK does.
|
|
595
628
|
|
|
596
629
|
- **Name resolution stopped at a fixed page, so a large workspace got false `not_found`s.** The
|
|
597
630
|
resolvers that match client-side asked for a fixed `first: 100`/`first: 250` and searched only
|
|
598
631
|
what came back: a team, workflow state, cycle or milestone that existed past the cap could not be
|
|
599
|
-
resolved by name, and — worse, because it is silent — the
|
|
632
|
+
resolved by name, and — worse, because it is silent — the _ambiguity_ check only ever saw a prefix,
|
|
600
633
|
so a duplicate name past the cap was invisible and the CLI picked one arbitrarily. Resolution now
|
|
601
634
|
follows the connection. The page size is 250 (Linear's maximum), so the ordinary workspace still
|
|
602
635
|
costs the single request it always did and only workspaces that really have more than 250 of
|
|
@@ -610,7 +643,7 @@ All notable changes to this project are documented here. The format is based on
|
|
|
610
643
|
`--status` is accepted as an alias for the same thing.
|
|
611
644
|
- **`issue list --label` was case-sensitive.** The filter used an exact-case `in` comparator, so
|
|
612
645
|
`--label bug` returned an empty list when the label is stored as `Bug` — wrong results with no
|
|
613
|
-
error, while label
|
|
646
|
+
error, while label _resolution_ everywhere else matches case-insensitively. (Repeating the flag
|
|
614
647
|
now narrows the match — see Changed.)
|
|
615
648
|
- **Deactivated users were invisible.** `team members` and `user list` never sent
|
|
616
649
|
`includeDisabled`, which Linear defaults to `false` — so deactivated users were never returned
|
|
@@ -643,7 +676,7 @@ All notable changes to this project are documented here. The format is based on
|
|
|
643
676
|
issue id inferred from the current branch as usual. `issue describe [id]` prints the issue
|
|
644
677
|
title plus a commit-message trailer using Linear's git magic words (`Fixes <ID>`, or
|
|
645
678
|
`References <ID>` with `-r`/`--references`) — drop it into `git commit -m "$(linear issue
|
|
646
|
-
|
|
679
|
+
describe)"`. `issue pull-request [id]` (alias `pr`) creates a GitHub PR via the `gh` CLI:
|
|
647
680
|
the title defaults to the issue title (`--title` to override) and the body is the issue
|
|
648
681
|
description followed by a `Fixes <ID>` trailer and the Linear URL, so the PR and issue
|
|
649
682
|
reference each other. Flags: `--base`, `--head`, `--draft`, `--web`. The created PR URL is the
|
|
@@ -652,8 +685,8 @@ All notable changes to this project are documented here. The format is based on
|
|
|
652
685
|
or when `gh` itself fails.
|
|
653
686
|
- **Multi-workspace credentials.** Store API keys for several workspaces and switch between
|
|
654
687
|
them. New `auth` subcommands: `auth list` (configured workspaces + default), `auth default
|
|
655
|
-
|
|
656
|
-
|
|
688
|
+
<slug>` (set the default), and `auth token` (print the resolved key for scripting). `auth
|
|
689
|
+
login` now accepts the global `--workspace <slug>` (derived from the key's organization when
|
|
657
690
|
omitted) and `auth status` reports the active credential workspace. A new global
|
|
658
691
|
`--workspace <slug>` selects which stored credential to use for any command. Credentials live
|
|
659
692
|
in quoted `[workspaces."<slug>"]` tables under a top-level `default_workspace`. Credential
|
|
@@ -661,12 +694,12 @@ All notable changes to this project are documented here. The format is based on
|
|
|
661
694
|
`--workspace`/`LINEAR_WORKSPACE`/`default_workspace`, and is never steered by project
|
|
662
695
|
`.linear.toml`. When several workspaces are configured with no default, the error is deferred
|
|
663
696
|
until a command actually needs the API — so `auth list`/`default`/`login` still work.
|
|
664
|
-
- **`--no-input` did nothing
|
|
697
|
+
- **`--no-input` did nothing.** It is the flag that makes the CLI safe to run
|
|
665
698
|
unattended, and it had never once had an effect. Two independent faults, either of which alone
|
|
666
699
|
was fatal. First, the key: commander stores a negation under the name with `no-` stripped, so the
|
|
667
700
|
parser wrote `input: false` while `Context` read `noInput` — a field nothing ever set, so the
|
|
668
701
|
guard was reading `undefined` forever. Second, and the reason fixing the key would not have been
|
|
669
|
-
enough: a lone negation is
|
|
702
|
+
enough: a lone negation is _also_ seeded with a default of `true` on every command it is
|
|
670
703
|
registered on, including the root program, and `optsWithGlobals()` lets ancestors overwrite
|
|
671
704
|
descendants. Because global options are usable in any position, the flag is parsed by the
|
|
672
705
|
subcommand — so the root's default `true` then overwrote the subcommand's `false` on the way into
|
|
@@ -679,25 +712,25 @@ All notable changes to this project are documented here. The format is based on
|
|
|
679
712
|
goes for a redirected stdout, which is where inquirer draws the prompt and would therefore write
|
|
680
713
|
the question into the caller's output. Commands that need a missing value now fail with the usual
|
|
681
714
|
usage error naming the flag to pass, instead of waiting forever.
|
|
682
|
-
- **`--no-color` broke `label create
|
|
715
|
+
- **`--no-color` broke `label create`.** The global terminal-colour flag and the
|
|
683
716
|
entity flag `--color <hex>` both reduced to commander's `color` attribute, so
|
|
684
717
|
`label create --name x --team TES --no-color` put `color: false` into the mutation input and
|
|
685
718
|
Linear rejected the call outright: `Variable "$input" got invalid value false at "input.color"`.
|
|
686
719
|
`project` and `roadmap` escaped the crash only because their guards happened to be truthy-based —
|
|
687
720
|
they dropped the flag instead. Beyond the crash, there was simply no way to set an entity colour
|
|
688
|
-
|
|
721
|
+
_and_ turn off terminal colour in one command, because one flag overwrote the other. The global
|
|
689
722
|
is now spelled **`--no-ansi`**, with `--no-color` kept as an alias on every command (it is the
|
|
690
723
|
conventional spelling, and both write the same key, so they cannot drift). Terminal colour and
|
|
691
724
|
entity colour are separate keys now, which makes the whole class of collision structurally
|
|
692
725
|
impossible rather than fixed one command at a time — a test walks the command tree and asserts no
|
|
693
726
|
option anywhere can write `false` into `color`.
|
|
694
|
-
- **`auth login` echoed the API key
|
|
727
|
+
- **`auth login` echoed the API key.** The prompt used inquirer's `input`, so the
|
|
695
728
|
credential appeared on screen as it was typed and then stayed in the terminal's scrollback for as
|
|
696
729
|
long as the window lived. It now uses inquirer's `password` prompt, which never renders the value.
|
|
697
730
|
`--key` is unchanged for scripts, and nothing in the command logs or echoes the key — the receipt
|
|
698
731
|
names the user and the file it was written to.
|
|
699
732
|
- **`--json --debug` produced output that could not be parsed.** The debug detail was appended
|
|
700
|
-
|
|
733
|
+
_after_ the error envelope as a second, plaintext block, so the one combination a caller reaches
|
|
701
734
|
for when a scripted call misbehaves was the one that broke the contract:
|
|
702
735
|
`linear … --json --debug 2>&1 | jq` died with "Invalid numeric literal". In JSON mode the detail
|
|
703
736
|
now lives inside the envelope as `error.detail`. Without `--debug`, or when the error carries no
|
|
@@ -717,15 +750,15 @@ All notable changes to this project are documented here. The format is based on
|
|
|
717
750
|
different request from the one that was typed, executed without comment. A flag value must now be
|
|
718
751
|
a complete integer. Priority additionally validates the 0–4 range locally, matching the wording
|
|
719
752
|
`initiative` has used all along, so the two cannot read as different rules.
|
|
720
|
-
- **`project update --team` was accepted and ignored
|
|
721
|
-
than implemented: a project belongs to
|
|
753
|
+
- **`project update --team` was accepted and ignored.** It is rejected now, rather
|
|
754
|
+
than implemented: a project belongs to _several_ teams, and the existing `--teams` **replaces**
|
|
722
755
|
that whole set — so quietly treating `--team TES` as `--teams TES` would remove every other team
|
|
723
756
|
from the project, which is a destructive reading of a flag the user most likely meant as "also
|
|
724
757
|
this team". The error names `--teams` and says that it replaces. The flag is declared locally on
|
|
725
758
|
the command (which is what stops the global from being injected over it) and hidden, so `--help`
|
|
726
759
|
and `linear commands --json` advertise only the flag that works. `project create --team` is
|
|
727
760
|
untouched — there it is the genuine fallback team.
|
|
728
|
-
- **`api --operation` did nothing at all
|
|
761
|
+
- **`api --operation` did nothing at all.** It was passed as a fourth argument to the
|
|
729
762
|
SDK's `rawRequest`, which takes three — so it was discarded, and a multi-operation document went
|
|
730
763
|
to the API with no operation named. The API's answer to that is not "run the first one" but a
|
|
731
764
|
flat `The operation does not exist on the query.`, which made multi-operation documents unusable
|
|
@@ -738,12 +771,12 @@ All notable changes to this project are documented here. The format is based on
|
|
|
738
771
|
multi-operation document is now a usage error that lists the names, rather than a confusing error
|
|
739
772
|
from the server, and `--operation` naming an operation the document does not define is caught here
|
|
740
773
|
too.
|
|
741
|
-
- **`api --paginate` never checked what it was re-running
|
|
742
|
-
whole document once per cursor, so a
|
|
774
|
+
- **`api --paginate` never checked what it was re-running.** The loop re-executes the
|
|
775
|
+
whole document once per cursor, so a _mutation_ whose payload happens to contain a paginatable
|
|
743
776
|
connection would have been executed once per page — creating duplicate entities, silently, in
|
|
744
777
|
proportion to how much data came back. It now refuses anything that is not a query, and refuses it
|
|
745
778
|
**before the first request**, so the check cannot itself cost a side effect. The kind is read from
|
|
746
|
-
the same parse that `--operation` uses, which means it is the
|
|
779
|
+
the same parse that `--operation` uses, which means it is the _selected_ operation that is
|
|
747
780
|
checked, not merely the first one in the file.
|
|
748
781
|
- **`schema --json --output <file>` ignored the file.** The JSON branch returned before reaching the
|
|
749
782
|
write, so the introspection result went to stdout and no file was ever created — silently, since
|
|
@@ -757,7 +790,7 @@ All notable changes to this project are documented here. The format is based on
|
|
|
757
790
|
stderr, where it lands in scrollback, CI logs and bug reports. The same channel let a project
|
|
758
791
|
`.linear.toml` — a file that is not ours and may arrive with a checkout — emit raw escape
|
|
759
792
|
sequences through our error output. We now report only the reason and the position (`line 3,
|
|
760
|
-
|
|
793
|
+
column 36`), never an excerpt from a credential-bearing file, and strip control characters and
|
|
761
794
|
bidi overrides from what remains. The error stays actionable: it still says exactly where to look.
|
|
762
795
|
- **Credential writes could lose a config or leave a truncated one.** Writing the config in place
|
|
763
796
|
truncates it first, so a crash or a concurrently-running `linear` could observe — or leave behind
|
package/COVERAGE.md
CHANGED
|
@@ -2,11 +2,11 @@
|
|
|
2
2
|
|
|
3
3
|
Generated by `bun run audit:coverage`. Total LinearClient members: **470**.
|
|
4
4
|
|
|
5
|
-
| Status
|
|
6
|
-
|
|
|
7
|
-
| curated
|
|
8
|
-
| raw-only | 140
|
|
9
|
-
| excluded | 228
|
|
5
|
+
| Status | Count | Meaning |
|
|
6
|
+
| -------- | ----- | ----------------------------------------------- |
|
|
7
|
+
| curated | 102 | Has a first-class CLI command |
|
|
8
|
+
| raw-only | 140 | Reachable via `linear api` (no bespoke command) |
|
|
9
|
+
| excluded | 228 | Out of scope (admin/integration/SDK plumbing) |
|
|
10
10
|
|
|
11
11
|
Every member is classified — CI fails otherwise. `raw-only` members are still
|
|
12
12
|
100% reachable through the raw GraphQL escape hatch; they simply lack a tailored command.
|