useblocks / sphinx-needs-vscode

https://sphinx-needs-vscode.useblocks.com
MIT License
3 stars 2 forks source link

Cleaned log messages #11

Closed danwos closed 1 year ago

danwos commented 1 year ago

The log-output of Sphinx-Needs extension is too noisy and it's hard to detect problems.

Some messages, which get written if a certain feature is triggered, for instance "Hover feature". Also a timestamp is missing, so that it is hard to tell, if a message is new or not.

I think we should introduce the following changes/rules:

  1. Use a logging-lib, so that we get timestamp and log level
  2. Use log levels for all messages
  3. Default log level is warn, but it should be configurable by user (setting)
  4. Each "error" should be shown also as message-window. So they must be short, user-friendly and somehow summarize the problem (e.g. one message, even if multiple needs are corrupted)
  5. For any kind of helpful message during development, use "debug" message
  6. For any kind of information, which goes into details and may be repeated (e.g. a message for each need which is corrupted), use "info" level.