search

SAP / ui5-migration

ARCHIVED - A tool to support the migration of UI5 projects by adapting code for new UI5 framework versions.
Apache License 2.0
37 stars 7 forks source link

Logging improvements for CI-integration #39

Open Nimuae opened 5 years ago

Nimuae commented 5 years ago

Dear UI5 team,

As communicated before, this is the collection of logging improvements we'd need in order to use the ui5-migration tool inside our Git pre-commit hook and, later on, also in our CI infrastructure.

The current logging done by the tool is not concise enough and does not show exactly what is wrong where in what file. As there are different tasks that can be executed using the tool, the ideal output for us would contain some information about the issue that was found and its position in the file, as well as log-level-appropriate output. Currently, there are only minor up to no differences between the report levels:

It could look like the ESLint output, grouped by file name:

/absolute/path/to/some/js/file.js
    1:1  warning  Replace global call of "sap.ui.thirdparty.jquery" with "jQuery" (replaceGlobals)
  500:42 warning  Add dependency for "jQuery" (amdCleanup)

✖ 2 problems (0 error, 2 warnings)

As most of the developers are already familiar with this logging format, it would be great if you could adopt it. If you don't want to change it, it would also be feasible for us if there were a concept for pluggable Reporters where we could add a custom implementation for the reporting only.

Thank you for your help with this! 🙂

Best regards, Dominic

Thodd commented 5 years ago

Hi Dominic,

we started an RFC for optimizing the logging mechanisms: https://github.com/SAP/ui5-migration/pull/42

The RFC focuses mainly on internal refactorings, but the intended solution aims to allow for much better logging support.

BR, Thorsten