auto-terminal-profile 3.0.2 → 5.0.0

package/.github/funding.yml

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

package/actions/enable.js

@@ -1,24 +1,58 @@
 import {config} from '../config.js';
 import {packageJson} from '../constants/index.js';
-import {enableAutomaticSwitching} from '../functions/index.js';
+import {
+	enableAutomaticSwitching,
+	getCurrentMode,
+	isTerminalOpen,
+	setTerminalProfile,
+} from '../functions/index.js';
 
-export async function enable({darkProfile, lightProfile}) {
-	if (!darkProfile && !config.darkProfile) {
-		throw new Error(
-			`Dark profile must be specified with --dark-profile or previously set with \`${packageJson.name} set-dark-mode\``,
-		);
+/**
+ * @param {string} mode
+ */
+function undefinedProfileMessage(mode) {
+	return `${mode} profile must be specified with --${mode}-profile or previously set with \`${packageJson.name} set-${mode}-mode\``;
+}
+
+/**
+ * @param {object} parameters
+ * @param {string|undefined} parameters.darkProfile
+ * @param {string|undefined} parameters.lightProfile
+ */
+export async function enable(parameters) {
+	if (
+		[parameters.darkProfile, config.darkProfile].every(
+			(value) => value === undefined,
+		)
+	) {
+		throw new Error(undefinedProfileMessage('dark'));
+	}
+
+	if (
+		[parameters.lightProfile, config.lightProfile].every(
+			(value) => value === undefined,
+		)
+	) {
+		throw new Error(undefinedProfileMessage('light'));
 	}
 
-	if (!lightProfile && !config.lightProfile) {
-		throw new Error(
-			`Light profile must be specified with --light-profile or previously set with \`${packageJson.name} set-light-mode\``,
-		);
+	if (parameters.darkProfile !== undefined) {
+		config.darkProfile = parameters.darkProfile;
 	}
 
-	if (darkProfile) config.darkProfile = darkProfile;
-	if (lightProfile) config.lightProfile = lightProfile;
+	if (parameters.lightProfile !== undefined) {
+		config.lightProfile = parameters.lightProfile;
+	}
 
 	await enableAutomaticSwitching();
 
-	console.log('Automatic switching enabled');
+	if (await isTerminalOpen()) {
+		const mode = await getCurrentMode();
+
+		if (parameters[`${mode}Profile`] !== undefined) {
+			await setTerminalProfile(config[`${mode}Profile`]);
+		}
+	}
+
+	console.log('automatic switching enabled');
 }

package/actions/set-mode-profile.js

@@ -1,7 +1,21 @@
 import {config} from '../config.js';
+import {
+	getCurrentMode,
+	isAutomaticSwitchingEnabled,
+	isTerminalOpen,
+	setTerminalProfile,
+} from '../functions/index.js';
 
-export function setModeProfile({mode, profile}) {
+export async function setModeProfile({mode, profile}) {
 	config[`${mode}Profile`] = profile;
 
+	if ((await isAutomaticSwitchingEnabled()) && (await isTerminalOpen())) {
+		const currentMode = await getCurrentMode();
+
+		if (currentMode === mode) {
+			await setTerminalProfile(profile);
+		}
+	}
+
 	console.log(`${mode} mode profile set to '${profile}'`);
 }

package/actions/update-profile.js

@@ -1,10 +1,15 @@
-import process from 'node:process';
-import {setTerminalProfile, setTerminalDefaultProfile} from 'terminal-profile';
 import {config} from '../config.js';
-import {isTerminalOpen} from '../functions/index.js';
+import {
+	getCurrentMode,
+	isAutomaticSwitchingEnabled,
+	isTerminalOpen,
+	setTerminalProfile,
+} 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,11 +19,8 @@ export async function updateProfile() {
 		throw new Error('Light profile not set');
 	}
 
-	const mode = process.env.DARKMODE === '1' ? 'dark' : 'light';
+	const mode = await getCurrentMode();
 	const profile = config[`${mode}Profile`];
 
-	await Promise.all([
-		setTerminalProfile(profile),
-		setTerminalDefaultProfile(profile),
-	]);
+	await setTerminalProfile(profile);
 }

package/changelog.md

@@ -5,19 +5,40 @@ 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
+## [5.0.0](https://github.com/patrik-csak/auto-terminal-profile/compare/v4.0.0...v5.0.0) – 2024-11-27
+
+### Changed
+
+- **BREAKING**: `enable` and `set-(dark|light)-profile` now set the Terminal profile
+- Updated dependencies
+
+## [4.0.0](https://github.com/patrik-csak/auto-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/auto-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/auto-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/auto-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,13 +48,13 @@ 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/auto-terminal-profile/compare/v2.0.0...v2.1.0) – 2023-07-04
 
 ### Changed
 
 - Update dependencies
 
-## [2.0.0](https://github.com/patrik-csak/terminal-profile/compare/v1.1.1...v2.0.0) – 2023-05-10
+## [2.0.0](https://github.com/patrik-csak/auto-terminal-profile/compare/v1.1.1...v2.0.0) – 2023-05-10
 
 ### Added
 

package/config.js

@@ -12,7 +12,7 @@ class Config {
 	};
 
 	/**
-	 * @return {string}
+	 * @return {string|undefined}
 	 */
 	get darkProfile() {
 		return config_.get(this.keys.darkProfile);
@@ -26,7 +26,7 @@ class Config {
 	}
 
 	/**
-	 * @return {string}
+	 * @return {string|undefined}
 	 */
 	get lightProfile() {
 		return config_.get(this.keys.lightProfile);

package/functions/disable-automatic-switching.js

@@ -3,7 +3,7 @@ import {execa} from 'execa';
 import {launchAgentPlistFilePath} from '../constants/index.js';
 
 export async function disableAutomaticSwitching() {
-	await execa('launchctl', ['unload', '-w', launchAgentPlistFilePath]);
+	await execa`launchctl unload -w ${launchAgentPlistFilePath}`;
 
 	await unlink(launchAgentPlistFilePath);
 }

package/functions/enable-automatic-switching.js

@@ -9,5 +9,5 @@ export async function enableAutomaticSwitching() {
 		await getLaunchAgentPlistFileContents(),
 	);
 
-	await execa('launchctl', ['load', '-w', launchAgentPlistFilePath]);
+	await execa`launchctl load -w ${launchAgentPlistFilePath}`;
 }

package/functions/get-current-mode.js

@@ -0,0 +1,8 @@
+import darkMode from 'dark-mode';
+
+/**
+ * @returns {Promise<'dark' | 'light'>} Current macOS appearance mode
+ */
+export async function getCurrentMode() {
+	return (await darkMode.isEnabled()) ? 'dark' : 'light';
+}

package/functions/index.js

@@ -1,5 +1,7 @@
 export {enableAutomaticSwitching} from './enable-automatic-switching.js';
 export {disableAutomaticSwitching} from './disable-automatic-switching.js';
+export {getCurrentMode} from './get-current-mode.js';
 export {getLaunchAgentPlistFileContents} from './get-launch-agent-plist-file-contents.js';
 export {isAutomaticSwitchingEnabled} from './is-automatic-switching-enabled.js';
 export {isTerminalOpen} from './is-terminal-open.js';
+export {setTerminalProfile} from './set-terminal-profile.js';

package/functions/is-automatic-switching-enabled.js

@@ -6,7 +6,7 @@ import {launchAgentPlistFilePath} from '../constants/index.js';
  * @return {Promise<boolean>}
  */
 async function isDarkModeNotifyRunning() {
-	const {stdout} = await execa('launchctl', ['list']);
+	const {stdout} = await execa`launchctl list`;
 
 	return stdout.includes('ke.bou.dark-mode-notify');
 }

package/functions/set-terminal-profile.js

@@ -0,0 +1,11 @@
+import {
+	setTerminalDefaultProfile as setDefaultProfile,
+	setTerminalProfile as setProfile,
+} from 'terminal-profile';
+
+/**
+ * @param {string} profile
+ */
+export async function setTerminalProfile(profile) {
+	await Promise.all([setDefaultProfile(profile), setProfile(profile)]);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "auto-terminal-profile",
-  "version": "3.0.2",
+  "version": "5.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",
@@ -21,9 +22,10 @@
   },
   "dependencies": {
     "commander": "^12.0.0",
-    "conf": "^12.0.0",
+    "conf": "^13.0.1",
+    "dark-mode": "^4.0.0",
     "env-paths": "^3.0.0",
-    "execa": "^8.0.1",
+    "execa": "^9.5.1",
     "pupa": "^3.1.0",
     "read-package-up": "^11.0.0",
     "run-applescript": "^7.0.0",
@@ -32,7 +34,7 @@
   },
   "devDependencies": {
     "sort-package-json": "^2.7.0",
-    "xo": "^0.57.0"
+    "xo": "^0.59.3"
   },
   "engines": {
     "node": ">=18 <=20"

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
+```