@tanstack/intent 0.0.9 → 0.0.10
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 +28 -7
- package/meta/feedback-collection/SKILL.md +21 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,15 +2,21 @@
|
|
|
2
2
|
|
|
3
3
|
Ship compositional knowledge for AI coding agents alongside your npm packages.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
## The problem
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
Your docs are good. Your types are solid. Your agent still gets it wrong.
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
Docs target humans who browse. Types check individual API calls but can't encode intent. Training data snapshots the ecosystem as it _was_, mixing versions without flagging which applies. Once a breaking change ships, models contain _both_ versions forever with no way to disambiguate.
|
|
10
10
|
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
11
|
+
The ecosystem already moves toward agent-readable knowledge — Cursor rules, CLAUDE.md files, skills directories. But delivery is stuck in copy-paste: hunt for a community-maintained rules file, paste it into your config, repeat for every tool. No versioning, no update path, no staleness signal.
|
|
12
|
+
|
|
13
|
+
## Skills: the fourth artifact
|
|
14
|
+
|
|
15
|
+
You ship code, docs, and types. Skills are the fourth artifact — knowledge encoded for the thing writing most of your code.
|
|
16
|
+
|
|
17
|
+
Skills are npm packages of knowledge — encoding how tools compose, which patterns fit which goals, and what to avoid. When a library ships skills using `@tanstack/intent`, that knowledge travels with the tool via `npm update` — not the model's training cutoff. Versioned knowledge the maintainer owns, updated when the package updates.
|
|
18
|
+
|
|
19
|
+
Each skill declares its source docs. When those docs change, the CLI flags the skill for review. One source of truth, one derived artifact that stays in sync.
|
|
14
20
|
|
|
15
21
|
## Quick Start
|
|
16
22
|
|
|
@@ -22,6 +28,8 @@ Set up skill-to-task mappings in your project's agent config files (CLAUDE.md, .
|
|
|
22
28
|
npx @tanstack/intent install
|
|
23
29
|
```
|
|
24
30
|
|
|
31
|
+
No per-library setup. No hunting for rules files. Install the package, run `intent install`, and the agent understands the tool. Update the package, and skills update too.
|
|
32
|
+
|
|
25
33
|
List available skills from installed packages:
|
|
26
34
|
|
|
27
35
|
```bash
|
|
@@ -44,12 +52,24 @@ Validate your skill files:
|
|
|
44
52
|
npx @tanstack/intent validate
|
|
45
53
|
```
|
|
46
54
|
|
|
47
|
-
|
|
55
|
+
Check for skills that have fallen behind their sources:
|
|
56
|
+
|
|
57
|
+
```bash
|
|
58
|
+
npx @tanstack/intent stale
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
Copy CI workflow templates into your repo so validation and staleness checks run on every push:
|
|
48
62
|
|
|
49
63
|
```bash
|
|
50
64
|
npx @tanstack/intent setup
|
|
51
65
|
```
|
|
52
66
|
|
|
67
|
+
## Keeping skills current
|
|
68
|
+
|
|
69
|
+
The real risk with any derived artifact is staleness. `intent stale` flags skills whose source docs have changed, and CI templates catch drift before it ships.
|
|
70
|
+
|
|
71
|
+
The feedback loop runs both directions. `intent feedback` lets users submit structured reports when a skill produces wrong output — which skill, which version, what broke. That context flows back to the maintainer, and the fix ships to everyone on the next `npm update`.
|
|
72
|
+
|
|
53
73
|
## CLI Commands
|
|
54
74
|
|
|
55
75
|
| Command | Description |
|
|
@@ -61,6 +81,7 @@ npx @tanstack/intent setup
|
|
|
61
81
|
| `intent validate [dir]` | Validate SKILL.md files |
|
|
62
82
|
| `intent setup` | Copy CI templates, generate shim, create labels |
|
|
63
83
|
| `intent stale [--json]` | Check skills for version drift |
|
|
84
|
+
| `intent feedback` | Submit skill feedback |
|
|
64
85
|
|
|
65
86
|
## License
|
|
66
87
|
|
|
@@ -145,6 +145,27 @@ Determine the target repo from the skill's package. The repo is typically
|
|
|
145
145
|
derivable from the `repository` field in the package's `package.json`, or
|
|
146
146
|
from the `sources` field in the SKILL.md frontmatter.
|
|
147
147
|
|
|
148
|
+
### Privacy check
|
|
149
|
+
|
|
150
|
+
Before submitting, determine whether the user's project is public or private.
|
|
151
|
+
Check with `gh repo view --json visibility` or look for a `private` field in
|
|
152
|
+
the project's `package.json`. If you can't determine visibility, assume private.
|
|
153
|
+
|
|
154
|
+
**Private repos:** Feedback is submitted to a public issue tracker, so it must
|
|
155
|
+
not contain project-specific details. Before submission:
|
|
156
|
+
|
|
157
|
+
1. Strip any project-specific code, file paths, internal API names, service
|
|
158
|
+
URLs, or business logic from all fields
|
|
159
|
+
2. Rewrite the "Task" field to describe the _type_ of task generically
|
|
160
|
+
(e.g. "set up authenticated data fetching" not "set up auth for our
|
|
161
|
+
internal billing API at api.acme.corp/billing")
|
|
162
|
+
3. Rewrite "What Failed" and "Missing" entries to reference only the
|
|
163
|
+
skill's own APIs and patterns, not the user's code
|
|
164
|
+
4. Show the sanitized feedback to the user and ask them to confirm it's
|
|
165
|
+
safe to submit before proceeding
|
|
166
|
+
|
|
167
|
+
**Public repos:** No sanitization needed. Proceed directly to submission.
|
|
168
|
+
|
|
148
169
|
### If `gh` CLI is available
|
|
149
170
|
|
|
150
171
|
Submit directly as a GitHub issue:
|