generator-ui5-library

generator-ui5-library

Yeoman generator kickstarting the development of UI5 libraries. The generator incorporates the latest best-practices, is using the UI5 Tooling and the UI5 Tooling extensions provided by the UI5 community. It is maintained by the UI5 community and OpenUI5/SAPUI5 developers. This generator was build as a plug-in for the community project Easy-UI5 by SAP.

Usage with Easy-UI5

$> npm i -g yo generator-easy-ui5
$> yo easy-ui5 library

     _-----_
    |       |    ╭──────────────────────────╮
    |--(o)--|    │  Welcome to the easy-ui5 │
   `---------´   │        generator!        │
    ( _´U`_ )    ╰──────────────────────────╯
    /___A___\   /
     |  ~  |
   __'.___.'__
 ´   `  |° ´ Y `

After the generation of your project you can use npm start (or yarn start) to start the local development server.

Standalone usage

Note the different greeting when the generator starts:

$> npm i -g yo
$> yo ./generator-ui5-library

     _-----_     ╭───────────────────────╮
    |       |    │    Welcome to the     │
    |--(o)--|    │ generator-ui5-library │
   `---------´   │      generator!       │
    ( _´U`_ )    ╰───────────────────────╯
    /___A___\   /
     |  ~  |
   __'.___.'__
 ´   `  |° ´ Y `

Development Setup

After cloning the repository, run:

npm run setup

This runs npm install followed by npm run prepare (which installs the Husky git hooks). A dedicated setup script is needed because the project uses ignore-scripts=true in .npmrc to prevent execution of arbitrary postinstall scripts from dependencies — a supply-chain security hardening measure. Since lifecycle scripts are disabled globally, the prepare hook that normally installs Husky doesn't fire automatically, so npm run setup triggers it explicitly.

Support

Please use the GitHub bug tracking system to post questions, bug reports or to create pull requests.

Contributing

We welcome any type of contribution (code contributions, pull requests, issues) to this generator equally.

License

This project is licensed under the Apache Software License, version 2.0 except as noted otherwise in the LICENSE file.

This generator is provided to you by Geert-Jan Klaps and contributors 😉