facebookarchive/atom-ide-ui

Allow code format providers to return null to 'fall through'

Open

#26 opened on Sep 13, 2017

View on GitHub
 (1 comment) (0 reactions) (0 assignees)JavaScript (937 stars) (110 forks)batch import
code formatenhancementhelp wanted

Description

Code format providers are currently forced to return something: https://github.com/facebook-atom/atom-ide-ui/blob/master/modules/atom-ide-ui/pkg/atom-ide-code-format/lib/types.js

However, this makes it difficult to have multiple formatting providers for the same document, since we only use the one with the highest priority.

Instead, we should use ProviderRegistry.getAllProvidersForEditor (e.g. on https://github.com/facebook-atom/atom-ide-ui/blob/master/modules/atom-ide-ui/pkg/atom-ide-code-format/lib/CodeFormatManager.js#L257) and take the first one with a non-nullable result.

cc @damieng

Contributor guide

Tech stack
javascript
Domain
developer experiencetooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Understanding of Atom IDE plugin architectureFamiliarity with ProviderRegistry
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
This issue suggests modifying CodeFormatManager.js to use ProviderRegistry.getAllProvidersForEditor and iterate through providers, taking the first non null result. The change is localized to the module referenced in the issue. First, understand the current flow in CodeFormatManager.js at line 257 and the types.js file. Then implement fallback logic as described.