Skip to content

Add IsLog type class #24

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.

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

jvliwanag
Copy link

JS console functions typically handle logging of certain types in a special manner. For instance, logging Errors also display an accompanying stack trace. Logging dom elements on browsers can also emits a dom tree that can be interactively inspected.

Pointing to purescript-debug might not always suffice, since there are use cases outside of debugging -- for instance logging errors with stack traces on server side purescript.

I've read that there used to be Any variants (logAny, warnAny) that were forall a. a -> Effect Unit, but have been removed.

Perhaps aa middleground between accepting anything vs limiting logging only to strings is to simply mark which types make sense to be logged. So I introduced the typeclass IsLog here and an instance for String and Array. I'm open to renaming this. (Logging extra long arrays auto truncates the array and offers interactive expanding on browsers)

Another option is to keep log only for strings, but introduce log' which accepts others that have an IsLog instance.

* Adds a way to declare types that can be logged directly to the
  console. (Ex: Error with stacktraces)
@hdgarrood
Copy link
Contributor

The problem with this is that it's quite JS-specific, and for such a low-down library in the ecosystem I think we need to make sure that what we provide here makes sense in alternate backends, and I doubt this will. Plus, I don't think a type class is appropriate here, because pretty much any value can be displayed at least half-sensibly in a JS console if you just pass it to console.log. The only exceptions are types like Map which hide their representations. I think this approach would be a better fit for a separate library.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants