@narumitw/pi-jupyter 0.1.0 → 0.1.1

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 (2) hide show
  1. package/README.md +31 -8
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -18,30 +18,37 @@ The preview is a static text rendering of notebook cells and selected text outpu
18
18
  Install from npm globally:
19
19
 
20
20
  ```bash
21
- pi install npm:pi-jupyter
21
+ pi install npm:@narumitw/pi-jupyter
22
22
  ```
23
23
 
24
24
  Or pin a version:
25
25
 
26
26
  ```bash
27
- pi install npm:pi-jupyter@0.1.0
27
+ pi install npm:@narumitw/pi-jupyter@0.1.1
28
28
  ```
29
29
 
30
30
  Install for the current project only:
31
31
 
32
32
  ```bash
33
- pi install npm:pi-jupyter -l
33
+ pi install npm:@narumitw/pi-jupyter -l
34
34
  ```
35
35
 
36
- Install from GitHub/tag:
36
+ If npm returns `E404`, the scoped package has not been published yet. Until then, install from GitHub/tag:
37
37
 
38
38
  ```bash
39
- pi install git:github.com/narumiruna/pi-jupyter@v0.1.0
39
+ pi install git:github.com/narumiruna/pi-jupyter@v0.1.1
40
+ ```
41
+
42
+ If you previously installed the unscoped package, remove it before installing the scoped package:
43
+
44
+ ```bash
45
+ pi remove npm:pi-jupyter
46
+ pi install npm:@narumitw/pi-jupyter
40
47
  ```
41
48
 
42
49
  ## Local development install
43
50
 
44
- Use one source at a time. If `npm:pi-jupyter` is installed globally and this repo is also installed locally with `-l`, Pi will load both and report shortcut conflicts.
51
+ Use one source at a time. If `npm:@narumitw/pi-jupyter` is installed globally and this repo is also installed locally with `-l`, Pi will load both and report shortcut conflicts.
45
52
 
46
53
  For temporary local testing, prefer:
47
54
 
@@ -55,13 +62,16 @@ For a persistent project-local install:
55
62
  pi install . -l
56
63
  ```
57
64
 
58
- If you also have the npm package installed globally, remove one of them before starting Pi:
65
+ If you also have an npm package installed globally, remove one source before starting Pi:
59
66
 
60
67
  ```bash
61
68
  # Keep the npm package; remove the project-local package from this repo
62
69
  pi remove . -l
63
70
 
64
71
  # Or keep the local package; remove the global npm package
72
+ pi remove npm:@narumitw/pi-jupyter
73
+
74
+ # If you installed the older unscoped package, remove that too
65
75
  pi remove npm:pi-jupyter
66
76
  ```
67
77
 
@@ -74,12 +84,25 @@ just format
74
84
  pre-commit install
75
85
  ```
76
86
 
77
- Publish to npm. This runs `biome check .` first via the `justfile`, then `npm publish`:
87
+ Publish to npm. This runs `biome check .` first via the `justfile`, then `npm publish --access public`:
78
88
 
79
89
  ```bash
90
+ npm login
80
91
  just publish
81
92
  ```
82
93
 
94
+ If npm requires two-factor authentication, pass the one-time password:
95
+
96
+ ```bash
97
+ just publish 123456
98
+ ```
99
+
100
+ After publishing succeeds, this install command will work:
101
+
102
+ ```bash
103
+ pi install npm:@narumitw/pi-jupyter
104
+ ```
105
+
83
106
  Preview the npm package without publishing:
84
107
 
85
108
  ```bash
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@narumitw/pi-jupyter",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "Pi extension: right-side Jupyter notebook preview while editing .ipynb files.",
5
5
  "type": "module",
6
6
  "keywords": [