Closed Bug 1568779 Opened 5 years ago Closed 5 years ago

Remove editors settings comments in devtools files

Categories

(DevTools :: General, task, P3)

task

Tracking

(firefox70 fixed)

RESOLVED FIXED
Firefox 70
Tracking Status
firefox70 --- fixed

People

(Reporter: ochameau, Assigned: nchevobbe)

References

(Blocks 2 open bugs)

Details

Attachments

(1 file)

Florens raised this topic (again?).
A lot of DevTools JS files are having the following headers:

/* -*- indent-tabs-mode: nil; js-indent-level: 2 -*- */
/* vim: set ft=javascript ts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
`` 
Now that we are using prettier for all JS files, we can probably get rid of all these comment and so only keep the MPL comment?

Searched in devtools/client/<panel>/

  • Inspector has a lot of vim comments, but very few emacs ones.
  • Console has them in all files (vim+emacs).
  • Debugger: a few in tests.
  • Netmonitor: a few in tests.
  • DOM: a few, like 18 (but that tool may have fewers source files).
  • Storage: 2 vim, 1 emacs
  • Performance (old): 2 vim, 1 emacs
  • shared: 136 vim, 76 emacs
  • framework: roughly 80 (vim+emacs)
  • accessibility: 1 in tests
  • Memory: none
  • responsive.html: nope
  • aboutdebugging-new: nah
  • performance-new: nada

In today's DevTools meeting noone bring any particular argument in order to keep these comments around.
Let's wait a bit more to have async feedback.

Jim, You might be the only one to have any argument to keep them around. Or just explain why we used to add them.

Flags: needinfo?(jimb)
Type: enhancement → task
Priority: -- → P3

We should proceed with this cleanup. Noone objected against it and most of the team actually agree on it.

Flags: needinfo?(jimb)
Assignee: nobody → nchevobbe
Status: NEW → ASSIGNED
Pushed by nchevobbe@mozilla.com:
https://hg.mozilla.org/integration/autoland/rev/21fd41eee871
Remove editors settings comments in devtools files. r=pbro.
Status: ASSIGNED → RESOLVED
Closed: 5 years ago
Resolution: --- → FIXED
Target Milestone: --- → Firefox 70
You need to log in before you can comment on or make changes to this bug.

Attachment

General

Created:
Updated:
Size: