fix(gatsby): Handle special characters in windows paths (#19600)

Author: vladar

packages/gatsby-core-utils/src/__tests__/path.js

@@ -1,4 +1,4 @@
-const { joinPath, isNodeInternalModulePath } = require(`../path`)
+const { joinPath, isNodeInternalModulePath, slash } = require(`../path`)
 const os = require(`os`)
 
 describe(`paths`, () => {
@@ -30,4 +30,24 @@ describe(`paths`, () => {
       expect(isNodeInternalModulePath(modulePath)).toBe(false)
     })
   })
+
+  describe(`slash path`, () => {
+    it(`can correctly slash path`, () => {
+      ;[
+        [`foo\\bar`, `foo/bar`],
+        [`foo/bar`, `foo/bar`],
+        [`foo\\中文`, `foo/中文`],
+        [`foo/中文`, `foo/中文`],
+        [`foo/жä`, `foo/жä`],
+        [`foo\\жä`, `foo/жä`],
+      ].forEach(([path, expectRes]) => {
+        expect(slash(path)).toBe(expectRes)
+      })
+    })
+
+    it(`does not modify extended length paths`, () => {
+      const extended = `\\\\?\\some\\path`
+      expect(slash(extended)).toBe(extended)
+    })
+  })
 })

packages/gatsby-core-utils/src/index.js

@@ -1,6 +1,7 @@
 exports.createContentDigest = require(`./create-content-digest`)
 exports.joinPath = require(`./path`).joinPath
 exports.isNodeInternalModulePath = require(`./path`).isNodeInternalModulePath
+exports.slash = require(`./path`).slash
 exports.cpuCoreCount = require(`./cpu-core-count`)
 exports.urlResolve = require(`./url`).resolve
 exports.isCI = require(`./ci`).isCI

packages/gatsby-core-utils/src/path.js

@@ -74,3 +74,22 @@ const nodePaths = [
  */
 export const isNodeInternalModulePath = fileName =>
   nodePaths.some(regTest => regTest.test(fileName))
+
+/**
+ * slash
+ * --
+ * Convert Windows backslash paths to slash paths: foo\\bar ➔ foo/bar
+ *
+ *
+ * @param  {String}          path
+ * @return {String}          slashed path
+ */
+export function slash(path) {
+  const isExtendedLengthPath = /^\\\\\?\\/.test(path)
+
+  if (isExtendedLengthPath) {
+    return path
+  }
+
+  return path.replace(/\\/g, `/`)
+}

packages/gatsby-page-utils/package.json

@@ -24,10 +24,10 @@
     "bluebird": "^3.7.1",
     "chokidar": "3.3.0",
     "fs-exists-cached": "^1.0.0",
+    "gatsby-core-utils": "^1.0.19",
     "glob": "^7.1.6",
     "lodash": "^4.17.15",
-    "micromatch": "^3.1.10",
-    "slash": "^3.0.0"
+    "micromatch": "^3.1.10"
   },
   "devDependencies": {
     "@babel/cli": "^7.7.0",

packages/gatsby-page-utils/src/watch-directory.js

@@ -1,6 +1,6 @@
 const Promise = require(`bluebird`)
 const chokidar = require(`chokidar`)
-const slash = require(`slash`)
+const { slash } = require(`gatsby-core-utils`)
 
 module.exports = async (path, glob, onNewFile, onRemovedFile) =>
   new Promise((resolve, reject) => {

packages/gatsby-plugin-mdx/loaders/mdx-loader.js

@@ -21,7 +21,7 @@ const genMdx = require(`../utils/gen-mdx`)
 const withDefaultOptions = require(`../utils/default-options`)
 const createMDXNode = require(`../utils/create-mdx-node`)
 const { createFileNode } = require(`../utils/create-fake-file-node`)
-const slash = require(`slash`)
+const { slash } = require(`gatsby-core-utils`)
 
 const DEFAULT_OPTIONS = {
   footnotes: true,

packages/gatsby-plugin-mdx/loaders/mdx-scopes.js

@@ -1,6 +1,6 @@
 const fs = require(`fs`)
 const path = require(`path`)
-const slash = require(`slash`)
+const { slash } = require(`gatsby-core-utils`)
 const loaderUtils = require(`loader-utils`)
 const { MDX_SCOPES_LOCATION } = require(`../constants`)
 

packages/gatsby-plugin-mdx/package.json

@@ -33,6 +33,7 @@
     "escape-string-regexp": "^1.0.5",
     "eval": "^0.1.4",
     "fs-extra": "^8.1.0",
+    "gatsby-core-utils": "^1.0.19",
     "gray-matter": "^4.0.2",
     "json5": "^2.1.1",
     "loader-utils": "^1.2.3",
@@ -45,7 +46,6 @@
     "remark": "^10.0.1",
     "remark-retext": "^3.1.3",
     "retext-english": "^3.0.4",
-    "slash": "^3.0.0",
     "static-site-generator-webpack-plugin": "^3.4.2",
     "style-to-object": "^0.3.0",
     "underscore.string": "^3.3.5",

packages/gatsby-plugin-mdx/utils/create-fake-file-node.js

@@ -1,4 +1,4 @@
-const slash = require(`slash`)
+const { slash } = require(`gatsby-core-utils`)
 const path = require(`path`)
 const fs = require(`fs`)
 const mime = require(`mime`)

packages/gatsby-plugin-offline/package.json

@@ -9,10 +9,10 @@
   "dependencies": {
     "@babel/runtime": "^7.7.2",
     "cheerio": "^1.0.0-rc.3",
+    "gatsby-core-utils": "^1.0.19",
     "glob": "^7.1.6",
     "idb-keyval": "^3.2.0",
     "lodash": "^4.17.15",
-    "slash": "^3.0.0",
     "workbox-build": "^4.3.1"
   },
   "devDependencies": {

packages/gatsby-plugin-offline/src/gatsby-node.js

@@ -2,7 +2,7 @@
 let fs = require(`fs`)
 let workboxBuild = require(`workbox-build`)
 const path = require(`path`)
-const slash = require(`slash`)
+const { slash } = require(`gatsby-core-utils`)
 const glob = require(`glob`)
 const _ = require(`lodash`)
 

packages/gatsby-remark-images/package.json

@@ -10,12 +10,12 @@
     "@babel/runtime": "^7.7.2",
     "chalk": "^2.4.2",
     "cheerio": "^1.0.0-rc.3",
+    "gatsby-core-utils": "^1.0.19",
     "is-relative-url": "^3.0.0",
     "lodash": "^4.17.15",
     "mdast-util-definitions": "^1.2.5",
     "potrace": "^2.1.2",
     "query-string": "^6.8.3",
-    "slash": "^3.0.0",
     "unist-util-select": "^1.5.0",
     "unist-util-visit-parents": "^2.1.2"
   },

packages/gatsby-remark-images/src/index.js

@@ -13,7 +13,7 @@ const _ = require(`lodash`)
 const { fluid, stats, traceSVG } = require(`gatsby-plugin-sharp`)
 const Promise = require(`bluebird`)
 const cheerio = require(`cheerio`)
-const slash = require(`slash`)
+const { slash } = require(`gatsby-core-utils`)
 const chalk = require(`chalk`)
 
 // If the image is relative (not hosted elsewhere)

packages/gatsby-source-filesystem/src/__tests__/utils.js

@@ -4,7 +4,6 @@ const {
   getRemoteFileExtension,
   getRemoteFileName,
   createProgress,
-  slash,
 } = require(`../utils`)
 const reporter = require(`gatsby-cli/lib/reporter`)
 const progress = require(`progress`)
@@ -62,21 +61,3 @@ describe(`createProgress`, () => {
     expect(bar).toHaveProperty(`total`)
   })
 })
-
-describe(`slash path`, () => {
-  it(`can correctly slash path`, () => {
-    ;[
-      [`foo\\bar`, `foo/bar`],
-      [`foo/bar`, `foo/bar`],
-      [`foo\\中文`, `foo/中文`],
-      [`foo/中文`, `foo/中文`],
-    ].forEach(([path, expectRes]) => {
-      expect(slash(path)).toBe(expectRes)
-    })
-  })
-
-  it(`does not modify extended length paths`, () => {
-    const extended = `\\\\?\\some\\path`
-    expect(slash(extended)).toBe(extended)
-  })
-})

packages/gatsby-source-filesystem/src/create-file-node.js

@@ -1,11 +1,10 @@
-const { slash } = require(`./utils`)
 const path = require(`path`)
 const fs = require(`fs-extra`)
 const mime = require(`mime`)
 const prettyBytes = require(`pretty-bytes`)
 
 const md5File = require(`bluebird`).promisify(require(`md5-file`))
-const { createContentDigest } = require(`gatsby-core-utils`)
+const { createContentDigest, slash } = require(`gatsby-core-utils`)
 
 exports.createFileNode = async (
   pathToFile,

packages/gatsby-source-filesystem/src/create-file-path.js

@@ -1,5 +1,5 @@
 const path = require(`path`)
-const { slash } = require(`./utils`)
+const { slash } = require(`gatsby-core-utils`)
 
 function findFileNode({ node, getNode }) {
   // Find the file node.

packages/gatsby-source-filesystem/src/utils.js

@@ -68,25 +68,6 @@ export function createProgress(message, reporter) {
   }
 }
 
-/**
- * slash
- * --
- * Convert Windows backslash paths to slash paths: foo\\bar ➔ foo/bar
- *
- *
- * @param  {String}          path
- * @return {String}          slashed path
- */
-export function slash(path) {
-  const isExtendedLengthPath = /^\\\\\?\\/.test(path)
-
-  if (isExtendedLengthPath) {
-    return path
-  }
-
-  return path.replace(/\\/g, `/`)
-}
-
 /**
  * createFilePath
  * --

packages/gatsby/package.json

@@ -121,7 +121,7 @@
     "shallow-compare": "^1.2.2",
     "sift": "^5.1.0",
     "signal-exit": "^3.0.2",
-    "slash": "^3.0.0",
+    "slugify": "^1.3.6",
     "socket.io": "^2.3.0",
     "stack-trace": "^0.0.10",
     "string-similarity": "^1.2.2",

packages/gatsby/src/bootstrap/index.js

@@ -1,7 +1,7 @@
 /* @flow */
 
 const _ = require(`lodash`)
-const slash = require(`slash`)
+const { slash } = require(`gatsby-core-utils`)
 const fs = require(`fs-extra`)
 const md5File = require(`md5-file/promise`)
 const crypto = require(`crypto`)

packages/gatsby/src/bootstrap/load-plugins/__tests__/load-plugins.js

@@ -1,5 +1,5 @@
 const loadPlugins = require(`../index`)
-const slash = require(`slash`)
+const { slash } = require(`gatsby-core-utils`)
 
 describe(`Load plugins`, () => {
   /**

packages/gatsby/src/bootstrap/load-plugins/load.js

@@ -1,5 +1,5 @@
 const _ = require(`lodash`)
-const slash = require(`slash`)
+const { slash } = require(`gatsby-core-utils`)
 const fs = require(`fs`)
 const path = require(`path`)
 const crypto = require(`crypto`)

packages/gatsby/src/bootstrap/requires-writer.js

@@ -2,7 +2,7 @@ const _ = require(`lodash`)
 const path = require(`path`)
 const fs = require(`fs-extra`)
 const crypto = require(`crypto`)
-const slash = require(`slash`)
+const { slash } = require(`gatsby-core-utils`)
 const { store, emitter } = require(`../redux/`)
 const reporter = require(`gatsby-cli/lib/reporter`)
 const { match } = require(`@reach/router/lib/utils`)

packages/gatsby/src/commands/develop.js

@@ -32,7 +32,7 @@ const withResolverContext = require(`../schema/context`)
 const sourceNodes = require(`../utils/source-nodes`)
 const websocketManager = require(`../utils/websocket-manager`)
 const getSslCert = require(`../utils/get-ssl-cert`)
-const slash = require(`slash`)
+const { slash } = require(`gatsby-core-utils`)
 const { initTracer } = require(`../utils/tracer`)
 const apiRunnerNode = require(`../utils/api-runner-node`)
 const db = require(`../db`)