isomorphic-git 1.28.0 → 1.30.0

package/README.md

@@ -17,7 +17,7 @@ By providing functionality as individual functions, code bundlers can produce sm
 The project includes type definitions so you can enjoy static type-checking and intelligent code completion in editors like VS Code and [CodeSandbox](https://codesandbox.io).
 
 ## Project status
-The original author of the project ([Billie Hilton](https://github.com/wmhilton)) left the project, but the project is still maintained by two volunteers:
+The original author of the project ([Billie Hilton](https://github.com/billiegoose)) left the project, but the project is still maintained by two volunteers:
 
 * [@jcubic](https://github.com/jcubic) (most active)
 * [@mojavelinux](https://github.com/mojavelinux)
@@ -114,14 +114,14 @@ Unfortunately, due to the same-origin policy by default `isomorphic-git` can onl
 For this purpose [@isomorphic-git/cors-proxy](https://github.com/isomorphic-git/cors-proxy) exists which you can clone or [`npm install`](https://www.npmjs.com/package/@isomorphic-git/cors-proxy).
 For testing or small projects, you can also use [https://cors.isomorphic-git.org](https://cors.isomorphic-git.org) - a free proxy sponsored by [Clever Cloud](https://www.clever-cloud.com/?utm_source=ref&utm_medium=link&utm_campaign=isomorphic-git).
 
-I'm hoping to get CORS headers added to all the major Git hosting platforms eventually, and will list my progress here:
+We hope to get CORS headers added to all the major Git hosting platforms eventually, and will list the progress made here:
 
 | Service             | Supports CORS requests                                                                                                                                                       |
 | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | Gogs (self-hosted)  | [✔](https://isomorphic-git.github.io/blog/2018/04/07/gogs-adds-cors-headers-for-isomorphic-git.html)                                                                         |
 | Gitea (self-hosted) | [✔](https://github.com/go-gitea/gitea/pull/5719)                                                                                                                             |
 | Azure DevOps        | [✔](https://github.com/isomorphic-git/isomorphic-git/issues/678#issuecomment-452402740) (Usage Note: requires authentication)                        |
-| Gitlab              | ❌ My [PR](https://gitlab.com/gitlab-org/gitlab-workhorse/merge_requests/219) was rejected, but the [issue](https://gitlab.com/gitlab-org/gitlab/issues/20590) is still open! |
+| Gitlab              | ❌ Our [PR](https://gitlab.com/gitlab-org/gitlab-workhorse/merge_requests/219) was rejected, but the [issue](https://gitlab.com/gitlab-org/gitlab/issues/20590) is still open! |
 | Bitbucket           | ❌                                                                                                                                                                            |
 | Github              | ❌                                                                                                                                                                            |
 
@@ -140,7 +140,7 @@ The CLI is more of a lark for quickly testing `isomorphic-git` and isn't really
 
 ## Supported Git commands
 
-This project follows semantic versioning, so I may continue to make changes to the API but they will always be backwards compatible
+This project follows semantic versioning, so we may continue to make changes to the API but they will always be backwards compatible
 unless there is a major version bump.
 
 ### commands
@@ -183,6 +183,7 @@ unless there is a major version bump.
 - [listBranches](https://isomorphic-git.github.io/docs/listBranches.html)
 - [listFiles](https://isomorphic-git.github.io/docs/listFiles.html)
 - [listNotes](https://isomorphic-git.github.io/docs/listNotes.html)
+- [listRefs](https://isomorphic-git.github.io/docs/listRefs.html)
 - [listRemotes](https://isomorphic-git.github.io/docs/listRemotes.html)
 - [listServerRefs](https://isomorphic-git.github.io/docs/listServerRefs.html)
 - [listTags](https://isomorphic-git.github.io/docs/listTags.html)
@@ -266,7 +267,7 @@ Check out the [`CONTRIBUTING`](./CONTRIBUTING.md) document for more instructions
 
 Isomorphic-git would not have been possible without the pioneering work by
 @creationix and @chrisdickinson. Git is a tricky binary mess, and without
-their examples (and their modules!) I would not have been able to come even
+their examples (and their modules!) we would not have been able to come even
 close to finishing this. They are geniuses ahead of their time.
 
 Cross-browser device testing is provided by:
@@ -373,13 +374,17 @@ Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds
     <td align="center"><a href="http://www.codeproject.com/script/Articles/MemberArticles.aspx?amid=62372"><img src="https://avatars.githubusercontent.com/u/865809?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Modesty Zhang</b></sub></a><br /><a href="https://github.com/isomorphic-git/isomorphic-git/commits?author=modesty" title="Code">💻</a> <a href="https://github.com/isomorphic-git/isomorphic-git/commits?author=modesty" title="Documentation">📖</a> <a href="https://github.com/isomorphic-git/isomorphic-git/commits?author=modesty" title="Tests">⚠️</a></td>
     <td align="center"><a href="https://github.com/amrc-benmorrow"><img src="https://avatars.githubusercontent.com/u/120477944?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Ben Morrow</b></sub></a><br /><a href="https://github.com/isomorphic-git/isomorphic-git/commits?author=amrc-benmorrow" title="Code">💻</a></td>
   </tr>
-  <tr>    
+  <tr>
     <td align="center"><a href="https://github.com/jayree"><img src="https://avatars.githubusercontent.com/u/14836154?v=4?s=60" width="60px;" alt=""/><br /><sub><b>jayree</b></sub></a><br /><a href="https://github.com/isomorphic-git/isomorphic-git/commits?author=jayree" title="Code">💻</a> <a href="https://github.com/isomorphic-git/isomorphic-git/commits?author=jayree" title="Tests">⚠️</a></td>
     <td align="center"><a href="https://github.com/lsegurado"><img src="https://avatars.githubusercontent.com/u/27731047?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Lucas Martin Segurado</b></sub></a><br /><a href="https://github.com/isomorphic-git/isomorphic-git/commits?author=lsegurado" title="Documentation">📖</a> <a href="https://github.com/isomorphic-git/isomorphic-git/issues?q=author%3Alsegurado" title="Bug reports">🐛</a></td>
     <td align="center"><a href="https://github.com/limond"><img src="https://avatars.githubusercontent.com/u/1025682?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Leon Kaucher</b></sub></a><br /><a href="https://github.com/isomorphic-git/isomorphic-git/commits?author=limond" title="Code">💻</a> <a href="https://github.com/isomorphic-git/isomorphic-git/commits?author=limond" title="Tests">⚠️</a></td>
     <td align="center"><a href="https://github.com/gilisho"><img src="https://avatars.githubusercontent.com/u/40733156?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Gili Shohat</b></sub></a><br /><a href="https://github.com/isomorphic-git/isomorphic-git/commits?author=gilisho" title="Code">💻</a> <a href="https://github.com/isomorphic-git/isomorphic-git/commits?author=gilisho" title="Documentation">📖</a> <a href="https://github.com/isomorphic-git/isomorphic-git/commits?author=gilisho" title="Tests">⚠️</a></td>
     <td align="center"><a href="https://github.com/hhourani27"><img src="https://avatars.githubusercontent.com/u/61935766?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Habib</b></sub></a><br /><a href="https://github.com/isomorphic-git/isomorphic-git/commits?author=hhourani27" title="Code">💻</a> <a href="https://github.com/isomorphic-git/isomorphic-git/commits?author=hhourani27" title="Documentation">📖</a> <a href="https://github.com/isomorphic-git/isomorphic-git/commits?author=hhourani27" title="Tests">⚠️</a></td>
     <td align="center"><a href="https://github.com/Vinzent03"><img src="https://avatars.githubusercontent.com/u/63981639?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Vinzent</b></sub></a><br /><a href="https://github.com/isomorphic-git/isomorphic-git/commits?author=Vinzent03" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/LokiMidgard"><img src="https://avatars.githubusercontent.com/u/389101?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Patrick Kranz</b></sub></a><br /><a href="https://github.com/isomorphic-git/isomorphic-git/commits?author=LokiMidgard" title="Code">💻</a> <a href="https://github.com/isomorphic-git/isomorphic-git/commits?author=LokiMidgard" title="Documentation">📖</a> <a href="https://github.com/isomorphic-git/isomorphic-git/commits?author=LokiMidgard" title="Tests">⚠️</a></td>
+  </tr>
+  <tr>
+    <td align="center"><a href="https://github.com/lukecotter"><img src="https://avatars.githubusercontent.com/u/4013877?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Luke Cotter</b></sub></a><br /><a href="https://github.com/isomorphic-git/isomorphic-git/commits?author=lukecotter" title="Code">💻</a></td>
   </tr>
 </table>
 

package/browser-tests.json

@@ -1,12 +1,8 @@
 [
   "Chrome Headless 79.0.3945.0 (Linux x86_64)",
-  "Firefox 132.0 (Ubuntu 0.0.0)",
-  "X Chrome 128.0.0.0 (Android 10)",
+  "Firefox 136.0 (Ubuntu 0.0.0)",
+  "Chrome 128.0.0.0 (Android 10)",
   "Edge 79.0.309.65 (Windows 10)",
-  "Safari 13.1 (Mac OS 10.15.4)",
-  "Mobile Safari 13.0 (iOS 13.0)",
-  "Chrome Headless 79.0.3945.0 (Linux x86_64)",
-  "X Chrome 128.0.0.0 (Android 10)",
-  "Chrome Headless 79.0.3945.0 (Linux x86_64)",
-  "Chrome 128.0.0.0 (Android 10)"
+  "Safari 14.1 (Mac OS 10.15.7)",
+  "Mobile Safari 14.0 (iOS 14.0.1)"
 ]

package/http/node/index.d.ts

@@ -13,13 +13,13 @@ export type GitHttpRequest = {
     /**
      * - The HTTP method to use
      */
-    method?: string;
+    method?: string | undefined;
     /**
      * - Headers to include in the HTTP request
      */
     headers?: {
         [x: string]: string;
-    };
+    } | undefined;
     /**
      * - An HTTP or HTTPS agent that manages connections for the HTTP client (Node.js only)
      */
@@ -27,15 +27,15 @@ export type GitHttpRequest = {
     /**
      * - An async iterator of Uint8Arrays that make up the body of POST requests
      */
-    body?: any;
+    body?: AsyncIterableIterator<Uint8Array>;
     /**
      * - Reserved for future use (emitting `GitProgressEvent`s)
      */
-    onProgress?: ProgressCallback;
+    onProgress?: ProgressCallback | undefined;
     /**
      * - Reserved for future use (canceling a request)
      */
-    signal?: any;
+    signal?: object;
 };
 export type GitHttpResponse = {
     /**
@@ -45,17 +45,17 @@ export type GitHttpResponse = {
     /**
      * - The HTTP method that was used
      */
-    method?: string;
+    method?: string | undefined;
     /**
      * - HTTP response headers
      */
     headers?: {
         [x: string]: string;
-    };
+    } | undefined;
     /**
      * - An async iterator of Uint8Arrays that make up the body of the response
      */
-    body?: any;
+    body?: AsyncIterableIterator<Uint8Array>;
     /**
      * - The HTTP status code
      */

package/http/web/index.d.ts

@@ -13,13 +13,13 @@ export type GitHttpRequest = {
     /**
      * - The HTTP method to use
      */
-    method?: string;
+    method?: string | undefined;
     /**
      * - Headers to include in the HTTP request
      */
     headers?: {
         [x: string]: string;
-    };
+    } | undefined;
     /**
      * - An HTTP or HTTPS agent that manages connections for the HTTP client (Node.js only)
      */
@@ -27,15 +27,15 @@ export type GitHttpRequest = {
     /**
      * - An async iterator of Uint8Arrays that make up the body of POST requests
      */
-    body?: any;
+    body?: AsyncIterableIterator<Uint8Array>;
     /**
      * - Reserved for future use (emitting `GitProgressEvent`s)
      */
-    onProgress?: ProgressCallback;
+    onProgress?: ProgressCallback | undefined;
     /**
      * - Reserved for future use (canceling a request)
      */
-    signal?: any;
+    signal?: object;
 };
 export type GitHttpResponse = {
     /**
@@ -45,17 +45,17 @@ export type GitHttpResponse = {
     /**
      * - The HTTP method that was used
      */
-    method?: string;
+    method?: string | undefined;
     /**
      * - HTTP response headers
      */
     headers?: {
         [x: string]: string;
-    };
+    } | undefined;
     /**
      * - An async iterator of Uint8Arrays that make up the body of the response
      */
-    body?: any;
+    body?: AsyncIterableIterator<Uint8Array>;
     /**
      * - The HTTP status code
      */

package/index.cjs

@@ -1489,6 +1489,10 @@ function compareRefNames(a, b) {
 
 // This is straight from parse_unit_factor in config.c of canonical git
 const num = val => {
+  if (typeof val === 'number') {
+    return val
+  }
+
   val = val.toLowerCase();
   let n = parseInt(val);
   if (val.endsWith('k')) n *= 1024;
@@ -1499,6 +1503,10 @@ const num = val => {
 
 // This is straight from git_parse_maybe_bool_text in config.c of canonical git
 const bool = val => {
+  if (typeof val === 'boolean') {
+    return val
+  }
+
   val = val.trim().toLowerCase();
   if (val === 'true' || val === 'yes' || val === 'on') return true
   if (val === 'false' || val === 'no' || val === 'off') return false
@@ -1614,6 +1622,7 @@ const normalizePath = path => {
     name,
     path: getPath(section, subsection, name),
     sectionPath: getPath(section, subsection, null),
+    isSection: !!section,
   }
 };
 
@@ -1674,7 +1683,7 @@ class GitConfig {
 
   async getSubsections(section) {
     return this.parsedConfig
-      .filter(config => config.section === section && config.isSection)
+      .filter(config => config.isSection && config.section === section)
       .map(config => config.subsection)
   }
 
@@ -1696,7 +1705,9 @@ class GitConfig {
       name,
       path: normalizedPath,
       sectionPath,
+      isSection,
     } = normalizePath(path);
+
     const configIndex = findLastIndex(
       this.parsedConfig,
       config => config.path === normalizedPath
@@ -1738,6 +1749,7 @@ class GitConfig {
           } else {
             // Add a new section
             const newSection = {
+              isSection,
               section,
               subsection,
               modified: true,
@@ -4124,6 +4136,8 @@ class GitWalkerFs {
     this.cache = cache;
     this.dir = dir;
     this.gitdir = gitdir;
+
+    this.config = null;
     const walker = this;
     this.ConstructEntry = class WorkdirEntry {
       constructor(fullpath) {
@@ -4210,7 +4224,7 @@ class GitWalkerFs {
       if ((await entry.type()) === 'tree') {
         entry._content = undefined;
       } else {
-        const config = await GitConfigManager.get({ fs, gitdir });
+        const config = await this._getGitConfig(fs, gitdir);
         const autocrlf = await config.get('core.autocrlf');
         const content = await fs.read(`${dir}/${entry._fullpath}`, { autocrlf });
         // workaround for a BrowserFS edge case
@@ -4226,6 +4240,7 @@ class GitWalkerFs {
 
   async oid(entry) {
     if (entry._oid === false) {
+      const self = this;
       const { fs, gitdir, cache } = this;
       let oid;
       // See if we can use the SHA1 hash in the index.
@@ -4234,7 +4249,7 @@ class GitWalkerFs {
       ) {
         const stage = index.entriesMap.get(entry._fullpath);
         const stats = await entry.stat();
-        const config = await GitConfigManager.get({ fs, gitdir });
+        const config = await self._getGitConfig(fs, gitdir);
         const filemode = await config.get('core.filemode');
         const trustino =
           typeof process !== 'undefined'
@@ -4273,6 +4288,14 @@ class GitWalkerFs {
     }
     return entry._oid
   }
+
+  async _getGitConfig(fs, gitdir) {
+    if (this.config) {
+      return this.config
+    }
+    this.config = await GitConfigManager.get({ fs, gitdir });
+    return this.config
+  }
 }
 
 // @ts-check
@@ -5066,6 +5089,8 @@ async function add({
 
     const fs = new FileSystem(_fs);
     await GitIndexManager.acquire({ fs, gitdir, cache }, async index => {
+      const config = await GitConfigManager.get({ fs, gitdir });
+      const autocrlf = await config.get('core.autocrlf');
       return addToIndex({
         dir,
         gitdir,
@@ -5074,6 +5099,7 @@ async function add({
         index,
         force,
         parallel,
+        autocrlf,
       })
     });
   } catch (err) {
@@ -5090,6 +5116,7 @@ async function addToIndex({
   index,
   force,
   parallel,
+  autocrlf,
 }) {
   // TODO: Should ignore UNLESS it's already in the index.
   filepath = Array.isArray(filepath) ? filepath : [filepath];
@@ -5118,6 +5145,7 @@ async function addToIndex({
             index,
             force,
             parallel,
+            autocrlf,
           })
         );
         await Promise.all(promises);
@@ -5131,12 +5159,11 @@ async function addToIndex({
             index,
             force,
             parallel,
+            autocrlf,
           });
         }
       }
     } else {
-      const config = await GitConfigManager.get({ fs, gitdir });
-      const autocrlf = await config.get('core.autocrlf');
       const object = stats.isSymbolicLink()
         ? await fs.readlink(pathBrowserify.join(dir, currentFilepath)).then(posixifyPathBuffer)
         : await fs.read(pathBrowserify.join(dir, currentFilepath), { autocrlf });
@@ -7605,8 +7632,8 @@ function filterCapabilities(server, client) {
 
 const pkg = {
   name: 'isomorphic-git',
-  version: '1.28.0',
-  agent: 'git/isomorphic-git@1.28.0',
+  version: '1.30.0',
+  agent: 'git/isomorphic-git@1.30.0',
 };
 
 class FIFO {
@@ -11070,6 +11097,40 @@ async function listNotes({
 
 // @ts-check
 
+/**
+ * List refs
+ *
+ * @param {object} args
+ * @param {FsClient} args.fs - a file system client
+ * @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.filepath] - [required] The refs path to list
+ *
+ * @returns {Promise<Array<string>>} Resolves successfully with an array of ref names below the supplied `filepath`
+ *
+ * @example
+ * let refs = await git.listRefs({ fs, dir: '/tutorial', filepath: 'refs/heads' })
+ * console.log(refs)
+ *
+ */
+async function listRefs({
+  fs,
+  dir,
+  gitdir = pathBrowserify.join(dir, '.git'),
+  filepath,
+}) {
+  try {
+    assertParameter('fs', fs);
+    assertParameter('gitdir', gitdir);
+    return GitRefManager.listRefs({ fs: new FileSystem(fs), gitdir, filepath })
+  } catch (err) {
+    err.caller = 'git.listRefs';
+    throw err
+  }
+}
+
+// @ts-check
+
 /**
  * @param {object} args
  * @param {import('../models/FileSystem.js').FileSystem} args.fs
@@ -16056,6 +16117,7 @@ var index = {
   listBranches,
   listFiles,
   listNotes,
+  listRefs,
   listRemotes,
   listServerRefs,
   listTags,
@@ -16127,6 +16189,7 @@ exports.isIgnored = isIgnored;
 exports.listBranches = listBranches;
 exports.listFiles = listFiles;
 exports.listNotes = listNotes;
+exports.listRefs = listRefs;
 exports.listRemotes = listRemotes;
 exports.listServerRefs = listServerRefs;
 exports.listTags = listTags;