From 97b03e4d7818bb4a29363335edb566c2c740cf68 Mon Sep 17 00:00:00 2001 From: Yavor Ivanov Date: Tue, 1 Oct 2024 11:25:48 +0300 Subject: [PATCH 1/7] fix: Update documentation --- README.md | 44 ++++++++++++++++++++++++++++++++++++-------- 1 file changed, 36 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 6ea66d9b7..c730fa27e 100644 --- a/README.md +++ b/README.md @@ -46,10 +46,10 @@ npm install --save-dev @ui5/linter ## Usage -Run the `ui5lint` command in your project root folder +Run the `ui5lint [files...]` command in your project root folder ```sh -ui5lint +> ui5lint UI5 linter report: @@ -73,17 +73,45 @@ UI5 linter report: Note: Use "ui5lint --details" to show more information about the findings ``` -### Options +You can provide multiple glob patterns as arguments after the `ui5lint` command to filter and narrow down the linting results. -#### `--file-paths` +```sh +> ui5lint webapp/**/* -Specify which files to lint by providing a list of file paths. +UI5 linter report: -**Example:** -```sh -ui5lint --file-paths webapp/controller/App.controller.js webapp/view/App.view.xml +/webapp/Component.js + 3:9 error Component is not configured for asynchronous loading. + +/webapp/controller/App.controller.js + 7:2 error Deprecated access of enum pseudo module 'sap/ui/core/BarColor' + 26:22 error Access of global variable 'jQuery' (jQuery) + 27:32 error Call to deprecated function 'control' (avatarDOM.control) + 36:6 error Use of deprecated property 'tap' of class 'Button' + 136:18 error Access of global variable 'sap' (sap.ui.getCore) + 136:25 error Call to deprecated function 'getCore' (sap.ui.getCore) + 136:35 error Call to deprecated function 'byId' of class 'Core' + +/webapp/index.html + 13:3 warning Outdated spelling of bootstrap parameter: 'data-sap-ui-resourceRoots'; should be written as 'data-sap-ui-resource-roots' + 16:3 warning Outdated spelling of bootstrap parameter: 'data-sap-ui-onInit'; should be written as 'data-sap-ui-on-init' + 17:3 warning Outdated spelling of bootstrap parameter: 'data-sap-ui-compatVersion'; should be written as 'data-sap-ui-compat-version' + +/webapp/manifest.json + 14:17 error Use of deprecated library 'sap.ui.commons' + +/webapp/view/App.view.xml + 7:8 error Import of deprecated module 'sap/f/Avatar' + +13 problems (10 errors, 3 warnings) + +Note: Use "ui5lint --details" to show more information about the findings ``` + + +### Options + #### `--details` Show more information about the findings and how to fix them. From 089d0900536b19f9705dba18517a47a278856dc4 Mon Sep 17 00:00:00 2001 From: Yavor Ivanov Date: Tue, 1 Oct 2024 15:46:24 +0300 Subject: [PATCH 2/7] docs: Update README.md Co-authored-by: Merlin Beutlberger --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c730fa27e..e0394bea2 100644 --- a/README.md +++ b/README.md @@ -73,7 +73,7 @@ UI5 linter report: Note: Use "ui5lint --details" to show more information about the findings ``` -You can provide multiple glob patterns as arguments after the `ui5lint` command to filter and narrow down the linting results. +You can provide multiple glob patterns as arguments after the `ui5lint` command to filter and narrow down the linting results. Note: this can't be used to include files that normally wouldn't be checked (e.g. files outside of `webapp` in application projects) ```sh > ui5lint webapp/**/* From d38a9e67191a3d6e9a33cda6e22ad2d1055fa12e Mon Sep 17 00:00:00 2001 From: Yavor Ivanov Date: Tue, 1 Oct 2024 16:08:37 +0300 Subject: [PATCH 3/7] docs: Update Readme --- README.md | 26 +++----------------------- 1 file changed, 3 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index e0394bea2..12730b60d 100644 --- a/README.md +++ b/README.md @@ -76,34 +76,14 @@ Note: Use "ui5lint --details" to show more information about the findings You can provide multiple glob patterns as arguments after the `ui5lint` command to filter and narrow down the linting results. Note: this can't be used to include files that normally wouldn't be checked (e.g. files outside of `webapp` in application projects) ```sh -> ui5lint webapp/**/* +> ui5lint "webapp/**/*.xml" UI5 linter report: -/webapp/Component.js - 3:9 error Component is not configured for asynchronous loading. - -/webapp/controller/App.controller.js - 7:2 error Deprecated access of enum pseudo module 'sap/ui/core/BarColor' - 26:22 error Access of global variable 'jQuery' (jQuery) - 27:32 error Call to deprecated function 'control' (avatarDOM.control) - 36:6 error Use of deprecated property 'tap' of class 'Button' - 136:18 error Access of global variable 'sap' (sap.ui.getCore) - 136:25 error Call to deprecated function 'getCore' (sap.ui.getCore) - 136:35 error Call to deprecated function 'byId' of class 'Core' - -/webapp/index.html - 13:3 warning Outdated spelling of bootstrap parameter: 'data-sap-ui-resourceRoots'; should be written as 'data-sap-ui-resource-roots' - 16:3 warning Outdated spelling of bootstrap parameter: 'data-sap-ui-onInit'; should be written as 'data-sap-ui-on-init' - 17:3 warning Outdated spelling of bootstrap parameter: 'data-sap-ui-compatVersion'; should be written as 'data-sap-ui-compat-version' - -/webapp/manifest.json - 14:17 error Use of deprecated library 'sap.ui.commons' - -/webapp/view/App.view.xml +webapp/view/App.view.xml 7:8 error Import of deprecated module 'sap/f/Avatar' -13 problems (10 errors, 3 warnings) +1 problems (1 errors, 0 warnings) Note: Use "ui5lint --details" to show more information about the findings ``` From b0890dfe0c04f4d50059a7a1bb0e773efa420c02 Mon Sep 17 00:00:00 2001 From: Yavor Ivanov Date: Tue, 1 Oct 2024 16:10:49 +0300 Subject: [PATCH 4/7] docs: Update readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 12730b60d..d62fd395b 100644 --- a/README.md +++ b/README.md @@ -73,7 +73,7 @@ UI5 linter report: Note: Use "ui5lint --details" to show more information about the findings ``` -You can provide multiple glob patterns as arguments after the `ui5lint` command to filter and narrow down the linting results. Note: this can't be used to include files that normally wouldn't be checked (e.g. files outside of `webapp` in application projects) +You can provide multiple glob patterns as arguments after the `ui5lint` command to filter and narrow down the linting results. **Note**: this can't be used to include files that normally wouldn't be checked (e.g. files outside of `webapp` in application projects) ```sh > ui5lint "webapp/**/*.xml" From f35835d4ec7dc98c84571ced4ceacf106d2055fe Mon Sep 17 00:00:00 2001 From: Yavor Ivanov Date: Tue, 1 Oct 2024 16:14:57 +0300 Subject: [PATCH 5/7] docs: Add POSIX separator requirement for the glob patterns --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d62fd395b..e3a191ac1 100644 --- a/README.md +++ b/README.md @@ -73,7 +73,11 @@ UI5 linter report: Note: Use "ui5lint --details" to show more information about the findings ``` -You can provide multiple glob patterns as arguments after the `ui5lint` command to filter and narrow down the linting results. **Note**: this can't be used to include files that normally wouldn't be checked (e.g. files outside of `webapp` in application projects) +You can provide multiple glob patterns as arguments after the `ui5lint` command to filter and narrow down the linting results. + +**Note**: this can't be used to include files that normally wouldn't be checked (e.g. files outside of `webapp` in application projects) + +**Note**: Only POSIX separators are allowed, regardless of the target platform. ```sh > ui5lint "webapp/**/*.xml" From d80f30ae1f3f12e791a8baf8249ae186b2864dd0 Mon Sep 17 00:00:00 2001 From: Yavor Ivanov Date: Tue, 1 Oct 2024 16:16:53 +0300 Subject: [PATCH 6/7] docs: Make samples related --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e3a191ac1..97c7843b4 100644 --- a/README.md +++ b/README.md @@ -80,14 +80,15 @@ You can provide multiple glob patterns as arguments after the `ui5lint` command **Note**: Only POSIX separators are allowed, regardless of the target platform. ```sh -> ui5lint "webapp/**/*.xml" +> ui5lint "application/webapp/**/*.xml" UI5 linter report: -webapp/view/App.view.xml - 7:8 error Import of deprecated module 'sap/f/Avatar' +/application/webapp/view/Main.view.xml + 16:39 error Import of deprecated module 'sap/m/MessagePage' + 22:5 error Use of deprecated property 'blocked' of class 'Button' -1 problems (1 errors, 0 warnings) +2 problems (2 errors, 0 warnings) Note: Use "ui5lint --details" to show more information about the findings ``` From c9f2daf521ce4079cecea0ce177f563ee32462ae Mon Sep 17 00:00:00 2001 From: Yavor Ivanov Date: Wed, 2 Oct 2024 10:09:48 +0300 Subject: [PATCH 7/7] docs: Update README.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Günter Klatt <57760635+KlattG@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 97c7843b4..aaa83d99a 100644 --- a/README.md +++ b/README.md @@ -75,7 +75,7 @@ Note: Use "ui5lint --details" to show more information about the findings You can provide multiple glob patterns as arguments after the `ui5lint` command to filter and narrow down the linting results. -**Note**: this can't be used to include files that normally wouldn't be checked (e.g. files outside of `webapp` in application projects) +**Note**: This option does not permit you to include files that normally wouldn't be checked (e.g. files outside of the `webapp` folder in application projects). **Note**: Only POSIX separators are allowed, regardless of the target platform.