pointfree-docs 0.2.1 → 0.2.4
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 -0
- package/dist/cli.js +4 -1
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -10,6 +10,21 @@ https://github.com/user-attachments/assets/ed6c6340-2d29-4515-89ca-62f65cfa4755
|
|
|
10
10
|
|
|
11
11
|
## Quick Start
|
|
12
12
|
|
|
13
|
+
### Claude Code Plugin
|
|
14
|
+
|
|
15
|
+
Install as a Claude Code plugin so Claude can search Point-Free docs automatically:
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
claude plugin marketplace add ronnie3786/pointfree-docs
|
|
19
|
+
claude plugin install pointfree-docs
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
The plugin handles CLI installation and doc indexing for you. Once installed, Claude will use `pf-docs` whenever you're working with Point-Free libraries.
|
|
23
|
+
|
|
24
|
+
### Direct CLI Install
|
|
25
|
+
|
|
26
|
+
Install the CLI standalone for use in your terminal or with other tools:
|
|
27
|
+
|
|
13
28
|
```bash
|
|
14
29
|
# Install from npm
|
|
15
30
|
npm install -g pointfree-docs
|
package/dist/cli.js
CHANGED
|
@@ -5,12 +5,15 @@
|
|
|
5
5
|
* A CLI for searching and browsing Point-Free library documentation.
|
|
6
6
|
*/
|
|
7
7
|
import { Command } from "commander";
|
|
8
|
+
import { createRequire } from "node:module";
|
|
8
9
|
import { initCommand } from "./commands/init.js";
|
|
9
10
|
import { updateCommand } from "./commands/update.js";
|
|
10
11
|
import { searchCommand } from "./commands/search.js";
|
|
11
12
|
import { getCommand } from "./commands/get.js";
|
|
12
13
|
import { listCommand } from "./commands/list.js";
|
|
13
14
|
import { statsCommand } from "./commands/stats.js";
|
|
15
|
+
const require = createRequire(import.meta.url);
|
|
16
|
+
const packageMetadata = require("../package.json");
|
|
14
17
|
const program = new Command();
|
|
15
18
|
program
|
|
16
19
|
.name("pf-docs")
|
|
@@ -28,7 +31,7 @@ Path format: <library>/<Articles|Tutorials|Extensions>/<Name>
|
|
|
28
31
|
e.g. tca/Articles/TestingTCA, sharing/Articles/SharingState
|
|
29
32
|
|
|
30
33
|
All commands support --json for machine-readable output.`)
|
|
31
|
-
.version(
|
|
34
|
+
.version(packageMetadata.version);
|
|
32
35
|
program
|
|
33
36
|
.command("init")
|
|
34
37
|
.description("Initialize and download documentation for specified libraries")
|
package/package.json
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "pointfree-docs",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.4",
|
|
4
4
|
"description": "CLI tool for searching Point-Free library documentation",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"bin": {
|
|
7
|
-
"pf-docs": "
|
|
7
|
+
"pf-docs": "dist/cli.js"
|
|
8
8
|
},
|
|
9
9
|
"files": [
|
|
10
10
|
"dist",
|
|
@@ -32,7 +32,7 @@
|
|
|
32
32
|
],
|
|
33
33
|
"license": "MIT",
|
|
34
34
|
"dependencies": {
|
|
35
|
-
"better-sqlite3": "^
|
|
35
|
+
"better-sqlite3": "^12.10.0",
|
|
36
36
|
"chalk": "^5.3.0",
|
|
37
37
|
"commander": "^12.0.0",
|
|
38
38
|
"glob": "^10.3.0",
|
|
@@ -44,6 +44,6 @@
|
|
|
44
44
|
"typescript": "^5.3.0"
|
|
45
45
|
},
|
|
46
46
|
"engines": {
|
|
47
|
-
"node": ">=
|
|
47
|
+
"node": ">=20.0.0"
|
|
48
48
|
}
|
|
49
49
|
}
|