tuidoro 0.0.2 → 0.1.1

package/README.md

@@ -1,6 +1,6 @@
 # TUIdoro
 
-TUIdoro is a sleek pomodoro timer that runs in your terminal.
+TUIdoro is a minimal pomodoro timer that runs in your terminal.
 
 ![screenshot](./assets/screenshot1.png)
 
@@ -29,12 +29,9 @@ bun run build
 
 ## Configuration
 
-The priority for reading the configuration is as follows:
+The configuration file will be created on initial startup:
 
-1. `$TUIDORO_SETTINGS_PATH` environment variable
-2. `~/.config/tuidoro/settings.json`
-
-If the configuration file does not exist TUIdoro will launch with its [defaults](./config/settings.json).
+`~/.config/tuidoro/settings.json`
 
 ## Contributing
 

package/package.json

@@ -1,6 +1,7 @@
 {
+  "version": "0.1.1",
   "name": "tuidoro",
-  "description": "A sleek pomodoro timer that runs in your terminal.",
+  "description": "A minimal pomodoro timer that runs in your terminal.",
   "author": "b12o",
   "keywords": [
     "pomodoro",
@@ -18,7 +19,6 @@
   "engines": {
     "bun": ">=1.3.0"
   },
-  "version": "0.0.2",
   "module": "src/index.ts",
   "type": "module",
   "bin": {

package/src/index.ts

@@ -4,18 +4,13 @@ import { createCliRenderer, RGBA } from "@opentui/core";
 import { createLayout } from "./layout.js";
 import { logger } from "./logger.js";
 import { Timer } from "./timer.js";
-import type { PomodoroSettings, TimerState } from "./types.js";
-import { loadConfig, loadDefaultConfig, playSound } from "./utils.js";
+import type { TimerState } from "./types.js";
+import { loadConfig, playSound, isAudioAvailable } from "./utils.js";
 
 //@ts-ignore -- this is a bun-specific file embed import that ts is not aware of
 import toggleSound from "../assets/tuidoro_toggle.mp3" with { type: "file" };
 
-let config: PomodoroSettings;
-try {
-  config = loadConfig();
-} catch {
-  config = loadDefaultConfig();
-}
+const config = await loadConfig();
 
 const timer = new Timer(config);
 
@@ -28,6 +23,7 @@ let zenModeEnabled = config.zenMode ?? false;
 
 const {
   root,
+  audioAvailableContainer,
   captionContainer,
   captionText,
   timeContainer,
@@ -48,6 +44,7 @@ renderer.root.add(root);
 // initial render
 timeText.color = RGBA.fromHex(timer.activeColor);
 showHideElements();
+audioAvailableContainer.visible = config.sound && !isAudioAvailable();
 
 // 250ms in order to respond fairly quickly to timer.ts updates without
 // unnecessarily re-rendering UI

package/src/layout.ts

@@ -37,6 +37,15 @@ export function createLayout(renderer: CliRenderer, initialData: InitialData) {
     fg: RGBA.fromHex(offWhite),
   });
 
+  const audioAvailableText = new TextRenderable(renderer, {
+    id: "audioAvailable",
+    content:
+      "Can't play audio ('paplay' not installed).\
+Disable 'sound' in your config or install paplay to remove this notice.",
+    justifyContent: "center",
+    fg: RGBA.fromHex(offWhite),
+  });
+
   const separator = new TextRenderable(renderer, {
     content: "_________________________________________",
     fg: RGBA.fromHex(gray),
@@ -66,6 +75,12 @@ export function createLayout(renderer: CliRenderer, initialData: InitialData) {
     fg: RGBA.fromHex(offWhite),
   });
 
+  const audioAvailableContainer = new BoxRenderable(renderer, {
+    id: "audioAvailableContainer",
+    border: true,
+  });
+  audioAvailableContainer.add(audioAvailableText);
+
   const captionContainer = new BoxRenderable(renderer, {
     id: "captionContainer",
     alignItems: "center",
@@ -119,6 +134,7 @@ export function createLayout(renderer: CliRenderer, initialData: InitialData) {
         alignItems: "center",
         justifyContent: "center",
       },
+      audioAvailableContainer,
       captionContainer,
       timeContainer,
       pomodoriContainer,
@@ -129,6 +145,7 @@ export function createLayout(renderer: CliRenderer, initialData: InitialData) {
 
   return {
     root,
+    audioAvailableContainer,
     captionContainer,
     captionText,
     timeContainer,

package/src/logger.ts

@@ -1,4 +1,6 @@
 import { appendFileSync } from "fs";
+import os from "os";
+import path from "path";
 
 const levels = {
   debug: 0,
@@ -8,11 +10,11 @@ const levels = {
 };
 
 type Level = keyof typeof levels;
-const currentLevel: Level = (process.env.LOG_LEVEL as Level) || "info";
+const currentLevel: Level = (process.env.TUIDORO_LOG_LEVEL as Level) || "info";
 
 function logToFile(msg: string) {
-  // tuidoro is located in project root.
-  appendFileSync("tuidoro.log", `${msg}\n`);
+  const logPath = path.join(os.tmpdir(), "tuidoro.log");
+  appendFileSync(logPath, `${msg}\n`);
 }
 
 export const logger = {

package/src/timer.ts

@@ -7,7 +7,6 @@ import {
   validateBreakInterval,
   validateHex,
   validateWorkInterval,
-  getConfigPath,
 } from "./utils.js";
 
 //@ts-ignore -- this is a bun-specific file embed import that ts is not aware of
@@ -57,7 +56,6 @@ export class Timer {
     this.isWork = true;
 
     logger.debug("\n\n=================================\n");
-    logger.debug(`config path: ${getConfigPath()}`);
 
     logger.debug("Initialized timer with following settings:");
     logger.debug(`workduration (seconds): ${this.workDurationSeconds}`);
@@ -178,6 +176,7 @@ export class Timer {
       this.caption = WORK_CAPTION;
     }
     notifyMessage = this.caption;
-    notifyMessage.length > 0 && Bun.spawn(["notify-send", notifyMessage]);
+    if (notifyMessage.length)
+      Bun.spawn(["notify-send", notifyMessage], { stderr: "ignore" });
   }
 }

package/src/utils.ts

@@ -41,25 +41,24 @@ export function validateHex(hex: string) {
   return /^#([0-9A-F]{3}){1,2}$/i.test(hex);
 }
 
-export function getConfigPath() {
-  let configPath = path.join(
+export async function loadConfig(): Promise<PomodoroSettings> {
+  const configPath = path.join(
     os.homedir(),
     ".config",
     APP_NAME,
     "settings.json",
   );
-  const envPath = process.env.TUIDORO_SETTINGS_PATH;
-  if (envPath && existsSync(envPath)) {
-    configPath = envPath;
+  try {
+    const rawInput = readFileSync(configPath, "utf8");
+    return JSON.parse(rawInput);
+  } catch {
+    if (!existsSync(configPath)) {
+      await Bun.write(configPath, JSON.stringify(defaultSettings, null, 2));
+    }
+    return defaultSettings;
   }
-  return configPath;
 }
 
-export function loadConfig(): PomodoroSettings {
-  const rawInput = readFileSync(getConfigPath(), "utf8");
-  return JSON.parse(rawInput);
-}
-
-export function loadDefaultConfig(): PomodoroSettings {
-  return defaultSettings;
+export function isAudioAvailable() {
+  return Bun.which("paplay") !== null;
 }