@s2j/global-npm 2.1.0 → 2.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.
- package/README.md +22 -13
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -11,7 +11,7 @@ GitHub: [stein2nd/global-npm-setup](https://github.com/stein2nd/global-npm-setup
|
|
|
11
11
|
global-npm check # グローバルパッケージの更新確認 (ncu)
|
|
12
12
|
global-npm update # package.json のバージョン範囲を更新 (ncu -u)
|
|
13
13
|
global-npm install # dependencies を列挙して npm install -g を実行
|
|
14
|
-
global-npm sync # upstream + user-deps →
|
|
14
|
+
global-npm sync # upstream + user-deps → 実効 package.json を再生成
|
|
15
15
|
global-npm add # user-deps.json にパッケージを追記
|
|
16
16
|
```
|
|
17
17
|
|
|
@@ -29,7 +29,7 @@ global-npm install
|
|
|
29
29
|
|--------|------|------|
|
|
30
30
|
| Upstream 正本 | `@s2j/global-npm` 同梱 `package.json` | 公式 `dependencies` 一覧 |
|
|
31
31
|
| ユーザー overlay | `$SETUP_DIR/user-deps.json` | 追加分、ピン留め |
|
|
32
|
-
|
|
|
32
|
+
| 実効 package.json | `$SETUP_DIR/package.json` | ncu / install が読む実効マニフェスト |
|
|
33
33
|
|
|
34
34
|
**setup ディレクトリ (`$SETUP_DIR`) のデフォルト**
|
|
35
35
|
|
|
@@ -38,7 +38,7 @@ global-npm install
|
|
|
38
38
|
| macOS / Linux | `~/.config/global-npm` |
|
|
39
39
|
| Windows 11 | `%APPDATA%\global-npm` |
|
|
40
40
|
|
|
41
|
-
`GLOBAL_NPM_SETUP_DIR` 環境変数で上書きできます。詳細は [docs/layout.md](./docs/layout.md)
|
|
41
|
+
`GLOBAL_NPM_SETUP_DIR` 環境変数で上書きできます。詳細は [docs/layout.md](./docs/layout.md) をご覧ください。
|
|
42
42
|
|
|
43
43
|
## セットアップ
|
|
44
44
|
|
|
@@ -79,13 +79,13 @@ Node.js v18以上 (LTS 推奨) が未導入の場合は、先にインストー
|
|
|
79
79
|
```sh
|
|
80
80
|
npm install -g @s2j/global-npm # CLI 本体の導入 (これは一度だけ)
|
|
81
81
|
global-npm add @s2j/docs-linter@^1.0.16 # 任意: ユーザー追加分
|
|
82
|
-
global-npm install #
|
|
82
|
+
global-npm install # 実効 package.json の dependencies を global install
|
|
83
83
|
```
|
|
84
84
|
|
|
85
|
-
初回の `global-npm install` で `~/.config/global-npm/` (Windows 11では `%APPDATA%\global-npm\`)
|
|
85
|
+
初回の `global-npm install` で `~/.config/global-npm/` (Windows 11では `%APPDATA%\global-npm\`) に実効 `package.json` が生成されます。
|
|
86
86
|
`global-npm install` は、`@s2j/global-npm` 自身 (自己参照) も含め、`dependencies` のキーを列挙して `npm install -g` します。
|
|
87
87
|
|
|
88
|
-
###
|
|
88
|
+
### 開発: リポジトリ clone
|
|
89
89
|
|
|
90
90
|
```sh
|
|
91
91
|
git clone https://github.com/stein2nd/global-npm-setup.git
|
|
@@ -110,6 +110,15 @@ global-npm sync --dry-run
|
|
|
110
110
|
* upstream 管理パッケージのうち未 update 分は、次回 `check` 時の sync で新 range に追従する。
|
|
111
111
|
* upstream パッケージをピン留めする場合は、`user-deps.json` の `dependencies` に同名で range を書く。
|
|
112
112
|
|
|
113
|
+
## 使い方
|
|
114
|
+
|
|
115
|
+
下記については、[使い方](./docs/usage.md) をご覧ください。
|
|
116
|
+
|
|
117
|
+
* 各コマンドの役割
|
|
118
|
+
* 定番フロー (`check` → `update` → `install`)
|
|
119
|
+
* 毎回 `sync` を実行する必要があるか
|
|
120
|
+
* upstream 管理分と追加分の衝突が起こった場合
|
|
121
|
+
|
|
113
122
|
## 日常の更新サイクル
|
|
114
123
|
|
|
115
124
|
```mermaid
|
|
@@ -121,8 +130,8 @@ flowchart LR
|
|
|
121
130
|
```
|
|
122
131
|
|
|
123
132
|
* **check:** sync 後に ncu で更新候補を表示。ncu 自体は range を書き換えない。
|
|
124
|
-
* **update:**
|
|
125
|
-
* **install:**
|
|
133
|
+
* **update:** 実効 package.json の `dependencies` / `devDependencies` の range を更新。
|
|
134
|
+
* **install:** 実効 package.json の **dependencies** のみ global install。
|
|
126
135
|
|
|
127
136
|
## 開発用 scripts
|
|
128
137
|
|
|
@@ -139,8 +148,8 @@ npm run ncu:update
|
|
|
139
148
|
|
|
140
149
|
| v1 | v2 |
|
|
141
150
|
|----|-----|
|
|
142
|
-
| `~/bin/global-npm` (Zsh) |
|
|
143
|
-
| `install-global.zsh` |
|
|
151
|
+
| `~/bin/global-npm` (Zsh) | 廃止: `npm install -g @s2j/global-npm` |
|
|
152
|
+
| `install-global.zsh` | 廃止: `global-npm install` |
|
|
144
153
|
| `ncu:install` (jq 列挙) | `global-npm install` (Node 列挙) |
|
|
145
154
|
|
|
146
155
|
### v2.0.x → v2.1
|
|
@@ -148,16 +157,16 @@ npm run ncu:update
|
|
|
148
157
|
| v2.0.x | v2.1 |
|
|
149
158
|
|--------|------|
|
|
150
159
|
| setup = package root | setup = `~/.config/global-npm`。Windows は `%APPDATA%\global-npm` |
|
|
151
|
-
| 同梱 `package.json` を直接 ncu |
|
|
160
|
+
| 同梱 `package.json` を直接 ncu | 実効 package.json を ncu |
|
|
152
161
|
| 3サブコマンド | 5サブコマンド (`sync` / `add` 追加) |
|
|
153
162
|
|
|
154
163
|
移行手順は、下記のとおりです。
|
|
155
164
|
|
|
156
165
|
1. `npm update -g @s2j/global-npm` で v2.1に上げる。
|
|
157
166
|
2. 追加分を `global-npm add …` で登録する。
|
|
158
|
-
3. `global-npm sync` で
|
|
167
|
+
3. `global-npm sync` で 実効 package.json を生成する。
|
|
159
168
|
4. `global-npm install` で global 環境を同期する。
|
|
160
169
|
|
|
161
170
|
## ライセンス
|
|
162
171
|
|
|
163
|
-
GPL-3.0-or-later
|
|
172
|
+
GPL-3.0-or-later: 詳細は [LICENSE](./LICENSE) をご覧ください。
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@s2j/global-npm",
|
|
3
|
-
"version": "2.1.
|
|
3
|
+
"version": "2.1.1",
|
|
4
4
|
"description": "Manage globally installed npm packages via package.json with ncu.",
|
|
5
5
|
"author": "Koutarou ISHIKAWA <stein2nd@gmail.com>",
|
|
6
6
|
"type": "commonjs",
|
|
@@ -56,7 +56,7 @@
|
|
|
56
56
|
"typescript": "^5.9.3"
|
|
57
57
|
},
|
|
58
58
|
"dependencies": {
|
|
59
|
-
"@s2j/global-npm": "^2.0
|
|
59
|
+
"@s2j/global-npm": "^2.1.0",
|
|
60
60
|
"corepack": "^0.35.0",
|
|
61
61
|
"editorconfig-cli": "^1.0.0",
|
|
62
62
|
"envinfo": "^7.21.0",
|