906640 - Scratchpad does not have any script beautify/prettify function

Status: RESOLVED FIXED

(DevTools Graveyard :: Scratchpad, enhancement, P2)

Description

[Eldmannen]

User Agent: Mozilla/5.0 (Windows NT 6.2; WOW64; rv:26.0) Gecko/20100101 Firefox/26.0 (Beta/Release)
Build ID: 20130818030219

Steps to reproduce:

Open Scratchpad. (Shift-F4)
Wrote ugly code.


Actual results:

Found no beautify/prettify button or menu entry.


Expected results:

There should have been a beautify/prettify button or menu entry that utilized the existing jsb (JavaScript beautifier) function in Firefox available in the Developer Toolbar (Shift-F2) under the 'jsb' command.

Comment 1

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

Attachment: bug-906640-scratchpad-pretty-print.patch

hello sir

do you remember me?

I am contacting you by bugmail

https://tbpl.mozilla.org/?tree=Try&rev=f6d379c287e3

Comment 2

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

ping

Comment 3

[Victor Porof [:vporof][:vp]]

/kick

Comment 4

[Rob Campbell [:rc] (:robcee)]

>_<

Comment 5

[Anton Kovalyov (:anton)]

Comment on attachment 797854 [details] [diff] [review]
bug-906640-scratchpad-pretty-print.patch

Review of attachment 797854 [details] [diff] [review]:
-----------------------------------------------------------------

Aside from one minor comment, looks good to me.

::: browser/devtools/scratchpad/scratchpad.js
@@ +533,5 @@
> +      const ast = Reflect.parse(uglyText);
> +      const prettyText = escodegen.generate(ast);
> +      this.setText(prettyText);
> +    } catch (e) {
> +      this.writeAsComment(DevToolsUtils.safeErrorString(e));

Why not this.writeAsErrorComment(e)?

Comment 6

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

Attachment: bug-906640-scratchpad-pretty-print.patch

Using writeAsErrorComment. Pushing to try again to see if the "extra scratchpad window" thing has fixed itself.

https://tbpl.mozilla.org/?tree=Try&rev=ffe0e0b071cc

Comment 7

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

https://hg.mozilla.org/integration/fx-team/rev/cff37b5ea5fb

Comment 8

[Wes Kocher (:KWierso) (Not reading bugmail; email directly if needed)]

https://hg.mozilla.org/mozilla-central/rev/cff37b5ea5fb

Comment 9

[Eldmannen]

I just tested the new "Pretty Print" button in the nightly build.

It works! :)
However, it strips all comments. :(

Comment 10

[Eldmannen]

The "Pretty Print" button uses 2 space indention.

Open the Developer Toolbar (Shift+F2), type:
> jsb https://bugzilla.mozilla.org/js/yui/yahoo-dom-event/yahoo-dom-event.js

The indention used by jsb defaults to 4 spaces.

This is inconsistent. It would be desirable to be consistent.

Douglas Crockford advocates four spaces.
Google and GitHub uses two spaces.
jQuery uses tabs.
Firefox built-in jsbeautifier defaults to two spaces.
The built-in prettyprinter in Chrome and Internet Explorer uses four spaces.

Comment 11

[Anton Kovalyov (:anton)]

Given that Scratchpad itself uses four spaces by default, we should change Pretty Print to be consistent with it and use four spaces.

Comment 12

[Brandon Benvie [:benvie]]

(In reply to Eldmannen from comment #9)
> However, it strips all comments. :(

Unfortunately Reflect.parse, which parses JS into AST, does not retain information about comments. In order to keep comments, we'd also have incorporate a separate parser, like Esprima or Acorn.

Comment 13

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

Filed bug 913060 regarding indentation

Comment 14

[Liu Ping]

escodegen cannot handle some syntax (ForOfStatement, SpreadExpression, etc), when "Pretty Print", following lines will throw

  for (x of [1,2,3]) console.log(x);
  y = [0, ...[1,2,3]];

Comment 15

[Eldmannen]

It also strips newlines away from the code.

The code:
> function foo() {
> }
>
> function bar() {
> }

Becomes:
> function foo() {
> }
> function bar() {
> }

When using 'jsb' from the Developer Toolbar (Shift+F2) then this is not a problem. Only in Scratchpad.