@pathmx/paths 0.5.2 → 0.5.6
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 +9 -25
- package/index.ts +8 -4
- package/package.json +7 -4
package/README.md
CHANGED
|
@@ -5,22 +5,17 @@ and Player at matching PathMX versions.
|
|
|
5
5
|
|
|
6
6
|
## Quickstart
|
|
7
7
|
|
|
8
|
-
|
|
8
|
+
Initialize a project and install the preset:
|
|
9
9
|
|
|
10
10
|
```sh
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
mkdir -p paths plugins
|
|
11
|
+
bunx @pathmx/core@beta init my-path
|
|
12
|
+
cd my-path
|
|
13
|
+
pmx plugins add paths
|
|
14
|
+
mv paths/index.md paths/index.path.md
|
|
16
15
|
```
|
|
17
16
|
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
```ts
|
|
21
|
-
// plugins/paths.plugin.ts
|
|
22
|
-
export { default } from "@pathmx/paths"
|
|
23
|
-
```
|
|
17
|
+
The command records `@pathmx/paths` in `package.json#pathmx.plugins`; no
|
|
18
|
+
repository Plugin entrypoint is needed.
|
|
24
19
|
|
|
25
20
|
Create `paths/index.path.md`:
|
|
26
21
|
|
|
@@ -40,21 +35,10 @@ echo '# Introduction' > paths/introduction.md
|
|
|
40
35
|
echo '# Next steps' > paths/next-steps.md
|
|
41
36
|
```
|
|
42
37
|
|
|
43
|
-
Add project-local commands to `package.json`:
|
|
44
|
-
|
|
45
|
-
```json
|
|
46
|
-
{
|
|
47
|
-
"scripts": {
|
|
48
|
-
"dev": "pmx dev",
|
|
49
|
-
"lint": "pmx lint"
|
|
50
|
-
}
|
|
51
|
-
}
|
|
52
|
-
```
|
|
53
|
-
|
|
54
38
|
Start PathMX:
|
|
55
39
|
|
|
56
40
|
```sh
|
|
57
|
-
|
|
41
|
+
pmx dev
|
|
58
42
|
```
|
|
59
43
|
|
|
60
44
|
## Optional packages
|
|
@@ -62,7 +46,7 @@ bun run dev
|
|
|
62
46
|
Authentication and Mermaid rendering remain explicit additions:
|
|
63
47
|
|
|
64
48
|
```sh
|
|
65
|
-
bun
|
|
49
|
+
bun add @pathmx/auth@beta @pathmx/mermaid@beta
|
|
66
50
|
```
|
|
67
51
|
|
|
68
52
|
Add each package through its own repository Plugin so its configuration stays
|
package/index.ts
CHANGED
|
@@ -1,12 +1,16 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
1
|
+
import { createCompletionPlugin } from "@pathmx/completion"
|
|
2
|
+
import { PathCompletionTargets, createPathPlugin } from "@pathmx/path"
|
|
3
3
|
import { PlayerPlugin } from "@pathmx/player"
|
|
4
4
|
import { definePreset } from "@pathmx/core"
|
|
5
5
|
|
|
6
6
|
/** The opinionated, provider-neutral Paths product baseline. */
|
|
7
7
|
export const PathsPreset = definePreset([
|
|
8
|
-
|
|
9
|
-
() =>
|
|
8
|
+
() => createPathPlugin().plugin,
|
|
9
|
+
() =>
|
|
10
|
+
createCompletionPlugin({
|
|
11
|
+
storage: "actor",
|
|
12
|
+
targets: [PathCompletionTargets],
|
|
13
|
+
}).plugin,
|
|
10
14
|
PlayerPlugin,
|
|
11
15
|
])
|
|
12
16
|
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@pathmx/paths",
|
|
3
3
|
"description": "The provider-neutral Path, Completion, and Player experience for PathMX.",
|
|
4
|
-
"version": "0.5.
|
|
4
|
+
"version": "0.5.6",
|
|
5
5
|
"license": "SEE LICENSE IN LICENSE.md",
|
|
6
6
|
"repository": {
|
|
7
7
|
"type": "git",
|
|
@@ -17,6 +17,9 @@
|
|
|
17
17
|
},
|
|
18
18
|
"type": "module",
|
|
19
19
|
"exports": "./index.ts",
|
|
20
|
+
"pathmx": {
|
|
21
|
+
"plugin": "."
|
|
22
|
+
},
|
|
20
23
|
"engines": {
|
|
21
24
|
"bun": ">=1.4.0"
|
|
22
25
|
},
|
|
@@ -24,8 +27,8 @@
|
|
|
24
27
|
"@pathmx/core": "^0.5.0"
|
|
25
28
|
},
|
|
26
29
|
"dependencies": {
|
|
27
|
-
"@pathmx/completion": "0.5.
|
|
28
|
-
"@pathmx/path": "0.5.
|
|
29
|
-
"@pathmx/player": "0.5.
|
|
30
|
+
"@pathmx/completion": "0.5.6",
|
|
31
|
+
"@pathmx/path": "0.5.6",
|
|
32
|
+
"@pathmx/player": "0.5.6"
|
|
30
33
|
}
|
|
31
34
|
}
|