Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Agnostic interest: Collection of the static, electron-specific bits of docs-parser #19

Open
bnb opened this issue Dec 1, 2019 · 1 comment

Comments

@bnb
Copy link
Member

bnb commented Dec 1, 2019

Currently running through docs-parser to see if it could be adapted to something like Node.js's docs. Here's a set of things that I've found to be highly electron-focused:

  • Output file is by default called electron-api.json.
    • Possible resolution: default to api.json and provide a CLI flag to change the name to something custom (like electron-api.json or node-api.json).
  • Website URL is hardcoded to electronjs.org
    • Possible resolution: have a project config that can define this.
    • Possible resolution: don't include unless CLI flag is passed or a project config exists.
  • Repo URL is hardcoded to electron/electron
    • Possible resolution: have a project config that can define this.
    • Possible resolution: don't include unless CLI flag is passed or a project config exists.
  • Process property exists in the root of the JSON output where it may not be useful for anything outside of Electron.
    • Possible resolution: opt-in to including this via flag/config.
@MarshallOfSound
Copy link
Member

Fixed in #21

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants