Package Builder Script
Packaging Building
This section explains how the script processes solution.json
to generate two package configuration files:
be-openimis.json
: Contains backend (be-packages
) packages.fe-openimis.json
: Contains frontend (fe-packages
) packages.
Each package is transformed to meet specific naming conventions and structure requirements based on its type
.
Backend Package Rules (be-openimis.json
)
General Format:
Backend packages are listed under thepip
key. Depending on thetype
, they are transformed as follows:Type:
pip
{ "name": "menu", "pip": "openimis-be-menu==v1.8.0" }
Type: github
{
"name": "core",
"pip": "git+https://github.com/openimis/openimis-be-core_py.git@develop#egg=openimis-be-core"
}
Naming Rules:
For
pip
packages, the fullopenimis-be-<module_name>
pattern is retained.For
github
packages, theopenimis-be-
prefix and_py
suffix are removed, leaving only<module_name>
inname
.
Frontend Package Rules (fe-openimis.json
)
General Format:
Frontend packages are listed under thenpm
key. Depending on thetype
, they are transformed as follows:Type:
npm
{ "name": "CoreModule", "npm": "@openimis/fe-core@>=v1.7.1" }
Type: github
Naming Rules:
The
name
key is converted to PascalCase with theModule
suffix (e.g.,GrievanceSocialProtectionModule
).For
npm
packages,_js
suffixes are removed.For
github
packages, URLs follow the patternopenimis/openimis-<module_name>_js
.
Generated Files
be-openimis.json
fe-openimis.json
Did you encounter a problem or do you have a suggestion?
Please contact our Service Desk
This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License. https://creativecommons.org/licenses/by-sa/4.0/