feat: Add new output format markdown #258
Conversation
|
Any reason why text path is the full path and json is relativ?: Text: JSON: |
|
Thank you very much for this PR! We'll discuss it in the team and get back to you.
The full path in the text output allows you to jump directly to the finding in some IDEs. In VSCode for example, such paths will be rendered as a link that you can "ctrl+click" to open the file and even scroll to the correct position in the file. Since the JSON output is not intended for direct consumption by developers but rather for automated reportings or statistics, we decided to keep the paths relative to save on file size and to not include potentially sensitive path segments from a developers local system. ESLint always uses absolute paths in its output: https://eslint.org/docs/latest/use/formatters/#stylish |
|
I reviewed the code already last week and have no objections. Regarding the paths I think we should format them relative to the project root. In addition, we played around with the PR and found the formatting was not ideal in all cases. Especially when there are many findings in a single file, and some are warnings while others are errors (or fatal errors) we should think whether a sorting based on the severity (and then by position) makes sense. I'm also unsure of the use of emojis for illustrating the severity. I believe the two circles 🟡 🔴 might be hard to distinguish for individuals with visual impairment. We have an intern this summer (@konnraad) and tasked him with creating a table-version based on your PR, see below. He also added the mentioned sorting based on severity. Please let us know what you think: Table output sampleUI5 Linter ReportFindings per Fileui5.yaml
webapp/Component.js
webapp/controller/App.controller.js
webapp/manifest.json
webapp/view/App.view.xml
webapp/view/Demo.view.xml
Summary
The drawback when using a table is that it's harder to read in plain-text or in the console output compared to your initial proposal. But we are not sure whether this is a valid use case for you anyways. Should we focus on having a nice format in the rendered markdown or is the plain text format important as well? (CC: @marcelschork) Looking forward to your feedback. Our intern is also standing by to make the necessary changes depending on what we agree on 😉 |
|
Hi Merlin, I actually don't have (yet) a use case for markdown. I actually tried to implement the |
|
@RandomByte I very much like the table format because the readability is much better now (which is essential for PR decoration). I think if somebody choose the format option |
Grouping by rules has been removed with SAP#6 but it was missed to remove the corresponding data structures.
|
|
|
We moved the summary to the top. Sorting is now by severity (order: Fatal Errors, Errors, Warnings), then line, then column. The output looks like this now: Updated Table output sampleUI5 linter ReportSummary
Findingsui5.yaml
webapp/Component.js
webapp/controller/App.controller.js
webapp/manifest.json
webapp/view/App.view.xml
webapp/view/Demo.view.xml
|
|
@marianfoo we appreciate your opinion on the current state of this PR. If you are satisfied with the current state we will follow-up with the merge of the PR and produce a new release. |
|
Released with https://github.com/SAP/ui5-linter/releases/tag/v0.3.4. Thanks a lot @marianfoo for your contribution! |
fix #178
Added new
markdownoption for output as suggested in the issue.Added tests for output.
Here is a sample output with
ui5lint --format markdown --details:Markdown output sample
UI5 Linter Report
/Users/marianzeis/DEV//webapp/control/DynamicCompartmentBox.ts
write. Typically,writeis used to create a longer sequence of HTML markup (e.g. an element with attributes and children) in a single call. Such a markup sequence has to be split into the individual calls of the Semantic Rendering API.write. Typically,writeis used to create a longer sequence of HTML markup (e.g. an element with attributes and children) in a single call. Such a markup sequence has to be split into the individual calls of the Semantic Rendering API.write. Typically,writeis used to create a longer sequence of HTML markup (e.g. an element with attributes and children) in a single call. Such a markup sequence has to be split into the individual calls of the Semantic Rendering API./Users/marianzeis/DEV//webapp/control/DynamicCompartmentBoxItem.ts
write. Typically,writeis used to create a longer sequence of HTML markup (e.g. an element with attributes and children) in a single call. Such a markup sequence has to be split into the individual calls of the Semantic Rendering API.write. Typically,writeis used to create a longer sequence of HTML markup (e.g. an element with attributes and children) in a single call. Such a markup sequence has to be split into the individual calls of the Semantic Rendering API.write. Typically,writeis used to create a longer sequence of HTML markup (e.g. an element with attributes and children) in a single call. Such a markup sequence has to be split into the individual calls of the Semantic Rendering API./Users/marianzeis/DEV//webapp/localService/mockserver.js
/Users/marianzeis/DEV//webapp/util/Util.ts
/Users/marianzeis/DEV//webapp/view/Source.view.xml
enableExportproperty.rowModeaggregation instead.rootLevelbinding parameter. May not work with all bindings.numberOfExpandedLevelsbinding parameter. May not work with all bindings./Users/marianzeis/DEV//webapp/view/Target.view.xml
rowModeaggregation instead./Users/marianzeis/DEV//webapp/view/TargetBadHU.view.xml
rowModeaggregation instead.Summary
Text output sample
JSON output sample
[ { "filePath": "webapp/util/Util.ts", "messages": [ { "ruleId": "ui5-linter-no-deprecated-api", "severity": 2, "line": 24, "column": 59, "message": "Call to deprecated function 'getLanguage' of class 'Configuration'", "messageDetails": "(since 1.119) - Please use Localization.getLanguage (https://ui5.sap.com/1.120/#/api/module:sap/base/i18n/Localization%23methods/sap/base/i18n/Localization.getLanguage)instead." }, { "ruleId": "ui5-linter-no-deprecated-api", "severity": 2, "line": 24, "column": 40, "message": "Call to deprecated function 'getConfiguration' of class 'Core'", "messageDetails": "(since 1.120) - Please see Configuration (https://ui5.sap.com/1.120/#/api/sap.ui.core.Configuration) for the corrsponding\nreplacements." }, { "ruleId": "ui5-linter-no-deprecated-api", "severity": 2, "line": 24, "column": 30, "message": "Call to deprecated function 'getCore' (sap.ui.getCore)", "messageDetails": "(since 1.118) - Please require 'sap/ui/core/Core' instead and use the module export directly\nwithout using 'new'.\"" }, { "ruleId": "ui5-linter-no-globals-js", "severity": 2, "line": 24, "column": 23, "message": "Access of global variable 'sap' (sap.ui.getCore)" } ], "errorCount": 4, "warningCount": 0, "fatalErrorCount": 0 }, { "filePath": "webapp/view/TargetBadHU.view.xml", "messages": [ { "ruleId": "ui5-linter-no-deprecated-api", "severity": 2, "line": 89, "column": 17, "message": "Use of deprecated property 'visibleRowCount' of class 'Table'", "messageDetails": "(since 1.119) - use the `rowMode` aggregation instead." } ], "errorCount": 1, "warningCount": 0, "fatalErrorCount": 0 }, { "filePath": "webapp/view/Target.view.xml", "messages": [ { "ruleId": "ui5-linter-no-deprecated-api", "severity": 2, "line": 120, "column": 29, "message": "Use of deprecated property 'visibleRowCount' of class 'TreeTable'", "messageDetails": "(since 1.119) - use the `rowMode` aggregation instead." } ], "errorCount": 1, "warningCount": 0, "fatalErrorCount": 0 }, { "filePath": "webapp/view/Source.view.xml", "messages": [ { "ruleId": "ui5-linter-no-deprecated-api", "severity": 2, "line": 143, "column": 41, "message": "Use of deprecated property 'visibleRowCount' of class 'TreeTable'", "messageDetails": "(since 1.119) - use the `rowMode` aggregation instead." }, { "ruleId": "ui5-linter-no-deprecated-api", "severity": 2, "line": 143, "column": 61, "message": "Use of deprecated property 'rootLevel' of class 'TreeTable'", "messageDetails": "(since 1.76) - replaced by the `rootLevel` binding parameter. May not work with all bindings." }, { "ruleId": "ui5-linter-no-deprecated-api", "severity": 2, "line": 143, "column": 75, "message": "Use of deprecated property 'expandFirstLevel' of class 'TreeTable'", "messageDetails": "(since 1.46.3) - replaced by the `numberOfExpandedLevels` binding parameter. May not work\nwith all bindings." }, { "ruleId": "ui5-linter-no-deprecated-api", "severity": 2, "line": 111, "column": 37, "message": "Use of deprecated property 'useExportToExcel' of class 'SmartTable'", "messageDetails": "(since 1.100) - replaced by `enableExport` property." } ], "errorCount": 4, "warningCount": 0, "fatalErrorCount": 0 }, { "filePath": "webapp/localService/mockserver.js", "messages": [ { "ruleId": "ui5-linter-no-deprecated-api", "severity": 2, "line": 16, "column": 34, "message": "Use of deprecated API 'jQuery.sap.getUriParameters'", "messageDetails": "since 1.58. To avoid usage of global variables in general, please\ndo not use the jQuery.sap namespace any longer. Most of the jQuery.sap functionalities\nare replaced by alternative modules which can be found in the API doc." }, { "ruleId": "ui5-linter-no-deprecated-api", "severity": 2, "line": 17, "column": 33, "message": "Use of deprecated API 'jQuery.sap.getModulePath'", "messageDetails": "since 1.58. To avoid usage of global variables in general, please\ndo not use the jQuery.sap namespace any longer. Most of the jQuery.sap functionalities\nare replaced by alternative modules which can be found in the API doc." }, { "ruleId": "ui5-linter-no-deprecated-api", "severity": 2, "line": 18, "column": 32, "message": "Use of deprecated API 'jQuery.sap.getModulePath'", "messageDetails": "since 1.58. To avoid usage of global variables in general, please\ndo not use the jQuery.sap namespace any longer. Most of the jQuery.sap functionalities\nare replaced by alternative modules which can be found in the API doc." }, { "ruleId": "ui5-linter-no-deprecated-api", "severity": 2, "line": 22, "column": 29, "message": "Use of deprecated API 'jQuery.sap.syncGetJSON'", "messageDetails": "since 1.58. To avoid usage of global variables in general, please\ndo not use the jQuery.sap namespace any longer. Most of the jQuery.sap functionalities\nare replaced by alternative modules which can be found in the API doc." }, { "ruleId": "ui5-linter-no-deprecated-api", "severity": 2, "line": 25, "column": 32, "message": "Use of deprecated API 'jQuery.sap.getModulePath'", "messageDetails": "since 1.58. To avoid usage of global variables in general, please\ndo not use the jQuery.sap namespace any longer. Most of the jQuery.sap functionalities\nare replaced by alternative modules which can be found in the API doc." }, { "ruleId": "ui5-linter-no-deprecated-api", "severity": 2, "line": 81, "column": 13, "message": "Use of deprecated API 'jQuery.sap.log.info'", "messageDetails": "since 1.58. To avoid usage of global variables in general, please\ndo not use the jQuery.sap namespace any longer. Most of the jQuery.sap functionalities\nare replaced by alternative modules which can be found in the API doc." }, { "ruleId": "ui5-linter-no-deprecated-api", "severity": 2, "line": 87, "column": 37, "message": "Use of deprecated API 'jQuery.sap.getModulePath'", "messageDetails": "since 1.58. To avoid usage of global variables in general, please\ndo not use the jQuery.sap namespace any longer. Most of the jQuery.sap functionalities\nare replaced by alternative modules which can be found in the API doc." }, { "ruleId": "ui5-linter-no-deprecated-api", "severity": 2, "line": 100, "column": 37, "message": "Use of deprecated API 'jQuery.sap.require'", "messageDetails": "since 1.58. To avoid usage of global variables in general, please\ndo not use the jQuery.sap namespace any longer. Most of the jQuery.sap functionalities\nare replaced by alternative modules which can be found in the API doc." }, { "ruleId": "ui5-linter-no-deprecated-api", "severity": 2, "line": 102, "column": 56, "message": "Use of deprecated API 'jQuery.sap.sjax'", "messageDetails": "since 1.58. To avoid usage of global variables in general, please\ndo not use the jQuery.sap namespace any longer. Most of the jQuery.sap functionalities\nare replaced by alternative modules which can be found in the API doc." }, { "ruleId": "ui5-linter-no-deprecated-api", "severity": 2, "line": 107, "column": 62, "message": "Use of deprecated API 'jQuery.sap.serializeXML'", "messageDetails": "since 1.58. To avoid usage of global variables in general, please\ndo not use the jQuery.sap namespace any longer. Most of the jQuery.sap functionalities\nare replaced by alternative modules which can be found in the API doc." } ], "errorCount": 10, "warningCount": 0, "fatalErrorCount": 0 }, { "filePath": "webapp/control/DynamicCompartmentBoxItem.ts", "messages": [ { "ruleId": "ui5-linter-no-deprecated-api", "severity": 2, "line": 142, "column": 12, "message": "Call to deprecated function 'write' of class 'RenderManager'", "messageDetails": "(since 1.92) - Instead, use the Semantic Rendering API (https://ui5.sap.com/1.120/#/api/sap.ui.core.RenderManager).\nThere is no 1:1 replacement for `write`. Typically, `write` is used to create a longer sequence of HTML\nmarkup (e.g. an element with attributes and children) in a single call. Such a markup sequence has to\nbe split into the individual calls of the Semantic Rendering API." }, { "ruleId": "ui5-linter-no-deprecated-api", "severity": 2, "line": 147, "column": 12, "message": "Call to deprecated function 'writeControlData' of class 'RenderManager'", "messageDetails": "(since 1.92) - Instead use sap.ui.core.RenderManager#openStart (https://ui5.sap.com/1.120/#/api/sap.ui.core.RenderManager%23methods/openStart) or sap.ui.core.RenderManager#voidStart (https://ui5.sap.com/1.120/#/api/sap.ui.core.RenderManager%23methods/voidStart)\nof the Semantic Rendering API (https://ui5.sap.com/1.120/#/api/sap.ui.core.RenderManager) and pass the desired control data as\nthe second parameter to the new API." }, { "ruleId": "ui5-linter-no-deprecated-api", "severity": 2, "line": 167, "column": 16, "message": "Call to deprecated function 'write' of class 'RenderManager'", "messageDetails": "(since 1.92) - Instead, use the Semantic Rendering API (https://ui5.sap.com/1.120/#/api/sap.ui.core.RenderManager).\nThere is no 1:1 replacement for `write`. Typically, `write` is used to create a longer sequence of HTML\nmarkup (e.g. an element with attributes and children) in a single call. Such a markup sequence has to\nbe split into the individual calls of the Semantic Rendering API." }, { "ruleId": "ui5-linter-no-deprecated-api", "severity": 2, "line": 173, "column": 16, "message": "Call to deprecated function 'write' of class 'RenderManager'", "messageDetails": "(since 1.92) - Instead, use the Semantic Rendering API (https://ui5.sap.com/1.120/#/api/sap.ui.core.RenderManager).\nThere is no 1:1 replacement for `write`. Typically, `write` is used to create a longer sequence of HTML\nmarkup (e.g. an element with attributes and children) in a single call. Such a markup sequence has to\nbe split into the individual calls of the Semantic Rendering API." } ], "errorCount": 4, "warningCount": 0, "fatalErrorCount": 0 }, { "filePath": "webapp/control/DynamicCompartmentBox.ts", "messages": [ { "ruleId": "ui5-linter-no-deprecated-api", "severity": 2, "line": 81, "column": 7, "message": "Call to deprecated function 'writeControlData' of class 'RenderManager'", "messageDetails": "(since 1.92) - Instead use sap.ui.core.RenderManager#openStart (https://ui5.sap.com/1.120/#/api/sap.ui.core.RenderManager%23methods/openStart) or sap.ui.core.RenderManager#voidStart (https://ui5.sap.com/1.120/#/api/sap.ui.core.RenderManager%23methods/voidStart)\nof the Semantic Rendering API (https://ui5.sap.com/1.120/#/api/sap.ui.core.RenderManager) and pass the desired control data as\nthe second parameter to the new API." }, { "ruleId": "ui5-linter-no-deprecated-api", "severity": 2, "line": 104, "column": 9, "message": "Call to deprecated function 'write' of class 'RenderManager'", "messageDetails": "(since 1.92) - Instead, use the Semantic Rendering API (https://ui5.sap.com/1.120/#/api/sap.ui.core.RenderManager).\nThere is no 1:1 replacement for `write`. Typically, `write` is used to create a longer sequence of HTML\nmarkup (e.g. an element with attributes and children) in a single call. Such a markup sequence has to\nbe split into the individual calls of the Semantic Rendering API." }, { "ruleId": "ui5-linter-no-deprecated-api", "severity": 2, "line": 108, "column": 9, "message": "Call to deprecated function 'write' of class 'RenderManager'", "messageDetails": "(since 1.92) - Instead, use the Semantic Rendering API (https://ui5.sap.com/1.120/#/api/sap.ui.core.RenderManager).\nThere is no 1:1 replacement for `write`. Typically, `write` is used to create a longer sequence of HTML\nmarkup (e.g. an element with attributes and children) in a single call. Such a markup sequence has to\nbe split into the individual calls of the Semantic Rendering API." }, { "ruleId": "ui5-linter-no-deprecated-api", "severity": 2, "line": 129, "column": 7, "message": "Call to deprecated function 'write' of class 'RenderManager'", "messageDetails": "(since 1.92) - Instead, use the Semantic Rendering API (https://ui5.sap.com/1.120/#/api/sap.ui.core.RenderManager).\nThere is no 1:1 replacement for `write`. Typically, `write` is used to create a longer sequence of HTML\nmarkup (e.g. an element with attributes and children) in a single call. Such a markup sequence has to\nbe split into the individual calls of the Semantic Rendering API." } ], "errorCount": 4, "warningCount": 0, "fatalErrorCount": 0 } ]JIRA: CPOUI5FOUNDATION-890