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

feat: promisify app.getFileIcon() #15742

Merged
merged 12 commits into from Dec 5, 2018
Merged

feat: promisify app.getFileIcon() #15742

merged 12 commits into from Dec 5, 2018

Conversation

codebytere
Copy link
Member

@codebytere codebytere commented Nov 16, 2018

Description of Change

Promisifies app.getFileIcon natively.

Todo:

  • specs
  • docs

/cc @ckerr @deepak1556

Checklist

  • PR description included and stakeholders cc'd
  • npm test passes
  • tests are changed or added
  • relevant documentation is changed or added
  • PR title follows semantic commit guidelines

Release Notes

Notes: Promisifies app.getFileIcon

Co-authored-by: Charles Kerr ckerr@github.com

@codebytere codebytere requested review from a team November 16, 2018 21:12
@codebytere codebytere changed the title [WIP] feat: promisify app.getFileIcon feat: promisify app.getFileIcon Nov 18, 2018
docs/api/app.md Outdated Show resolved Hide resolved
@codebytere codebytere changed the title feat: promisify app.getFileIcon feat: promisify app.getFileIcon() Nov 19, 2018
Copy link
Member

@ckerr ckerr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The pieces that are here LGTM. Nice work!

Before we start merging PRs though I think we need a plan to make the API churn more managable to Electron app developers, e.g. the framework discussed at https://github.com/electron/maintainers/issues/159 (CC @alexeykuzmin, @MarshallOfSound).

Additionally, whatever plan we follow should be in a public repo. E.g. if we still like 159 we should move it verbatim into electron/electron/issues

Marking as Request changes to press pause while getting feedback from pineapples on how we want this rollout to proceed not due to any code issues in the PR.

@codebytere
Copy link
Member Author

codebytere commented Nov 19, 2018

Some thoughts:

The initial plan for promisification hinged on waiting until Node 8 (which bundled util.promisify) and then blanket converting all methods taking callbacks at once. From discussion in that issue, i think (and i agree with this perspective) that native promisification as a goal is more desirable than util.promisify, as it provides less of a band-aid over the issue and addresses it at the root.

However, this means that we can't, then, batch convert over all relevant methods at once, and need to do it in this more piecemeal manner. My proposal would be that we maintain a public project board with our progress on this issue, in addition to an issue in maintainers, and merge these piecemeal rather than bottleneck on each method being converted so that we can flag them all at once.

What are y'all's thoughts?

^convo continued in another issue

@codebytere codebytere closed this Nov 19, 2018
@codebytere codebytere reopened this Nov 19, 2018
@codebytere
Copy link
Member Author

dangit meant to comment not close and comment

atom/browser/api/atom_api_app.cc Outdated Show resolved Hide resolved
Copy link
Member

@deepak1556 deepak1556 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with minor change. Thanks!

spec/api-app-spec.js Outdated Show resolved Hide resolved
atom/browser/api/atom_api_app.cc Outdated Show resolved Hide resolved
@codebytere codebytere merged commit 3f15f51 into master Dec 5, 2018
@release-clerk
Copy link

release-clerk bot commented Dec 5, 2018

Release Notes Persisted

Promisifies app.getFileIcon

@codebytere codebytere deleted the promise-getFileIcon branch December 5, 2018 16:50
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

Successfully merging this pull request may close these issues.

None yet

5 participants