b.santos/cloud-cap-samples
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

adopt latest custom build task changes

Browse Source 
- single BuildTaskHandler instead of BuildTaskProvider/BuildTaskHandler
  approach
- static build task handler config moved to meta
- default build task properties are now returned as name/value pairs
  using property config
- runWith to declare dependencies across build task handlers, ensuring
  correct dependency graph
- optional getTasks method to implement build task specific constraints
This commit is contained in:
Lothar Bender
2021-12-09 13:04:08 +01:00
parent c796bda9ad
commit 9a6f4b71b3
1 changed files with 25 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files

74
cds-plugin-openapi/index.js
View File

@@ -1,53 +1,29 @@
/* eslint-disable require-await */ /* eslint-disable require-await */
const path = require("path") const cds = require('@sap/cds'), { BuildTaskHandler } = cds.build
const fs = require("fs")
const cds = require('@sap/cds'), { BuildTaskProvider, BuildTaskHandler } = cds.build
const cdsdk = require('@sap/cds-dk') const cdsdk = require('@sap/cds-dk')
const logger = cds.log("build")
// module.exports.activate = () => { cds.build.register(class OpenApiHandler extends BuildTaskHandler {
cds.build.registerProvider( static get meta() {
new (class extends BuildTaskProvider { return {
get id() { id: 'openapi',
return 'openapi' runWith: ['node-cf', 'java-cf'],
} config: { src: cds.env.folders.srv.replace(/\/$/, '') }
get dependents() { }
return ['node-cf', 'java-cf'] }
} async clean() {
applyDefaults(task) { return this.remove('openapi-docs')
task.src = task.src || cds.env.folders.srv.replace(/\/$/, '') }
} async build() {
get handler() { const model = await this.model()
return class extends BuildTaskHandler { const { options } = this.task
async clean() {
fs.rm(path.join(this.task.dest, "openapi-docs"), { recursive: true, force: true }, (err) => err ? logger.error(err) : '')
}
async build() { // generate openapi files for all services
const model = await this.model() await Promise.all(cds.linked(model).services.map(service => {
const { options } = this.task const openApi = cdsdk.compile.to.openapi(model, {
service: service.name,
// generate openapi files for all services 'openapi:diagram': String(options.diagram) === 'true'
await Promise.all(cds.linked(model).services.map(service => { })
const openApi = cdsdk.compile.to.openapi(model, { this.write(openApi).to(`openapi-docs/${service.name}.openapi3.json`)
service: service.name, }))
'openapi:diagram': String(options.diagram) === 'true' }
}) })
this.write(openApi).to(`openapi-docs/${service.name}.openapi3.json`)
}))
}
}
}
/**
* Additional constraints can be defined, e.g. generate openapi service specification in production builds only.
* > cds build --production
* > cds build --for node-cf --production
*/
// async lookupTasks() {
// if (process.env.NODE_ENV === 'production') {
// return [{ for: this.id }]
// }
// }
})()
)
// }