commit 599ef00e3105c21e9b053803cfef1b04133e8b17 Author: Elara6331 Date: Sat Jul 20 16:27:46 2024 -0700 Initial Commit diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d0a1fa1 --- /dev/null +++ b/LICENSE @@ -0,0 +1,373 @@ +Mozilla Public License Version 2.0 +================================== + +1. Definitions +-------------- + +1.1. "Contributor" + means each individual or legal entity that creates, contributes to + the creation of, or owns Covered Software. + +1.2. "Contributor Version" + means the combination of the Contributions of others (if any) used + by a Contributor and that particular Contributor's Contribution. + +1.3. "Contribution" + means Covered Software of a particular Contributor. + +1.4. "Covered Software" + means Source Code Form to which the initial Contributor has attached + the notice in Exhibit A, the Executable Form of such Source Code + Form, and Modifications of such Source Code Form, in each case + including portions thereof. + +1.5. "Incompatible With Secondary Licenses" + means + + (a) that the initial Contributor has attached the notice described + in Exhibit B to the Covered Software; or + + (b) that the Covered Software was made available under the terms of + version 1.1 or earlier of the License, but not also under the + terms of a Secondary License. + +1.6. "Executable Form" + means any form of the work other than Source Code Form. + +1.7. "Larger Work" + means a work that combines Covered Software with other material, in + a separate file or files, that is not Covered Software. + +1.8. "License" + means this document. + +1.9. "Licensable" + means having the right to grant, to the maximum extent possible, + whether at the time of the initial grant or subsequently, any and + all of the rights conveyed by this License. + +1.10. "Modifications" + means any of the following: + + (a) any file in Source Code Form that results from an addition to, + deletion from, or modification of the contents of Covered + Software; or + + (b) any new file in Source Code Form that contains any Covered + Software. + +1.11. "Patent Claims" of a Contributor + means any patent claim(s), including without limitation, method, + process, and apparatus claims, in any patent Licensable by such + Contributor that would be infringed, but for the grant of the + License, by the making, using, selling, offering for sale, having + made, import, or transfer of either its Contributions or its + Contributor Version. + +1.12. "Secondary License" + means either the GNU General Public License, Version 2.0, the GNU + Lesser General Public License, Version 2.1, the GNU Affero General + Public License, Version 3.0, or any later versions of those + licenses. + +1.13. "Source Code Form" + means the form of the work preferred for making modifications. + +1.14. "You" (or "Your") + means an individual or a legal entity exercising rights under this + License. For legal entities, "You" includes any entity that + controls, is controlled by, or is under common control with You. For + purposes of this definition, "control" means (a) the power, direct + or indirect, to cause the direction or management of such entity, + whether by contract or otherwise, or (b) ownership of more than + fifty percent (50%) of the outstanding shares or beneficial + ownership of such entity. + +2. License Grants and Conditions +-------------------------------- + +2.1. Grants + +Each Contributor hereby grants You a world-wide, royalty-free, +non-exclusive license: + +(a) under intellectual property rights (other than patent or trademark) + Licensable by such Contributor to use, reproduce, make available, + modify, display, perform, distribute, and otherwise exploit its + Contributions, either on an unmodified basis, with Modifications, or + as part of a Larger Work; and + +(b) under Patent Claims of such Contributor to make, use, sell, offer + for sale, have made, import, and otherwise transfer either its + Contributions or its Contributor Version. + +2.2. Effective Date + +The licenses granted in Section 2.1 with respect to any Contribution +become effective for each Contribution on the date the Contributor first +distributes such Contribution. + +2.3. Limitations on Grant Scope + +The licenses granted in this Section 2 are the only rights granted under +this License. No additional rights or licenses will be implied from the +distribution or licensing of Covered Software under this License. +Notwithstanding Section 2.1(b) above, no patent license is granted by a +Contributor: + +(a) for any code that a Contributor has removed from Covered Software; + or + +(b) for infringements caused by: (i) Your and any other third party's + modifications of Covered Software, or (ii) the combination of its + Contributions with other software (except as part of its Contributor + Version); or + +(c) under Patent Claims infringed by Covered Software in the absence of + its Contributions. + +This License does not grant any rights in the trademarks, service marks, +or logos of any Contributor (except as may be necessary to comply with +the notice requirements in Section 3.4). + +2.4. Subsequent Licenses + +No Contributor makes additional grants as a result of Your choice to +distribute the Covered Software under a subsequent version of this +License (see Section 10.2) or under the terms of a Secondary License (if +permitted under the terms of Section 3.3). + +2.5. Representation + +Each Contributor represents that the Contributor believes its +Contributions are its original creation(s) or it has sufficient rights +to grant the rights to its Contributions conveyed by this License. + +2.6. Fair Use + +This License is not intended to limit any rights You have under +applicable copyright doctrines of fair use, fair dealing, or other +equivalents. + +2.7. Conditions + +Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted +in Section 2.1. + +3. Responsibilities +------------------- + +3.1. Distribution of Source Form + +All distribution of Covered Software in Source Code Form, including any +Modifications that You create or to which You contribute, must be under +the terms of this License. You must inform recipients that the Source +Code Form of the Covered Software is governed by the terms of this +License, and how they can obtain a copy of this License. You may not +attempt to alter or restrict the recipients' rights in the Source Code +Form. + +3.2. Distribution of Executable Form + +If You distribute Covered Software in Executable Form then: + +(a) such Covered Software must also be made available in Source Code + Form, as described in Section 3.1, and You must inform recipients of + the Executable Form how they can obtain a copy of such Source Code + Form by reasonable means in a timely manner, at a charge no more + than the cost of distribution to the recipient; and + +(b) You may distribute such Executable Form under the terms of this + License, or sublicense it under different terms, provided that the + license for the Executable Form does not attempt to limit or alter + the recipients' rights in the Source Code Form under this License. + +3.3. Distribution of a Larger Work + +You may create and distribute a Larger Work under terms of Your choice, +provided that You also comply with the requirements of this License for +the Covered Software. If the Larger Work is a combination of Covered +Software with a work governed by one or more Secondary Licenses, and the +Covered Software is not Incompatible With Secondary Licenses, this +License permits You to additionally distribute such Covered Software +under the terms of such Secondary License(s), so that the recipient of +the Larger Work may, at their option, further distribute the Covered +Software under the terms of either this License or such Secondary +License(s). + +3.4. Notices + +You may not remove or alter the substance of any license notices +(including copyright notices, patent notices, disclaimers of warranty, +or limitations of liability) contained within the Source Code Form of +the Covered Software, except that You may alter any license notices to +the extent required to remedy known factual inaccuracies. + +3.5. Application of Additional Terms + +You may choose to offer, and to charge a fee for, warranty, support, +indemnity or liability obligations to one or more recipients of Covered +Software. However, You may do so only on Your own behalf, and not on +behalf of any Contributor. You must make it absolutely clear that any +such warranty, support, indemnity, or liability obligation is offered by +You alone, and You hereby agree to indemnify every Contributor for any +liability incurred by such Contributor as a result of warranty, support, +indemnity or liability terms You offer. You may include additional +disclaimers of warranty and limitations of liability specific to any +jurisdiction. + +4. Inability to Comply Due to Statute or Regulation +--------------------------------------------------- + +If it is impossible for You to comply with any of the terms of this +License with respect to some or all of the Covered Software due to +statute, judicial order, or regulation then You must: (a) comply with +the terms of this License to the maximum extent possible; and (b) +describe the limitations and the code they affect. Such description must +be placed in a text file included with all distributions of the Covered +Software under this License. Except to the extent prohibited by statute +or regulation, such description must be sufficiently detailed for a +recipient of ordinary skill to be able to understand it. + +5. Termination +-------------- + +5.1. The rights granted under this License will terminate automatically +if You fail to comply with any of its terms. However, if You become +compliant, then the rights granted under this License from a particular +Contributor are reinstated (a) provisionally, unless and until such +Contributor explicitly and finally terminates Your grants, and (b) on an +ongoing basis, if such Contributor fails to notify You of the +non-compliance by some reasonable means prior to 60 days after You have +come back into compliance. Moreover, Your grants from a particular +Contributor are reinstated on an ongoing basis if such Contributor +notifies You of the non-compliance by some reasonable means, this is the +first time You have received notice of non-compliance with this License +from such Contributor, and You become compliant prior to 30 days after +Your receipt of the notice. + +5.2. If You initiate litigation against any entity by asserting a patent +infringement claim (excluding declaratory judgment actions, +counter-claims, and cross-claims) alleging that a Contributor Version +directly or indirectly infringes any patent, then the rights granted to +You by any and all Contributors for the Covered Software under Section +2.1 of this License shall terminate. + +5.3. In the event of termination under Sections 5.1 or 5.2 above, all +end user license agreements (excluding distributors and resellers) which +have been validly granted by You or Your distributors under this License +prior to termination shall survive termination. + +************************************************************************ +* * +* 6. Disclaimer of Warranty * +* ------------------------- * +* * +* Covered Software is provided under this License on an "as is" * +* basis, without warranty of any kind, either expressed, implied, or * +* statutory, including, without limitation, warranties that the * +* Covered Software is free of defects, merchantable, fit for a * +* particular purpose or non-infringing. The entire risk as to the * +* quality and performance of the Covered Software is with You. * +* Should any Covered Software prove defective in any respect, You * +* (not any Contributor) assume the cost of any necessary servicing, * +* repair, or correction. This disclaimer of warranty constitutes an * +* essential part of this License. No use of any Covered Software is * +* authorized under this License except under this disclaimer. * +* * +************************************************************************ + +************************************************************************ +* * +* 7. Limitation of Liability * +* -------------------------- * +* * +* Under no circumstances and under no legal theory, whether tort * +* (including negligence), contract, or otherwise, shall any * +* Contributor, or anyone who distributes Covered Software as * +* permitted above, be liable to You for any direct, indirect, * +* special, incidental, or consequential damages of any character * +* including, without limitation, damages for lost profits, loss of * +* goodwill, work stoppage, computer failure or malfunction, or any * +* and all other commercial damages or losses, even if such party * +* shall have been informed of the possibility of such damages. This * +* limitation of liability shall not apply to liability for death or * +* personal injury resulting from such party's negligence to the * +* extent applicable law prohibits such limitation. Some * +* jurisdictions do not allow the exclusion or limitation of * +* incidental or consequential damages, so this exclusion and * +* limitation may not apply to You. * +* * +************************************************************************ + +8. Litigation +------------- + +Any litigation relating to this License may be brought only in the +courts of a jurisdiction where the defendant maintains its principal +place of business and such litigation shall be governed by laws of that +jurisdiction, without reference to its conflict-of-law provisions. +Nothing in this Section shall prevent a party's ability to bring +cross-claims or counter-claims. + +9. Miscellaneous +---------------- + +This License represents the complete agreement concerning the subject +matter hereof. If any provision of this License is held to be +unenforceable, such provision shall be reformed only to the extent +necessary to make it enforceable. Any law or regulation which provides +that the language of a contract shall be construed against the drafter +shall not be used to construe this License against a Contributor. + +10. Versions of the License +--------------------------- + +10.1. New Versions + +Mozilla Foundation is the license steward. Except as provided in Section +10.3, no one other than the license steward has the right to modify or +publish new versions of this License. Each version will be given a +distinguishing version number. + +10.2. Effect of New Versions + +You may distribute the Covered Software under the terms of the version +of the License under which You originally received the Covered Software, +or under the terms of any subsequent version published by the license +steward. + +10.3. Modified Versions + +If you create software not governed by this License, and you want to +create a new license for such software, you may create and use a +modified version of this License if you rename the license and remove +any references to the name of the license steward (except to note that +such modified license differs from this License). + +10.4. Distributing Source Code Form that is Incompatible With Secondary +Licenses + +If You choose to distribute Source Code Form that is Incompatible With +Secondary Licenses under the terms of this version of the License, the +notice described in Exhibit B of this License must be attached. + +Exhibit A - Source Code Form License Notice +------------------------------------------- + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at https://mozilla.org/MPL/2.0/. + +If it is not possible or desirable to put the notice in a particular +file, then You may include the notice in a location (such as a LICENSE +file in a relevant directory) where a recipient would be likely to look +for such a notice. + +You may add additional accurate notices of copyright ownership. + +Exhibit B - "Incompatible With Secondary Licenses" Notice +--------------------------------------------------------- + + This Source Code Form is "Incompatible With Secondary Licenses", as + defined by the Mozilla Public License, v. 2.0. diff --git a/README.md b/README.md new file mode 100644 index 0000000..b75d672 --- /dev/null +++ b/README.md @@ -0,0 +1,41 @@ +# Loggers + +Loggers is a collection of [`log/slog`](https://pkg.go.dev/log/slog) handlers that pretty print logs, similar to Zerolog's ConsoleWriter, but without sacrificing any performance. + +# Example + +```go +package main + +import ( + "log/slog" + "os" + "strconv" + + "go.elara.ws/loggers" +) + +const input = "hello" + +func main() { + log := slog.New(loggers.NewPretty(os.Stdout, loggers.Options{ + Level: slog.LevelDebug, + ShowCaller: true, + })) + + i, err := strconv.Atoi(input) + if err != nil { + log.Error( + "Couldn't convert to integer", + slog.String("input", input), + slog.Any("error", err), + ) + return + } + + log.Info( + "Converted to integer!", + slog.Int("output", i), + ) +} +``` \ No newline at end of file diff --git a/cli.go b/cli.go new file mode 100644 index 0000000..28d56c6 --- /dev/null +++ b/cli.go @@ -0,0 +1,127 @@ +package loggers + +import ( + "context" + "io" + "log/slog" + "sync" + + "go.elara.ws/loggers/internal/buffer" + "go.elara.ws/loggers/internal/colors" +) + +// CLI is an slog handler for command-line tools where users will view +// and read the logs throughout the application's execution. +type CLI struct { + mtx *sync.Mutex + goa []groupOrAttr + + // Colorize indicates whether colors will be used + // in log output. + Colorize bool + + // Out is where log output will be written. + Out io.Writer + + Options +} + +// NewPretty creates and returns a new [CLI] handler. +func NewCLI(wr io.Writer, opts Options) *CLI { + return &CLI{ + mtx: &sync.Mutex{}, + Colorize: opts.ForceColors || isTerm(wr), + Out: wr, + Options: opts, + } +} + +// Enabled reports whether the handler handles records at the given level. +// The handler ignores records whose level is lower. +func (c *CLI) Enabled(_ context.Context, level slog.Level) bool { + return level >= c.Level +} + +// WithGroup returns a new [CLI] handler with the given group name. +func (c *CLI) WithGroup(group string) slog.Handler { + return &CLI{ + mtx: c.mtx, + Out: c.Out, + Options: c.Options, + Colorize: c.Colorize, + goa: append(c.goa, groupOrAttr{group: group}), + } +} + +// WithAttrs returns a new [CLI] handler whose attributes +// consists of c's attributes followed by attrs. +func (c *CLI) WithAttrs(attrs []slog.Attr) slog.Handler { + goa := make([]groupOrAttr, len(attrs)) + for i, attr := range attrs { + goa[i] = groupOrAttr{attr: attr} + } + return &CLI{ + mtx: c.mtx, + Out: c.Out, + Options: c.Options, + Colorize: c.Colorize, + goa: append(c.goa, goa...), + } +} + +// Handle formats the given [log/slog.Record] as a human-readable string on a single line. +func (c *CLI) Handle(_ context.Context, rec slog.Record) error { + buf := buffer.Alloc() + defer buffer.Free(buf) + + switch rec.Level { + case slog.LevelInfo: + colors.WriteString(c.Colorize, buf, colors.Green, "-->") + case slog.LevelError: + colors.WriteString(c.Colorize, buf, colors.Red, " ->") + case slog.LevelWarn: + colors.WriteString(c.Colorize, buf, colors.Yellow, " ->") + case slog.LevelDebug: + colors.WriteString(c.Colorize, buf, colors.Magenta, "[DBG]") + } + buf.WriteByte(' ') + + buf.WriteString(rec.Message) + + lastGroup := "" + for _, goa := range c.goa { + switch { + case goa.group == "": + if lastGroup != "" { + goa.attr.Key = lastGroup + goa.attr.Key + } + buf.WriteByte(' ') + writeAttr(c.Colorize, buf, goa.attr) + default: + lastGroup += goa.group + "." + } + } + + if rec.NumAttrs() > 0 { + rec.Attrs(func(attr slog.Attr) bool { + if lastGroup != "" { + attr.Key = lastGroup + attr.Key + } + buf.WriteByte(' ') + writeAttr(c.Colorize, buf, attr) + return true + }) + } + + if c.ShowCaller { + writeCaller(c.Colorize, buf, rec.PC) + } + + buf.WriteByte('\n') + + c.mtx.Lock() + defer c.mtx.Unlock() + + _, err := buf.WriteTo(c.Out) + return err +} diff --git a/colors.go b/colors.go new file mode 100644 index 0000000..16a92e3 --- /dev/null +++ b/colors.go @@ -0,0 +1,60 @@ +package loggers + +// Color represents an ANSI color escape code +type Color string + +const ( + // Reset resets all text formatting + Reset Color = "\033[0m" + + // Bold represents bold text + Bold Color = "\033[1m" + + // Underline represents underlined text + Underline Color = "\033[4m" + + // Reverse represents reversed text (background and foreground colors are swapped) + Reverse Color = "\033[7m" + + // LightRed represents light red color + LightRed Color = "\033[91m" + + // LightGreen represents light green color + LightGreen Color = "\033[92m" + + // LightYellow represents light yellow color + LightYellow Color = "\033[93m" + + // LightBlue represents light blue color + LightBlue Color = "\033[94m" + + // LightMagenta represents light magenta color + LightMagenta Color = "\033[95m" + + // LightCyan represents light cyan color + LightCyan Color = "\033[96m" + + // Black represents black color + Black Color = "\033[30m" + + // Red represents red color + Red Color = "\033[31m" + + // Green represents green color + Green Color = "\033[32m" + + // Yellow represents yellow color + Yellow Color = "\033[33m" + + // Blue represents blue color + Blue Color = "\033[34m" + + // Magenta represents magenta color + Magenta Color = "\033[35m" + + // Cyan represents cyan color + Cyan Color = "\033[36m" + + // White represents white color + White Color = "\033[37m" +) diff --git a/common.go b/common.go new file mode 100644 index 0000000..f785c3f --- /dev/null +++ b/common.go @@ -0,0 +1,115 @@ +package loggers + +import ( + "bytes" + "io" + "log/slog" + "os" + "path/filepath" + "runtime" + "strconv" + "time" + + "go.elara.ws/loggers/internal/colors" + "golang.org/x/term" +) + +// Options represents common options for slog handlers +// in this package. +type Options struct { + // TimeFormat represents the format of the timestamp + // provided by the [Pretty] logger. + TimeFormat string + + // Level is the log level above which the handler will + // handle records. + Level slog.Level + + // ShowCaller indicates whether the caller that created the + // record should be provided in the output + ShowCaller bool + + // ForceColors prevents checking whether a handler outputs + // to a valid tty and always enables colors if set to true. + ForceColors bool +} + +// groupOrAttr represents a group name or [log/slog.Attr]. +type groupOrAttr struct { + attr slog.Attr + group string +} + +// writeGroup writes all the attributes in a group to buf. +func writeGroup(colorize bool, buf *bytes.Buffer, group slog.Attr) { + attrs := group.Value.Group() + for i, attr := range attrs { + attr.Key = group.Key + "." + attr.Key + writeAttr(colorize, buf, attr) + if i < len(attrs)-1 { + buf.WriteByte(' ') + } + } +} + +// writeAttr writes a single attribute to buf. +// +// If the attribute is a [log/slog.Group], it calls [writeGroup]. +// If the value of the attribute is an error, it will color it red. +func writeAttr(colorize bool, buf *bytes.Buffer, attr slog.Attr) { + attr.Value = attr.Value.Resolve() + + if attr.Equal(slog.Attr{}) { + return + } + + if attr.Value.Kind() == slog.KindGroup { + writeGroup(colorize, buf, attr) + return + } + + if _, ok := attr.Value.Any().(error); ok { + colors.WriteString(colorize, buf, colors.Red, attr.Key+"=") + colors.WriteCode(colorize, buf, colors.LightRed) + } else { + colors.WriteString(colorize, buf, colors.Cyan, attr.Key+"=") + colors.WriteCode(colorize, buf, colors.White) + } + + abuf := buf.AvailableBuffer() + switch attr.Value.Kind() { + case slog.KindInt64: + abuf = strconv.AppendInt(abuf, attr.Value.Int64(), 10) + case slog.KindUint64: + abuf = strconv.AppendUint(abuf, attr.Value.Uint64(), 10) + case slog.KindFloat64: + abuf = strconv.AppendFloat(abuf, attr.Value.Float64(), 'g', -1, 64) + case slog.KindBool: + abuf = strconv.AppendBool(abuf, attr.Value.Bool()) + case slog.KindDuration: + abuf = append(abuf, attr.Value.Duration().String()...) + case slog.KindTime: + abuf = attr.Value.Time().AppendFormat(abuf, time.RFC3339) + default: + abuf = strconv.AppendQuote(abuf, attr.Value.String()) + } + buf.Write(abuf) + colors.WriteCode(colorize, buf, colors.Reset) +} + +// writeCaller extracts the caller from the given program counter +// and writes it to buf, enclosed in square brackets. +func writeCaller(colorize bool, buf *bytes.Buffer, pc uintptr) { + frame, _ := runtime.CallersFrames([]uintptr{pc}).Next() + text := "[" + filepath.Base(frame.File) + ":" + strconv.Itoa(frame.Line) + "]" + buf.WriteByte(' ') + colors.WriteString(colorize, buf, colors.Bold+colors.LightBlue, text) +} + +// isTerm checks if wr corresponds to a valid tty. +func isTerm(wr io.Writer) bool { + if fl, ok := wr.(*os.File); ok { + return term.IsTerminal(int(fl.Fd())) + } + return false +} diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..5f9a04d --- /dev/null +++ b/go.mod @@ -0,0 +1,7 @@ +module go.elara.ws/loggers + +go 1.22.0 + +require golang.org/x/term v0.22.0 + +require golang.org/x/sys v0.22.0 // indirect diff --git a/go.sum b/go.sum new file mode 100644 index 0000000..94815f6 --- /dev/null +++ b/go.sum @@ -0,0 +1,4 @@ +golang.org/x/sys v0.22.0 h1:RI27ohtqKCnwULzJLqkv897zojh5/DwS/ENaMzUOaWI= +golang.org/x/sys v0.22.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= +golang.org/x/term v0.22.0 h1:BbsgPEJULsl2fV/AT3v15Mjva5yXKQDyKf+TbDz7QJk= +golang.org/x/term v0.22.0/go.mod h1:F3qCibpT5AMpCRfhfT53vVJwhLtIVHhB9XDjfFvnMI4= diff --git a/internal/buffer/buffer.go b/internal/buffer/buffer.go new file mode 100644 index 0000000..27ce078 --- /dev/null +++ b/internal/buffer/buffer.go @@ -0,0 +1,32 @@ +package buffer + +import ( + "bytes" + "sync" +) + +const ( + maxBufSize = 16384 + initBufSize = 1024 +) + +var bufPool = sync.Pool{ + New: func() any { + return bytes.NewBuffer(make([]byte, 0, initBufSize)) + }, +} + +// Alloc gets an existing buffer or allocates a new 1kB buffer. +func Alloc() *bytes.Buffer { + return bufPool.Get().(*bytes.Buffer) +} + +// Free releases the buffer back into the pool. If the buffer +// is over 16kB, it isn't put back into the pool to avoid excessive +// memory usage. +func Free(buf *bytes.Buffer) { + if buf.Cap() <= maxBufSize { + buf.Reset() + bufPool.Put(buf) + } +} diff --git a/internal/colors/color.go b/internal/colors/color.go new file mode 100644 index 0000000..2167429 --- /dev/null +++ b/internal/colors/color.go @@ -0,0 +1,127 @@ +package colors + +import "io" + +// Color represents an ANSI color escape code +type Color string + +const ( + // Reset resets all text formatting + Reset Color = "\x1b[0m" + + // Bold represents bold text + Bold Color = "\x1b[1m" + + // Underline represents underlined text + Underline Color = "\x1b[4m" + + // Reverse represents reversed text (background and foreground colors are swapped) + Reverse Color = "\x1b[7m" + + // Grey represents the grey color + Grey Color = "\x1b[38:5:240m" + + // LightRed represents the light red color + LightRed Color = "\x1b[91m" + + // LightGreen represents the light green color + LightGreen Color = "\x1b[92m" + + // LightYellow represents the light yellow color + LightYellow Color = "\x1b[93m" + + // LightBlue represents the light blue color + LightBlue Color = "\x1b[94m" + + // LightMagenta represents the light magenta color + LightMagenta Color = "\x1b[95m" + + // LightCyan represents the light cyan color + LightCyan Color = "\x1b[96m" + + // Black represents the black color + Black Color = "\x1b[30m" + + // Red represents the red color + Red Color = "\x1b[31m" + + // Green represents the green color + Green Color = "\x1b[32m" + + // Yellow represents the yellow color + Yellow Color = "\x1b[33m" + + // Blue represents the blue color + Blue Color = "\x1b[34m" + + // Magenta represents the magenta color + Magenta Color = "\x1b[35m" + + // Cyan represents the cyan color + Cyan Color = "\x1b[36m" + + // White represents the white color + White Color = "\x1b[38:5:15m" +) + +// WriteCode writes a single col to w if uc is true +func WriteCode(uc bool, w io.Writer, col Color) (int, error) { + if uc { + return io.WriteString(w, string(col)) + } + return 0, nil +} + +// Write writes b to w. It prepends col and appends a reset if uc is true. +func Write(uc bool, w io.Writer, col Color, b []byte) (n int, err error) { + if uc { + nn, err := io.WriteString(w, string(col)) + if err != nil { + return nn, err + } + n += nn + } + + nn, err := w.Write(b) + if err != nil { + return nn, err + } + n += nn + + if uc { + nn, err := io.WriteString(w, string(Reset)) + if err != nil { + return nn, err + } + n += nn + } + + return n, nil +} + +// Write writes s to w. It prepends col and appends a reset if uc is true. +func WriteString(uc bool, w io.Writer, col Color, s string) (n int, err error) { + if uc { + nn, err := io.WriteString(w, string(col)) + if err != nil { + return nn, err + } + n += nn + } + + nn, err := io.WriteString(w, s) + if err != nil { + return nn, err + } + n += nn + + if uc { + nn, err := io.WriteString(w, string(Reset)) + if err != nil { + return nn, err + } + n += nn + } + + return n, nil +} diff --git a/pretty.go b/pretty.go new file mode 100644 index 0000000..72d3a69 --- /dev/null +++ b/pretty.go @@ -0,0 +1,135 @@ +package loggers + +import ( + "context" + "io" + "log/slog" + "sync" + "time" + + "go.elara.ws/loggers/internal/buffer" + "go.elara.ws/loggers/internal/colors" +) + +// Pretty is an slog handler with a human-readable output +type Pretty struct { + mtx *sync.Mutex + goa []groupOrAttr + + // Colorize indicates whether colors will be used + // in log output. + Colorize bool + + // Out is where log output will be written. + Out io.Writer + + Options +} + +// NewPretty creates and returns a new [Pretty] handler. +// If opts doesn't specify a time format, [time.Kitchen] will be used. +func NewPretty(wr io.Writer, opts Options) *Pretty { + if opts.TimeFormat == "" { + opts.TimeFormat = time.Kitchen + } + + return &Pretty{ + mtx: &sync.Mutex{}, + Colorize: opts.ForceColors || isTerm(wr), + Out: wr, + Options: opts, + } +} + +// Enabled reports whether the handler handles records at the given level. +// The handler ignores records whose level is lower. +func (p *Pretty) Enabled(_ context.Context, level slog.Level) bool { + return level >= p.Level +} + +// WithGroup returns a new [Pretty] handler with the given group name. +func (p *Pretty) WithGroup(name string) slog.Handler { + return &Pretty{ + mtx: p.mtx, + Out: p.Out, + Options: p.Options, + Colorize: p.Colorize, + goa: append(p.goa, groupOrAttr{group: name}), + } +} + +// WithAttrs returns a new [Pretty] handler whose attributes +// consists of p's attributes followed by attrs. +func (p *Pretty) WithAttrs(attrs []slog.Attr) slog.Handler { + goa := make([]groupOrAttr, len(attrs)) + for i, attr := range attrs { + goa[i] = groupOrAttr{attr: attr} + } + return &Pretty{ + mtx: p.mtx, + Out: p.Out, + Options: p.Options, + Colorize: p.Colorize, + goa: append(p.goa, goa...), + } +} + +// Handle formats the given [log/slog.Record] as a human-readable string on a single line. +func (p *Pretty) Handle(_ context.Context, rec slog.Record) error { + buf := buffer.Alloc() + defer buffer.Free(buf) + + colors.WriteString(p.Colorize, buf, colors.Grey, rec.Time.Format(p.TimeFormat)) + buf.WriteByte(' ') + + switch rec.Level { + case slog.LevelInfo: + colors.WriteString(p.Colorize, buf, colors.Green, "INF") + case slog.LevelError: + colors.WriteString(p.Colorize, buf, colors.Red, "ERR") + case slog.LevelWarn: + colors.WriteString(p.Colorize, buf, colors.Yellow, "WRN") + case slog.LevelDebug: + colors.WriteString(p.Colorize, buf, colors.Magenta, "DBG") + } + buf.WriteByte(' ') + + buf.WriteString(rec.Message) + + lastGroup := "" + for _, goa := range p.goa { + switch { + case goa.group == "": + if lastGroup != "" { + goa.attr.Key = lastGroup + goa.attr.Key + } + buf.WriteByte(' ') + writeAttr(p.Colorize, buf, goa.attr) + default: + lastGroup += goa.group + "." + } + } + + if rec.NumAttrs() > 0 { + rec.Attrs(func(attr slog.Attr) bool { + if lastGroup != "" { + attr.Key = lastGroup + attr.Key + } + buf.WriteByte(' ') + writeAttr(p.Colorize, buf, attr) + return true + }) + } + + if p.ShowCaller { + writeCaller(p.Colorize, buf, rec.PC) + } + + buf.WriteByte('\n') + + p.mtx.Lock() + defer p.mtx.Unlock() + + _, err := buf.WriteTo(p.Out) + return err +}