prinfer 0.4.1 → 0.4.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 +15 -1
- package/dist/postinstall.cjs +6 -4
- package/dist/postinstall.cjs.map +1 -1
- package/dist/postinstall.js +6 -4
- package/dist/postinstall.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,3 +1,7 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<img src="printfer-logo.webp" alt="prinfer logo" width="400">
|
|
3
|
+
</p>
|
|
4
|
+
|
|
1
5
|
# prinfer
|
|
2
6
|
|
|
3
7
|
**Typehints for your AI agent.**
|
|
@@ -7,6 +11,7 @@ prinfer gives AI coding assistants the ability to inspect TypeScript's inferred
|
|
|
7
11
|
## Why?
|
|
8
12
|
|
|
9
13
|
AI agents write TypeScript, but they can't see what the compiler infers. This leads to:
|
|
14
|
+
|
|
10
15
|
- Unnecessary explicit type annotations everywhere
|
|
11
16
|
- Verbose code that fights against TypeScript's design
|
|
12
17
|
- Missed opportunities to leverage type inference
|
|
@@ -19,7 +24,14 @@ prinfer solves this by exposing TypeScript's type inference to your agent via MC
|
|
|
19
24
|
npm i -g prinfer
|
|
20
25
|
```
|
|
21
26
|
|
|
27
|
+
or
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
bun add -g prinfer
|
|
31
|
+
```
|
|
32
|
+
|
|
22
33
|
That's it. On install, prinfer automatically:
|
|
34
|
+
|
|
23
35
|
1. Adds itself as an MCP tool for Claude
|
|
24
36
|
2. Installs a skill that teaches Claude to prefer type inference
|
|
25
37
|
|
|
@@ -34,9 +46,10 @@ infer_type(file: "src/utils.ts", name: "myFunction")
|
|
|
34
46
|
infer_type(file: "src/utils.ts", name: "commandResult", line: 75)
|
|
35
47
|
```
|
|
36
48
|
|
|
37
|
-
### Claude Skill (`~/.claude/skills/
|
|
49
|
+
### Claude Skill (`~/.claude/skills/prefer-infer.md`)
|
|
38
50
|
|
|
39
51
|
A coding guideline that encourages your agent to:
|
|
52
|
+
|
|
40
53
|
- Rely on type inference instead of explicit annotations
|
|
41
54
|
- Use prinfer to verify types before adding redundant hints
|
|
42
55
|
- Write idiomatic TypeScript
|
|
@@ -67,6 +80,7 @@ prinfer src/utils.ts:75 commandResult
|
|
|
67
80
|
```
|
|
68
81
|
|
|
69
82
|
Output:
|
|
83
|
+
|
|
70
84
|
```
|
|
71
85
|
(x: number, y: string) => boolean
|
|
72
86
|
returns: boolean
|
package/dist/postinstall.cjs
CHANGED
|
@@ -64,13 +64,15 @@ Use the \`infer_type\` MCP tool to check the type:
|
|
|
64
64
|
function main() {
|
|
65
65
|
const homeDir = import_node_os.default.homedir();
|
|
66
66
|
const skillsDir = import_node_path.default.join(homeDir, ".claude", "skills");
|
|
67
|
-
const skillFile = import_node_path.default.join(skillsDir, "
|
|
67
|
+
const skillFile = import_node_path.default.join(skillsDir, "prefer-infer.md");
|
|
68
68
|
const claudeDir = import_node_path.default.join(homeDir, ".claude");
|
|
69
69
|
if (!import_node_fs.default.existsSync(claudeDir)) {
|
|
70
70
|
console.log(
|
|
71
71
|
"~/.claude directory not found. Skipping skill installation."
|
|
72
72
|
);
|
|
73
|
-
console.log(
|
|
73
|
+
console.log(
|
|
74
|
+
"To manually install, create ~/.claude/skills/prefer-infer.md"
|
|
75
|
+
);
|
|
74
76
|
return;
|
|
75
77
|
}
|
|
76
78
|
if (!import_node_fs.default.existsSync(skillsDir)) {
|
|
@@ -78,12 +80,12 @@ function main() {
|
|
|
78
80
|
}
|
|
79
81
|
if (import_node_fs.default.existsSync(skillFile)) {
|
|
80
82
|
console.log(
|
|
81
|
-
"prinfer skill already installed at ~/.claude/skills/
|
|
83
|
+
"prinfer skill already installed at ~/.claude/skills/prefer-infer.md"
|
|
82
84
|
);
|
|
83
85
|
return;
|
|
84
86
|
}
|
|
85
87
|
import_node_fs.default.writeFileSync(skillFile, SKILL_CONTENT);
|
|
86
|
-
console.log("Installed prinfer skill to ~/.claude/skills/
|
|
88
|
+
console.log("Installed prinfer skill to ~/.claude/skills/prefer-infer.md");
|
|
87
89
|
console.log("You can now use /check-type to verify TypeScript types!");
|
|
88
90
|
}
|
|
89
91
|
main();
|
package/dist/postinstall.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/postinstall.ts"],"sourcesContent":["#!/usr/bin/env node\nimport fs from \"node:fs\";\nimport os from \"node:os\";\nimport path from \"node:path\";\n\nconst SKILL_CONTENT = `# TypeScript Type Inference (prinfer)\n\n## Coding Guideline\n\nWhen writing TypeScript code, prefer relying on type inference over explicit type annotations:\n\n- Let TypeScript infer return types for functions when the implementation makes them obvious\n- Let TypeScript infer variable types from their initializers\n- Only add explicit types when:\n - The inferred type is too wide (e.g., \\`string\\` instead of a literal type)\n - The type serves as documentation for complex structures\n - You're defining a public API contract\n\nUse the \\`prinfer\\` MCP tool (\\`infer_type\\`) to verify what TypeScript infers before adding explicit types.\n\n## Commands\n\n### /check-type\n\nCheck the inferred type of a TypeScript symbol.\n\nUsage: \\`/check-type <file>:<line> <name>\\` or \\`/check-type <file> <name>\\`\n\nExamples:\n- \\`/check-type src/utils.ts:75 commandResult\\`\n- \\`/check-type src/utils.ts myFunction\\`\n\n<command-name>check-type</command-name>\n\nUse the \\`infer_type\\` MCP tool to check the type:\n1. Parse the arguments to extract file, optional line number, and symbol name\n2. Call \\`infer_type(file, name, line?)\\`\n3. Report the inferred signature and return type\n`;\n\nfunction main() {\n\tconst homeDir = os.homedir();\n\tconst skillsDir = path.join(homeDir, \".claude\", \"skills\");\n\tconst skillFile = path.join(skillsDir, \"
|
|
1
|
+
{"version":3,"sources":["../src/postinstall.ts"],"sourcesContent":["#!/usr/bin/env node\nimport fs from \"node:fs\";\nimport os from \"node:os\";\nimport path from \"node:path\";\n\nconst SKILL_CONTENT = `# TypeScript Type Inference (prinfer)\n\n## Coding Guideline\n\nWhen writing TypeScript code, prefer relying on type inference over explicit type annotations:\n\n- Let TypeScript infer return types for functions when the implementation makes them obvious\n- Let TypeScript infer variable types from their initializers\n- Only add explicit types when:\n - The inferred type is too wide (e.g., \\`string\\` instead of a literal type)\n - The type serves as documentation for complex structures\n - You're defining a public API contract\n\nUse the \\`prinfer\\` MCP tool (\\`infer_type\\`) to verify what TypeScript infers before adding explicit types.\n\n## Commands\n\n### /check-type\n\nCheck the inferred type of a TypeScript symbol.\n\nUsage: \\`/check-type <file>:<line> <name>\\` or \\`/check-type <file> <name>\\`\n\nExamples:\n- \\`/check-type src/utils.ts:75 commandResult\\`\n- \\`/check-type src/utils.ts myFunction\\`\n\n<command-name>check-type</command-name>\n\nUse the \\`infer_type\\` MCP tool to check the type:\n1. Parse the arguments to extract file, optional line number, and symbol name\n2. Call \\`infer_type(file, name, line?)\\`\n3. Report the inferred signature and return type\n`;\n\nfunction main() {\n\tconst homeDir = os.homedir();\n\tconst skillsDir = path.join(homeDir, \".claude\", \"skills\");\n\tconst skillFile = path.join(skillsDir, \"prefer-infer.md\");\n\n\t// Check if ~/.claude exists\n\tconst claudeDir = path.join(homeDir, \".claude\");\n\tif (!fs.existsSync(claudeDir)) {\n\t\tconsole.log(\n\t\t\t\"~/.claude directory not found. Skipping skill installation.\",\n\t\t);\n\t\tconsole.log(\n\t\t\t\"To manually install, create ~/.claude/skills/prefer-infer.md\",\n\t\t);\n\t\treturn;\n\t}\n\n\t// Create skills directory if it doesn't exist\n\tif (!fs.existsSync(skillsDir)) {\n\t\tfs.mkdirSync(skillsDir, { recursive: true });\n\t}\n\n\t// Check if skill already exists\n\tif (fs.existsSync(skillFile)) {\n\t\tconsole.log(\n\t\t\t\"prinfer skill already installed at ~/.claude/skills/prefer-infer.md\",\n\t\t);\n\t\treturn;\n\t}\n\n\t// Write the skill file\n\tfs.writeFileSync(skillFile, SKILL_CONTENT);\n\tconsole.log(\"Installed prinfer skill to ~/.claude/skills/prefer-infer.md\");\n\tconsole.log(\"You can now use /check-type to verify TypeScript types!\");\n}\n\nmain();\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AACA,qBAAe;AACf,qBAAe;AACf,uBAAiB;AAEjB,IAAM,gBAAgB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAmCtB,SAAS,OAAO;AACf,QAAM,UAAU,eAAAA,QAAG,QAAQ;AAC3B,QAAM,YAAY,iBAAAC,QAAK,KAAK,SAAS,WAAW,QAAQ;AACxD,QAAM,YAAY,iBAAAA,QAAK,KAAK,WAAW,iBAAiB;AAGxD,QAAM,YAAY,iBAAAA,QAAK,KAAK,SAAS,SAAS;AAC9C,MAAI,CAAC,eAAAC,QAAG,WAAW,SAAS,GAAG;AAC9B,YAAQ;AAAA,MACP;AAAA,IACD;AACA,YAAQ;AAAA,MACP;AAAA,IACD;AACA;AAAA,EACD;AAGA,MAAI,CAAC,eAAAA,QAAG,WAAW,SAAS,GAAG;AAC9B,mBAAAA,QAAG,UAAU,WAAW,EAAE,WAAW,KAAK,CAAC;AAAA,EAC5C;AAGA,MAAI,eAAAA,QAAG,WAAW,SAAS,GAAG;AAC7B,YAAQ;AAAA,MACP;AAAA,IACD;AACA;AAAA,EACD;AAGA,iBAAAA,QAAG,cAAc,WAAW,aAAa;AACzC,UAAQ,IAAI,6DAA6D;AACzE,UAAQ,IAAI,yDAAyD;AACtE;AAEA,KAAK;","names":["os","path","fs"]}
|
package/dist/postinstall.js
CHANGED
|
@@ -41,13 +41,15 @@ Use the \`infer_type\` MCP tool to check the type:
|
|
|
41
41
|
function main() {
|
|
42
42
|
const homeDir = os.homedir();
|
|
43
43
|
const skillsDir = path.join(homeDir, ".claude", "skills");
|
|
44
|
-
const skillFile = path.join(skillsDir, "
|
|
44
|
+
const skillFile = path.join(skillsDir, "prefer-infer.md");
|
|
45
45
|
const claudeDir = path.join(homeDir, ".claude");
|
|
46
46
|
if (!fs.existsSync(claudeDir)) {
|
|
47
47
|
console.log(
|
|
48
48
|
"~/.claude directory not found. Skipping skill installation."
|
|
49
49
|
);
|
|
50
|
-
console.log(
|
|
50
|
+
console.log(
|
|
51
|
+
"To manually install, create ~/.claude/skills/prefer-infer.md"
|
|
52
|
+
);
|
|
51
53
|
return;
|
|
52
54
|
}
|
|
53
55
|
if (!fs.existsSync(skillsDir)) {
|
|
@@ -55,12 +57,12 @@ function main() {
|
|
|
55
57
|
}
|
|
56
58
|
if (fs.existsSync(skillFile)) {
|
|
57
59
|
console.log(
|
|
58
|
-
"prinfer skill already installed at ~/.claude/skills/
|
|
60
|
+
"prinfer skill already installed at ~/.claude/skills/prefer-infer.md"
|
|
59
61
|
);
|
|
60
62
|
return;
|
|
61
63
|
}
|
|
62
64
|
fs.writeFileSync(skillFile, SKILL_CONTENT);
|
|
63
|
-
console.log("Installed prinfer skill to ~/.claude/skills/
|
|
65
|
+
console.log("Installed prinfer skill to ~/.claude/skills/prefer-infer.md");
|
|
64
66
|
console.log("You can now use /check-type to verify TypeScript types!");
|
|
65
67
|
}
|
|
66
68
|
main();
|
package/dist/postinstall.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/postinstall.ts"],"sourcesContent":["#!/usr/bin/env node\nimport fs from \"node:fs\";\nimport os from \"node:os\";\nimport path from \"node:path\";\n\nconst SKILL_CONTENT = `# TypeScript Type Inference (prinfer)\n\n## Coding Guideline\n\nWhen writing TypeScript code, prefer relying on type inference over explicit type annotations:\n\n- Let TypeScript infer return types for functions when the implementation makes them obvious\n- Let TypeScript infer variable types from their initializers\n- Only add explicit types when:\n - The inferred type is too wide (e.g., \\`string\\` instead of a literal type)\n - The type serves as documentation for complex structures\n - You're defining a public API contract\n\nUse the \\`prinfer\\` MCP tool (\\`infer_type\\`) to verify what TypeScript infers before adding explicit types.\n\n## Commands\n\n### /check-type\n\nCheck the inferred type of a TypeScript symbol.\n\nUsage: \\`/check-type <file>:<line> <name>\\` or \\`/check-type <file> <name>\\`\n\nExamples:\n- \\`/check-type src/utils.ts:75 commandResult\\`\n- \\`/check-type src/utils.ts myFunction\\`\n\n<command-name>check-type</command-name>\n\nUse the \\`infer_type\\` MCP tool to check the type:\n1. Parse the arguments to extract file, optional line number, and symbol name\n2. Call \\`infer_type(file, name, line?)\\`\n3. Report the inferred signature and return type\n`;\n\nfunction main() {\n\tconst homeDir = os.homedir();\n\tconst skillsDir = path.join(homeDir, \".claude\", \"skills\");\n\tconst skillFile = path.join(skillsDir, \"
|
|
1
|
+
{"version":3,"sources":["../src/postinstall.ts"],"sourcesContent":["#!/usr/bin/env node\nimport fs from \"node:fs\";\nimport os from \"node:os\";\nimport path from \"node:path\";\n\nconst SKILL_CONTENT = `# TypeScript Type Inference (prinfer)\n\n## Coding Guideline\n\nWhen writing TypeScript code, prefer relying on type inference over explicit type annotations:\n\n- Let TypeScript infer return types for functions when the implementation makes them obvious\n- Let TypeScript infer variable types from their initializers\n- Only add explicit types when:\n - The inferred type is too wide (e.g., \\`string\\` instead of a literal type)\n - The type serves as documentation for complex structures\n - You're defining a public API contract\n\nUse the \\`prinfer\\` MCP tool (\\`infer_type\\`) to verify what TypeScript infers before adding explicit types.\n\n## Commands\n\n### /check-type\n\nCheck the inferred type of a TypeScript symbol.\n\nUsage: \\`/check-type <file>:<line> <name>\\` or \\`/check-type <file> <name>\\`\n\nExamples:\n- \\`/check-type src/utils.ts:75 commandResult\\`\n- \\`/check-type src/utils.ts myFunction\\`\n\n<command-name>check-type</command-name>\n\nUse the \\`infer_type\\` MCP tool to check the type:\n1. Parse the arguments to extract file, optional line number, and symbol name\n2. Call \\`infer_type(file, name, line?)\\`\n3. Report the inferred signature and return type\n`;\n\nfunction main() {\n\tconst homeDir = os.homedir();\n\tconst skillsDir = path.join(homeDir, \".claude\", \"skills\");\n\tconst skillFile = path.join(skillsDir, \"prefer-infer.md\");\n\n\t// Check if ~/.claude exists\n\tconst claudeDir = path.join(homeDir, \".claude\");\n\tif (!fs.existsSync(claudeDir)) {\n\t\tconsole.log(\n\t\t\t\"~/.claude directory not found. Skipping skill installation.\",\n\t\t);\n\t\tconsole.log(\n\t\t\t\"To manually install, create ~/.claude/skills/prefer-infer.md\",\n\t\t);\n\t\treturn;\n\t}\n\n\t// Create skills directory if it doesn't exist\n\tif (!fs.existsSync(skillsDir)) {\n\t\tfs.mkdirSync(skillsDir, { recursive: true });\n\t}\n\n\t// Check if skill already exists\n\tif (fs.existsSync(skillFile)) {\n\t\tconsole.log(\n\t\t\t\"prinfer skill already installed at ~/.claude/skills/prefer-infer.md\",\n\t\t);\n\t\treturn;\n\t}\n\n\t// Write the skill file\n\tfs.writeFileSync(skillFile, SKILL_CONTENT);\n\tconsole.log(\"Installed prinfer skill to ~/.claude/skills/prefer-infer.md\");\n\tconsole.log(\"You can now use /check-type to verify TypeScript types!\");\n}\n\nmain();\n"],"mappings":";;;AACA,OAAO,QAAQ;AACf,OAAO,QAAQ;AACf,OAAO,UAAU;AAEjB,IAAM,gBAAgB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAmCtB,SAAS,OAAO;AACf,QAAM,UAAU,GAAG,QAAQ;AAC3B,QAAM,YAAY,KAAK,KAAK,SAAS,WAAW,QAAQ;AACxD,QAAM,YAAY,KAAK,KAAK,WAAW,iBAAiB;AAGxD,QAAM,YAAY,KAAK,KAAK,SAAS,SAAS;AAC9C,MAAI,CAAC,GAAG,WAAW,SAAS,GAAG;AAC9B,YAAQ;AAAA,MACP;AAAA,IACD;AACA,YAAQ;AAAA,MACP;AAAA,IACD;AACA;AAAA,EACD;AAGA,MAAI,CAAC,GAAG,WAAW,SAAS,GAAG;AAC9B,OAAG,UAAU,WAAW,EAAE,WAAW,KAAK,CAAC;AAAA,EAC5C;AAGA,MAAI,GAAG,WAAW,SAAS,GAAG;AAC7B,YAAQ;AAAA,MACP;AAAA,IACD;AACA;AAAA,EACD;AAGA,KAAG,cAAc,WAAW,aAAa;AACzC,UAAQ,IAAI,6DAA6D;AACzE,UAAQ,IAAI,yDAAyD;AACtE;AAEA,KAAK;","names":[]}
|