fix: use forward slashes on $ref paths generated on windows (#82)

* fix: user forward slashes on $ref paths generated on windows

* chore: add comment explaining a method and referencing the source

Author: volodymyr-rutskyi

Diff for: lib/migrate-2-3.js

@@ -13,6 +13,7 @@ const {
   traverseFolderDeep,
   replace$Refs,
   implicitlyReferenceDiscriminator,
+  ensureForwardSlashesInPath,
   OPENAPI3_COMPONENTS,
   OPENAPI3_METHODS
 } = require('./utils');
@@ -96,7 +97,7 @@ module.exports = async function migrate() {
     const encodedPath = basename(file, '.yaml');
     const path = encodedPath.replace(/@/g, '/');
     paths['/' + path] = {
-      $ref: './' + join('paths', file)
+      $ref: ensureForwardSlashesInPath('./' + join('paths', file))
     };
 
     const pathData = readYaml(join('spec/paths', file));

Diff for: lib/split-definition.js

@@ -10,6 +10,7 @@ const {
   implicitlyReferenceDiscriminator,
   replace$Refs,
   traverseFolderDeep,
+  ensureForwardSlashesInPath,
   OPENAPI3_COMPONENTS,
   OPENAPI3_METHODS
 } = require('./utils');
@@ -69,7 +70,7 @@ module.exports = function(openapi, openapiDir) {
 
       writeYaml(pathData, pathFile);
       openapi.paths[oasPath] = {
-        $ref: path.relative(openapiDir, pathFile)
+        $ref: ensureForwardSlashesInPath(path.relative(openapiDir, pathFile))
       };
     }
   }

Diff for: lib/utils.js

@@ -225,3 +225,17 @@ function crawl(object, visitor) {
     crawl(object[key], visitor);
   }
 }
+
+/**
+ * Convert Windows backslash paths to slash paths: foo\\bar ➔ foo/bar
+ * Copied form openapi-cli: 
+ * https://github.com/Redocly/openapi-cli/blob/b389661f91202174d5c46766ef2be73bfe9faf0d/packages/core/src/utils.ts#L161
+ */
+exports.ensureForwardSlashesInPath = (path) => {
+  const isExtendedLengthPath = /^\\\\\?\\/.test(path)
+  if (isExtendedLengthPath) {
+    return path
+  }
+
+  return path.replace(/\\/g, '/');
+}