Provide more specific file type descriptions on macOS #117713

NSExceptional · 2021-02-25T22:43:11Z

Motivation and Summary of Changes

Right now, VS Code defines the file type description for every file association it creates as "VS Code document", which is not very useful. The file type description is what appears in the Info pane for a file in Finder:

This PR aims to 1) make it possible to specify specific names at all, and 2) to provide some default names for most of the existing supported file types.

My commit messages and code documentation have more detailed information on the approach I took to this.

Oh, also, I could not for the life of me figure out how to get these changes to build. I ran yarn compile inside build/ and it built the *.js files, but could not get the results published in the final product. If someone can tell me how to do that, I will test it on my machine to ensure it works as expected.

PR Checklist

There is no issue associated with this PR, because I just started on a PR first instead of making an issue.
Do I need to create an issue anyway?
I have read through the coding guidelines and I think the only guideline I may be breaking is this one:

Do not introduce new types or values to the global namespace

However, I'm not sure where to put the two new types I declared. I need some direction here if my PR cannot be merged because of this.

ghost · 2021-02-25T22:43:25Z

All CLA requirements met.

NSExceptional · 2021-02-26T22:56:22Z

Fixed the build errors, but still haven't actually been able to test it

joaomoreno · 2021-03-01T08:52:15Z

PR Checklist

There is no issue associated with this PR, because I just started on a PR first instead of making an issue.
Do I need to create an issue anyway?

Yeah let's create one.

I have read through the coding guidelines and I think the only guideline I may be breaking is this one:

Do not introduce new types or values to the global namespace

However, I'm not sure where to put the two new types I declared. I need some direction here if my PR cannot be merged because of this.

You're good here, no worries. 👌

Oh, also, I could not for the life of me figure out how to get these changes to build. I ran yarn compile inside build/ and it built the *.js files, but could not get the results published in the final product. If someone can tell me how to do that, I will test it on my machine to ensure it works as expected.

You'll be able to build an OSS version of VS Code with yarn gulp vscode-darwin, let me know how that goes.

joaomoreno · 2021-03-01T08:52:40Z

@NSExceptional I'll set the PR to draft until you've tested and we're ready for a review.

NSExceptional · 2021-03-01T19:47:22Z

@joaomoreno No dice, it builds without errors then fails to run :/

Screenshots

Is it possible I messed something up while snooping around in the OSS build folder? I tried yarn cache clean hoping that would blow away any build artifacts but I'm not sure if it does that

joaomoreno · 2021-03-02T09:42:51Z

Try rm -r .build, that will clean the local electron build, so it fetches a new one.

NSExceptional · 2021-03-02T17:00:16Z

That did the trick. It worked! Here's the generated Info.plist

NSExceptional · 2021-03-04T17:59:26Z

Noticed there were no associated file extensions in my screenshot 🤪 Fixed; I was indexing the object improperly in darwinBundleDocumentTypes:

function darwinBundleDocumentTypes(types: { [name: string]: string | string[] }, … {
    return Object.keys(types).map((name: string, idx: number): DarwinDocumentType => {
        const extensions = types[idx]; // <-- using idx by mistake
        ...

→

function darwinBundleDocumentTypes(types: { [name: string]: string | string[] }, … {
    return Object.keys(types).map((name: string): DarwinDocumentType => {
        const extensions = types[name]; // <-- use name instead
        ...

NSExceptional · 2021-03-04T18:14:06Z

Compilation is now failing here because of src/vs/workbench/test/browser/api/extHostBulkEdits.test.ts passing an extra argument to a function, but I didn't touch that file or any related files? 😟

NSExceptional · 2021-03-15T17:26:51Z

@joaomoreno Do you know what's going on? I need some guidance

joaomoreno · 2021-03-16T08:30:39Z

Just merge main into your branch and let's see if CI gets over that hump.

With this change, to define a document type, you need only pass the name (or relative path) of the darwin icon. So instead of passing 'resources/darwin/css.icns' you would just pass 'css'

Allow the caller to provide a specific file type description. The new function will not require source changes to existing calls, but will change how the file type description is generated. An unmodified call to darwinBundleDocumentType will use the given icon name as the file type description. All extensions passed to this function continue to use the same icon as before, and all extensions will have the same file type description as before.

Split darwinBundleDocumentType into two separate functions. The first function is unchanged. The second function allows you to specify specific names for different groups of extensions while all sharing the same icon. For example, this would allow you to differentiate between a C header and a C source file while using the same icon for both. Inherently, the second function will generate multiple file type declarations, so it returns an array instead of a single object. As a result we must use the splat operator on it when passing the result to an array literal.

Make use of the changes in the previous commit

NSExceptional · 2021-03-22T17:02:51Z

No wonder, I was rebasing on my local main which was tracking my fork, not upstream 🤦🏻‍♂️

NSExceptional · 2021-03-23T19:14:49Z

@joaomoreno All checks passed!

NSExceptional · 2021-04-12T00:28:31Z

@joaomoreno does this have any blockers?

NSExceptional · 2021-05-05T18:30:54Z

@joaomoreno will this be put into the May milestone?

joaomoreno · 2021-07-16T11:07:11Z

Thanks! 🍻

NSExceptional changed the title ~~Provide more specific file type descriptions~~ Provide more specific file type descriptions on macOS Feb 25, 2021

NSExceptional force-pushed the darwin-filetypes-pr branch from 037df13 to c59ed56 Compare February 26, 2021 17:29

rzhao271 requested a review from bpasero February 26, 2021 18:45

rzhao271 assigned bpasero Feb 26, 2021

rzhao271 removed the request for review from bpasero February 26, 2021 18:53

NSExceptional force-pushed the darwin-filetypes-pr branch 2 times, most recently from 853a28c to c9d10a8 Compare February 26, 2021 20:14

bpasero assigned joaomoreno and unassigned bpasero Feb 27, 2021

joaomoreno self-requested a review March 1, 2021 08:52

joaomoreno marked this pull request as draft March 1, 2021 08:53

NSExceptional marked this pull request as ready for review March 3, 2021 23:35

NSExceptional force-pushed the darwin-filetypes-pr branch from c9d10a8 to a9839f4 Compare March 4, 2021 17:55

NSExceptional force-pushed the darwin-filetypes-pr branch from a9839f4 to 45ca118 Compare March 4, 2021 18:06

NSExceptional added 4 commits March 22, 2021 12:01

Make darwinBundleDocumentType accept a darwin icon

35c20b2

With this change, to define a document type, you need only pass the name (or relative path) of the darwin icon. So instead of passing 'resources/darwin/css.icns' you would just pass 'css'

Provide more specific file type descriptions

772f41f

Make use of the changes in the previous commit

NSExceptional force-pushed the darwin-filetypes-pr branch from 45ca118 to 772f41f Compare March 22, 2021 17:01

joaomoreno added this to the April 2021 milestone Mar 24, 2021

tymsai approved these changes Apr 12, 2021

View reviewed changes

joaomoreno modified the milestones: April 2021, Backlog Apr 19, 2021

joaomoreno merged commit 8df547f into microsoft:main Jul 16, 2021

joaomoreno modified the milestones: Backlog, July 2021 Jul 16, 2021

github-actions bot locked and limited conversation to collaborators Aug 30, 2021

Provide more specific file type descriptions on macOS #117713

Provide more specific file type descriptions on macOS #117713

Uh oh!

Conversation

NSExceptional commented Feb 25, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Motivation and Summary of Changes

PR Checklist

Uh oh!

ghost commented Feb 25, 2021 • edited by ghost Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

NSExceptional commented Feb 26, 2021

Uh oh!

joaomoreno commented Mar 1, 2021

PR Checklist

Uh oh!

joaomoreno commented Mar 1, 2021

Uh oh!

NSExceptional commented Mar 1, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

joaomoreno commented Mar 2, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

NSExceptional commented Mar 2, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

NSExceptional commented Mar 4, 2021

Uh oh!

NSExceptional commented Mar 4, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

NSExceptional commented Mar 15, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

joaomoreno commented Mar 16, 2021

Uh oh!

NSExceptional commented Mar 22, 2021

Uh oh!

NSExceptional commented Mar 23, 2021

Uh oh!

NSExceptional commented Apr 12, 2021

Uh oh!

NSExceptional commented May 5, 2021

Uh oh!

joaomoreno commented Jul 16, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

NSExceptional commented Feb 25, 2021 •

edited

Loading

ghost commented Feb 25, 2021 •

edited by ghost

Loading

NSExceptional commented Mar 1, 2021 •

edited

Loading

joaomoreno commented Mar 2, 2021 •

edited

Loading

NSExceptional commented Mar 2, 2021 •

edited

Loading

NSExceptional commented Mar 4, 2021 •

edited

Loading

NSExceptional commented Mar 15, 2021 •

edited

Loading