1014634 - Make Pretty Print string normalization configurable

Status: RESOLVED WONTFIX

(DevTools Graveyard :: Scratchpad, defect)

Description

[Adrian Aichner [:anaran]]

Currently strings are normalized to single-quote from.

Various Mozilla coding standards recommend double-quote:

https://github.com/mozilla/addon-sdk/wiki/Coding-style-guide
https://developer.mozilla.org/en-US/docs/Developer_Guide/Coding_Style

These don't mention a preference but mochitest largely uses double-quote as well:

https://wiki.mozilla.org/DevTools/mochitests_coding_standards
https://wiki.mozilla.org/DevTools/CodingStandards

Since the current default for scratchpad is single-quote it might be best to make this configurable, just like tabsize.

I already have an experimental implemetation basically working and would like to take this bug.

Comment 1

[Adrian Aichner [:anaran]]

Attachment: 0001-Bug-1014634-Make-Pretty-Print-string-normalization-c.patch

This path contains changes to
git.mozilla.org/gecko-dev/toolkit/devtools/pretty-fast/
which I realize lives upstream at
https://github.com/mozilla/pretty-fast

I can separate this out when my overall approach seems sound.

Also, my addition of
pref("devtools.editor.quotechar", "'");
is currently used without error checking.

I would like to know how I should best address invalid pref values, like " ".

Comment 2

[Panos Astithas (he/him) [:past] (please ni?)]

Comment on attachment 8427093 [details] [diff] [review]
0001-Bug-1014634-Make-Pretty-Print-string-normalization-c.patch

Nick is the person to ask.

Comment 3

[Nick Fitzgerald [:fitzgen] [⏰PST; UTC-8]]

I appreciate the work you did to get this to work, however I don't believe that the value gained is worth the amount we complicate the code to implement the feature, especially when configuration of pretty printed code is a non-goal:

https://github.com/mozilla/pretty-fast#non-goals

> * Extreme configurability of types of indentation, where curly braces go, etc.

Comment 4

[Adrian Aichner [:anaran]]

(In reply to Nick Fitzgerald [:fitzgen] from comment #3)
> I appreciate the work you did to get this to work, however I don't believe
> that the value gained is worth the amount we complicate the code to
> implement the feature, especially when configuration of pretty printed code
> is a non-goal:
> 
> https://github.com/mozilla/pretty-fast#non-goals
> 
> > * Extreme configurability of types of indentation, where curly braces go, etc.

Yep, I saw that section.

However, shouldn't Scratchpad then be compliant with
https://developer.mozilla.org/en-US/docs/Developer_Guide/Coding_Style
and the vast majority of mozilla sources and use double-quote instead of single-quote for strings?

Right now Pretty Print cannot be used at all when working on gecko-dev sources.

Comment 5

[Nick Fitzgerald [:fitzgen] [⏰PST; UTC-8]]

The goal of the pretty print button is to make minified code somewhat readable and debuggable; it isn't meant as a JS formatter for gecko/firefox development (especially since it only supports ES5, not ES6 or spidermonkey's non-standard extensions).