Bundle local and remote file references

Author: thim81

CHANGELOG.md

@@ -1,5 +1,7 @@
 ## unreleased
 
+- CLI - Bundle local and remote file references
+
 ## [1.23.2] - 2024-09-16
 
 - Filter - handle inverseFlagValues removal of nested array values

bin/__snapshots__/cli.test.js.snap

@@ -1,16 +1,5 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`openapi-format CLI command should load the default .openapiformatrc if configFile is not provided 1`] = `
-"================================================================================
-OpenAPI-Format CLI settings:
-- Sort file:		(defaultSort.json)
-- Input file:		test/yaml-default/input.yaml
-================================================================================
-✅  OpenAPI formatted successfully
-================================================================================
-"
-`;
-
 exports[`openapi-format CLI command should keep the comments for YAML 1`] = `
 "================================================================================
 OpenAPI-Format CLI settings:
@@ -33,6 +22,17 @@ OpenAPI-Format CLI options:
 "
 `;
 
+exports[`openapi-format CLI command should load the default .openapiformatrc if configFile is not provided 1`] = `
+"================================================================================
+OpenAPI-Format CLI settings:
+- Sort file:		(defaultSort.json)
+- Input file:		test/yaml-default/input.yaml
+================================================================================
+✅  OpenAPI formatted successfully
+================================================================================
+"
+`;
+
 exports[`openapi-format CLI command should not convert large numbers in JSON 1`] = `
 "================================================================================
 OpenAPI-Format CLI settings:
@@ -132,7 +132,7 @@ exports[`openapi-format CLI command should stop and show error about remote file
 OpenAPI-Format CLI settings:
 - Sort file:		(defaultSort.json)
 - Input file:		https://raw.githubusercontent.com/thim81/openapi-format/main/test/yaml-default/foo.yaml
-[31m Input file error - Failed to download file: 404 Not Found
+[31m Input file error - Failed to read file: 404 Not Found
 "
 `;
 

bin/cli.js

@@ -204,7 +204,7 @@ async function run(oaFile, options) {
     input = resObj;
   } catch (err) {
     if (err.code !== 'ENOENT') {
-      console.error('\x1b[31m', `Input file error - Failed to download file: ${err.message}`);
+      console.error('\x1b[31m', `Input file error - Failed to read file: ${err.message}`);
       process.exit(1);
     }
     console.error('\x1b[31m', `Input file error - Failed to read file: ${oaFile}`);

openapi-format.js

@@ -28,7 +28,7 @@ const {
   convertExclusiveMaximum,
   setInObject
 } = require('./utils/convert');
-const {parseFile, writeFile, stringify, detectFormat, parseString, analyzeOpenApi} = require('./utils/file');
+const {parseFile, writeFile, stringify, detectFormat, parseString, analyzeOpenApi, readFile} = require('./utils/file');
 const {parseTpl, getOperation} = require('./utils/parseTpl');
 
 /**
@@ -1120,6 +1120,7 @@ module.exports = {
   openapiChangeCase: openapiChangeCase,
   openapiConvertVersion: openapiConvertVersion,
   openapiRename: openapiRename,
+  readFile: readFile,
   parseFile: parseFile,
   parseString: parseString,
   stringify: stringify,

package-lock.json

@@ -33,6 +33,7 @@
   },
   "dependencies": {
     "@stoplight/yaml": "^4.3.0",
+    "api-ref-bundler": "^0.4.3",
     "case-anything": "2.1.10",
     "commander": "^7.2.0",
     "neotraverse": "^0.6.18"

package.json

@@ -0,0 +1,7 @@
+components:
+  schemas:
+    Extern:
+      type: object
+      properties:
+        id:
+          type: string