Add support to pass a custom git repo

[CapOM]

Curently support to pass a local path but that would be great to support: git+https://[email protected]/MyName/electron.git#my_branch

[CapOM]

Goal: electron-typescript-definitions --in=git+https://[email protected]/MyName/electron.git#my_branch --out=node_modules/electron/electron.d.ts

[zeke]

Hi @CapOM. Would you be willing to open a PR that adds this capability?

[CapOM]

I was not planing but I can try. Will it require changes only in electron-docs repo ?
Will it be a new function being a mix of electron-docs/index.js::download and readFromDisk ?
Or is there anything we can re-use as usually adding git+https://[email protected]/MyName/electron.git#my_branch in package.json just work.
Thx!

[zeke]

I'm not sure I understand your questions, but there is already a capability to read docs from the disk, so if you have your branch checked out, you can point the module at your local path:

const path = require('path')
const docsPath = path.join(__dirname, 'docs')
electronDocs(docsPath).then(function(docs) {
  // ...
})

[CapOM]

No I do want read docs from a local checkout but from a custom git url (so not the default https://github.com/electron/electron-docs/blob/master/index.js#L26)

For example I am developing an app that uses electron and in MyApp/package.json I have "postinstall": "electron-typescript-definitions --out=node_modules/electron/electron.d.ts",

I want to add the param: --in=git+https://[email protected]/MyName/electron.git#my_branch