Skip to content

Add basic color detection #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 15 commits into from
Oct 27, 2021
Merged

Add basic color detection #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
511abb0
Add basic color detection
Richienb Oct 8, 2021
644ac8f
Update readme.md
Richienb Oct 8, 2021
9aacd55
Update readme.md
Richienb Oct 8, 2021
d49a990
Update readme.md
Richienb Oct 8, 2021
3536e7a
Update readme.md
Richienb Oct 8, 2021
c9a0a58
Update readme.md
Richienb Oct 8, 2021
bb3464a
Update index.js
Richienb Oct 8, 2021
b95ad78
Update package.json
Richienb Oct 9, 2021
aa3a93c
Update readme.md
sindresorhus Oct 24, 2021
42368f0
Update readme.md
Richienb Oct 24, 2021
2a5d748
Update readme.md
Richienb Oct 24, 2021
47155ea
Update package.json
Richienb Oct 24, 2021
23f0018
Update package.json
Richienb Oct 27, 2021
67ff9d8
Update package.json
Richienb Oct 27, 2021
62937bf
Update readme.md
sindresorhus Oct 27, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
import tty from 'node:tty';

// TODO: Use a better method when it's added to Node.js (https://github.com/nodejs/node/pull/40240)
const hasColors = tty.WriteStream.prototype.hasColors();
Copy link

@privatenumber privatenumber Oct 19, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Richienb

Was there a reason for doing this instead of process.stdout.hasColors()?

Copy link
Contributor Author

@Richienb Richienb Oct 19, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't remember.

@sindresorhus

Copy link
Owner

@sindresorhus sindresorhus Oct 20, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe the answer is in the TODO comment. process.stdout.hasColors() was not available then.

Copy link

@privatenumber privatenumber Oct 20, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, I missed that.

Seems process.stdout.hasColors() has been available. However, they're trying to deprecate it because:

In the PR, they're trying to expose a standalone function but is blocked by deprecation strategy for the prototype method.


// Intentionally not using template literal for performance.
const format = (startCode, endCode) => string => '\u001B[' + startCode + 'm' + string + '\u001B[' + endCode + 'm';
const format = (startCode, endCode) => hasColors ? string => '\u001B[' + startCode + 'm' + string + '\u001B[' + endCode + 'm' : string => string;

export const reset = format(0, 0);
export const bold = format(1, 22);
Expand Down
5 changes: 5 additions & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,5 +46,10 @@
"ava": "^3.15.0",
"tsd": "^0.17.0",
"xo": "^0.44.0"
},
"ava": {
"environmentVariables": {
"FORCE_COLOR": "1"
}
}
}
2 changes: 1 addition & 1 deletion readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ import * as colors from 'yoctocolors';
console.log(colors.red('Yo!'));
```

*This package does not do color support detection. Check out [`supports-color`](https://github.com/chalk/supports-color) if you need that. Node.js will hopefully get [built-in support](https://github.com/nodejs/node/pull/40240) for color support detection at some point.*
*This package supports [basic color detection](https://nodejs.org/api/tty.html#writestreamhascolorscount-env). Colors can be forcefully enabled by setting the `FORCE_COLOR` environment variable to `1` and can be forcefully disabled by setting `NO_COLOR` or `NODE_DISABLE_COLORS` to any value. [More info.](https://nodejs.org/api/tty.html#writestreamgetcolordepthenv)*

## Styles

Expand Down