Repository navigation
Conversation
Member
Author
|
Follows #373 |
flovogt
force-pushed
the
linter-tutorial
branch
from
November 12, 2026 08:40
1d78e09 to
035e185
Compare
There was a problem hiding this comment.
🟡 Changes recommended
The suite registers nonexistent test pages, blocking the documented test run, and the controller examples contain syntax and mobile-layout defects.
7 open issues
Register the existing unit page and remove the missing integration page · New Update shared guidance for the documentation-only JavaScript tutorial · New Initialize and commit the starter before relying on git diff · New Close onInit before closing the controller definition · New Limit the autofix checkpoint to onAfterRendering findings · New Enable Markdown parsing for fenced code in the disclosures · New Preserve isMobile when replacing the merge API · New
What changed in this PR
Adds a hands-on UI5 linter tutorial to the OpenUI5 tutorial site, guiding readers through modernizing an intentionally legacy Todo application.
Changes:
- Introduces seven lessons covering setup, diagnostics, autofix, manual migration, and ongoing linting.
- Supplies a starter application with localized UI, sample data, and QUnit tests.
- Registers the documentation-only tutorial in the site overview and step index.
| File | Description |
|---|---|
README.md |
Links the new tooling tutorial. |
packages/linter/steps/07/README.md |
Catalogs legacy findings by file. |
packages/linter/steps/06/README.md |
Documents lint scripts and CI integration. |
packages/linter/steps/05/README.md |
Explains manual API, manifest, CSP, and test migrations. |
packages/linter/steps/04/README.md |
Demonstrates autofix and blocked fixes. |
packages/linter/steps/03/README.md |
Summarizes rules and autofix scope. |
packages/linter/steps/02/README.md |
Introduces reports and detailed diagnostics. |
packages/linter/steps/01/README.md |
Covers installation and starter setup. |
packages/linter/steps.json |
Indexes seven documentation-only steps. |
packages/linter/README.md |
Introduces the exercise and links lessons. |
packages/linter/assets/linter-app/webapp/view/App.view.xml |
Defines the Todo interface to modernize. |
packages/linter/assets/linter-app/webapp/util/Helper.js |
Supplies a legacy global helper. |
packages/linter/assets/linter-app/webapp/test/unit/unitTests.qunit.js |
Loads controller unit tests. |
packages/linter/assets/linter-app/webapp/test/unit/legacyTests.qunit.js |
Bootstraps legacy QUnit tests. |
packages/linter/assets/linter-app/webapp/test/unit/legacyTests.qunit.html |
Hosts the legacy unit-test runner. |
packages/linter/assets/linter-app/webapp/test/unit/controller/App.controller.js |
Tests Todo controller behavior. |
packages/linter/assets/linter-app/webapp/test/testsuite.qunit.js |
Registers legacy test pages. |
packages/linter/assets/linter-app/webapp/test/testsuite.qunit.html |
Provides the test-suite entry page. |
packages/linter/assets/linter-app/webapp/model/todoitems.json |
Seeds the Todo model. |
packages/linter/assets/linter-app/webapp/manifest.json |
Includes app configuration targeted for migration. |
packages/linter/assets/linter-app/webapp/index.html |
Supplies legacy bootstrap settings and inline configuration. |
packages/linter/assets/linter-app/webapp/i18n/i18n.properties |
Provides default UI strings. |
packages/linter/assets/linter-app/webapp/i18n/i18n_en.properties |
Provides English UI strings. |
packages/linter/assets/linter-app/webapp/i18n/i18n_de.properties |
Provides German UI strings. |
packages/linter/assets/linter-app/webapp/css/styles.css |
Visually marks completed items. |
packages/linter/assets/linter-app/webapp/controller/App.controller.js |
Implements Todo behavior using deliberate legacy patterns. |
packages/linter/assets/linter-app/webapp/Component.js |
Defines the starter UI5 component. |
packages/linter/assets/linter-app/ui5.yaml |
Configures UI5 libraries and coverage middleware. |
packages/linter/assets/linter-app/package.json |
Defines starter scripts and development dependencies. |
packages/linter/assets/linter-app/eslint.config.mjs |
Configures JavaScript checks. |
packages/linter/assets/linter-app/.npmrc |
Sets starter installation defaults. |
Review effort: Max
flovogt
force-pushed
the
linter-tutorial
branch
from
November 12, 2026 15:20
131d779 to
aa75c24
Compare
Member
Author
|
Open findings: Critical (breaks the app at runtime):
Broken test infrastructure:
Tutorial content vs. actual source mismatches (breaks learner trust):
Minor:
|
Introduces a 7-step tutorial showing how UI5 linter can support modernizing OpenUI5 apps: - Step 01: Introduction & Setup - Step 02: Running UI5 linter — First Analysis - Step 03: Understanding Linter Rules - Step 04: Auto-fixing Issues - Step 05: Manual Fixes - Step 06: Best Practices - Step 07: Appendix: Legacy Patterns Reference Inspired by https://github.com/SAP-samples/ui5con-2026-ui5-linter-workshop.
flovogt
force-pushed
the
linter-tutorial
branch
from
November 13, 2026 12:37
aa75c24 to
4c52dd5
Compare
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.


Introduces a 7-step tutorial showing how UI5 linter can support modernizing OpenUI5 apps:
Inspired by https://github.com/SAP-samples/ui5con-2026-ui5-linter-workshop.