1439000 - Remove *-actor suffix from inspector actor files

Status: RESOLVED FIXED

(DevTools :: General, enhancement, P3)

Description

[J. Ryan Stinnett [:jryans] (Use needinfo, replies may be slow)]

Historically, we haven't used a `-actor` suffix on actor files.  This allows for a nice parallel naming scheme that matches the spec and front, such as:

devtools/server/actors/device.js
devtools/shared/fronts/device.js
devtools/shared/specs/device.js

Let's rename the inspector actors to remove `-actor`.

Comment 1

[J. Ryan Stinnett [:jryans] (Use needinfo, replies may be slow)]

Attachment: Bug 1439000 - Remove *-actor suffix from inspector actors.

Review commit: https://reviewboard.mozilla.org/r/221040/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/221040/

Comment 2

[Julian Descottes [:jdescottes]]

We can rename for now and discuss again later, and I admit I did this without consulting a broad audience.

However I think having a suffix is an improvement rather than an issue. What are the pros of having the same name for several files? On the other hand the opposite approach has inconvenients which I find painful to deal with:
- in my IDE, different tabs have the same name so it takes a longer time to identify which one to select
- cmd/ctrl+P in my editors (sublime & vs code) highlights the file name way more than the path. After typing "inspector", now I can really quickly see if I am going to open the good file
 
If we want consistent mapping what about having meaningful and descriptive names for other files as well?

Comment 3

[Julian Descottes [:jdescottes]]

Attachment: open-file-device-sublime.png

Comment 4

[Julian Descottes [:jdescottes]]

Attachment: open-file-device-vscode.png

Comment 5

[Julian Descottes [:jdescottes]]

Comment on attachment 8951766 [details]
Bug 1439000 - Remove *-actor suffix from inspector actors.

https://reviewboard.mozilla.org/r/221040/#review226940

Ok to rename for consistency, I'll bring up the issue via an RFC I guess :)

Comment 6

[J. Ryan Stinnett [:jryans] (Use needinfo, replies may be slow)]

(In reply to Julian Descottes [:jdescottes][:julian] from comment #2)
> We can rename for now and discuss again later, and I admit I did this
> without consulting a broad audience.
> 
> However I think having a suffix is an improvement rather than an issue. What
> are the pros of having the same name for several files? On the other hand
> the opposite approach has inconvenients which I find painful to deal with:
> - in my IDE, different tabs have the same name so it takes a longer time to
> identify which one to select
> - cmd/ctrl+P in my editors (sublime & vs code) highlights the file name way
> more than the path. After typing "inspector", now I can really quickly see
> if I am going to open the good file
>  
> If we want consistent mapping what about having meaningful and descriptive
> names for other files as well?

Well, I am not strictly opposed to *-actor per se, but I would definitely like every actor to follow the same naming scheme...

Since they are all in devtools/server/actors, the -actor suffix is redundant.  If we happen to have non-actor things in there too, maybe they should be in a different directory instead.  Saves a few keystrokes, makes some lines shorter.  A small thing I guess.  I believe it was originally done before we decided to entirely give up on line length for require calls...

As for editors, I haven't really experienced the trouble you're mentioning...  I am using VS Code these days, which adds directory info to tab titles if there's more than one open with the same file name.  For quick open, you can type "actorsdevice" to filter to only the one you want.

Comment 7

[J. Ryan Stinnett [:jryans] (Use needinfo, replies may be slow)]

https://treeherder.mozilla.org/#/jobs?repo=try&revision=1a44e6ed5987dbcbfbc77360725c6a85c741b314

Comment 8

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/df193243863e
Remove *-actor suffix from inspector actors. r=jdescottes

Comment 9

[Dorel Luca [:dluca]]

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