Skip to content

Latest commit

 

History

History
93 lines (87 loc) · 3.23 KB

todo.org

File metadata and controls

93 lines (87 loc) · 3.23 KB

Log.gd Todos

v0.1.0

[X] pull in Log.gd from Dothop/dino

[X] create example scene and script that uses it

[X] add gdunit

[X] write some tests

[X] github actions running tests

[X] impl, tests for log() (duck-typing opt-in to pretty printing per object)

should be argless

[X] license

[X] create docs website

check out pandora, phantom-cam, gaea’s static site tooling

SKIP github action creating releases

[X] restore call-site module prefix

  • add line to docs and readme
  • update readme/site screenshots
  • include line numbers

[X] write and submit to godot asset library

[X] to_printable naming (vs to_pretty)?

[ ] Docs: ‘Example’ page

walk through the ExampleScene.gd with individual line-by-line output screenshots

[ ] readme/docs content

preview (short-version) of docs example page

non-Log.gd-based godot printing quick hits

  • print, prints, printt, print_rich
  • print_verbose

“Don’t want to install a whole addon? Here’s a godot print helper overview”

A/B differences between Log.pr() and print()

for an object, a node, a list, a dictionary

features, with code and screenshots

pretty-printing primitives

pretty-printing arrays and dicts

opting-in to prettier/limited classes/objects

func to_printable():
    {your=str(value)}

call-site prefixes

not a production log-to-file helper

but maybe that’s a future direction?

prior art

[ ] docs for public api

Log.to_pretty

`to_pretty()`, `data()`

Log.set_color_scheme(scheme) and related

[ ] readme link, docs install instructions

[ ] Example scene should have buttons for printing more things

the example outputs could also colorize and print the source code - that output might be a fun sharable version of the tutorial (i.e. the tutorial is all printed via Log.gd)

[ ] docs full api page

[ ] call-site prefix test coverage

[ ] better public obj -> rich-string function

no more wrap it in [] nonsense

v1.0.0

[ ] list prior art (other godot asset lib loggers)

[ ] consider csharp support + implementation

[ ] configurable per-type prettyprint overrides

example: i want to impl a to_printable for PandoraEntities without subclassing it

type->to_printable opts passed in as a dictionary? ideally written as a config of some kind

but how to read it from a static function? maybe need to write constants to disk like pandora does?

could read/write from a res://log.gd for opts. (this is what gd-plug does, for example)

  • specify colors for types
  • specify to_printable overrides
    • for eg, a fallback for PandoraEntities

[ ] configurable colors and multiple schemas

  • pretty colors
  • terminal-safe colors
  • custom color dictionary

[ ] hide/show logs based on arbitrary categories

https://mastodon.gamedev.place/deck/@[email protected]/112140962069868440

[ ] hide/show logs based on script name