auto-terminal-profile 3.0.1 → 4.0.0

package/.github/funding.yml

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

package/actions/update-profile.js

@@ -1,8 +1,16 @@
-import process from 'node:process';
+import darkMode from 'dark-mode';
 import {setTerminalProfile, setTerminalDefaultProfile} from 'terminal-profile';
 import {config} from '../config.js';
+import {
+	isAutomaticSwitchingEnabled,
+	isTerminalOpen,
+} from '../functions/index.js';
 
 export async function updateProfile() {
+	if (!(await isAutomaticSwitchingEnabled()) || !(await isTerminalOpen())) {
+		return;
+	}
+
 	if (!config.darkProfile) {
 		throw new Error('Dark profile not set');
 	}
@@ -11,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,13 +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.1](https://github.com/ptrkcsk/terminal-profile/compare/v3.0.0...v3.0.1) – 2024-02-20
+## [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
 
-- Broken post-install compilation step
+- Fix Terminal opening when closed
+
+## [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
+
+## [3.0.0](https://github.com/patrik-csak/terminal-profile/compare/v2.1.0...v3.0.0) – 2024-02-19
+
+### Changed
 
-## [v3.0.0](https://github.com/ptrkcsk/terminal-profile/compare/v2.1.0...v3.0.0) – 2024-02-19
+- **BREAKING**: `update-profile` gets appearance mode from `DARKMODE` environment variable instead of from OS
 
 ### Removed
 
@@ -19,15 +39,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixed
 
-- Issue causing `auto-terminal-profile` to silently fail on macOS Sonoma
+- Fix issue causing `auto-terminal-profile` to silently fail on macOS Sonoma
 
-## [v2.1.0](https://github.com/ptrkcsk/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
 
 - Update dependencies
 
-## [2.0.0](https://github.com/ptrkcsk/terminal-profile/compare/v1.1.1...v2.0.0) – 2023-05-10
+## [2.0.0](https://github.com/patrik-csak/terminal-profile/compare/v1.1.1...v2.0.0) – 2023-05-10
 
 ### Added
 

package/config.js

@@ -3,7 +3,7 @@ import {readPackageUp} from 'read-package-up';
 
 const {packageJson} = await readPackageUp({cwd: new URL('.', import.meta.url)});
 
-const conf = new Conf({projectName: packageJson.name});
+const config_ = new Conf({projectName: packageJson.name});
 
 class Config {
 	keys = {
@@ -15,28 +15,28 @@ class Config {
 	 * @return {string}
 	 */
 	get darkProfile() {
-		return conf.get(this.keys.darkProfile);
+		return config_.get(this.keys.darkProfile);
 	}
 
 	/**
 	 * @param {string} profile
 	 */
 	set darkProfile(profile) {
-		conf.set(this.keys.darkProfile, profile);
+		config_.set(this.keys.darkProfile, profile);
 	}
 
 	/**
 	 * @return {string}
 	 */
 	get lightProfile() {
-		return conf.get(this.keys.lightProfile);
+		return config_.get(this.keys.lightProfile);
 	}
 
 	/**
 	 * @param {string} profile
 	 */
 	set lightProfile(profile) {
-		conf.set(this.keys.lightProfile, profile);
+		config_.set(this.keys.lightProfile, profile);
 	}
 }
 

package/functions/index.js

@@ -2,3 +2,4 @@ export {enableAutomaticSwitching} from './enable-automatic-switching.js';
 export {disableAutomaticSwitching} from './disable-automatic-switching.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';

package/functions/is-terminal-open.js

@@ -0,0 +1,18 @@
+import {runAppleScript} from 'run-applescript';
+
+/**
+ * @returns {Promise<boolean>}
+ */
+export async function isTerminalOpen() {
+	const result = await runAppleScript(`tell application "System Events"
+	set isOpen to (name of processes) contains "Terminal"
+end tell
+
+if isOpen then
+	return "true"
+else
+	return "false"
+end if`);
+
+	return result === 'true';
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "auto-terminal-profile",
-  "version": "3.0.1",
+  "version": "4.0.0",
   "description": "Automatically switch macOS Terminal profile when system dark / light mode changes",
   "keywords": [
     "macos",
@@ -9,10 +9,12 @@
     "dark mode",
     "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",
   "bin": "./cli.js",
-  "repository": "github:patrik-csak/auto-terminal-profile",
   "scripts": {
     "format": "xo --fix && sort-package-json",
     "postinstall": "cd dark-mode-notify && make build",
@@ -21,10 +23,12 @@
   "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",
     "read-package-up": "^11.0.0",
+    "run-applescript": "^7.0.0",
     "terminal-profile": "^2.0.0",
     "untildify": "^5.0.0"
   },
@@ -37,6 +41,5 @@
   },
   "os": [
     "darwin"
-  ],
-  "type": "module"
+  ]
 }

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