auto-terminal-profile 1.0.0

package/actions/disable.js

@@ -0,0 +1,9 @@
+#! /usr/bin/env node
+
+import {disableAutomaticSwitching} from '../functions/index.js';
+
+export async function disable() {
+	await disableAutomaticSwitching();
+
+	console.log('Automatic switching disabled');
+}

package/actions/enable.js

@@ -0,0 +1,24 @@
+import {config} from '../config.js';
+import {packageJson} from '../constants/index.js';
+import {enableAutomaticSwitching} 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\``,
+		);
+	}
+
+	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 (darkProfile) config.darkProfile = darkProfile;
+	if (lightProfile) config.lightProfile = lightProfile;
+
+	await enableAutomaticSwitching();
+
+	console.log('Automatic switching enabled');
+}

package/actions/index.js

@@ -0,0 +1,5 @@
+export {disable} from './disable.js';
+export {enable} from './enable.js';
+export {setModeProfile} from './set-mode-profile.js';
+export {status} from './status.js';
+export {updateProfile} from './update-profile.js';

package/actions/set-mode-profile.js

@@ -0,0 +1,7 @@
+import {config} from '../config.js';
+
+export function setModeProfile({mode, profile}) {
+	config[`${mode}Profile`] = profile;
+
+	console.log(`${mode} mode profile set to '${profile}'`);
+}

package/actions/status.js

@@ -0,0 +1,12 @@
+import {isAutomaticSwitchingEnabled} from '../functions/index.js';
+import {config} from '../config.js';
+
+export async function status() {
+	console.log(
+		`automatic switching : ${
+			(await isAutomaticSwitchingEnabled()) ? 'enabled' : 'disabled'
+		}`,
+	);
+	console.log(`dark profile : ${config.darkProfile}`);
+	console.log(`light profile : ${config.lightProfile}`);
+}

package/actions/update-profile.js

@@ -0,0 +1,17 @@
+import darkMode from 'dark-mode';
+import {setTerminalProfile} from 'terminal-profile';
+import {config} from '../config.js';
+
+export async function updateProfile() {
+	if (!config.darkProfile) {
+		throw new Error('Dark profile not set');
+	}
+
+	if (!config.lightProfile) {
+		throw new Error('Light profile not set');
+	}
+
+	const mode = (await darkMode.isEnabled()) ? 'dark' : 'light';
+
+	await setTerminalProfile(config[`${mode}Profile`]);
+}

package/cli.js

@@ -0,0 +1,60 @@
+#! /usr/bin/env node
+
+import {program} from 'commander';
+import {packageJson} from './constants/index.js';
+import {
+	disable,
+	enable,
+	setModeProfile,
+	status,
+	updateProfile,
+} from './actions/index.js';
+
+program
+	.name(packageJson.name)
+	.description(packageJson.description)
+	.version(packageJson.version);
+
+program
+	.command('disable')
+	.description(
+		'Disable automatic macOS Terminal profile switching based on system dark / light mode',
+	)
+	.action(disable);
+
+program
+	.command('enable')
+	.description(
+		'Enable automatic macOS Terminal profile switching based on system dark / light mode',
+	)
+	.option(
+		'--dark-profile <profile>',
+		'dark profile name, for example "One Dark"',
+	)
+	.option(
+		'--light-profile <profile>',
+		'light profile name, for example "One Light"',
+	)
+	.action(enable);
+
+for (const mode of ['dark', 'light']) {
+	program
+		.command(`set-${mode}-profile`)
+		.description(`Set the Terminal profile to use in ${mode} mode`)
+		.argument('<profile>')
+		.action((profile) => setModeProfile({mode, profile}));
+}
+
+program
+	.command('status')
+	.description('Show status and configuration')
+	.action(status);
+
+program
+	.command('update-profile')
+	.description(
+		'Update the profile of currently running Terminal windows / tabs',
+	)
+	.action(updateProfile);
+
+program.parse();

package/config.js

@@ -0,0 +1,43 @@
+import Conf from 'conf';
+import {readPackageUp} from 'read-pkg-up';
+
+const {packageJson} = await readPackageUp({cwd: new URL('.', import.meta.url)});
+
+const conf = new Conf({projectName: packageJson.name});
+
+class Config {
+	keys = {
+		darkProfile: 'darkProfile',
+		lightProfile: 'lightProfile',
+	};
+
+	/**
+	 * @return {string}
+	 */
+	get darkProfile() {
+		return conf.get(this.keys.darkProfile);
+	}
+
+	/**
+	 * @param {string} profile
+	 */
+	set darkProfile(profile) {
+		conf.set(this.keys.darkProfile, profile);
+	}
+
+	/**
+	 * @return {string}
+	 */
+	get lightProfile() {
+		return conf.get(this.keys.lightProfile);
+	}
+
+	/**
+	 * @param {string} profile
+	 */
+	set lightProfile(profile) {
+		conf.set(this.keys.lightProfile, profile);
+	}
+}
+
+export const config = new Config();

package/constants/index.js

@@ -0,0 +1,2 @@
+export {launchAgentPlistFilePath} from './launch-agent-plist-file-path.js';
+export {packageJson} from './package-json.js';

package/constants/launch-agent-plist-file-path.js

@@ -0,0 +1,5 @@
+import untildify from 'untildify';
+
+export const launchAgentPlistFilePath = untildify(
+	'~/Library/LaunchAgents/ke.bou.dark-mode-notify.plist',
+);

package/constants/package-json.js

@@ -0,0 +1,5 @@
+import {readPackageUp} from 'read-pkg-up';
+
+export const {packageJson} = await readPackageUp({
+	cwd: new URL('.', import.meta.url),
+});

package/dark-mode-notify/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Bouke van der Bijl
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dark-mode-notify/README.md

@@ -0,0 +1,44 @@
+# dark-mode-notify
+
+This small Swift program will run a command whenever the dark mode status changes on macOS. You can use it to change your vim color config automatically for example.
+
+## Usage
+
+You can run it directly by doing `./dark-mode-notify.swift <program>`.
+
+Alternatively you can compile it by doing `swiftc dark-mode-notify.swift -o /usr/local/bin/dark-mode-notify`.
+
+The program will be run immediately when the command starts, and every time the OS goes from dark mode to light mode or back. The environment variable `DARKMODE` will be set to either `1` or `0`.
+
+## Background agent
+
+To keep this program running in the background, compile the binary to somewhere and create the following file at `~/Library/LaunchAgents/ke.bou.dark-mode-notify.plist`. Don't forget to replace the arguments and the path to the logs (which comes in handy for debugging)
+
+```xml
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN"
+"http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+    <key>Label</key>
+    <string>ke.bou.dark-mode-notify</string>
+    <key>KeepAlive</key>
+    <true/>
+    <key>StandardErrorPath</key>
+    <string>----Path to a location----/dark-mode-notify-stderr.log</string>
+    <key>StandardOutPath</key>
+    <string>----Path to a location----/dark-mode-notify-stdout.log</string>
+    <key>ProgramArguments</key>
+    <array>
+       <string>/usr/local/bin/dark-mode-notify</string>
+       <string>--- Path to your script ---</string>
+    </array>
+</dict>
+</plist>
+```
+
+Then `launchctl load -w ~/Library/LaunchAgents/ke.bou.dark-mode-notify.plist` will keep it running on boot.
+
+## Credit
+
+This script is a lightly modified version of https://github.com/mnewt/dotemacs/blob/master/bin/dark-mode-notifier.swift

package/dark-mode-notify/dark-mode-notify.swift

@@ -0,0 +1,38 @@
+#!/usr/bin/env swift
+
+// Run as ./notify.swift <program to run when dark mode changes>
+// The program will have the DARKMODE env flag set to 1 or 0
+// You can also compile with:
+// swiftc notify.swift -o notify
+// And run the binary directly
+// Most credit goes to https://github.com/mnewt/dotemacs/blob/master/bin/dark-mode-notifier.swift
+
+import Cocoa
+
+@discardableResult
+func shell(_ args: [String]) -> Int32 {
+    let task = Process()
+    let isDark = UserDefaults.standard.string(forKey: "AppleInterfaceStyle") == "Dark"
+    var env = ProcessInfo.processInfo.environment
+    env["DARKMODE"] = isDark ? "1" : "0"
+    task.environment = env
+    task.launchPath = "/usr/bin/env"
+    task.arguments = args
+    task.standardError = FileHandle.standardError
+    task.standardOutput = FileHandle.standardOutput
+    task.launch()
+    task.waitUntilExit()
+    return task.terminationStatus
+}
+
+let args = Array(CommandLine.arguments.suffix(from: 1))
+shell(args)
+
+DistributedNotificationCenter.default.addObserver(
+    forName: Notification.Name("AppleInterfaceThemeChangedNotification"),
+    object: nil,
+    queue: nil) { (notification) in
+        shell(args)
+}
+
+NSApplication.shared.run()

package/functions/disable-automatic-switching.js

@@ -0,0 +1,9 @@
+import {unlink} from 'node:fs/promises';
+import {execa} from 'execa';
+import {launchAgentPlistFilePath} from '../constants/index.js';
+
+export async function disableAutomaticSwitching() {
+	await execa('launchctl', ['unload', '-w', launchAgentPlistFilePath]);
+
+	await unlink(launchAgentPlistFilePath);
+}

package/functions/enable-automatic-switching.js

@@ -0,0 +1,13 @@
+import {writeFile} from 'node:fs/promises';
+import {execa} from 'execa';
+import {launchAgentPlistFilePath} from '../constants/index.js';
+import {getLaunchAgentPlistFileContents} from './get-launch-agent-plist-file-contents.js';
+
+export async function enableAutomaticSwitching() {
+	await writeFile(
+		launchAgentPlistFilePath,
+		await getLaunchAgentPlistFileContents(),
+	);
+
+	await execa('launchctl', ['load', '-w', launchAgentPlistFilePath]);
+}

package/functions/get-launch-agent-plist-file-contents.js

@@ -0,0 +1,24 @@
+import {readFile} from 'node:fs/promises';
+import {fileURLToPath} from 'node:url';
+import process from 'node:process';
+import pupa from 'pupa';
+import envPaths from 'env-paths';
+import {packageJson} from '../constants/index.js';
+
+export async function getLaunchAgentPlistFileContents() {
+	return pupa(
+		await readFile(new URL('../templates/launch-agent.xml', import.meta.url), {
+			encoding: 'utf8',
+		}),
+		{
+			autoTerminalProfilePath: fileURLToPath(
+				new URL('../cli.js', import.meta.url),
+			),
+			darkModeNotifyPath: fileURLToPath(
+				new URL('../dark-mode-notify/dark-mode-notify.swift', import.meta.url),
+			),
+			logPath: envPaths(packageJson.name).log,
+			path: process.env.PATH,
+		},
+	);
+}

package/functions/index.js

@@ -0,0 +1,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';

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

@@ -0,0 +1,32 @@
+import {existsSync as exists} from 'node:fs';
+import {execa} from 'execa';
+import {launchAgentPlistFilePath} from '../constants/index.js';
+
+/**
+ * @return {Promise<boolean>}
+ */
+async function isDarkModeNotifyRunning() {
+	const {stdout} = await execa('launchctl', ['list']);
+
+	return stdout.includes('ke.bou.dark-mode-notify');
+}
+
+/**
+ * @return {Promise<boolean>}
+ */
+export async function isAutomaticSwitchingEnabled() {
+	const _isDarkModeNotifyRunning = await isDarkModeNotifyRunning();
+	const plistFileExists = exists(launchAgentPlistFilePath);
+
+	if (_isDarkModeNotifyRunning && !plistFileExists) {
+		throw new Error(
+			`Automatic switching is running, but the launch agent plist file (${launchAgentPlistFilePath}) doesn't exist`,
+		);
+	} else if (!_isDarkModeNotifyRunning && plistFileExists) {
+		throw new Error(
+			`Automatic switching is not running, but the launch agent plist file (${launchAgentPlistFilePath}) exists`,
+		);
+	}
+
+	return _isDarkModeNotifyRunning && plistFileExists;
+}

package/license.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Patrik Csak
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "auto-terminal-profile",
+  "version": "1.0.0",
+  "description": "Automatically switch the macOS Terminal profile based on the system-wide dark / light appearance mode",
+  "keywords": [
+    "macos",
+    "terminal",
+    "light mode",
+    "dark mode",
+    "profile"
+  ],
+  "license": "MIT",
+  "author": "Patrik Csak <p@trikcsak.com>",
+  "bin": "./cli.js",
+  "repository": "github:ptrkcsk/auto-terminal-profile",
+  "scripts": {
+    "format": "xo --fix",
+    "test": "xo"
+  },
+  "dependencies": {
+    "commander": "^9.3.0",
+    "conf": "^10.1.2",
+    "dark-mode": "^4.0.0",
+    "env-paths": "^3.0.0",
+    "execa": "^6.1.0",
+    "pupa": "^3.1.0",
+    "read-pkg-up": "^9.1.0",
+    "terminal-profile": "^1.0.1",
+    "untildify": "^4.0.0"
+  },
+  "devDependencies": {
+    "xo": "^0.50.0"
+  },
+  "engines": {
+    "node": "14 - 16"
+  },
+  "os": [
+    "darwin"
+  ],
+  "type": "module"
+}

package/readme.md

@@ -0,0 +1,44 @@
+# `auto-terminal-profile`
+
+Automatically switch the macOS Terminal profile based on the system-wide dark / light appearance mode
+
+![auto-terminal-profile demonstration screen recording](./documentation/demo.gif)
+
+## Prerequisites
+
+- [Node.js](https://nodejs.org/en/) 14-16
+
+## Installation
+
+```sh
+npm install --global auto-terminal-profile
+```
+
+## Usage
+
+```sh
+auto-terminal-profile --help
+```
+
+```
+Usage: auto-terminal-profile [options] [command]
+
+Automatically switch the macOS Terminal profile based on the system-wide dark / light appearance mode
+
+Options:
+  -V, --version                output the version number
+  -h, --help                   display help for command
+
+Commands:
+  disable                      Disable automatic macOS Terminal profile switching based on system dark / light mode
+  enable [options]             Enable automatic macOS Terminal profile switching based on system dark / light mode
+  set-dark-profile <profile>   Set the Terminal profile to use in dark mode
+  set-light-profile <profile>  Set the Terminal profile to use in light mode
+  status                       Show status and configuration
+  update-profile               Update the profile of currently running Terminal windows / tabs
+  help [command]               display help for command
+```
+
+## Acknowledgements
+
+Thanks to [Fatih Arslan](https://github.com/fatih) for his article [*Automatic dark mode for terminal applications*](https://arslan.io/2021/02/15/automatic-dark-mode-for-terminal-applications/) and [Bouke van der Bijl](https://github.com/bouk) for his project [dark-mode-notify](https://github.com/bouk/dark-mode-notify), which this project uses

package/templates/launch-agent.xml

@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN"
+"http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+    <key>Label</key>
+    <string>ke.bou.dark-mode-notify</string>
+    <key>KeepAlive</key>
+    <true/>
+    <key>StandardErrorPath</key>
+    <string>{logPath}/dark-mode-notify-stderr.log</string>
+    <key>StandardOutPath</key>
+    <string>{logPath}/dark-mode-notify-stdout.log</string>
+    <key>EnvironmentVariables</key>
+    <dict>
+        <key>PATH</key>
+        <string>{path}</string>
+    </dict>
+    <key>ProgramArguments</key>
+    <array>
+        <string>{darkModeNotifyPath}</string>
+        <string>{autoTerminalProfilePath}</string>
+        <string>update-profile</string>
+    </array>
+</dict>
+</plist>