dsh-ci-diet 0.2.0 → 0.3.1

package/README.ko.md

@@ -2,9 +2,10 @@
 
 낭비된 GitHub Actions 러너 시간을 찾고, 작고 검토 가능한 패치를 제안합니다.
 
-상태: **알파, npm에 `dsh-ci-diet@0.2.0`로 배포됨**. 계약, 명세, 분석 엔진,
+상태: **알파, `dsh-ci-diet@0.3.1` npm 게시됨**. 계약, 명세, 분석 엔진,
 패치 엔진, CLI, DSH 플러그인 도구, 자체 완결형 HTML 보고서는 구현과 테스트를
-마쳤습니다. DSH Web 클라이언트 화면은 아직 남아 있습니다.
+마쳤습니다. DSH Web 클라이언트는 설정 화면을 제공하고, 보고서·적용 화면은 아직
+남아 있습니다.
 
 ## 하는 일
 
@@ -58,15 +59,43 @@ CI Diet는 두 가지를 읽고 비교합니다.
 
 ## 설치
 
+CLI는 Node `^22.19.0 || >=24.0.0`이 필요합니다. DSH 플러그인은 DSH
+`>=0.2.1-rc.2 <0.3.0-0` 또는 `>=0.2.2-rc.1 <0.3.0-0`이 필요합니다. `0.3.1`
+릴리스는 DSH `0.2.1-rc.2`에서 검증했으며 DSH `0.3.0`은 아직 지원하지 않습니다.
+
+CLI 설치:
+
+```
+npm install --global dsh-ci-diet@0.3.1
+ci-diet --version
+```
+
+전역 설치를 원하지 않으면 `npx dsh-ci-diet@0.3.1`으로 같은 CLI를 실행할 수
+있습니다.
+
+DSH 플러그인 설치:
+
+```
+dsh plugin --profile web add dsh-ci-diet@0.3.1
+dsh --profile web
+```
+
+플러그인은 기본으로 꺼진 로더 항목 하나와 **설정 → CI Diet** 페이지를 추가합니다.
+이 페이지에서 분석 규칙, 이력 상한, 저장 공간 한도, 비용 추정, 네트워크 접근,
+상태 디렉터리를 모두 바꿀 수 있습니다. 값은 `ci-diet --config`와 같은 계약 검증과
+기본값을 쓰며, 재시작 없이 다음 도구 호출부터 적용되고 CLI의 설정 파일은 건드리지
+않습니다. 적용 도구가 아직 없어 `localApplyEnabled`는 노출하지 않습니다.
+
+기존 설치 업데이트:
+
 ```
-npm install --global dsh-ci-diet
-dsh plugin --profile web add dsh-ci-diet
+npm install --global dsh-ci-diet@latest
+dsh plugin --profile web add dsh-ci-diet@latest
 ```
 
-플러그인은 기본으로 꺼진 로더 항목 하나를 추가합니다. 이력 동기화를 쓸 때만
-`networkEnabled`를 켜십시오. 전역 설치는 선택 사항입니다. `npx dsh-ci-diet`로
-같은 CLI를 실행할 수 있고, DSH 플러그인은 프로필에 패키지가 있으면 됩니다.
-릴리스 태그는 GitHub에, 같은 버전은 npm `0.2.0`에 있습니다.
+플러그인을 업데이트한 뒤 DSH를 재시작합니다. `dsh plugin --profile web list`로
+설치된 플러그인 버전을, `ci-diet --version`(또는
+`npx dsh-ci-diet@latest --version`)으로 CLI 버전을 확인할 수 있습니다.
 
 ## 실행
 
@@ -114,8 +143,8 @@ lockfile 변경을 따라가지 못하는 리터럴 캐시 키가 대상입니
 `.github/workflows/publish.yml`이 실행됩니다.
 
 ```
-git tag v0.2.0
-git push origin v0.2.0
+git tag v0.3.1
+git push origin v0.3.1
 ```
 
 워크플로는 태그와 `package.json` 버전을 대조하고(`node

package/README.md

@@ -2,10 +2,10 @@
 
 Find wasted GitHub Actions runner time and propose small, reviewable patches.
 
-Status: **alpha, published on npm** as `dsh-ci-diet@0.2.0`. The contracts,
+Status: **alpha**, `dsh-ci-diet@0.3.1` is released on npm. The contracts,
 specification, analysis engine, patch engine, CLI, DSH plugin tools, and a
-self-contained HTML report are implemented and tested. The DSH Web client
-screens are still open.
+self-contained HTML report are implemented and tested. The DSH Web client has a
+Settings screen; the report and apply screens are still open.
 
 ## What it does
 
@@ -60,15 +60,43 @@ is not shipped.
 
 ## Install
 
+The CLI needs Node `^22.19.0 || >=24.0.0`. The DSH plugin needs DSH
+`>=0.2.1-rc.2 <0.3.0-0` or `>=0.2.2-rc.1 <0.3.0-0`. Release `0.3.1` was tested
+against DSH `0.2.1-rc.2`; DSH `0.3.0` is not supported yet.
+
+Install the CLI:
+
+```
+npm install --global dsh-ci-diet@0.3.1
+ci-diet --version
+```
+
+If you do not want a global install, `npx dsh-ci-diet@0.3.1` runs the same CLI.
+
+Install the DSH plugin into a profile:
+
 ```
-npm install --global dsh-ci-diet
-dsh plugin --profile web add dsh-ci-diet
+dsh plugin --profile web add dsh-ci-diet@0.3.1
+dsh --profile web
 ```
 
-The plugin adds one disabled loader entry; enable `networkEnabled` only if you
-want history sync. Installing the package globally is optional: `npx dsh-ci-diet`
-runs the same CLI, and the DSH plugin only needs the package in the profile.
-Release tags are on GitHub; the matching npm version is `0.2.0`.
+The plugin adds one disabled loader entry and a **Settings → CI Diet** page.
+The page edits every engine setting used by the DSH tools: analysis rules, history
+caps, storage limits, the cost estimate, network access, and the state directory.
+Values use the same contract validation and defaults as `ci-diet --config`, apply
+to the next tool call without a restart, and never rewrite the CLI's own config.
+`localApplyEnabled` is not exposed because there is no apply tool yet.
+
+Update an existing install:
+
+```
+npm install --global dsh-ci-diet@latest
+dsh plugin --profile web add dsh-ci-diet@latest
+```
+
+Restart DSH after updating the plugin. `dsh plugin --profile web list` shows the
+installed plugin version, and `ci-diet --version` (or
+`npx dsh-ci-diet@latest --version`) shows the CLI version.
 
 ## Run it
 
@@ -85,13 +113,21 @@ ci-diet revert --change <changeId>       # restores the backed-up bytes
 `plan` refuses to write when the finding is not patch-eligible, when coverage
 does not allow a write, or when the policy snapshot a rule depends on is stale.
 CD005 needs `--job` and `--minutes`; CD008 needs `--job` and `--step`, plus
-`--claims artifact-purpose:temporary,consumer-min-days:7`. Nothing is committed,
-pushed, or applied without the explicit `approve` step.
+`--claims artifact-purpose:temporary,consumer-min-days:7`. The command prints the
+proposed lines as a diff, and `ci-diet plans --plan <planId>` shows a saved plan
+again. Nothing is committed, pushed, or applied without the explicit `approve`
+step.
+
+`--config <file>` merges a partial JSON configuration over the built-in defaults
+for any command, so a repository can lower the workflow size limit or the
+storage quota without code changes. The merged document is validated against
+the frozen contract before the command runs; an unreadable or invalid file
+exits `2`. Relative paths resolve against the effective `--cwd`.
 
 ## Read a report
 
 ```
-ci-diet report                 # text summary of the latest stored report
+ci-diet report                 # text summary for this repository
 ci-diet report --format html --out report.html
 ci-diet diagnose               # explain job-name attribution and collection coverage
 ci-diet prune                  # drop expired reports, plans, and cache entries
@@ -117,8 +153,8 @@ Pushing a tag that matches the version in `package.json` triggers
 `.github/workflows/publish.yml`:
 
 ```
-git tag v0.2.0
-git push origin v0.2.0
+git tag v0.3.1
+git push origin v0.3.1
 ```
 
 The workflow compares the tag with `package.json` (`node

package/client/index.d.ts

@@ -0,0 +1,3 @@
+/** DSH Web client half for the CI Diet settings section. */
+declare const plugin: { readonly inject: readonly string[]; apply(ctx: unknown): void };
+export default plugin;