@pathmx/paths 0.5.1 → 0.5.3

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.
Files changed (3) hide show
  1. package/README.md +6 -17
  2. package/index.ts +6 -4
  3. package/package.json +4 -4
package/README.md CHANGED
@@ -5,14 +5,14 @@ and Player at matching PathMX versions.
5
5
 
6
6
  ## Quickstart
7
7
 
8
- Create a Bun project and install the beta CLI plus the preset:
8
+ Initialize a project and install the preset:
9
9
 
10
10
  ```sh
11
- mkdir my-path && cd my-path
12
- bun init -y
13
- bun add --exact @pathmx/core@beta
11
+ bunx @pathmx/core@beta init my-path
12
+ cd my-path
14
13
  bun run pmx plugins add paths
15
- mkdir -p paths plugins
14
+ mkdir plugins
15
+ mv paths/index.md paths/index.path.md
16
16
  ```
17
17
 
18
18
  Activate the preset:
@@ -40,18 +40,7 @@ echo '# Introduction' > paths/introduction.md
40
40
  echo '# Next steps' > paths/next-steps.md
41
41
  ```
42
42
 
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
- Start PathMX:
43
+ Start PathMX with the generated project-local command:
55
44
 
56
45
  ```sh
57
46
  bun run dev
package/index.ts CHANGED
@@ -1,12 +1,14 @@
1
- import { CompletionPlugin } from "@pathmx/completion"
2
- import { PathCompletionContributor, PathPlugin } from "@pathmx/path"
1
+ import { createCompletionPlugin } from "@pathmx/completion"
2
+ import { PathCompletionContributor, 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
- PathPlugin,
9
- () => CompletionPlugin({ contributors: [PathCompletionContributor] }),
8
+ () => createPathPlugin().plugin,
9
+ () =>
10
+ createCompletionPlugin({ contributors: [PathCompletionContributor] })
11
+ .plugin,
10
12
  PlayerPlugin,
11
13
  ])
12
14
 
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.1",
4
+ "version": "0.5.3",
5
5
  "license": "SEE LICENSE IN LICENSE.md",
6
6
  "repository": {
7
7
  "type": "git",
@@ -24,8 +24,8 @@
24
24
  "@pathmx/core": "^0.5.0"
25
25
  },
26
26
  "dependencies": {
27
- "@pathmx/completion": "0.5.1",
28
- "@pathmx/path": "0.5.1",
29
- "@pathmx/player": "0.5.1"
27
+ "@pathmx/completion": "0.5.3",
28
+ "@pathmx/path": "0.5.3",
29
+ "@pathmx/player": "0.5.3"
30
30
  }
31
31
  }