isomorphic-git
diff --git a/‎.gitignore
Copy file name to clipboard
+5Lines changed: 5 additions & 0 deletions b/‎.gitignore
Copy file name to clipboard
+5Lines changed: 5 additions & 0 deletions
diff --git a/‎README.md
Copy file name to clipboard
+3-2Lines changed: 3 additions & 2 deletions b/‎README.md
Copy file name to clipboard
+3-2Lines changed: 3 additions & 2 deletions
diff --git a/‎__tests__/__helpers__/FixtureFS/makeBrowserFS.js
Copy file name to clipboard
+4-3Lines changed: 4 additions & 3 deletions b/‎__tests__/__helpers__/FixtureFS/makeBrowserFS.js
Copy file name to clipboard
+4-3Lines changed: 4 additions & 3 deletions
diff --git a/‎__tests__/__helpers__/FixtureFS/makeLightningFS.js
Copy file name to clipboard
+4-3Lines changed: 4 additions & 3 deletions b/‎__tests__/__helpers__/FixtureFS/makeLightningFS.js
Copy file name to clipboard
+4-3Lines changed: 4 additions & 3 deletions
diff --git a/‎__tests__/__helpers__/FixtureFS/makeNodeFixture.js
Copy file name to clipboard
+3-2Lines changed: 3 additions & 2 deletions b/‎__tests__/__helpers__/FixtureFS/makeNodeFixture.js
Copy file name to clipboard
+3-2Lines changed: 3 additions & 2 deletions
diff --git a/‎__tests__/__helpers__/generate-docs.js
Copy file name to clipboard
+40-28Lines changed: 40 additions & 28 deletions b/‎__tests__/__helpers__/generate-docs.js
Copy file name to clipboard
+40-28Lines changed: 40 additions & 28 deletions
diff --git a/‎__tests__/__helpers__/generate-errors.js
Copy file name to clipboard
-18Lines changed: 0 additions & 18 deletions b/‎__tests__/__helpers__/generate-errors.js
Copy file name to clipboard
-18Lines changed: 0 additions & 18 deletions
diff --git a/‎__tests__/__snapshots__/test-exports.js.snap
Copy file name to clipboard
-1Lines changed: 0 additions & 1 deletion b/‎__tests__/__snapshots__/test-exports.js.snap
Copy file name to clipboard
-1Lines changed: 0 additions & 1 deletion
diff --git a/‎__tests__/test-annotatedTag.js
Copy file name to clipboard
+1-1Lines changed: 1 addition & 1 deletion b/‎__tests__/test-annotatedTag.js
Copy file name to clipboard
+1-1Lines changed: 1 addition & 1 deletion
diff --git a/‎__tests__/test-commit.js
Copy file name to clipboard
+1-1Lines changed: 1 addition & 1 deletion b/‎__tests__/test-commit.js
Copy file name to clipboard
+1-1Lines changed: 1 addition & 1 deletion
@@ -116,6 +116,11 @@ docs/listTags.md
 docs/log.md
 docs/merge.md
 docs/packObjects.md
+docs/plugin_credentialManager.md
+docs/plugin_emitter.md
+docs/plugin_fs.md
+docs/plugin_http.md
+docs/plugin_pgp.md
 docs/pull.md
 docs/push.md
 docs/readBlob.md
 
@@ -46,6 +46,7 @@ At the time of writing, the following breaking changes are planned:
 - [x] Deprecated commands and function arguments will be removed:
   - [x] The `sign` command will be removed.
   - [x] The commands `utils.auth` and `utils.oauth2` will be removed.
+  - [x] The undocumented param aliases `authUsername` and `authPassword` are removed in favor of `username` and `password`.
   - [x] The `emitter` function argument will be removed.
   - [x] The `fs` function argument will be removed.
   - [x] The `fast` argument to `pull` will be removed since it will always use the `fastCheckout` implementation.
@@ -74,7 +75,7 @@ If you're only using `isomorphic-git` in Node, you can just use the native `fs`
 ```js
 const git = require('isomorphic-git');
 const fs = require('fs');
-git.plugins.set('fs', fs)
+git.plugins.fs(fs)
 ```
 
 If you're writing code for the browser though, you'll need something that emulates the `fs` API.
@@ -86,7 +87,7 @@ If LightningFS doesn't meet your requirements, isomorphic-git should also work w
 <script src="https://unpkg.com/isomorphic-git"></script>
 <script>
 const fs = new LightningFS('fs')
-git.plugins.set('fs', fs)
+git.plugins.fs(fs)
 </script>
 ```
 
 
@@ -1,6 +1,6 @@
 const pify = require('pify')
 
-const { cores, plugins } = require('isomorphic-git')
+const { plugins } = require('isomorphic-git')
 const { FileSystem } = require('isomorphic-git/internal-apis')
 
 let i = 0
@@ -28,8 +28,9 @@ async function makeBrowserFS (dir) {
   browserFSwritable.empty()
 
   const core = `core-browserfs-${i++}`
-  cores.create(core).set('fs', _fs)
-  plugins.set('fs', _fs) // deprecated
+  plugins.createCore(core)
+  plugins.fs(_fs, core)
+  plugins.fs(_fs) // deprecated
 
   const fs = new FileSystem(_fs)
 
 
@@ -1,4 +1,4 @@
-const { cores, plugins } = require('isomorphic-git')
+const { plugins } = require('isomorphic-git')
 const { FileSystem } = require('isomorphic-git/internal-apis')
 
 let i = 0
@@ -14,8 +14,9 @@ async function makeLightningFS (dir) {
     url: `https://${localhost}:9876/base/__tests__/__fixtures__`
   })
   const core = `core-lightningfs-${i++}`
-  cores.create(core).set('fs', _fs)
-  plugins.set('fs', _fs) // deprecated
+  plugins.createCore(core)
+  plugins.fs(_fs, core)
+  plugins.fs(_fs) // deprecated
   const fs = new FileSystem(_fs)
   dir = `/${dir}`
   const gitdir = `/${dir}.git`
 
@@ -8,8 +8,9 @@ let i = 0
 async function makeNodeFixture (fixture) {
   const _fs = Object.assign({}, require('fs'))
   const core = `core-node-${i++}`
-  cores.create(core).set('fs', _fs)
-  plugins.set('fs', _fs) // deprecated
+  plugins.createCore(core)
+  plugins.fs(_fs, core)
+  plugins.fs(_fs) // deprecated
 
   const fs = new FileSystem(_fs)
 
 
@@ -4,7 +4,7 @@ const path = require('path')
 const table = require('markdown-table')
 const git = require('../..')
 
-git.plugins.set('fs', fs)
+git.plugins.fs(fs)
 
 const dir = path.join(__dirname, '..', '..')
 const ref = process.argv[2] || 'HEAD'
@@ -95,12 +95,12 @@ function gentypedef (ast) {
   typedefs.set(ast.name, text)
 }
 
-function gendoc (file, filepath) {
+async function gendoc (file, filepath) {
   // Fix some TypeScript-isms that jsdoc doesn't like
   file = file.replace(/\{import\('events'\)\.EventEmitter\}/g, '{EventEmitter}')
   let ast
   try {
-    ast = jsdoc.explainSync({ source: file })
+    ast = await jsdoc.explain({ source: file })
   } catch (e) {
     console.log(`Unable to parse ${filepath}`, e.message)
     return ''
@@ -160,15 +160,21 @@ function gendoc (file, filepath) {
           }
 
           let description = param.description
-          if (description.startsWith('[deprecated]')) {
-            description = description.replace('[deprecated] ', '')
-            name = name += ' [deprecated]'
-          }
-          // because of the `dir` / `gitdir` weirdness, some args are "required" but have default values
-          // and I have to distinguish them in a way that doesn't upset TypeScript
-          if (description.startsWith('[required]')) {
-            description = description.replace('[required] ', '')
-            name = `**${name}**`
+          if (!description) {
+            console.log(
+              `User error: The function param ${param.name} is missing a description.`
+            )
+          } else {
+            if (description.startsWith('[deprecated]')) {
+              description = description.replace('[deprecated] ', '')
+              name = name += ' [deprecated]'
+            }
+            // because of the `dir` / `gitdir` weirdness, some args are "required" but have default values
+            // and I have to distinguish them in a way that doesn't upset TypeScript
+            if (description.startsWith('[required]')) {
+              description = description.replace('[required] ', '')
+              name = `**${name}**`
+            }
           }
           rows.push([name, escapeType(type), escapeType(description)])
         }
@@ -245,23 +251,29 @@ function gendoc (file, filepath) {
 
   const oid = await git.resolveRef({ dir, ref })
   const { tree } = await git.readTree({ dir, oid, filepath: 'src/commands' })
-  for (const entry of tree) {
-    if (entry.type !== 'blob') continue
-    if (entry.path.startsWith('_')) continue
-    // Load file
-    const { blob } = await git.readBlob({
-      dir,
-      oid,
-      filepath: `src/commands/${entry.path}`
+  const entries = tree.filter(
+    entry => entry.type === 'blob' && !entry.path.startsWith('_')
+  )
+  const docs = []
+  await Promise.all(
+    entries.map(async entry => {
+      // Load file
+      const { blob } = await git.readBlob({
+        dir,
+        oid,
+        filepath: `src/commands/${entry.path}`
+      })
+      const filetext = Buffer.from(blob).toString('utf8')
+      const doctext = await gendoc(filetext, entry.path)
+      if (doctext !== '') {
+        const docfilename = entry.path.replace(/js$/, 'md')
+        fs.writeFileSync(path.join(docDir, docfilename), doctext)
+        docs.push(`docs/${docfilename}`)
+      }
     })
-    const filetext = Buffer.from(blob).toString('utf8')
-    const doctext = gendoc(filetext, entry.path)
-    if (doctext !== '') {
-      const docfilename = entry.path.replace(/js$/, 'md')
-      fs.writeFileSync(path.join(docDir, docfilename), doctext)
-      gitignoreContent += `docs/${docfilename}\n`
-    }
-  }
+  )
+  docs.sort()
+  gitignoreContent += docs.join('\n') + '\n'
   fs.writeFileSync(gitignorePath, gitignoreContent, 'utf8')
 
   // Generate errors.md
 
@@ -15,7 +15,6 @@ Array [
   "clone",
   "commit",
   "config",
-  "cores",
   "currentBranch",
   "deleteBranch",
   "deleteRef",
 
@@ -48,7 +48,7 @@ describe('annotatedTag', () => {
     // Setup
     const { pgp } = require('@isomorphic-git/pgp-plugin')
     const { gitdir } = await makeFixture('test-annotatedTag')
-    plugins.set('pgp', pgp)
+    plugins.pgp(pgp)
     // Test
     const { privateKey, publicKey } = require('./__fixtures__/pgp-keys.js')
     await annotatedTag({
 
@@ -201,7 +201,7 @@ describe('commit', () => {
     // Setup
     const { pgp } = require('@isomorphic-git/pgp-plugin')
     const { gitdir } = await makeFixture('test-commit')
-    plugins.set('pgp', pgp)
+    plugins.pgp(pgp)
     // Test
     const { privateKey, publicKey } = require('./__fixtures__/pgp-keys.js')
     await commit({