chore: Update penify-oapi-codegen package name, improve command-line argument handling, and generate sample code for all languages and variants in OpenAPIHelper

Author: sumansaurabh

README.md

@@ -1,7 +1,6 @@
+# Penify Open API Code Gen
 
-# Open API Code Gen
-
-Openapi-code-gen is a JavaScript library designed to convert OpenAPI schemas into various code examples. This tool simplifies the process of generating client libraries in different programming languages based on your API documentation.
+`penify-oapi-codegen` is a JavaScript library designed to convert OpenAPI schemas into various code examples. This tool simplifies the process of generating client libraries in different programming languages based on your API documentation.
 
 ## Features
 
@@ -10,7 +9,7 @@ Openapi-code-gen is a JavaScript library designed to convert OpenAPI schemas int
 
 ## Prerequisites
 
-Before installing `openapi-code-gen`, ensure you have the following installed:
+Before installing `penify-oapi-codegen`, ensure you have the following installed:
 
 - [Node.js](https://nodejs.org/) (version 12 or higher)
 - npm (Node package manager)
@@ -23,29 +22,28 @@ npm install -g openapi-to-postmanv2
 
 ## Installation
 
-To install `openapi-code-gen`, run the following command:
+To install `penify-oapi-codegen`, run the following command:
 
 ```bash
-npm install openapi-code-gen
+npm install penify-oapi-codegen
 ```
 
 ## Usage
 
-Once installed, you can use `openapi-code-gen` from the command line to generate code examples from your OpenAPI schemas.
+Once installed, you can use `penify-oapi-codegen` from the command line to generate code examples from your OpenAPI schemas.
 
 ### Generate Code Examples
 
 ```bash
-openapi-code-gen generate -i path/to/your/openapi/schema.yaml -l language -v variant -o path/to/output/code_example
+penify-oapi-codegen -s path/to/your/openapi/schema.yaml -l language -v variant -o path/to/output/code_example
 ```
 
 ### Options
 
-- `generate`: Generates code examples from an OpenAPI schema.
-  - `-i, --input <path>`: Path to the OpenAPI schema file (required).
-  - `-l, --language <language>`: Programming language for the code example (required).
-  - `-v, --variant <variant>`: Variant of the code generator for the specified language (required).
-  - `-o, --output <path>`: Path to the output code example file (required).
+- `-s, --source <path>`: Path to the OpenAPI schema file (required).
+- `-l, --language <language>`: Programming language for the code example (optional).
+- `-v, --variant <variant>`: Variant of the code generator for the specified language (optional).
+- `-o, --output <path>`: Path to the output code example file (optional).
 
 ## Supported Code Generators
 
@@ -92,13 +90,13 @@ The tool supports generating code examples for the following languages and varia
 ### Example 1: Generate Python Requests Code Example
 
 ```bash
-openapi-code-gen generate -i ./schemas/api.yaml -l Python -v Requests -o ./examples/python_requests_example.py
+penify-oapi-codegen -s ./schemas/api.yaml -l Python -v Requests -o ./examples/python_requests_example.py
 ```
 
 ### Example 2: Generate JavaScript Fetch Code Example
 
 ```bash
-openapi-code-gen generate -i ./schemas/api.yaml -l JavaScript -v Fetch -o ./examples/js_fetch_example.js
+penify-oapi-codegen -s ./schemas/api.yaml -l JavaScript -v Fetch -o ./examples/js_fetch_example.js
 ```
 
 ## Contributing
@@ -111,7 +109,7 @@ This project is licensed under the ISC License.
 
 ## Author
 
-[Your Name]
+sumansaurabh
 
 ---
 

package.json

@@ -25,6 +25,7 @@
     "eslint": "^9.4.0",
     "globals": "^15.4.0",
     "jest": "^29.7.0",
+    "js-yaml": "^4.1.0",
     "uuid": "^9.0.1"
   },
   "peerDependencies": {

src/OpenAPIHelper.js

@@ -2,6 +2,7 @@ const fs = require('fs');
 const { Collection, Item } = require('postman-collection');
 const codegen = require('postman-code-generators');
 const { execSync } = require('child_process');
+const yaml = require('js-yaml');
 
 class OpenAPIHelper {
   static convertOpenAPIToPostman(openAPIPath, postmanOutputPath) {
@@ -37,7 +38,7 @@ class OpenAPIHelper {
           console.error(error);
         } else {
           const fileName = `${operationId}_${language}_${variant}.pm`;
-          fs.writeFileSync(`sample_code/${fileName}`, snippet);
+          fs.writeFileSync(`/tmp/sample_code/${fileName}`, snippet);
         }
       });
     };
@@ -48,7 +49,6 @@ class OpenAPIHelper {
       const method = item.request.method.toLowerCase(); // eg: "get"
       const operationId = `${name.join('_')}_${url.join('_')}_${method}`;
       return operationId;
-      
     }
 
     function processItems(items) {
@@ -71,10 +71,18 @@ class OpenAPIHelper {
   }
 
   static addSampleCodeToOpenAPI(openAPIPath, outputAPIPath) {
-    const openapiSchema = JSON.parse(fs.readFileSync(openAPIPath).toString());
+    let openapiSchema;
+    const ext = path.extname(openAPIPath);
+
+    if (ext === '.yaml' || ext === '.yml') {
+      openapiSchema = yaml.load(fs.readFileSync(openAPIPath, 'utf8'));
+    } else {
+      openapiSchema = JSON.parse(fs.readFileSync(openAPIPath).toString());
+    }
+
     const sampleCode = {};
 
-    fs.readdirSync('sample_code').forEach(file => {
+    fs.readdirSync('/tmp/sample_code').forEach(file => {
       const code = fs.readFileSync(`/tmp/sample_code/${file}`).toString();
       const [operationId, lang, vari] = file.replace('.pm', '').split('~');
       if (!sampleCode[operationId]) {
@@ -98,7 +106,11 @@ class OpenAPIHelper {
       });
     });
 
-    fs.writeFileSync(outputAPIPath, JSON.stringify(openapiSchema, null, 2));
+    if (ext === '.yaml' || ext === '.yml') {
+      fs.writeFileSync(outputAPIPath, yaml.dump(openapiSchema));
+    } else {
+      fs.writeFileSync(outputAPIPath, JSON.stringify(openapiSchema, null, 2));
+    }
   }
 }
 

src/index.js

@@ -11,7 +11,7 @@ const argv = yargs(hideBin(process.argv))
   .usage('Usage: penify-oapi-codegen -s <source> -l <language> -v <variant> -o <output>')
   .option('s', {
     alias: 'source',
-    describe: 'Path to the OpenAPI JSON file',
+    describe: 'Path to the OpenAPI JSON or YAML file',
     type: 'string',
     demandOption: true
   })
@@ -36,15 +36,14 @@ const argv = yargs(hideBin(process.argv))
 const openAPIPath = argv.s;
 const language = argv.l || null;
 const variant = argv.v || null;
-const outputAPIPath = argv.o || path.resolve(`${path.basename(openAPIPath)}_with_code.json`);
+const outputAPIPath = argv.o || path.resolve(`${path.basename(openAPIPath, path.extname(openAPIPath))}_with_code.json`);
 
 if (!openAPIPath) {
-  console.error('Please provide the path to the OpenAPI JSON file.');
+  console.error('Please provide the path to the OpenAPI file.');
   process.exit(1);
 }
 
 const resolvedOpenAPIPath = path.resolve(openAPIPath);
-const file_name = path.basename(resolvedOpenAPIPath);
 const guid = uuidv4();
 
 const postmanOutputPath = path.resolve(`/tmp/openapi_schema_postman_${guid}.json`);