The project has a ui5.yaml configuring ui5-tooling-transpile 3.0.0 or later, and karma 6.4.1 or later The karma-ui5 plugin is installed alongside it, which the README calls obligatory because the configuration is read from it
karma-ui5-transpile
A Karma preprocessor that transpiles a UI5 project's sources with the ui5-tooling-transpileui5-tooling-transpileA UI5 CLI extension that transpiles modern JavaScript or TypeScript during the UI5 build, with a transformJSX option that handles JSX and TSX in the same step.community org, ui5 configuration in its ui5.yaml.
A UI5 project that writes TypeScript or modern JavaScript and builds it with ui5-tooling-transpileui5-tooling-transpileA UI5 CLI extension that transpiles modern JavaScript or TypeScript during the UI5 build, with a transformJSX option that handles JSX and TSX in the same step.community org, ui5 needs the same transpiling before Karma can run and measure it. The ui5-transpile preprocessor, set per path in karma.conf.js, reads that configuration from ui5.yaml, or from the file karma-ui5's configPath names, which is how code coverage is collected for such a project. It needs karma 6.4.1 or later, ui5-tooling-transpile 3.0.0 or later, and the karma-ui5 plugin, which the README calls obligatory because the configuration is read from it. The README marks it deprecated along with the karma-ui5 plugin and points to the testing projects listed on bestofui5.org.
This project has been deprecated. We recommend you to pick a successor from the [available UI5 community projects](https://bestofui5.org/#/packages?tokens=testing:tag).karma-ui5-transpile — README, deprecation notice
Facts
Where it sits
Who is behind it
In the atlas: maintains 14, contributes to 80, wrote 2@petermuessigUI5 CommunityUI5 CommunityMaintains this
In the atlas: maintains 69@ui5-communitymaintainersFlorian VogtContributes to this
In the atlas: contributes to 50, wrote 4@flovogtLukas Theis (MuwuM)Contributes to this
In the atlas: contributes to 7@MuwuM2 contributors
What it declares
Every artifact
- Type
- Package
- Origin
- By a community org
As a package
- Where it runs
- does not say
- Distributed through
- does not say
For UI5 testing
- Supports
- Code coverage
Tasks this contributes to
Run a UI5 project's existing QUnit and OPA5 pages unattendedThe test pages a project already has run from one command, with nobody opening them in a browser tab, and the run leaves a report a pipeline can read.
Connections
Unit, integration and end-to-end tests for UI5 apps
UI5 CLI extension transpiling code during the UI5 build
Download
Install
npm add karma-ui5-transpileDerived from the package name. No recipe recorded; the README has the configuration.
README
quoted from ui5-community/ui5-ecosystem-showcase under Apache-2.0, readkarma-ui5-transpile [DEPRECATED]
⚠️ This project has been deprecated. We recommend you to pick a successor from the available UI5 community projects. For more information see Deprecation of karma-ui5 plugin.
👋 This is an open‑source, community‑driven project, developed and actively monitored by members of the UI5 community. You are welcome to use it, report issues, contribute enhancements, and support others in the community.
The karma-ui5-transpile preprocessor transpiles code of UI5 projects having a ui5.yaml using ui5-tooling-transpile UI5 CLI extension. This preprocesser is usable for Karma testing to transpile your resources before testing (i.e. TypeScript compilation for later usage of the karma-coverage plugin).
Prerequisites
The plugin requires karma >=6.4.1, and ui5-tooling-transpile >=3.0.0.
Installation
You can install the required dependencies with the following command:
npm install --save-dev karma karma-coverage ui5-tooling-transpile karma-ui5 karma-ui5-transpile
The usage of the karma-ui5 plugin is obligatory as it integrates UI5 into the Karma testing flow although it is not directly necessary for the karma-ui5-transpile plugin. Only the configuration is read from the karma-ui5 plugin. The plugin karma-coverage is also optional as it can be used for the creation of the coverage report. As a preprocessor it is not needed when using karma-ui5-transpile.
Configuration
See ui5-tooling-transpile for more details about the possible configurations in the ui5.yaml of your UI5 project.
If you have a custom ui5.yaml for testing the plugin reads the configuration from the karma-ui5 plugin, i.e.:
module.exports = function (config) {
config.set({
[...]
ui5: {
configPath: "ui5-dist.yaml",
},
[...]
});
};
Code Coverage for UI5 projects using ui5-tooling-transpile
To enable code coverage for your UI5 project using ui5-tooling-transpile, you can install and use the karma-ui5-transpile to preprocess your source files of your project. It uses the same configuration as the ui5-tooling-transpile and karma-ui5.
Let's assume you already use the UI5 CLI extension ui5-tooling-transpile and all is configured properly in ui5.yaml. To add code coverage, we first need to install all required dependencies karma, karma-ui5, karma-ui5-transpile, karma-coverage, and karma-chrome-launcher which are needed for the automated execution of your e.g. QUnit or OPA tests:
npm install --save-dev karma karma-ui5 karma-ui5-transpile karma-coverage karma-chrome-launcher
Second, in your karma.conf.js (or better you create separate ones for different scenarios), you need to configure the preprocessor ui5-transpile for which local paths is should run. Below we use the preprocessor for all .ts resources in the webapp folder - also defining multiple folders is possible, e.g. src/**/*.ts and test/**/*.ts for typical UI5 library projects:
module.exports = function (config) {
config.set({
frameworks: ["ui5"],
browsers: ["Chrome"],
reporters: ["progress", "coverage"],
preprocessors: {
"webapp/**/*.ts": ["ui5-transpile"],
},
coverageReporter: {
dir: "coverage",
reporters: [
{ type: "html", subdir: "report-html" },
{ type: "cobertura", subdir: ".", file: "cobertura.txt" },
{ type: "lcovonly", subdir: ".", file: "report-lcovonly.txt" },
{ type: "text-summary" },
],
},
});
};
⚠️ When using the ui5-transpile preprocessor please avoid using the coverage preprocessor as the instrumentation will also take place during the ui5-transpile Babel transformation process. If you use both, you will see a warning in the console and instrument your source files twice!
That's it! Now, you are able to run your coverage tests with Karma for your TypeScript-based UI5 projects. To do so, just run:
karma start
If you are interested in out of the box examples, you can find them in the UI5 Ecosystem Showcase repository within the showcases folder:
The TypeScript-based projects genereted with Easy UI5 soon contain the setup for coverage testing with Karma for the QUnit and for OPA testing.
Support
Please use the GitHub bug tracking system to post questions, bug reports or to create pull requests.
Contributing
Any type of contribution (code contributions, pull requests, issues) to this set of UI5 CLI extensions will be equally appreciated.
License
This work is licensed under Apache 2.0.
Built with care (and a lot of caffeine). If this helped you build, test, or ship, the next coffee — or drink — is on you when you bump into a contributor.
History
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Notes
Note: Version bump only for package karma-ui5-transpile
Others providing
Compare all 14 on the UI5 testing page →- ui5-test-runnerui5-test-runnerA standalone command line that runs a UI5 project's QUnit and OPA test pages in parallel browser instances, written for suites too large for one browser, and merges their coverage into one report.independent, ui5Command line running UI5 QUnit and OPA tests in parallel
- ui5-middleware-odata-recorderui5-middleware-odata-recorderA UI5 server middleware that records the OData traffic a running app makes against a real backend and writes entity JSON files and metadata.xml that the Fiori elements mock server can replay.independent, ui5UI5 middleware recording OData traffic as mock server datasets
- jest-environment-ui5jest-environment-ui5A Jest test environment named ui5 that boots UI5 from a local HTML file into jsdom, so UI5 unit tests run in Node.js with no web server and no browser.independent, ui5Jest environment running UI5 unit tests in Node.js
- openui5-smart-mockserveropenui5-smart-mockserverAn extended UI5 MockServer that generates meaningful mock data with Faker.js, from the metadata's sap:semantics annotations or from rules that map an OData property to a Faker method.independent, ui5UI5 MockServer extension generating mock data with Faker.js
- vitest-environment-ui5vitest-environment-ui5A Vitest environment named ui5 that boots UI5 from a local HTML file into jsdom, so UI5 unit tests run in Node.js with no web server and no browser.independent, ui5Vitest environment running UI5 unit tests in Node.js
- wdio-qunit-servicewdio-qunit-serviceA WebdriverIO service that runs QUnit HTML test pages in a browser and reports the results as WebdriverIO test suites, presented as a drop-in replacement for Karma-based QUnit setups.independent, ui5WebdriverIO service running QUnit test pages
- @openui5/sap.ui.core@openui5/sap.ui.coreThe OpenUI5 core: the module loader, the MVC runtime, data binding, routing, theming and the test stack, which is everything a UI5 app does before a single community package is added.sap official, ui5Framework core: module loader, MVC runtime, binding, routing, theming
- ui5-journey-recorderui5-journey-recorderA Chrome extension that records clicks and inputs against a running UI5 app and generates OPA5 or wdi5 end-to-end test code from the recorded journey.community org, ui5Chrome extension generating OPA5 or wdi5 tests from recorded journeys
- wdi5-cucumberwdi5-cucumberA wdi5 plugin that extends wdi5's end-to-end testing with Cucumber-style BDD scenarios, run against UI5 Fiori Elements apps.community org, ui5wdi5 plugin for Cucumber-style BDD tests on Fiori Elements apps
- wdi5-fe-selectorswdi5-fe-selectorsA set of wdi5-flavoured control selectors tuned for locating controls in Fiori Elements apps, extending the selectors wdi5 itself provides.community org, ui5wdi5 selectors for locating controls in Fiori Elements apps
- wdio-ui5-servicewdio-ui5-serviceEnd-to-end testing for UI5 as a WebdriverIO service that drives a real browser through UI5's own test API, so a test addresses controls with OPA5-compatible selectors rather than DOM nodes.community org, ui5End-to-end testing for UI5 on WebdriverIO with UI5 control selectors
- @ui5/middleware-code-coverage@ui5/middleware-code-coverageUI5 CLI server middleware that instruments a project's JavaScript files with Istanbul as the dev server sends them, and generates the coverage report from the records the OpenUI5 QUnit tests send back.sap official, ui5UI5 CLI middleware for Istanbul code coverage
- vscode-ui5-odata-mock-generatorvscode-ui5-odata-mock-generatorVS Code extension that generates JSON mock data files for an OData service from its metadata, with faker.js values, per-set sizes, value lists and values tied to other properties.independent, ui5VS Code extension generating OData mock data from service metadata
Details
Sources
Sources are graph entities: the same page may back several entries, and an unreachable source flags every row that rests on it.
Compatibility and provenance
Contributors
History in the atlas
- The README's own notice, which the description already paraphrased, was not recorded as the maker's dated statement. It is quoted here and shown as plain text: the maintainer's claim, not a reading and not a tier.
- two quoted sources and the coverage_report property
- The same sentence, with why karma-ui5 is needed.
- First seen.
For your agent
- Ref
artifact:ui5-community-karma-ui5-transpile- JSON
- /artifacts/ui5-community-karma-ui5-transpile.json
- MCP
- Connecting an agent