@talosjs/linear 1.1.0 → 1.1.2
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 +5 -64
- package/package.json +7 -7
package/README.md
CHANGED
|
@@ -1,10 +1,6 @@
|
|
|
1
1
|
# @talosjs/linear
|
|
2
2
|
|
|
3
|
-
Linear project management integration
|
|
4
|
-
|
|
5
|
-

|
|
6
|
-

|
|
7
|
-

|
|
3
|
+
Linear project management integration — create, update, and query issues, teams, and projects via the Linear API with dependency injection support
|
|
8
4
|
|
|
9
5
|
## Installation
|
|
10
6
|
|
|
@@ -12,65 +8,10 @@ Linear project management integration for querying and mutating Linear issues, t
|
|
|
12
8
|
bun add @talosjs/linear
|
|
13
9
|
```
|
|
14
10
|
|
|
15
|
-
##
|
|
16
|
-
|
|
17
|
-
`LinearService` requires a Linear API key. Provide it through the constructor config or expose it through `AppEnv` as `LINEAR_API_KEY`.
|
|
18
|
-
|
|
19
|
-
```typescript
|
|
20
|
-
import { AppEnv } from "@talosjs/app-env";
|
|
21
|
-
import { LinearService } from "@talosjs/linear";
|
|
22
|
-
|
|
23
|
-
const linear = new LinearService(new AppEnv(), {
|
|
24
|
-
apiKey: "lin_api_...",
|
|
25
|
-
teamId: "team-id",
|
|
26
|
-
});
|
|
27
|
-
```
|
|
28
|
-
|
|
29
|
-
When the service is resolved through the Talos container, inject `LinearService` and configure `LINEAR_API_KEY` and optionally `LINEAR_TEAM_ID` in the application environment.
|
|
30
|
-
|
|
31
|
-
## Usage
|
|
32
|
-
|
|
33
|
-
```typescript
|
|
34
|
-
const issue = await linear.getIssue("OO-123");
|
|
35
|
-
|
|
36
|
-
const created = await linear.createIssue({
|
|
37
|
-
title: "Document Linear package",
|
|
38
|
-
description: "Add public package usage documentation.",
|
|
39
|
-
team: {
|
|
40
|
-
id: "team-id",
|
|
41
|
-
name: "Engineering",
|
|
42
|
-
key: "ENG",
|
|
43
|
-
},
|
|
44
|
-
});
|
|
45
|
-
|
|
46
|
-
await linear.createComment(created.id, "Documentation added.");
|
|
47
|
-
```
|
|
48
|
-
|
|
49
|
-
## API
|
|
50
|
-
|
|
51
|
-
### Issues
|
|
52
|
-
|
|
53
|
-
- `getIssue(id)` fetches one issue.
|
|
54
|
-
- `getIssues(teamId?, filters?)` fetches issues, optionally scoped to a team and Linear filters.
|
|
55
|
-
- `createIssue(input)` creates an issue. `title` and `team.id` are required.
|
|
56
|
-
- `updateIssue(id, input)` updates issue fields.
|
|
57
|
-
- `deleteIssue(id)` deletes an issue and returns Linear's success flag.
|
|
58
|
-
|
|
59
|
-
### Teams, Projects, Labels, States, and Priorities
|
|
60
|
-
|
|
61
|
-
- `getTeams()` returns available teams.
|
|
62
|
-
- `getProjects(teamId?)` returns projects, optionally filtered by team.
|
|
63
|
-
- `getLabel(id)`, `getLabels(teamId?)`, `createLabel(input)`, `updateLabel(id, input)`, and `deleteLabel(id)` manage issue labels.
|
|
64
|
-
- `getState(id)`, `getStates(teamId?)`, `createState(input)`, `updateState(id, input)`, and `deleteState(id)` manage workflow states.
|
|
65
|
-
- `getPriorities()`, `getPriority(issueId)`, `setPriority(issueId, priority)`, and `clearPriority(issueId)` manage priorities.
|
|
66
|
-
|
|
67
|
-
### Checks and Comments
|
|
11
|
+
## Documentation
|
|
68
12
|
|
|
69
|
-
|
|
70
|
-
- `checkPriorityById(value)` and `checkPriorityByName(name)` test whether a priority is supported.
|
|
71
|
-
- `checkStateById(id)` and `checkStateByName(name, teamId?)` test whether states exist.
|
|
72
|
-
- `createComment(issueId, body)` creates a comment on an issue.
|
|
13
|
+
Read the full documentation at [docs.talosjs.com/integrations/linear](https://docs.talosjs.com/integrations/linear).
|
|
73
14
|
|
|
74
|
-
##
|
|
15
|
+
## License
|
|
75
16
|
|
|
76
|
-
|
|
17
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@talosjs/linear",
|
|
3
3
|
"description": "Linear project management integration — create, update, and query issues, teams, and projects via the Linear API with dependency injection support",
|
|
4
|
-
"version": "1.1.
|
|
4
|
+
"version": "1.1.2",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"files": [
|
|
7
7
|
"dist",
|
|
@@ -24,15 +24,15 @@
|
|
|
24
24
|
"scripts": {
|
|
25
25
|
"test": "bun test tests",
|
|
26
26
|
"build": "bunup",
|
|
27
|
-
"
|
|
28
|
-
"
|
|
27
|
+
"fmt": "bunx biome check --write",
|
|
28
|
+
"lint": "tsc --noEmit && bunx biome lint"
|
|
29
29
|
},
|
|
30
30
|
"dependencies": {
|
|
31
31
|
"@linear/sdk": "^84.0.0",
|
|
32
|
-
"@talosjs/app-env": "^1.
|
|
33
|
-
"@talosjs/container": "^1.1.
|
|
34
|
-
"@talosjs/exception": "^1.1.
|
|
35
|
-
"@talosjs/http-status": "^1.1.
|
|
32
|
+
"@talosjs/app-env": "^1.2.3",
|
|
33
|
+
"@talosjs/container": "^1.1.2",
|
|
34
|
+
"@talosjs/exception": "^1.1.2",
|
|
35
|
+
"@talosjs/http-status": "^1.1.2"
|
|
36
36
|
},
|
|
37
37
|
"devDependencies": {},
|
|
38
38
|
"keywords": [
|