auto-terminal-profile 3.0.2 → 4.0.0

package/.github/funding.yml

@@ -0,0 +1 @@
+buy_me_a_coffee: patrikcsak

package/actions/update-profile.js

@@ -1,10 +1,15 @@
-import process from 'node:process';
+import darkMode from 'dark-mode';
 import {setTerminalProfile, setTerminalDefaultProfile} from 'terminal-profile';
 import {config} from '../config.js';
-import {isTerminalOpen} from '../functions/index.js';
+import {
+	isAutomaticSwitchingEnabled,
+	isTerminalOpen,
+} from '../functions/index.js';
 
 export async function updateProfile() {
-	if (!(await isTerminalOpen())) return;
+	if (!(await isAutomaticSwitchingEnabled()) || !(await isTerminalOpen())) {
+		return;
+	}
 
 	if (!config.darkProfile) {
 		throw new Error('Dark profile not set');
@@ -14,7 +19,7 @@ export async function updateProfile() {
 		throw new Error('Light profile not set');
 	}
 
-	const mode = process.env.DARKMODE === '1' ? 'dark' : 'light';
+	const mode = (await darkMode.isEnabled()) ? 'dark' : 'light';
 	const profile = config[`${mode}Profile`];
 
 	await Promise.all([

package/changelog.md

@@ -5,19 +5,33 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [v3.0.2](https://github.com/patrik-csak/terminal-profile/compare/v3.0.1...v3.0.2) – 2024-02-21
+## [4.0.0](https://github.com/patrik-csak/terminal-profile/compare/v3.0.2...v4.0.0) – 2024-03-25
+
+### Added
+
+- Documentation explaining how to automatically update Terminal profile when opening Terminal 
+
+### Changed
+
+- **BREAKING**: `update-profile` gets appearance mode from OS instead of from `DARKMODE` environment variable
+
+## [3.0.2](https://github.com/patrik-csak/terminal-profile/compare/v3.0.1...v3.0.2) – 2024-02-21
 
 ### Fixed
 
 - Fix Terminal opening when closed
 
-## [v3.0.1](https://github.com/patrik-csak/terminal-profile/compare/v3.0.0...v3.0.1) – 2024-02-20
+## [3.0.1](https://github.com/patrik-csak/terminal-profile/compare/v3.0.0...v3.0.1) – 2024-02-20
 
 ### Fixed
 
 - Fix broken post-install compilation step
 
-## [v3.0.0](https://github.com/patrik-csak/terminal-profile/compare/v2.1.0...v3.0.0) – 2024-02-19
+## [3.0.0](https://github.com/patrik-csak/terminal-profile/compare/v2.1.0...v3.0.0) – 2024-02-19
+
+### Changed
+
+- **BREAKING**: `update-profile` gets appearance mode from `DARKMODE` environment variable instead of from OS
 
 ### Removed
 
@@ -27,7 +41,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Fix issue causing `auto-terminal-profile` to silently fail on macOS Sonoma
 
-## [v2.1.0](https://github.com/patrik-csak/terminal-profile/compare/v2.0.0...v2.1.0) – 2023-07-04
+## [2.1.0](https://github.com/patrik-csak/terminal-profile/compare/v2.0.0...v2.1.0) – 2023-07-04
 
 ### Changed
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "auto-terminal-profile",
-  "version": "3.0.2",
+  "version": "4.0.0",
   "description": "Automatically switch macOS Terminal profile when system dark / light mode changes",
   "keywords": [
     "macos",
@@ -10,6 +10,7 @@
     "profile"
   ],
   "repository": "github:patrik-csak/auto-terminal-profile",
+  "funding": "https://buymeacoffee.com/patrikcsak",
   "license": "MIT",
   "author": "Patrik Csak <p@trikcsak.com> (https://patrikcsak.com)",
   "type": "module",
@@ -22,6 +23,7 @@
   "dependencies": {
     "commander": "^12.0.0",
     "conf": "^12.0.0",
+    "dark-mode": "^4.0.0",
     "env-paths": "^3.0.0",
     "execa": "^8.0.1",
     "pupa": "^3.1.0",

package/readme.md

@@ -1,35 +1,51 @@
-# `auto-terminal-profile`
+# Auto Terminal Profile
 
-Automatically switch the macOS Terminal profile based on the system-wide dark / light appearance mode
+Automatically switch [macOS Terminal](https://en.wikipedia.org/wiki/Terminal_%28macOS%29) profiles when the [dark / light appearance mode](https://support.apple.com/guide/mac-help/use-a-light-or-dark-appearance-mchl52e1c2d2/mac) changes
 
 ![auto-terminal-profile demonstration screen recording](./documentation/demo.gif)
 
 ## Prerequisites
 
-- [Node.js](https://nodejs.org/en/) 18–20
+- [Node.js](https://nodejs.org/) 18–20
 
 ## Installation
 
-```sh
+```shell
 npm install --global auto-terminal-profile
 ```
 
 ## Usage
 
+### Enable automatic profile switching
+
 To get started, enable automatic profile switching and set your preferred dark and light mode profiles:
 
-```sh
+```shell
 auto-terminal-profile enable \
   --dark-profile='One Dark' \
   --light-profile='One Light'
 ```
 
-For more information view the help output:
+### Switch profile on Terminal startup
 
-```sh
-auto-terminal-profile --help
+Auto Terminal Profile only runs if Terminal is running, so the profile can fall out of sync if the macOS appearance mode changes while Terminal isn’t running.
+
+To sync the Terminal profile to the current macOS appearance mode once:
+
+```shell
+auto-terminal-profile update-profile
+```
+
+To sync the Terminal profile to the current macOS appearance mode when Terminal app is opened, you can add that line to your shell startup script (e.g. `.zshrc`), but it will increase the startup time of new shell sessions.
+
+### Disable automatic profile switching
+
+```shell
+auto-terminal-profile disable
 ```
 
-## Acknowledgements
+### Help
 
-Thanks [Bouke van der Bijl](https://bou.ke) for his project [dark-mode-notify](https://github.com/bouk/dark-mode-notify), which this project depends on
+```shell
+auto-terminal-profile --help
+```