binaryage / binaryage/cljs-devtools
Generalize code and documentation to include Firefox
- Dominant language
- Clojure
- Stars
- 1.1k
- Forks
- 51
- PR merge metrics
- No merged PRs in 30d
Description
An [implementation for custom formatters in Firefox](https://bugzilla.mozilla.org/show_bug.cgi?id=1734614) is on its way. So the code and documentaton of the CLJS DevTools should account for that.
Currently, there's an [explicit check for Chrome 47 in the formatters code](https://github.com/binaryage/cljs-devtools/blob/4b4e256019f58ca7b3227a68ab2606664c95a906/src/lib/devtools/formatters.cljs#L17).
One possibility would be to simply remove the check and the logic around it as browsers not supporting custom formatters simply display the logged objects with their normal rendering.
The downside of that approach is, of course, that there won't be a hint anymore when the custom formatters couldn't be applied.
And the documentation is also still very much focused on Chrome as browser. Once the implementation in Firefox stands, all mentions in the documentation should reflect that. This means, adding Firefox where necessary or removing the wording related to Chrome where possible.
Sebastian
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by checking the linked Firefox implementation status, then read src/lib/devtools/formatters.cljs around the explicit Chrome 47 check. Review the documentation for Chrome-specific wording and determine how formatter support should be represented when browsers lack it; done means the code and documentation account for Firefox without losing appropriate user guidance.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- clojure
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100