Servoy 2020 Documentation
Child pages
  • Developing packages for NGClient2
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

[workspace]/.metadata/.plugins/com.servoy.eclipse.ngclient.ui/target

Is the working directoy of the NGClient2 sources,
the package.json will be adjusted by Servoy depending on the web packages you have installed for the active solution.

Then Servoy will run in developer "npm run build_debug_nowatch" script on that to generate source mapped application for easier debugging in the developer.
It will only run that when it sees it needs to run "npm install webpackage" for a webpackage that is not installed.

"Copy the NGClient2 sources" menu entry in the Solex will overwrite the sources in that target dir and trigger a npm install again for all the packages and will run once a npm build
This is then a clean install.

To develop a Component or Service package they must be on the same version of angular then the core.
that Component or Service pacakage can be added to the current solution as a project (instead of a zip)

For a Service the spec file must have a section:
This one describes a service:

"ng2Config": {
"packageName": "@servoy/ngdesktopfile",
"serviceName": "NGDesktopFileService",
"entryPoint": "dist/servoy/ngdesktopfile"
},

The PackageName is the npm name.
The ServiceName is how the Service is exported like:

@Injectable()
export class NGDesktopFileService {


The entry point is the distribution folder what is the root of the npm package.

If it is installed as a source project then that folder is used to install that npm package (as a folder install)

To debug then you first need to run the the package folder in watch mode:

npm run build_debug

and after that the same command must be run in the [workspace]/.metadata/.plugins/com.servoy.eclipse.ngclient.ui/target folder to also run that one in watch mode


For a Component package the configuration are in the META-INF/manifest.mf


NG2-CSS-ClientLibs: ~@servoy/bootstrapcomponents/svy_bootstrapcomponents.css,
 ~@danielmoncada/angular-datetime-picker/assets/style/picker.min.css
NPM-PackageName: @servoy/bootstrapcomponents
NG2-Module: ServoyBootstrapComponentsModule
Entry-Point: dist/servoy/bootstrapcomponents


To use a component package you can use the zip that we now create for that, for example in bootstrapcomponents package use: npm install, npm run build, npm make_release commands, this will generate a bootstrapcomponents.zip with the NG2 resources inside (It could be that you first need to install the servoy/public module first, see below)


If you want to use the bootstrapcomponents as a project, then after checkout you first must make sure that the project is fully build.

For now to use it like this it is easier to use then also the source of our public module, make sure that is first build run once in com.servoy.eclipse.ngclient.ui\node "npm run build_lib" to build only the module


then in the boostrapcomponents root folder run "npm install path_to/com.servoy.eclipse.ngclient.ui/node/dist/servoy/public"

to install the public servoy package into the bootstrapcomponents.

This command should also have installed all other stuff that it needs (a bootstrapcomponents/node_modules folder should be now fully created)

Then build this package. If you want to just use it and don't really want to code/change the component inside it you can just run "npm run build" 

If you want to watch this package because you are going to change stuff you can run "npm run build_debug" to start a watch mode build.


After that you can start the developer and add the boostrapcomponents  project to servoy and add it as a project reference.

after that this folder: [workspace]/.metadata/.plugins/com.servoy.eclipse.ngclient.ui/target should be adjusted and the package.json in that folder should have something like ""@servoy/bootstrapcomponents": "file:C:/Users/jcomp/git/bootstrapcomponents/dist/servoy/bootstrapcomponents","

Servoy will have compiled it now once (you can see that in the eclipse console) But if you then want to be in debug/watch mode

run "npm run build_debug" in this [workspace]/.metadata/.plugins/com.servoy.eclipse.ngclient.ui/target directory. (in another command window besides the bootstrap watch mode npm build)

If for some reason you need to restart the builds, always first run the component package then the one of the main target.




  • No labels