Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: introduce ADP FLP config generator #2730

Merged
merged 76 commits into from
Feb 5, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
76 commits
Select commit Hold shift + click to select a range
c20b5d0
feat: introduce ADP FLP config generator
mmilko01 Dec 20, 2024
f8c15f9
Merge branch 'main' into feat/2727/adp-flp-configuration-generator
mmilko01 Dec 20, 2024
73b727f
fix: overwriting files
mmilko01 Jan 3, 2025
ca379b3
fix: force generator to overwrite files
mmilko01 Jan 3, 2025
a8fd14a
fix: add translations
mmilko01 Jan 6, 2025
db4e3f3
fix: added cf not supported error text
mmilko01 Jan 6, 2025
bacd976
chore: create changeset
mmilko01 Jan 6, 2025
e04b80f
Merge branch 'main' into feat/2727/adp-flp-configuration-generator
mmilko01 Jan 6, 2025
cd9292f
chore: add lock file changes
mmilko01 Jan 6, 2025
c51d930
test: fix adp-tooling tests
mmilko01 Jan 6, 2025
f0f98dc
chore: add reminder
mmilko01 Jan 7, 2025
2392553
chore: fix readme type
mmilko01 Jan 8, 2025
dfd39c8
chore: remove duplicate file
mmilko01 Jan 8, 2025
575d3a5
fix: rename property and use shorthand
mmilko01 Jan 8, 2025
2948e91
fix: simplify logger usage
mmilko01 Jan 8, 2025
8a84433
fix: extract prompt setup in method
mmilko01 Jan 8, 2025
2c6ee78
fix: rename i18n namespace
mmilko01 Jan 8, 2025
59b3ce9
fix: get system name via system-access
mmilko01 Jan 8, 2025
98aabde
Merge branch 'main' into feat/2727/adp-flp-configuration-generator
mmilko01 Jan 8, 2025
d5a8803
Merge branch 'main' into feat/2727/adp-flp-configuration-generator
mmilko01 Jan 8, 2025
ef44a9c
feat: add connection successful message in system selection prompt
mmilko01 Jan 8, 2025
1d6b41d
Merge branch 'feat/2727/adp-flp-configuration-generator' of https://g…
mmilko01 Jan 8, 2025
a36d968
fix: system validation navigation name and description
mmilko01 Jan 8, 2025
55b5bb2
test: add generator tests
mmilko01 Jan 9, 2025
59987cb
chore: update pnpm-lock
mmilko01 Jan 9, 2025
c40b159
fix: restore snapshot
mmilko01 Jan 9, 2025
c05ecf2
fix: logging
mmilko01 Jan 9, 2025
a21eab4
Merge branch 'main' into feat/2727/adp-flp-configuration-generator
mmilko01 Jan 10, 2025
7805c6d
fix: logging
mmilko01 Jan 10, 2025
f9c51ea
refacor: Use @sap-ux/system-access module for system connection/valid…
mmilko01 Jan 28, 2025
58de32b
Merge branch 'main' into feat/2727/adp-flp-configuration-generator
mmilko01 Jan 28, 2025
b957cbe
fix: mask password prompt input
mmilko01 Jan 28, 2025
4812bb2
fix: callback return result
mmilko01 Jan 29, 2025
158f3dd
fix: add type for credential prompts
mmilko01 Jan 29, 2025
4de715a
refactor: extract credential prompts in inquirer-common
mmilko01 Jan 29, 2025
1b8bfb9
fix: yeoman ui page configuration
mmilko01 Jan 29, 2025
bf91aa0
fix: extract prompt setup
mmilko01 Jan 29, 2025
eedf3ed
refactor: change callback and error handling
mmilko01 Jan 30, 2025
de6f437
Merge branch 'main' into feat/2727/adp-flp-configuration-generator
mmilko01 Jan 30, 2025
f097c8f
test: amend existing tests
mmilko01 Jan 30, 2025
d6c86ac
Merge branch 'feat/2727/adp-flp-configuration-generator' of https://g…
mmilko01 Jan 30, 2025
8d8bfc3
Merge branch 'main' into feat/2727/adp-flp-configuration-generator
mmilko01 Jan 31, 2025
3dbea26
fix: check project type
mmilko01 Jan 31, 2025
f79018a
fix: spelling error
mmilko01 Jan 31, 2025
e7c6197
fix: error message for unsupported projects
mmilko01 Jan 31, 2025
8df055b
fix: error message
mmilko01 Jan 31, 2025
3bc8462
fix: merge types
mmilko01 Jan 31, 2025
9bd7b50
fix: duplicate type
mmilko01 Jan 31, 2025
93661e9
test: add tests
mmilko01 Jan 31, 2025
005197b
test: add tests
mmilko01 Jan 31, 2025
b98cda3
fix: Sonar issues
mmilko01 Feb 3, 2025
61566ab
fix: revert unneeded change
mmilko01 Feb 3, 2025
06398ab
test: add adp-tooling tests
mmilko01 Feb 3, 2025
e8bdee0
fix: i18n fs condition
mmilko01 Feb 3, 2025
5a09fcc
test: add inquirer-common tests
mmilko01 Feb 3, 2025
ecd6340
test: i18n tests
mmilko01 Feb 3, 2025
164e55b
chore: add new package to Sonar
mmilko01 Feb 3, 2025
957cf8c
Merge branch 'main' into feat/2727/adp-flp-configuration-generator
mmilko01 Feb 3, 2025
3f2c58c
chore: fix sonar report path
mmilko01 Feb 3, 2025
dfe9764
chore: fix sonar lcov path
mmilko01 Feb 3, 2025
eda533a
doc: change JSDoc
mmilko01 Feb 3, 2025
c4eef3d
fix: revert process working dir after tests
mmilko01 Feb 4, 2025
db1ed3f
Merge branch 'main' into feat/2727/adp-flp-configuration-generator
mmilko01 Feb 5, 2025
1f81c49
fix: change overwrite implementation
mmilko01 Feb 5, 2025
1befebb
fix: initialize translations earlier
mmilko01 Feb 5, 2025
b73b3a7
fix: typo
mmilko01 Feb 5, 2025
bd4b61e
fix: clean inspy in afterEach
mmilko01 Feb 5, 2025
f76e310
Merge branch 'main' into feat/2727/adp-flp-configuration-generator
mmilko01 Feb 5, 2025
b833f84
fix: hide label in CLI
mmilko01 Feb 5, 2025
7867919
Merge branch 'feat/2727/adp-flp-configuration-generator' of https://g…
mmilko01 Feb 5, 2025
0476444
Merge branch 'main' into feat/2727/adp-flp-configuration-generator
mmilko01 Feb 5, 2025
dcc18e9
Merge branch 'main' into feat/2727/adp-flp-configuration-generator
nikmace Feb 5, 2025
0fddd7e
Merge branch 'main' into feat/2727/adp-flp-configuration-generator
mmilko01 Feb 5, 2025
e0c7a7c
Merge branch 'main' into feat/2727/adp-flp-configuration-generator
mmilko01 Feb 5, 2025
8811aac
Merge branch 'main' into feat/2727/adp-flp-configuration-generator
mmilko01 Feb 5, 2025
42e0938
Merge branch 'main' into feat/2727/adp-flp-configuration-generator
mmilko01 Feb 5, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .changeset/tricky-pets-worry.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
"@sap-ux/adp-flp-config-sub-generator": patch
"@sap-ux/adp-tooling": patch
"@sap-ux/i18n": patch
---

Introduce ADP FLP config generator
3 changes: 3 additions & 0 deletions packages/adp-flp-config-sub-generator/.eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
/test/test-output/
/test/unit/expected-output/
generators
7 changes: 7 additions & 0 deletions packages/adp-flp-config-sub-generator/.eslintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
module.exports = {
extends: ['../../.eslintrc'],
parserOptions: {
project: './tsconfig.eslint.json',
tsconfigRootDir: __dirname
}
};
1 change: 1 addition & 0 deletions packages/adp-flp-config-sub-generator/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# @sap-ux/adp-flp-config-sub-generator
201 changes: 201 additions & 0 deletions packages/adp-flp-config-sub-generator/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
20 changes: 20 additions & 0 deletions packages/adp-flp-config-sub-generator/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# @sap-ux/adp-flp-config-sub-generator

## Features

The SAP Adaptation Project FLP sub-generator enables users to create a FLP configuration for an Adaptation Project.

## Installation

The SAP Adaptation Project FLP Configuration sub-generator is included in the [@sap/generator-fiori](https://www.npmjs.com/package/@sap/generator-fiori) generator and cannot be used independently. Additionally, it requires the [SAP Fiori Tools Extension](https://marketplace.visualstudio.com/items?itemName=SAPSE.sap-ux-fiori-tools-extension-pack) pack from the VSCode marketplace.


## Launch the SAP Reference Library sub-generator

Open the Command Palette in MS Visual Studio Code ( CMD/CTRL + Shift + P ) and execute the Fiori: Adaptation Project FLP configuration command.


## Keywords
SAP Fiori Elements
Yeoman
Generator
6 changes: 6 additions & 0 deletions packages/adp-flp-config-sub-generator/jest.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
const config = require('../../jest.base');
config.snapshotFormat = {
escapeString: false,
printBasicPrototype: false
};
module.exports = config;
65 changes: 65 additions & 0 deletions packages/adp-flp-config-sub-generator/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
{
"name": "@sap-ux/adp-flp-config-sub-generator",
"description": "Generator for adding FLP configuration to an Adaptation Project",
"version": "0.0.1",
"repository": {
"type": "git",
"url": "https://github.com/SAP/open-ux-tools.git",
"directory": "packages/adp-flp-config-sub-generator"
},
"bugs": {
"url": "https://github.com/SAP/open-ux-tools/issues?q=is%3Aopen+is%3Aissue"
},
"license": "Apache-2.0",
"main": "generators/app/index.js",
"scripts": {
"build": "tsc --build",
"clean": "rimraf --glob generators test/test-output coverage *.tsbuildinfo",
"watch": "tsc --watch",
"lint": "eslint . --ext .ts",
"lint:fix": "eslint . --ext .ts --fix",
"test": "jest --ci --forceExit --detectOpenHandles --colors --passWithNoTests",
"test-u": "jest --ci --forceExit --detectOpenHandles --colors -u",
"link": "pnpm link --global",
"unlink": "pnpm unlink --global"
},
"files": [
"LICENSE",
"generators",
"!generators/*.map",
"!generators/**/*.map"
],
"dependencies": {
"@sap-devx/yeoman-ui-types": "1.14.4",
"@sap-ux/adp-tooling": "workspace:*",
"@sap-ux/axios-extension": "workspace:*",
"@sap-ux/btp-utils": "workspace:*",
"@sap-ux/feature-toggle": "workspace:*",
"@sap-ux/fiori-generator-shared": "workspace:*",
"@sap-ux/flp-config-inquirer": "workspace:*",
"@sap-ux/inquirer-common": "workspace:*",
"@sap-ux/logger": "workspace:*",
"@sap-ux/project-access": "workspace:*",
"@sap-ux/store": "workspace:*",
"@sap-ux/system-access": "workspace:*",
"i18next": "23.5.1",
"yeoman-generator": "5.10.0"
},
"devDependencies": {
"@jest/types": "29.6.3",
"@types/fs-extra": "9.0.13",
"@types/inquirer": "8.2.6",
"@types/vscode": "1.73.1",
"@types/yeoman-environment": "2.10.11",
"@types/yeoman-generator": "5.2.11",
"@types/yeoman-test": "4.0.6",
"@vscode-logging/logger": "2.0.0",
"fs-extra": "10.0.0",
"rimraf": "5.0.5",
"typescript": "5.3.3",
"yeoman-test": "6.3.0"
},
"engines": {
"node": ">=18.x"
}
}
Loading
Loading