pomotty 1.0.0 → 1.0.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.ja.md +53 -0
- package/README.md +18 -41
- package/package.json +1 -1
package/README.ja.md
ADDED
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
# pomotty
|
|
2
|
+
|
|
3
|
+
[English](./README.md) | 日本語
|
|
4
|
+
|
|
5
|
+
Node.js 22以降で利用できる、ターミナル用のポモドーロタイマーです。
|
|
6
|
+
|
|
7
|
+
```shell
|
|
8
|
+
npx pomotty
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
グローバルにインストールする場合は、次のコマンドを実行します。
|
|
12
|
+
|
|
13
|
+
```shell
|
|
14
|
+
npm install --global pomotty
|
|
15
|
+
pomotty
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
`pomotty`で作業開始の選択メニューを表示します。上下キーで`OK`を選んで
|
|
19
|
+
Enterを押すと15分の作業と5分の休憩を3セット実行し、`NG`を選ぶとタイマーを
|
|
20
|
+
開始せず終了します。
|
|
21
|
+
|
|
22
|
+
```shell
|
|
23
|
+
pomotty
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
作業時間と休憩時間は、1〜1440の整数(分)で指定できます。片方だけを指定した
|
|
27
|
+
場合、もう片方には既定値が使われます。
|
|
28
|
+
|
|
29
|
+
```shell
|
|
30
|
+
pomotty --work 30 --break 10
|
|
31
|
+
pomotty --work=45 --break=15
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
`--roop`で作業・休憩の繰り返し回数を指定できます。既定値は3で、1以上の整数
|
|
35
|
+
(最大9007199254740991)を受け付けます。開始確認は最初の1回だけで、最後の休憩が
|
|
36
|
+
完了すると終了します。
|
|
37
|
+
|
|
38
|
+
```shell
|
|
39
|
+
pomotty --roop 5
|
|
40
|
+
pomotty --work=25 --break=5 --roop=2
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
利用可能なオプションは、次のコマンドで確認できます。
|
|
44
|
+
|
|
45
|
+
```shell
|
|
46
|
+
pomotty --help
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
作業と休憩の完了時には、それぞれ異なる通知音を再生します。macOSでは
|
|
50
|
+
`afplay`、Linuxでは`paplay`または`aplay`、WindowsではPowerShellを利用し、
|
|
51
|
+
再生できない環境では異なる回数のターミナルベルに切り替わります。
|
|
52
|
+
|
|
53
|
+
開発手順とnpmへの公開・更新手順は[開発ガイド](./DEVELOPMENT.ja.md)を参照してください。
|
package/README.md
CHANGED
|
@@ -1,77 +1,54 @@
|
|
|
1
1
|
# pomotty
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
English | [日本語](./README.ja.md)
|
|
4
|
+
|
|
5
|
+
A Pomodoro timer for the terminal, available on Node.js 22 or later.
|
|
4
6
|
|
|
5
7
|
```shell
|
|
6
8
|
npx pomotty
|
|
7
9
|
```
|
|
8
10
|
|
|
9
|
-
|
|
11
|
+
To install it globally, run:
|
|
10
12
|
|
|
11
13
|
```shell
|
|
12
14
|
npm install --global pomotty
|
|
13
15
|
pomotty
|
|
14
16
|
```
|
|
15
17
|
|
|
16
|
-
`pomotty
|
|
17
|
-
Enter
|
|
18
|
-
|
|
18
|
+
Run `pomotty` to display the start menu. Use the up and down arrow keys to select
|
|
19
|
+
`OK`, then press Enter to start 3 cycles of 15 minutes of work and 5 minutes of
|
|
20
|
+
break. Select `NG` to exit without starting the timer.
|
|
19
21
|
|
|
20
22
|
```shell
|
|
21
23
|
pomotty
|
|
22
24
|
```
|
|
23
25
|
|
|
24
|
-
|
|
25
|
-
|
|
26
|
+
Work and break durations accept whole numbers from 1 to 1440, in minutes. If you
|
|
27
|
+
specify only one duration, the other uses its default value.
|
|
26
28
|
|
|
27
29
|
```shell
|
|
28
30
|
pomotty --work 30 --break 10
|
|
29
31
|
pomotty --work=45 --break=15
|
|
30
32
|
```
|
|
31
33
|
|
|
32
|
-
`--roop
|
|
33
|
-
|
|
34
|
-
|
|
34
|
+
Use `--roop` to set the number of work and break cycles. It defaults to 3 and
|
|
35
|
+
accepts whole numbers from 1 to 9007199254740991. The start confirmation appears
|
|
36
|
+
only once, and the timer exits after the final break finishes.
|
|
35
37
|
|
|
36
38
|
```shell
|
|
37
39
|
pomotty --roop 5
|
|
38
40
|
pomotty --work=25 --break=5 --roop=2
|
|
39
41
|
```
|
|
40
42
|
|
|
41
|
-
|
|
43
|
+
To see the available options, run:
|
|
42
44
|
|
|
43
45
|
```shell
|
|
44
46
|
pomotty --help
|
|
45
47
|
```
|
|
46
48
|
|
|
47
|
-
|
|
48
|
-
`afplay
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
## 開発
|
|
52
|
-
|
|
53
|
-
```shell
|
|
54
|
-
pnpm install --frozen-lockfile
|
|
55
|
-
pnpm start
|
|
56
|
-
pnpm test
|
|
57
|
-
pnpm lint
|
|
58
|
-
pnpm format:check
|
|
59
|
-
```
|
|
60
|
-
|
|
61
|
-
## npmへの公開・更新
|
|
62
|
-
|
|
63
|
-
開発と公開にはpnpmを使用します。初回または認証が切れた場合は
|
|
64
|
-
`pnpm login --registry=https://registry.npmjs.org/`でnpmへログインします。
|
|
65
|
-
|
|
66
|
-
更新時は変更内容に応じて`pnpm version patch`、`pnpm version minor`、
|
|
67
|
-
`pnpm version major`で未公開のバージョンへ更新します。
|
|
68
|
-
これらのコマンドはGitコミットとタグも作成するため、先に変更をコミットしてください。
|
|
69
|
-
|
|
70
|
-
```shell
|
|
71
|
-
pnpm publish --dry-run --no-git-checks
|
|
72
|
-
pnpm publish
|
|
73
|
-
```
|
|
49
|
+
Different notification sounds play when work and break sessions end. Sound
|
|
50
|
+
playback uses `afplay` on macOS, `paplay` or `aplay` on Linux, and PowerShell on
|
|
51
|
+
Windows. If audio playback is unavailable, the timer falls back to different
|
|
52
|
+
numbers of terminal bells for work and break notifications.
|
|
74
53
|
|
|
75
|
-
|
|
76
|
-
配布物にはCLI、通知音、README、package.jsonが含まれます。
|
|
77
|
-
公開時にnpmから認証を求められたら、表示される案内に従って完了してください。
|
|
54
|
+
For development and npm publishing instructions, see the [development guide](./DEVELOPMENT.md).
|