fix: disable if no TTY session (eg; command pipe) (#33)

* Disable color output in pipes

* chore: set `isTTY` for CI

* fix: allow `FORCE_COLOR` override

* chore: run CI w/ `FORCE_COLOR` override

* fix: respond to "FORCE_COLOR=0" & GITHUB_ACTIONS

* fix: revert GITHUB_ACTIONS read

* chore: include bash tests for ENV detect

* sigh

* debug: print all

* fix(bash): remove faulty TTY assumption

* chore: addl combos; ignore trailing space

Co-authored-by: Luke Edwards <luke.edwards05@gmail.com>

.github/workflows/ci.yml

@@ -22,6 +22,11 @@ jobs:
 
     - name: Test w/ Coverage
       run: c8 npm test
+      env:
+        FORCE_COLOR: 1
+
+    - name: Test w/ Environment
+      run: npm run build && ./test/env.sh
 
     - name: Report
       if: matrix.nodejs >= 14

colors.mjs

@@ -1,7 +1,9 @@
 const { FORCE_COLOR, NODE_DISABLE_COLORS, TERM } = process.env;
 
 export const $ = {
-	enabled: !NODE_DISABLE_COLORS && TERM !== 'dumb' && FORCE_COLOR !== '0'
+	enabled: !NODE_DISABLE_COLORS && TERM !== 'dumb' && (
+		FORCE_COLOR != null && FORCE_COLOR !== '0' || process.stdout.isTTY
+	)
 }
 
 function init(x, y) {

index.mjs

@@ -3,7 +3,9 @@
 const { FORCE_COLOR, NODE_DISABLE_COLORS, TERM } = process.env;
 
 const $ = {
-	enabled: !NODE_DISABLE_COLORS && TERM !== 'dumb' && FORCE_COLOR !== '0',
+	enabled: !NODE_DISABLE_COLORS && TERM !== 'dumb' && (
+		FORCE_COLOR != null && FORCE_COLOR !== '0' || process.stdout.isTTY
+	),
 
 	// modifiers
 	reset: init(0, 0),

package.json

@@ -29,7 +29,7 @@
   },
   "scripts": {
     "build": "node build",
-    "test": "uvu -r esm -i utils"
+    "test": "uvu -r esm -i utils -i xyz"
   },
   "engines": {
     "node": ">=6"

test/env.sh

@@ -0,0 +1,47 @@
+#!/usr/bin/env bash
+
+code=0
+fail() {
+  printf "\x1b[31m[FAIL]\x1b[39m %s\n" "$@" >&2
+	code=1
+}
+
+colors() {
+	printf "\x1b[33m[DEBUG]\x1b[39m \"%s\" :: %s \n" "$2" "$1"
+	[ "$1" != "foo" ] || fail "$2"
+}
+
+nocolor() {
+	printf "\x1b[33m[DEBUG]\x1b[39m \"%s\" :: %s \n" "$2" "$1"
+	[[ "$1" =~ foo* ]] || fail "$2"
+}
+
+faketty() {
+	script -qfc "$(printf "%q " "$@")" /dev/null
+}
+
+# process.stdout.isTTY = undefined;
+printf "\nprocess.stdout.isTTY = %s;\n" `node -p "process.stdout.isTTY"`
+nocolor `node -p "require('.').red('foo')"` "FORCE_COLOR=?"
+nocolor `FORCE_COLOR=0 node -p "require('.').red('foo')"` "FORCE_COLOR=0"
+nocolor `NODE_DISABLE_COLORS=1 node -p "require('.').red('foo')"` "NODE_DISABLE_COLORS=1"
+nocolor `NODE_DISABLE_COLORS=1 FORCE_COLOR=1 node -p "require('.').red('foo')"` "NODE_DISABLE_COLORS=1; FORCE_COLOR=1"
+colors `FORCE_COLOR=1 node -p "require('.').red('foo')"` "FORCE_COLOR=1"
+nocolor `TERM=dumb FORCE_COLOR=1 node -p "require('.').red('foo')"` "TERM=dumb; FORCE_COLOR=1"
+nocolor `TERM=dumb node -p "require('.').red('foo')"` "TERM=dumb"
+
+# process.stdout.isTTY = true;
+printf "\n(faketty) process.stdout.isTTY = %s;\n" `faketty node -p "process.stdout.isTTY"`
+colors `faketty node -p "require('.').red('foo')"` "FORCE_COLOR=?"
+colors `FORCE_COLOR=0 faketty node -p "require('.').red('foo')"` "FORCE_COLOR=0"
+nocolor `NODE_DISABLE_COLORS=1 faketty node -p "require('.').red('foo')"` "NODE_DISABLE_COLORS=1"
+nocolor `NODE_DISABLE_COLORS=1 FORCE_COLOR=1 faketty node -p "require('.').red('foo')"` "NODE_DISABLE_COLORS=1; FORCE_COLOR=1"
+nocolor `TERM=dumb FORCE_COLOR=1 faketty node -p "require('.').red('foo')"` "TERM=dumb; FORCE_COLOR=1"
+colors `FORCE_COLOR=1 faketty node -p "require('.').red('foo')"` "FORCE_COLOR=1"
+nocolor `TERM=dumb node -r esm test/xyz.js` "TERM=dumb"
+
+if [ "$code" == "0" ]; then
+	printf "\x1b[32m[PASS]\x1b[39m $.enabled updates correctly \n"
+fi
+
+exit $code

test/xyz.js

@@ -0,0 +1,2 @@
+import kleur from '../index.mjs';
+console.log(kleur.red('foo'));