Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "slz",
"image": "mcr.microsoft.com/devcontainers/go:1.26",
"image": "mcr.microsoft.com/devcontainers/go:1.25",
"workspaceFolder": "/workspaces/${localWorkspaceFolderBasename}"
}
22 changes: 22 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: test

on:
pull_request:
branches:
- develop
- "dev-v*"

jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-go@v5
with:
go-version: "1.25"
- name: gofmt
run: test -z "$(gofmt -l .)"
- name: vet
run: go vet ./...
- name: test
run: go test ./...
4 changes: 2 additions & 2 deletions docs/main.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ mac コマンド(`mac dim` など)はコンテナでは動かさない。`GO

CLI の骨格は **cobra**(v0.1.0 から)。バージョン文字列は当面ハードコードする(`slz --version` → `slz version 0.1.0`)。

テスト仕様書は版ごとに `docs/tests/`(v0.1.0 は [tests/v0.1.0.md](./tests/v0.1.0.md))。自動テストの実装と CI は **v0.2.0 から**。
テスト仕様書は版ごとに `docs/tests/`(v0.1.0 は [tests/v0.1.0.md](./tests/v0.1.0.md)、v0.2.0 は [tests/v0.2.0.md](./tests/v0.2.0.md))。自動テストの実装と CI は **v0.2.0 から**。CI は `develop` / `dev-v*` 向け PR のみ。

## 役割分担

Expand Down Expand Up @@ -173,7 +173,7 @@ $XDG_CACHE_HOME/slz/ # 未設定なら ~/.cache/slz/

- v0.1.0: スキャフォールド、Dev Container、`slz -v` → [roadmap.md](./roadmap.md)
- v0.2.0: `setup` / `config` / `--help` / `mac dim`
- v0.3.0: v0.2.0 完了時に再検討
- v0.3.0: `mac dim` 復帰時の常駐解除、空 `config.yaml` の `<blank>` 表示。その他は v0.2.0 完了時に再検討
- 版未定のユースケース → [plans/unscheduled/usecases.md](./plans/unscheduled/usecases.md)
- キャッシュ実装、`slz prompt`、コマンドのディレクトリネスト → [plans/unscheduled/future-intents.md](./plans/unscheduled/future-intents.md)

Expand Down
2 changes: 1 addition & 1 deletion docs/plans/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
| パス | マイルストーン | 状態 |
| --- | --- | --- |
| [v0.1.0/scaffold.md](./v0.1.0/scaffold.md) | v0.1.0 | 仕様詳細 |
| [v0.2.0/usecases.md](./v0.2.0/usecases.md) | v0.2.0 | 方針確定 |
| [v0.2.0/usecases.md](./v0.2.0/usecases.md) | v0.2.0 | 仕様詳細 |
| [v0.3.0/revisit.md](./v0.3.0/revisit.md) | v0.3.0 | 意図スタブ |
| [unscheduled/usecases.md](./unscheduled/usecases.md) | unscheduled | 意図スタブ |
| [unscheduled/future-intents.md](./unscheduled/future-intents.md) | unscheduled | 意図スタブ |
Expand Down
5 changes: 3 additions & 2 deletions docs/plans/unscheduled/usecases.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,12 @@
版が付いたもの:

- v0.2.0: `setup` / `config` / `--help` / `mac dim` → [v0.2.0/usecases.md](../v0.2.0/usecases.md)
- v0.3.0 以降: [v0.3.0/revisit.md](../v0.3.0/revisit.md) で再検討
- v0.3.0: `slz mac dim` 復帰時の常駐解除、空 `config.yaml` の `<blank>` 表示 → [v0.3.0/revisit.md](../v0.3.0/revisit.md)
- v0.3.0 以降のその他: [v0.3.0/revisit.md](../v0.3.0/revisit.md) で再検討

## `slz mac dim`

v0.2.0。正本は [v0.2.0/usecases.md](../v0.2.0/usecases.md)。
v0.2.0。正本は [v0.2.0/usecases.md](../v0.2.0/usecases.md)。dim 復帰時の `caffeinate` 解除は [v0.3.0](../v0.3.0/revisit.md)。

## `slz mac awake`

Expand Down
10 changes: 6 additions & 4 deletions docs/plans/v0.2.0/usecases.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
# v0.2.0 最初のユースケース

- **状態**: 方針確定
- **状態**: 仕様詳細
- **マイルストーン**: `v0.2.0`

スキャフォールドの上に、次だけ実装する。`huh` は入れない(cobra の help と非対話で足りる)。

実装に入る直前にテスト仕様書 `docs/tests/v0.2.0.md` を書く(`--version` の自動テストも含む)。CI もこの版から入れる。
検証内容は [tests/v0.2.0.md](../../tests/v0.2.0.md)。Go は **1.25**(パッチはコンテナ側で追う)。

CI もこの版から入れる。回すのは **`develop` および `dev-v*` 向け PR のみ**(それ以外の base では走らせない)。

mac コマンドは Dev Container では動かさない。`GOOS=darwin` でクロスビルドし、**ホストの macOS で確認**する。未対応 OS ではエラー。

Expand Down Expand Up @@ -33,7 +35,7 @@ slz setup
slz config
```

設定ファイルの **中身** を標準出力に出す。無ければエラー(`slz setup` を案内)。`$EDITOR` で開く・キーの get/set は後回し。
設定ファイルの **中身** を標準出力に出す。無ければエラー(`slz setup` を案内)。`$EDITOR` で開く・キーの get/set は後回し。空 config の `<blank>` 表示は [v0.3.0](../v0.3.0/revisit.md)。

### `slz --help`

Expand All @@ -51,7 +53,7 @@ slz --help
slz mac dim
```

`caffeinate` でスリープを抑え、`pmset displaysleepnow` で画面を消す。プロセスは **前面で待つ**(Ctrl+C で `caffeinate` が終わり、通常のスリープに戻る)。バックグラウンド化や専用の止めコマンドは後回し。macOS 以外ではエラー。
`caffeinate` でスリープを抑え、`pmset displaysleepnow` で画面を消す。プロセスは **前面で待つ**(Ctrl+C で `caffeinate` が終わり、通常のスリープに戻る)。バックグラウンド化や専用の止めコマンドは後回し。macOS 以外ではエラー。復帰時の常駐解除は [v0.3.0](../v0.3.0/revisit.md)(v0.2.0 は Ctrl+C で止めるまま)。

## 含まないもの

Expand Down
18 changes: 18 additions & 0 deletions docs/plans/v0.3.0/revisit.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,24 @@
- **状態**: 意図スタブ
- **マイルストーン**: `v0.3.0`

## 含むもの

### `slz mac dim` 復帰時、常駐を解除する

v0.2.0 の `slz mac dim` は `caffeinate` を前面で待ち、`pmset displaysleepnow` で画面を消す。止め方は Ctrl+C。

v0.3.0 では、利用者が復帰したとき(画面が起きる / マシンに戻る)に常駐(`caffeinate`)を自動で解除する。通常のスリープに戻すのに Ctrl+C だけに頼らない。

`mac awake`(画面を消さずスリープだけ止める)は対象外。dim 本体の再実装もしない。

### `config.yaml` が空なら、`<blank>` という表示を出す

v0.2.0 の `slz config` は `config.yaml` の中身を出す。ファイルが無ければ `slz setup` を案内する。

v0.3.0 では、ファイルはあるが空(出す中身が無い)とき、リテラル `<blank>` を出す。設定が存在して空だと分かるようにする。何も出さない空の端末にはしない。

## その他

**v0.2.0 完了時に再検討する。** いま版を割り当てない。候補は [unscheduled/usecases.md](../unscheduled/usecases.md) と [unscheduled/future-intents.md](../unscheduled/future-intents.md)。

----
Expand Down
2 changes: 1 addition & 1 deletion docs/roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
| --- | --- | --- | --- |
| v0.1.0 | スキャフォールド、Dev Container、`slz -v` | 次 | [plans/v0.1.0/scaffold.md](./plans/v0.1.0/scaffold.md) |
| v0.2.0 | `setup` / `config` / `--help` / `mac dim` | 未着手 | [plans/v0.2.0/usecases.md](./plans/v0.2.0/usecases.md) |
| v0.3.0 | v0.2.0 完了時に再検討 | 意図スタブ | [plans/v0.3.0/revisit.md](./plans/v0.3.0/revisit.md) |
| v0.3.0 | `slz mac dim` 復帰時の常駐解除、空 `config.yaml` の `<blank>` 表示。その他は v0.2.0 完了時に再検討 | 意図スタブ | [plans/v0.3.0/revisit.md](./plans/v0.3.0/revisit.md) |

版未定のユースケース: [plans/unscheduled/usecases.md](./plans/unscheduled/usecases.md)
その他の将来: [plans/unscheduled/future-intents.md](./plans/unscheduled/future-intents.md)
Expand Down
111 changes: 111 additions & 0 deletions docs/tests/v0.2.0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
# v0.2.0 テスト仕様

最初のユースケースと `--version` の自動テスト。Go は 1.25。CI は `develop` / `dev-v*` 向け PR のみ。

関連: [plans/v0.2.0/usecases.md](../plans/v0.2.0/usecases.md) / [main.md](../main.md) / [tests/v0.1.0.md](./v0.1.0.md)

前提:

- 入口は `go run ./cmd/slz`(または同等のビルド成果物 `slz`)
- バージョン文字列はハードコードの `0.2.0`(v0.1.0 の `0.1.0` 期待は本ファイルが上書きする)
- cobra 既定の `--version` を使う。`-v` は対象外
- `huh` は使わない
- 設定の置き場は XDG。`XDG_CONFIG_HOME` があればその下の `slz/`、なければ `~/.config/slz/`
- `mac dim` の外部コマンドはテストではモックしてよい。実機確認はホストの macOS(仕様書の外)

---

### Execute

- cobra のルートコマンドを起動する
- `--version` が付いていればバージョンを標準出力に出して終了する
- `--help` が付いていれば cobra 既定の help を出して終了する

#### テスト:正常系
- `slz --version` の標準出力が `slz version 0.2.0`(末尾改行あり)である
- `slz --version` の終了コードが 0 である
- `slz --version` のとき標準エラーにバージョン文字列を出さない

#### テスト: 異常系
- 未知のフラグ(例: `slz --no-such-flag`)の終了コードが 0 でない
- 未知のサブコマンド(例: `slz nosuch`)の終了コードが 0 でない
- 引数なしの `slz` はバージョン行 `slz version 0.2.0` を標準出力に出さない

---

### Help

- cobra 既定の help を出す
- 使えるコマンドの一覧に、この版のサブコマンドが含まれる

#### テスト:正常系
- `slz --help` の終了コードが 0 である
- `slz --help` の標準出力に `setup` が含まれる
- `slz --help` の標準出力に `config` が含まれる
- `slz --help` の標準出力に `mac` が含まれる

#### テスト: 異常系
- `slz help nosuch` の終了コードが 0 でない
- `slz --help` は設定ディレクトリを作成しない
- `slz --help` は外部コマンド(`caffeinate` / `pmset`)を起動しない

---

### Setup

- XDG の設定ディレクトリを用意する
- 無ければディレクトリ、空の `config.yaml`、`commands/` を作る
- 既にあれば何もしない(冪等)
- `doctor` は走らせない

#### テスト:正常系
- 設定ディレクトリが無いとき、`slz setup` がディレクトリ・空の `config.yaml`・`commands/` を作り、終了コード 0 である
- 既にあるとき、`slz setup` は既存の `config.yaml` を上書きせず、終了コード 0 である
- `XDG_CONFIG_HOME` が設定されていれば、その下の `slz/` に作る(ホームの `~/.config/slz` には作らない)

#### テスト: 異常系
- `config.yaml` と同じ名前のディレクトリが既にあるなど、作れないときは終了コードが 0 でない
- `slz setup` は `doctor-warned` を作らない
- `slz setup extra` のように余剰な位置引数があるとき、終了コードが 0 でない

---

### Config

- 設定ファイルの中身を標準出力に出す
- 無ければエラーにし、`slz setup` を案内する
- `$EDITOR` で開かない。キーの get/set はしない

#### テスト:正常系
- `config.yaml` があるとき、`slz config` の標準出力がそのファイルの中身と一致し、終了コード 0 である
- 空の `config.yaml` のとき、終了コード 0 である(中身は空でよい)
- `XDG_CONFIG_HOME` が設定されていれば、その下の `slz/config.yaml` を読む

#### テスト: 異常系
- 設定ファイルが無いとき、終了コードが 0 でない
- 設定ファイルが無いときの標準エラーに `slz setup` が含まれる
- `slz config extra` のように余剰な位置引数があるとき、終了コードが 0 でない

---

### Dim

- macOS ではスリープを抑えつつ画面だけ暗くする
- `caffeinate` を前面で待ち、`pmset displaysleepnow` で画面を消す
- macOS 以外ではエラーにする
- バックグラウンド化しない

#### テスト:正常系
- darwin では `caffeinate` と `pmset displaysleepnow` をこの順で呼ぶ(実プロセスはモックしてよい)
- darwin で外部コマンドが成功すれば終了コード 0 である
- `caffeinate` はバックグラウンド化せず、呼び出し側が完了を待つ

#### テスト: 異常系
- darwin 以外では終了コードが 0 でなく、`caffeinate` / `pmset` を起動しない
- darwin で `caffeinate` が失敗したとき、終了コードが 0 でない
- `slz mac dim extra` のように余剰な位置引数があるとき、終了コードが 0 でない
- 未知の `slz mac nosuch` の終了コードが 0 でない

----

以上
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
module github.com/b4moss/slz

go 1.26
go 1.25

require github.com/spf13/cobra v1.10.2

Expand Down
35 changes: 35 additions & 0 deletions internal/cli/cli_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
package cli

import (
"bytes"
"testing"

"github.com/b4moss/slz/internal/mac"
)

func runCLI(t *testing.T, opts Options, args ...string) (stdout, stderr string, err error) {
t.Helper()
cmd := NewRoot(opts)
outBuf := new(bytes.Buffer)
errBuf := new(bytes.Buffer)
cmd.SetOut(outBuf)
cmd.SetErr(errBuf)
cmd.SetArgs(args)
err = cmd.Execute()
return outBuf.String(), errBuf.String(), err
}

type stubCmd struct{}

func (stubCmd) Start() error { return nil }
func (stubCmd) Run() error { return nil }
func (stubCmd) Wait() error { return nil }

type countingRunner struct {
n int
}

func (r *countingRunner) Command(name string, args ...string) mac.Cmd {
r.n++
return stubCmd{}
}
22 changes: 22 additions & 0 deletions internal/cli/config.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
package cli

import (
"github.com/b4moss/slz/internal/config"
"github.com/spf13/cobra"
)

func newConfigCmd() *cobra.Command {
return &cobra.Command{
Use: "config",
Short: "Print config.yaml",
Args: cobra.NoArgs,
RunE: func(cmd *cobra.Command, args []string) error {
data, err := config.Read()
if err != nil {
return err
}
_, err = cmd.OutOrStdout().Write(data)
return err
},
}
}
Loading
Loading