{"id":16190858,"url":"https://github.com/vobu/ui5-codecompletion","last_synced_at":"2025-09-09T12:40:14.590Z","repository":{"id":52167745,"uuid":"102736922","full_name":"vobu/ui5-codecompletion","owner":"vobu","description":"DEPRECATED: UI5 now delivers TS-types that allows a more complete code completion at dev time: https://github.com/SAP/ui5-typescript/tree/master/packages/ts-typesnode (was: CLI for adding UI5 code completion to WebStorm)","archived":false,"fork":false,"pushed_at":"2021-05-06T16:03:54.000Z","size":2406,"stargazers_count":30,"open_issues_count":4,"forks_count":3,"subscribers_count":5,"default_branch":"develop","last_synced_at":"2025-02-28T15:11:27.827Z","etag":null,"topics":["ui5","webstorm"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vobu.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-09-07T12:55:22.000Z","updated_at":"2023-10-27T08:10:23.000Z","dependencies_parsed_at":"2022-09-26T16:50:34.619Z","dependency_job_id":null,"html_url":"https://github.com/vobu/ui5-codecompletion","commit_stats":null,"previous_names":["vobujs/ui5-codecompletion"],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vobu%2Fui5-codecompletion","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vobu%2Fui5-codecompletion/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vobu%2Fui5-codecompletion/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vobu%2Fui5-codecompletion/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vobu","download_url":"https://codeload.github.com/vobu/ui5-codecompletion/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243965717,"owners_count":20375920,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ui5","webstorm"],"created_at":"2024-10-10T07:44:19.697Z","updated_at":"2025-03-19T03:30:59.361Z","avatar_url":"https://github.com/vobu.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# UI5 codecompletion\n\n[![Build Status](https://travis-ci.org/vobu/ui5-codecompletion.svg?branch=develop)](https://travis-ci.org/vobu/ui5-codecompletion) \n[![npm Package](https://img.shields.io/npm/v/ui5-codecompletion.svg)](https://www.npmjs.com/package/ui5-codecompletion)\n\n`ui5-codecompletion` is a npm module providing a CLI that enables code completion in WebStorm's JS editor for a \nspecific version of [(open)UI5](https://openui5.org). \n\n![coding example](doc/usage.gif)\n\n* [Installation](#installation)\n* [Usage](#usage)\n  * [download, install and configure UI5 LTS version](#download-install-and-configure-ui5-lts-version)\n  * [download a custom version to a custom location and install and configure it for code completion](#download-a-custom-version-to-a-custom-location-and-install-and-configure-it-for-code-completion)\n  * [configure existing UI5 lib for use with code completion](#configure-existing-ui5-lib-for-use-with-code-completion)\n* [FAQ](#faq)\n* [Related](#related)\n* [Contributors](#contributors)\n\n## Installation\n    npm install -g ui5-codecompletion\n    \nYes, global install is recommended so you can install/configure code completion in any project.   \nStill, local install `npm install ui5-codecompletion` will of course provide you `node_modules/.bin/ui5-codecompletion`.\n    \n## Usage\n    $~ \u003e ui5-codecompletion -h\n    Usage: ui5-codecompletion \u003ccommand\u003e [options]\n    \n    Commands:\n      configure [sourceDir]  uses the extracted UI5 library in $project/\n      install [from] [to]    downloads (if URL) or copies (if fs path) and\n                             configures a UI5 runtime library for code completion\n    \n    Options:\n      -h, --help       Show help                                           [boolean]\n      -f, --from       URL or file system path to zip-file w/ UI5 runtime sources,\n                       defaults to latest OpenUI5 version available\n      -t, --to         file system path, relative to $project_dir, to store UI5\n                       sources in; defaults to \"$project/.ui5\"\n      -s, --sourceDir  file system path, relative to $project_dir, to configure code\n                       completion with; defaults to \"$project/.ui5\"\n    \n    Examples:\n      ui5-codecompletion install                downloads and configures UI5 with\n                                                default options\n      ui5-codecompletion install                installs UI5 from the specified URL\n      --from=https://url/openui5-runtime.zip    to $project/.ui5\n      ui5-codecompletion install \\              installs UI5 from the URL pointing\n      \u003e -f=https://url/openui5-runtime.zip \\    to the .zip, to\n      \u003e -t=ui5/sources/local                    $project/ui5/sources/local\n      ui5-codecompletion configure              uses UI5 sources in\n                                                $project/.ui5 to configure code\n                                                completion\n      ui5-codecompletion configure              uses UI5 sources in\n      --sourceDir=my/relative/dir/ui5           $project/my/relative/dir/ui5 to\n                                                configure code completion\n      ui5-codecompletion configure -s=dir/ui5   uses UI5 sources in\n                                                $project_dir/dir/ui5 to configure\n                                                code completion\n\n\n### download, install and configure UI5 LTS version\n```\n$~/your/app\u003e ui5-codecompletion install\n```\nfor downloading the most recent long term support runtime version of UI5,   \nstoring it in `.ui5` of your project and    \npreparing those sources for code completion.   \n(other options available, see above)\n\nThen, tell WebStorm to use the library in your project.  \n(***this configuration is necessary, but only once***)   \n- Open the \"Settings \u003e Languages \u0026 Frameworks \u003e JavaScript \u003e Libraries\" dialog\n- Select \"LocalUI5Library\" and hit \"Manage Scopes\"   \n  ![activate local lib](doc/scope1.png)   \n- Select/Add the directory of your project code completion should apply to \nvia selecting \"LocalUI5Library\" in \"Library\" drop-down:   \n![assign lib](doc/scope2.png)\n\n### download a custom version to a custom location and install and configure it for code completion\n```\n$~/your/app\u003e ui5-codecompletion install --from=https://example.org/ui5.zip --to=local/lib\n```\nfor downloading your custom UI5 version to `~/your/app/local/lib` and use these sources for code completion.      \n(see above one-time config instructions if running `ui5-codecompletion` for the first time)\n\n### configure existing UI5 lib for use with code completion\n```\n$~/your/other/app\u003e ui5-codecompletion configure --sourcedir=extracted/UI5/sources\n```\nwill look for a `resources` folder in `~/your/other/app/extracted/UI5/sources` and use \nall `*.dbg.js` UI5 files in there for code completion.   \n(see above one-time config instructions if running `ui5-codecompletion` for the first time)\n\n## FAQ\n### Why [openUI5](https://openui5.org) only and not [SAPUI5](https://sapui5.hana.ondemand.com/) as well?\nBecause downloading [SAPUI5](https://sapui5.hana.ondemand.com/) requires checking of a disclaimer in the UI and\nwe were too lazy to script that. PR welcome!\n### Can I have multiple UI5 versions installed/configure in a project?\nTheoretically yes. Practically no, as it's not implemented - a single XML file is fed to WebStorm's scoping mechanism, \nso only the most current UI5 library provided via `ui5-codecompletion install -f=$url/ui5.zip` or \n`ui5-codecompletion configure -s=local/UI5/lib` is used for code completion.\n### Why WebStorm only?\nThat's the editor we're using. Feel free to port to yours. PR welcome!\n\n## Related\n- [UI5 Schemas](https://github.com/ui5experts/ui5-schemas/)  \n  for code completion in XML views in WebStorm\n- [UI5 helper](https://plugins.jetbrains.com/plugin/9427-ui5-helper)   \n  for some comfort navigating inside sources of a UI5 app in WebStorm\n  \n## Contributors\n[\u003cimg src=\"https://avatars0.githubusercontent.com/u/404480?v=4\u0026s=400\" width=\"100px;\"/\u003e\u003cbr /\u003e\u003csub\u003eConstantin Lebrecht\u003c/sub\u003e](http://www.js-soft.com)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvobu%2Fui5-codecompletion","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvobu%2Fui5-codecompletion","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvobu%2Fui5-codecompletion/lists"}