Merge pull request #16 from cap-js/plugin-to-package

Plugin to reuse library

README.md

@@ -2,26 +2,15 @@
 
 # AsyncAPI Plugin
 
-The `@cap-js/asyncapi` package is a [CDS plugin](https://cap.cloud.sap/docs/node.js/cds-plugins#cds-plugin-packages) that provides support for AsyncAPI document compilation.
+The `@cap-js/asyncapi` is a package that provides support for AsyncAPI document compilation.
 
 ### Table of Contents
 
-- [Setup](#setup)
 - [Generate AsyncAPI document](#generate-asyncapi-document)
 - [Contributing](#contributing)
 - [Code of Conduct](#code-of-conduct)
 - [Licensing](#licensing)
 
-## Setup
-
-To use `cds compile --to asyncapi` functionality, simply add this self-configuring plugin package to your project:
-
-```sh
- npm add @cap-js/asyncapi
-```
-
-In this guide, we use the [Incidents Management reference sample app](https://github.com/cap-js/incidents-app) as the base, to generate the AsyncAPI document for the `services.cds` file.
-
 ## Generate AsyncAPI document
 
 ### 1. Usage of programatic API

index.js

@@ -0,0 +1,17 @@
+const cds = require('@sap/cds')
+
+function _lazyRegisterCompileTarget() {
+ const value = require('./lib/compile/index')
+ Object.defineProperty(this, "asyncapi", { value })
+ return value
+}
+
+const registerAsyncapiCompileTarget = () => {
+ Object.defineProperty(cds.compile.to, "asyncapi", {
+ get: _lazyRegisterCompileTarget,
+ configurable: true
+ })
+ }
+
+
+module.exports = { registerAsyncapiCompileTarget }

package.json

@@ -1,7 +1,7 @@
 {
  "name": "@cap-js/asyncapi",
  "version": "1.0.0",
- "description": "CAP Plugin for AsyncAPI",
+ "description": "CAP tool for AsyncAPI",
  "repository": {
  "type": "git",
  "url": "git+https://github.com/cap-js/asyncapi.git"
@@ -15,9 +15,8 @@
  ],
  "author": "SAP SE (https://www.sap.com)",
  "license": "SEE LICENSE IN LICENSE",
- "main": "cds-plugin.js",
+ "main": "index.js",
  "files": [
- "cds-plugin.js",
  "lib/"
  ],
  "scripts": {

test/lib/compile/asyncapiOptions.test.js

@@ -1,5 +1,5 @@
 const toAsyncAPI = require('../../../lib/compile');
-require('../../../cds-plugin')
+require('../../../').registerAsyncapiCompileTarget();
 const cds = require('@sap/cds');
 const { readdir, read, path: { resolve } } = cds.utils;
 const { join } = require('path');