Giter Club home page Giter Club logo

Comments (7)

abeforgit avatar abeforgit commented on June 27, 2024 1

I see what you mean, but I'd disagree.
Simple usecase for example is logging method calls. I use a decorator to make this easy to add to interesting methods.
It prints: Calling ${methodName} with args: and then the args as objects. It's very useful to print them as objects since this is the browser and the browser console has some really powerful built-in logging formatters (especially for things like DOM nodes).

So I appreciate the current capability of allowing you to mix "text logs" and "object logs"

from diary.

maraisr avatar maraisr commented on June 27, 2024

Howdy @abeforgit β€” thank you for this. Yeah its definitely I was in mind of when designing the api. I didnt want an exact 1-to-1 relationship with console.log. It was more for the storytelling aspects.

But yeah maybe there is scope or use for just straight objects, or any data type other than string in that message argument. I can see value in something like a api or fetcher layer, where you may want it to simply log payloads coming back β€” the scope of the method would be that small that the diary name itself is descriptive enough. so diary('things').log({ payload: 'things' }) seems good enough for there.

So ya, let me have a ponder, see if anyone else chimes in with some ideas. If not ya will look at adding. πŸ•ΊπŸ»

from diary.

theKashey avatar theKashey commented on June 27, 2024

Sounds like there are

  • story telling use case, which (probably) give diary a name
  • structure logs use case, which is more applicable for, well, "logs"

Wondering - it is about expanding existing API, letting to do more(or less) stuff, or adding extra API/functionality a little aside, as it is actually a different use case

from diary.

abeforgit avatar abeforgit commented on June 27, 2024

Yeah I find that with a good diary name the message can become a bit redundant. It's also a slight deviation from the original console api which might trip up users (only once, really, but still)
Ultimately it's about control I think. Do you want to "force" users to use best practices? or do you allow them to use it however they want?

One thing I could see happening is people avoiding the issue by using console directly when the lib doesn't behave how they expect. Or passing "" as the message, which would be a bit silly.

@theKashey I don't think adding extra API for logging objects directly is the way to go. It's basically already supported anyway, all you have to do is provide a message (or "" if you really have nothing to say). I think extra methods would only increase confusion without adding value.

from diary.

theKashey avatar theKashey commented on June 27, 2024

Usually, it's or "textural logs" or "json logs". Never both at the same time.

from diary.

theKashey avatar theKashey commented on June 27, 2024

But the request is about logging something without any message provided. Sounds like it can be solved with a little different πŸ€·β€β™‚οΈ wording:

  • strict mode, enforcing you to follow some "model"
  • flexible mode, where you can do whatever you want πŸ‘ˆπŸ‘ˆπŸ‘ˆ the one you are looking for

from diary.

maraisr avatar maraisr commented on June 27, 2024

Hi @abeforgit sorry for the delay here πŸ˜…

We no longer restrict what you want to log, be it info('bob'), info(), or info({ foo: 'bar' }). We will respect this.

message[0] will still format, if it's a string.

from diary.

Related Issues (14)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.