chore: Expose executable cli from SDK tools npm package (#682)

Author: AgustinBettati

CONTRIBUTING.md

@@ -111,8 +111,8 @@ VSCode developers might use following debugging configuration for transformer an
             "env": {
                 "OPENAPI_FILE_NAME": "./openapi/atlas-api.yaml"
             },
-            "args": ["./openapi/atlas-api.yaml"],
-            "program": "${workspaceFolder}/tools/transformer/src/transform"
+            "args": ["transform", "--input", "./openapi/atlas-api.yaml", "--output", "./openapi/atlas-api-transformed.yaml"],
+            "program": "${workspaceFolder}/tools/transformer/src/cli.js"
         }
     ]
 }

package.json

@@ -0,0 +1,17 @@
+{
+  "name": "atlas-openapi-transformer",
+  "description": "Expose CLI for Atlas OpenAPI transformations (flatten, transform). Root level package enables npx usage referencing github repository.",
+  "bin": {
+    "atlas-openapi-transformer": "tools/transformer/src/cli.js"
+  },
+  "dependencies": {
+    "simple-node-logger": "^21.8.12",
+    "yaml": "2.8.1",
+    "yargs": "^17.7.2"
+  },
+  "engines": {
+    "node": ">= 16",
+    "npm": ">= 8"
+  }
+}
+

tools/package-lock.json

@@ -5,6 +5,7 @@
   "private": "true",
   "main": "transformer/src/index.js",
   "dependencies": {
+    "yargs": "^17.7.2",
     "simple-node-logger": "^21.8.12",
     "yaml": "2.8.1"
   },
@@ -15,7 +16,6 @@
     "prettier": "3.6.2"
   },
   "scripts": {
-    "sdk:transform": "node ./transformer/src/transform",
     "format": "prettier --write .",
     "format:check": "prettier --check .",
     "test": "jest **/__tests__/**.test.js",

tools/package.json

@@ -22,7 +22,7 @@ echo "# Running transformation based on $OPENAPI_FILE_NAME to the $transformed_f
 cp "$OPENAPI_FOLDER/$OPENAPI_FILE_NAME" "$openapiFileLocation"
 
 npm install
-npm run sdk:transform -- "$openapiFileLocation"
+npm exec --prefix .. atlas-openapi-transformer -- transform --input "$openapiFileLocation" --output "$openapiFileLocation"
 
 echo "# Running OpenAPI generator validation"
 npm exec openapi-generator-cli -- validate -i "$openapiFileLocation"

tools/scripts/generate.sh

@@ -19,4 +19,4 @@ echo "# Running transformation from $transformed_file OpenAPI from $OPENAPI_FILE
 cp "$OPENAPI_FOLDER/$OPENAPI_FILE_NAME" "$openapiFileLocation"
 
 npm install
-npm run sdk:transform -- "$openapiFileLocation"
+npm exec --prefix .. atlas-openapi-transformer -- transform --input "$openapiFileLocation" --output "$openapiFileLocation"