mrjacobbloom / echo Goto Github PK

Possible plan:

• Have a (global?) flag about whether to autoLog
• calls to render() unset flag
• autoLog's call to render() passed a secret arg (oooo a super secret symbol perhaps?) that tells it not to unset the flag

Alternative is to switch a flag in every public method, and separate render() into public and private versions

/* > */ Echo('foo\nbar')
/* < */ Echo('foo
bar')

Potential routes:

• Switch delimiter to `
• Escape newlines to \n
• NOT line continuations, they do the opposite of what you want

• Chrome (dark mode)
• Firefox (dark mode)
• IE / Edge

Would we need to use createRequire? Can we circumvent this since new Node should be able to use Symbol.for(...)?

https://www.typescriptlang.org/docs/handbook/namespaces.html

No need to muddy the global type scope if we can help it

Should tokens just always be wrapped in a type: default /unknown/whatever? It'd be more presentable

Does it do anything besides declare a global with some confusingly circular functionality? Might be nice to expose typings for options?

Can we auto-generate these? IDK if Typescript really understands what we're trying to do here

Not sure what this would look like?

Echo.options.theme = {
  default: 'rgba(111, 222, 123, 1)',
  /* ... */
}

Allow extension of existing theme instead of defining every token color?
Automatically calculate nearest ANSI color code? Add support for 8-bit/24-bit color? https://github.com/substack/node-x256

Would just make the output string prettier (in a way nobody should ever see)

Right now the recommended way to play with it is to paste the code into your console... which is bad... consider a RunKit link as the primary recommendation as well

https://npm.runkit.com/echo-proxy

If first argument is a string[] & { raw: string[] } then render as a tagged template literal

Right now the stringifier functions all pass through to their defaults if options.output='ToString'. They should probably always be overridden, and options.output='ToString' just disables automatic logging

Could potentially use https://github.com/Marak/colors.js/blob/master/lib/system/supports-colors.js
Node has hasColors() (11.13+) or getColorDepth() (9.9+) https://nodejs.org/api/tty.html#tty_writestream_hascolors_count_env

Does Chrome even still eager-eval Echo? What about giving the original (internal) Echo function side effects? It should never be called. Would that prevent autocomplete as well?

Autocomplete seems to stop after a construct (potentially also a call) -- or does it? Maybe there's a way to take advantage of that?

Is it worth it to specialize for Chrome's devtools?

Make it a type guard or whatever: https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards

: args is [TemplateStringsArray, ...any[]]

/* > */ Echo('\%s').foo(1)
/* < */ Echo('color: black').foo(1%c)

Format strings that may cause issues: %o, %O, %d, %i, %s, %f, %c, %.2f (etc)

Make sure fix doesn't slip into ansi mode unless it's invisible

Documentation on console formatting is pretty sparse: https://developer.mozilla.org/en-US/docs/Web/API/console#Using_string_substitutions

May have to use a zwsp or something :(

Why not?

Prereqs

• set minimum node version in package.json to 10.12 (see #1 and #3) npm docs
  • also make note in README about minimum Node version
• Write Tests #2
• Add instructions to README for how to --require

Right now it uses the value of Echo.render at the time of the Echo.then GET, ideally it should be grabbed at the time of apply. Maybe it could look more like

Echo.then = (...args) => Promise.prototype.then.apply(Echo.render(), args);

• % escaped in console text, not in other output modes
• ansi output ends with reset character
• 'Echo.then' behaves like a normal echo prop unless output='promise'
• Newlines in strings rendered as template strings
• Template tag detection, raw strings preserve escape codes, template literal args rendered correctly, etc.

BigInt renders as Number:

Booleans render as keywords??

Empty string renders as nothing:

(note that other values that stringify to empty string, like [], also render this way)

Object renders as stringified object:

Symbol (which may actually be detectable as distinct from string!!!!) doesn't even render the square brackets:

Getting Echo doesn't render anything at all: