search

SpineEventEngine / logging

Multiplatform fluent logging API for Kotlin projects
0 stars 0 forks source link

Update README files #69

Closed yevhenii-nadtochii closed 1 year ago

yevhenii-nadtochii commented 1 year ago

This PR updates README files.

The following modules have been updated:

I've renamed Module.md to README.md because README files are rendered by GitHub even if they are in nested directories.

Possible actions:

  1. We don't have slf4j backend, and after repackaging we are incompatible with Flogger's one. We should either create an issue to add this backend or remove two test modules that use this backend.
  2. There are several types under io.spine.testing.logging package in tests/fixtures module. And we also have io.spine.logging.testing in testutil-logging. Earlier, we decided to go with the latter option.
  3. Rename logging-fake-backend to backends/jvm-dynamic-backend. We don't need "logging" prefix because this module is not published. Also, I'm not sure whether to extract captureLogData() to a separate module. It feels so, but I haven't come up with a module name.
  4. Remove SimpleLoggerBackend. We have our own default backend (StdLoggerBackend), so Flogger's one can be removed.
  5. Can we get rid of logging prefix in module names? We use it for published modules, and it starts to pollute modules hierarchy with long names. Maybe spinePublihsing{} can do it for us.
  6. Bump Gradle. It freezes too often, up to ten times per working day. I hope they enhanced Kotlin Multiplatform support in Gradle 8+.
  7. We have lost the automatic pickup of the default backend when hid Flogger (#62). Putting of spine-logging on the classpath doesn't lead to the console output anymore. It leads to an error. We also have to put logging-backend explicitly.
codecov[bot] commented 1 year ago

Codecov Report

Merging #69 (2cd0001) into master (3a2ba61) will not change coverage. The diff coverage is n/a.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #69 +/- ## ========================================= Coverage 62.40% 62.40% Complexity 821 821 ========================================= Files 119 119 Lines 3809 3809 Branches 512 512 ========================================= Hits 2377 2377 Misses 1228 1228 Partials 204 204 ```
yevhenii-nadtochii commented 1 year ago

@armiol @alexander-yevsyukov PTAL

And let's discuss next steps after review of this PR.

yevhenii-nadtochii commented 1 year ago

@armiol @alexander-yevsyukov PTAL