purescript / purescript-console Goto Github PK

I'm getting 50 compile warnings from purescript-console and I see that the bower package is behind this repo. Could someone update?

In the Getting Started[0] guide is a solution to a Project Euler question. I continued working through questions using the Try Purescript REPL[1] and noticed I couldn't clear out my console easily. It would be nice to go console.clear() at the top of my solutions :)

Clear is missing in
https://pursuit.purescript.org/packages/purescript-console/2.0.0/docs/Control.Monad.Eff.Console

As described here
https://developer.mozilla.org/en-US/docs/Web/API/Console/clear

[0] http://www.purescript.org/learn/getting-started/
[1] http://try.purescript.org

Since there's like a thousand different console functions, would it be worthwhile to consider renaming print to log' and following this scheme for all the other functions?

error :: forall eff. String -> Eff (console :: CONSOLE | eff) Unit
error' :: forall a eff. (Show a) => a -> Eff (console :: CONSOLE | eff) Unit
log :: forall eff. String -> Eff (console :: CONSOLE | eff) Unit
log' :: forall a eff. (Show a) => a -> Eff (console :: CONSOLE | eff) Unit
warn :: forall eff. String -> Eff (console :: CONSOLE | eff) Unit
warn' :: forall a eff. (Show a) => a -> Eff (console :: CONSOLE | eff) Unit

etc.

Looks like traceAny :: a -> Effect Unit was added to this library awhile ago, then later removed.

Some arguments against that type signature:

It violates free theorem which says it ignores its argument
Implementations not violating such derived theorems is generally assumed of APIs
For example:
f :: forall a b. Tuple a b -> Tuple b a swaps the elements of the tuple given
f :: forall a. List a -> List a all elements in the output also exist in the input
f :: forall a b. a -> List b ignores its argument and returns the empty list
It’s something you can say about a (polymorphic) function given only its type
@rightfold

There's also the argument that it's possibly not referentially transparent.

I think it should exist here, though, in some form.

The console.log docs on MDN says it accepts any JS object. All PS types are JS objects at runtime, so we could say that a -> Effect Unit is a good description.

On the other hand, we could describe it as Json -> Effect Unit, where Json is a type which represents a data structure of "idiomatic primitive JSON types" in JavaScript, like plain-old objects (not classes), arrays, numbers, and strings.

We could do a constraint on a and implement that constraint like justinwoo/simple-json did: Json a => a -> Effect Unit.

Logging an Error has the effect of logging the original stack trace, just as if the exception was caught by the runtime. Using error with a string, or via show, erases the trace. Can we provide a function error' :: forall eff. Error -> Eff (console :: CONSOLE | eff) Unit?

console.{log,warn,error} are implemented with bindings.
console.debug is missing.

Is there a reason? Can it be added / would a PR be welcome?

https://developer.mozilla.org/de/docs/Web/API/Console/debug

Maybe they should be in Control.Monad.Eff.Console? See also purescript/purescript#1675

log :: a -> Effect Unit

Would be nice to have this function so we can just dump anything in there as we could with JavaScript. https://developer.mozilla.org/en-US/docs/Web/API/Console/log

I don't think logShow is a valid substitute as i think (but did not verify) that the developer console does different formatting when it operates on a different type.

Especially useful in combination with Foreign to avoid casting and type checks.

The module name has been changed for 0.12, but the file path still follows the Control.Monad.Effect hierarchy.

console.group is useful for logging with indentation, and it is well-supported for a long time now https://developer.mozilla.org/en-US/docs/Web/API/console/group