@plaited/development-skills 0.6.1 → 0.6.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 +35 -119
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,153 +1,69 @@
|
|
|
1
|
-
# development-skills
|
|
1
|
+
# @plaited/development-skills
|
|
2
2
|
|
|
3
3
|
[](https://www.npmjs.com/package/@plaited/development-skills)
|
|
4
4
|
[](https://github.com/plaited/development-skills/actions/workflows/ci.yml)
|
|
5
5
|
[](https://opensource.org/licenses/ISC)
|
|
6
6
|
|
|
7
|
+
> TypeScript LSP tools and AI agent skills for modern development workflows
|
|
7
8
|
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
## CLI Tool
|
|
11
|
-
|
|
12
|
-
Use these tools directly via the CLI without installation:
|
|
13
|
-
|
|
14
|
-
```bash
|
|
15
|
-
# Run without installing
|
|
16
|
-
bunx @plaited/development-skills lsp-hover src/index.ts 10 5
|
|
17
|
-
|
|
18
|
-
# Or install globally
|
|
19
|
-
bun add -g @plaited/development-skills
|
|
20
|
-
development-skills lsp-find parseConfig
|
|
21
|
-
```
|
|
22
|
-
|
|
23
|
-
### Commands
|
|
24
|
-
|
|
25
|
-
| Command | Description |
|
|
26
|
-
|---------|-------------|
|
|
27
|
-
| `lsp-hover <file> <line> <char>` | Get type information at position |
|
|
28
|
-
| `lsp-find <query> [file]` | Search for symbols across workspace |
|
|
29
|
-
| `lsp-refs <file> <line> <char>` | Find all references to symbol |
|
|
30
|
-
| `lsp-analyze <file> [options]` | Batch analysis of file |
|
|
31
|
-
| `validate-skill <path>` | Validate AgentSkills spec |
|
|
32
|
-
|
|
33
|
-
### Examples
|
|
9
|
+
## Examples
|
|
34
10
|
|
|
35
11
|
```bash
|
|
36
|
-
#
|
|
37
|
-
bunx @plaited/development-skills lsp-hover src/app.ts 25 10
|
|
38
|
-
|
|
39
|
-
# Symbol search
|
|
12
|
+
# Find where a type is defined
|
|
40
13
|
bunx @plaited/development-skills lsp-find UserConfig
|
|
41
14
|
|
|
42
|
-
#
|
|
43
|
-
bunx @plaited/development-skills lsp-
|
|
15
|
+
# Get type info at cursor position (line 25, column 10)
|
|
16
|
+
bunx @plaited/development-skills lsp-hover src/app.ts 25 10
|
|
44
17
|
|
|
45
|
-
#
|
|
46
|
-
bunx @plaited/development-skills lsp-
|
|
18
|
+
# Find all usages of a symbol
|
|
19
|
+
bunx @plaited/development-skills lsp-refs src/types.ts 15 12
|
|
47
20
|
|
|
48
|
-
# Validate skills
|
|
21
|
+
# Validate your AI agent skills
|
|
49
22
|
bunx @plaited/development-skills validate-skill .claude/skills
|
|
50
|
-
```
|
|
51
|
-
|
|
52
|
-
## Skills for AI Agents
|
|
53
|
-
|
|
54
|
-
**Install skills** for use with AI coding agents:
|
|
55
|
-
|
|
56
|
-
```bash
|
|
57
|
-
curl -fsSL https://raw.githubusercontent.com/plaited/skills-installer/main/install.sh | bash -s -- --agent <agent-name> --project development-skills
|
|
58
|
-
```
|
|
59
|
-
|
|
60
|
-
Replace `<agent-name>` with your agent: `claude`, `cursor`, `copilot`, `opencode`, `amp`, `goose`, `factory`
|
|
61
|
-
|
|
62
|
-
**Update skills:**
|
|
63
|
-
|
|
64
|
-
```bash
|
|
65
|
-
curl -fsSL https://raw.githubusercontent.com/plaited/skills-installer/main/install.sh | bash -s -- update --agent <agent-name> --project development-skills
|
|
66
|
-
```
|
|
67
23
|
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
### TypeScript LSP
|
|
71
|
-
|
|
72
|
-
TypeScript Language Server Protocol integration for exploring and understanding TypeScript/JavaScript codebases.
|
|
73
|
-
|
|
74
|
-
**Use LSP over Grep/Glob when:**
|
|
75
|
-
- Finding all usages of a function/type (LSP understands re-exports, aliases)
|
|
76
|
-
- Searching for symbols by name (LSP ignores strings, comments)
|
|
77
|
-
- Understanding file exports (LSP resolves re-exports)
|
|
78
|
-
- Getting type signatures (not possible with grep)
|
|
79
|
-
|
|
80
|
-
#### Commands
|
|
81
|
-
|
|
82
|
-
##### `/lsp-hover`
|
|
83
|
-
|
|
84
|
-
Get type information at a specific position.
|
|
85
|
-
|
|
86
|
-
```bash
|
|
87
|
-
/lsp-hover src/utils/parser.ts 42 10
|
|
24
|
+
# Scaffold development rules for your project
|
|
25
|
+
bunx @plaited/development-skills scaffold-rules
|
|
88
26
|
```
|
|
89
27
|
|
|
90
|
-
|
|
28
|
+
## Why LSP?
|
|
91
29
|
|
|
92
|
-
|
|
30
|
+
Text search finds strings. LSP finds *meaning*.
|
|
93
31
|
|
|
94
32
|
```bash
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
```
|
|
33
|
+
# Text search: finds "Config" in comments, strings, everywhere
|
|
34
|
+
grep -r "Config" src/
|
|
98
35
|
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
Find all references to a symbol (before refactoring).
|
|
102
|
-
|
|
103
|
-
```bash
|
|
104
|
-
/lsp-refs src/utils/parser.ts 42 10
|
|
36
|
+
# LSP search: finds the actual Config type and its usages
|
|
37
|
+
bunx @plaited/development-skills lsp-find Config
|
|
105
38
|
```
|
|
106
39
|
|
|
107
|
-
|
|
40
|
+
LSP understands re-exports, aliases, and type relationships.
|
|
108
41
|
|
|
109
|
-
|
|
42
|
+
## Install for AI Agents
|
|
110
43
|
|
|
111
44
|
```bash
|
|
112
|
-
|
|
113
|
-
/lsp-analyze src/utils/parser.ts --all
|
|
114
|
-
/lsp-analyze src/utils/parser.ts --hover 50:10 --refs 60:5
|
|
45
|
+
curl -fsSL https://raw.githubusercontent.com/plaited/skills-installer/main/install.sh | bash -s -- --agent <agent-name> --project development-skills
|
|
115
46
|
```
|
|
116
47
|
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
All commands accept:
|
|
120
|
-
- **Absolute paths**: `/Users/name/project/src/file.ts`
|
|
121
|
-
- **Relative paths**: `./src/file.ts`
|
|
122
|
-
- **Package export paths**: `my-package/src/module.ts` (resolved via `Bun.resolve()`)
|
|
123
|
-
|
|
124
|
-
### Skill Validation
|
|
125
|
-
|
|
126
|
-
Validate skill directories against the AgentSkills specification.
|
|
127
|
-
|
|
128
|
-
#### Commands
|
|
129
|
-
|
|
130
|
-
##### `/validate-skill`
|
|
48
|
+
**Agents:** `claude` · `cursor` · `copilot` · `codex` · `gemini` · `windsurf` · `opencode` · `amp` · `goose` · `factory`
|
|
131
49
|
|
|
132
|
-
|
|
50
|
+
## Commands
|
|
133
51
|
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
52
|
+
| Command | What it does |
|
|
53
|
+
|---------|--------------|
|
|
54
|
+
| `lsp-hover` | Type info at position |
|
|
55
|
+
| `lsp-find` | Symbol search |
|
|
56
|
+
| `lsp-refs` | Find references |
|
|
57
|
+
| `lsp-analyze` | Batch file analysis |
|
|
58
|
+
| `validate-skill` | Validate AgentSkills |
|
|
59
|
+
| `scaffold-rules` | Scaffold dev rules |
|
|
140
60
|
|
|
141
|
-
|
|
142
|
-
# Install dependencies
|
|
143
|
-
bun install
|
|
144
|
-
|
|
145
|
-
# Run checks
|
|
146
|
-
bun run check
|
|
61
|
+
## Skills Included
|
|
147
62
|
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
63
|
+
- **typescript-lsp** - LSP integration for AI agents
|
|
64
|
+
- **code-documentation** - TSDoc workflow and standards
|
|
65
|
+
- **validate-skill** - Skill validation
|
|
66
|
+
- **scaffold-rules** - Development rules scaffolding
|
|
151
67
|
|
|
152
68
|
## License
|
|
153
69
|
|