refactor: use upath instead of path || path.posix

because the latter does not pass treeshakeability test

Author: scolladon

package-lock.json

@@ -61,7 +61,8 @@
     "pify": "^4.0.1",
     "readable-stream": "^3.4.0",
     "sha.js": "^2.4.9",
-    "simple-get": "^4.0.1"
+    "simple-get": "^4.0.1",
+    "upath": "^2.0.1"
   },
   "devDependencies": {
     "@babel/core": "7.6.0",

package.json

@@ -1,6 +1,8 @@
 // @ts-check
 import '../typedefs.js'
 
+import { joinSafe } from 'upath'
+
 import { STAGE } from '../commands/STAGE.js'
 import { TREE } from '../commands/TREE.js'
 import { WORKDIR } from '../commands/WORKDIR.js'
@@ -10,7 +12,6 @@ import { GitIndexManager } from '../managers/GitIndexManager.js'
 import { FileSystem } from '../models/FileSystem.js'
 import { assertParameter } from '../utils/assertParameter.js'
 import { modified } from '../utils/modified.js'
-import { join } from '../utils/path.js'
 
 /**
  * Abort a merge in progress.
@@ -29,7 +30,7 @@ import { join } from '../utils/path.js'
  * @param {object} args
  * @param {FsClient} args.fs - a file system implementation
  * @param {string} args.dir - The [working tree](dir-vs-gitdir.md) directory path
- * @param {string} [args.gitdir=join(dir, '.git')] - [required] The [git directory](dir-vs-gitdir.md) path
+ * @param {string} [args.gitdir=joinSafe(dir, '.git')] - [required] The [git directory](dir-vs-gitdir.md) path
  * @param {string} [args.commit='HEAD'] - commit to reset the index and worktree to, defaults to HEAD
  * @param {object} [args.cache] - a [cache](cache.md) object
  *
@@ -39,7 +40,7 @@ import { join } from '../utils/path.js'
 export async function abortMerge({
   fs: _fs,
   dir,
-  gitdir = join(dir, '.git'),
+  gitdir = joinSafe(dir, '.git'),
   commit = 'HEAD',
   cache = {},
 }) {

src/api/abortMerge.js

@@ -1,14 +1,15 @@
 // @ts-check
 import '../typedefs.js'
 
+import { joinSafe } from 'upath'
+
 import { MultipleGitError } from '../errors/MultipleGitError'
 import { NotFoundError } from '../errors/NotFoundError.js'
 import { GitIgnoreManager } from '../managers/GitIgnoreManager.js'
 import { GitIndexManager } from '../managers/GitIndexManager.js'
 import { FileSystem } from '../models/FileSystem.js'
 import { _writeObject } from '../storage/writeObject.js'
 import { assertParameter } from '../utils/assertParameter.js'
-import { join } from '../utils/path.js'
 import { posixifyPathBuffer } from '../utils/posixifyPathBuffer.js'
 
 /**
@@ -17,7 +18,7 @@ import { posixifyPathBuffer } from '../utils/posixifyPathBuffer.js'
  * @param {object} args
  * @param {FsClient} args.fs - a file system implementation
  * @param {string} args.dir - The [working tree](dir-vs-gitdir.md) directory path
- * @param {string} [args.gitdir=join(dir, '.git')] - [required] The [git directory](dir-vs-gitdir.md) path
+ * @param {string} [args.gitdir=joinSafe(dir, '.git')] - [required] The [git directory](dir-vs-gitdir.md) path
  * @param {string|string[]} args.filepath - The path to the file to add to the index
  * @param {object} [args.cache] - a [cache](cache.md) object
  * @param {boolean} [args.force=false] - add to index even if matches gitignore. Think `git add --force`
@@ -34,7 +35,7 @@ import { posixifyPathBuffer } from '../utils/posixifyPathBuffer.js'
 export async function add({
   fs: _fs,
   dir,
-  gitdir = join(dir, '.git'),
+  gitdir = joinSafe(dir, '.git'),
   filepath,
   cache = {},
   force = false,
@@ -85,18 +86,18 @@ async function addToIndex({
       })
       if (ignored) return
     }
-    const stats = await fs.lstat(join(dir, currentFilepath))
+    const stats = await fs.lstat(joinSafe(dir, currentFilepath))
     if (!stats) throw new NotFoundError(currentFilepath)
 
     if (stats.isDirectory()) {
-      const children = await fs.readdir(join(dir, currentFilepath))
+      const children = await fs.readdir(joinSafe(dir, currentFilepath))
       if (parallel) {
         const promises = children.map(child =>
           addToIndex({
             dir,
             gitdir,
             fs,
-            filepath: [join(currentFilepath, child)],
+            filepath: [joinSafe(currentFilepath, child)],
             index,
             force,
             parallel,
@@ -109,7 +110,7 @@ async function addToIndex({
             dir,
             gitdir,
             fs,
-            filepath: [join(currentFilepath, child)],
+            filepath: [joinSafe(currentFilepath, child)],
             index,
             force,
             parallel,
@@ -118,8 +119,10 @@ async function addToIndex({
       }
     } else {
       const object = stats.isSymbolicLink()
-        ? await fs.readlink(join(dir, currentFilepath)).then(posixifyPathBuffer)
-        : await fs.read(join(dir, currentFilepath))
+        ? await fs
+            .readlink(joinSafe(dir, currentFilepath))
+            .then(posixifyPathBuffer)
+        : await fs.read(joinSafe(dir, currentFilepath))
       if (object === null) throw new NotFoundError(currentFilepath)
       const oid = await _writeObject({ fs, gitdir, type: 'blob', object })
       index.insert({ filepath: currentFilepath, stats, oid })

src/api/add.js

@@ -1,13 +1,14 @@
 // @ts-check
 import '../typedefs.js'
 
+import { joinSafe } from 'upath'
+
 import { _addNote } from '../commands/addNote.js'
 import { MissingNameError } from '../errors/MissingNameError.js'
 import { FileSystem } from '../models/FileSystem.js'
 import { assertParameter } from '../utils/assertParameter.js'
 import { normalizeAuthorObject } from '../utils/normalizeAuthorObject.js'
 import { normalizeCommitterObject } from '../utils/normalizeCommitterObject.js'
-import { join } from '../utils/path.js'
 
 /**
  * Add or update an object note
@@ -16,7 +17,7 @@ import { join } from '../utils/path.js'
  * @param {FsClient} args.fs - a file system implementation
  * @param {SignCallback} [args.onSign] - a PGP signing implementation
  * @param {string} [args.dir] - The [working tree](dir-vs-gitdir.md) directory path
- * @param {string} [args.gitdir=join(dir,'.git')] - [required] The [git directory](dir-vs-gitdir.md) path
+ * @param {string} [args.gitdir=joinSafe(dir,'.git')] - [required] The [git directory](dir-vs-gitdir.md) path
  * @param {string} [args.ref] - The notes ref to look under
  * @param {string} args.oid - The SHA-1 object id of the object to add the note to.
  * @param {string|Uint8Array} args.note - The note to add
@@ -41,7 +42,7 @@ export async function addNote({
   fs: _fs,
   onSign,
   dir,
-  gitdir = join(dir, '.git'),
+  gitdir = joinSafe(dir, '.git'),
   ref = 'refs/notes/commits',
   oid,
   note,

src/api/addNote.js

@@ -1,10 +1,11 @@
 // @ts-check
 import '../typedefs.js'
 
+import { joinSafe } from 'upath'
+
 import { _addRemote } from '../commands/addRemote.js'
 import { FileSystem } from '../models/FileSystem.js'
 import { assertParameter } from '../utils/assertParameter.js'
-import { join } from '../utils/path.js'
 
 /**
  * Add or update a remote
@@ -32,7 +33,7 @@ import { join } from '../utils/path.js'
 export async function addRemote({
   fs,
   dir,
-  gitdir = join(dir, '.git'),
+  gitdir = joinSafe(dir, '.git'),
   remote,
   url,
   force = false,

src/api/addRemote.js

@@ -1,12 +1,13 @@
 // @ts-check
 import '../typedefs.js'
 
+import { joinSafe } from 'upath'
+
 import { _annotatedTag } from '../commands/annotatedTag.js'
 import { MissingNameError } from '../errors/MissingNameError.js'
 import { FileSystem } from '../models/FileSystem.js'
 import { assertParameter } from '../utils/assertParameter.js'
 import { normalizeAuthorObject } from '../utils/normalizeAuthorObject.js'
-import { join } from '../utils/path.js'
 
 /**
  * Create an annotated tag.
@@ -15,7 +16,7 @@ import { join } from '../utils/path.js'
  * @param {FsClient} args.fs - a file system implementation
  * @param {SignCallback} [args.onSign] - a PGP signing implementation
  * @param {string} [args.dir] - The [working tree](dir-vs-gitdir.md) directory path
- * @param {string} [args.gitdir=join(dir,'.git')] - [required] The [git directory](dir-vs-gitdir.md) path
+ * @param {string} [args.gitdir=joinSafe(dir,'.git')] - [required] The [git directory](dir-vs-gitdir.md) path
  * @param {string} args.ref - What to name the tag
  * @param {string} [args.message = ref] - The tag message to use.
  * @param {string} [args.object = 'HEAD'] - The SHA-1 object id the tag points to. (Will resolve to a SHA-1 object id if value is a ref.) By default, the commit object which is referred by the current `HEAD` is used.
@@ -49,7 +50,7 @@ export async function annotatedTag({
   fs: _fs,
   onSign,
   dir,
-  gitdir = join(dir, '.git'),
+  gitdir = joinSafe(dir, '.git'),
   ref,
   tagger: _tagger,
   message = ref,

src/api/annotatedTag.js

@@ -1,18 +1,19 @@
 // @ts-check
 import '../typedefs.js'
 
+import { joinSafe } from 'upath'
+
 import { _branch } from '../commands/branch.js'
 import { FileSystem } from '../models/FileSystem.js'
 import { assertParameter } from '../utils/assertParameter.js'
-import { join } from '../utils/path.js'
 
 /**
  * Create a branch
  *
  * @param {object} args
  * @param {FsClient} args.fs - a file system implementation
  * @param {string} [args.dir] - The [working tree](dir-vs-gitdir.md) directory path
- * @param {string} [args.gitdir=join(dir,'.git')] - [required] The [git directory](dir-vs-gitdir.md) path
+ * @param {string} [args.gitdir=joinSafe(dir,'.git')] - [required] The [git directory](dir-vs-gitdir.md) path
  * @param {string} args.ref - What to name the branch
  * @param {string} [args.object = 'HEAD'] - What oid to use as the start point. Accepts a symbolic ref.
  * @param {boolean} [args.checkout = false] - Update `HEAD` to point at the newly created branch
@@ -28,7 +29,7 @@ import { join } from '../utils/path.js'
 export async function branch({
   fs,
   dir,
-  gitdir = join(dir, '.git'),
+  gitdir = joinSafe(dir, '.git'),
   ref,
   object,
   checkout = false,

src/api/branch.js

@@ -1,10 +1,11 @@
 // @ts-check
 import '../typedefs.js'
 
+import { joinSafe } from 'upath'
+
 import { _checkout } from '../commands/checkout.js'
 import { FileSystem } from '../models/FileSystem.js'
 import { assertParameter } from '../utils/assertParameter.js'
-import { join } from '../utils/path.js'
 
 /**
  * Checkout a branch
@@ -15,7 +16,7 @@ import { join } from '../utils/path.js'
  * @param {FsClient} args.fs - a file system implementation
  * @param {ProgressCallback} [args.onProgress] - optional progress event callback
  * @param {string} args.dir - The [working tree](dir-vs-gitdir.md) directory path
- * @param {string} [args.gitdir=join(dir,'.git')] - [required] The [git directory](dir-vs-gitdir.md) path
+ * @param {string} [args.gitdir=joinSafe(dir,'.git')] - [required] The [git directory](dir-vs-gitdir.md) path
  * @param {string} [args.ref = 'HEAD'] - Source to checkout files from
  * @param {string[]} [args.filepaths] - Limit the checkout to the given files and directories
  * @param {string} [args.remote = 'origin'] - Which remote repository to use
@@ -63,7 +64,7 @@ export async function checkout({
   fs,
   onProgress,
   dir,
-  gitdir = join(dir, '.git'),
+  gitdir = joinSafe(dir, '.git'),
   remote = 'origin',
   ref: _ref,
   filepaths,

src/api/checkout.js

@@ -1,10 +1,11 @@
 // @ts-check
 import '../typedefs.js'
 
+import { joinSafe } from 'upath'
+
 import { _clone } from '../commands/clone.js'
 import { FileSystem } from '../models/FileSystem.js'
 import { assertParameter } from '../utils/assertParameter.js'
-import { join } from '../utils/path.js'
 
 /**
  * Clone a repository
@@ -18,7 +19,7 @@ import { join } from '../utils/path.js'
  * @param {AuthFailureCallback} [args.onAuthFailure] - optional auth rejected callback
  * @param {AuthSuccessCallback} [args.onAuthSuccess] - optional auth approved callback
  * @param {string} args.dir - The [working tree](dir-vs-gitdir.md) directory path
- * @param {string} [args.gitdir=join(dir,'.git')] - [required] The [git directory](dir-vs-gitdir.md) path
+ * @param {string} [args.gitdir=joinSafe(dir,'.git')] - [required] The [git directory](dir-vs-gitdir.md) path
  * @param {string} args.url - The URL of the remote repository
  * @param {string} [args.corsProxy] - Optional [CORS proxy](https://www.npmjs.com/%40isomorphic-git/cors-proxy). Value is stored in the git config file for that repo.
  * @param {string} [args.ref] - Which branch to checkout. By default this is the designated "main branch" of the repository.
@@ -57,7 +58,7 @@ export async function clone({
   onAuthSuccess,
   onAuthFailure,
   dir,
-  gitdir = join(dir, '.git'),
+  gitdir = joinSafe(dir, '.git'),
   url,
   corsProxy = undefined,
   ref = undefined,