Add `editorFileExtension` when clause context #34889

Krzysztof-Cieslak · 2017-09-23T20:57:39Z

This adds file extension when clause context.

Some languages are using same languageId for multiple different types of files (with different extensions). It may be useful to let developers define command by file extension, and not only by languageId. For example in F#, we have single languageId (fsharp) for all different types of files (.fs - normal F# files, .fsx - F# script files, .fsi - F# signature files). We would like to be able to display some commands, or menu entries only for one of the types.

vbfox · 2017-09-23T21:00:01Z

👍

jrieken · 2017-09-27T09:48:22Z

Great we want that, a dupe is already on the October plan

jrieken

There is also https://github.com/Microsoft/vscode/blob/master/src/vs/workbench/common/resources.ts#L23 which is used in the explorer and in editor that aren't using the code editor widget. An analog context key, like resourceExtname, is also needed

jrieken · 2017-09-27T10:14:28Z

src/vs/editor/common/editorContextKeys.ts

@@ -28,6 +28,7 @@ export namespace EditorContextKeys {

 	// -- mode context keys
 	export const languageId = new RawContextKey<string>('editorLangId', undefined);
+	export const fileExtension = new RawContextKey<string>('editorFileExtension', undefined);


Don't use File as it might not a file, maybe editorResourceExtension, editorExtension, or editorExtname?

jrieken · 2017-09-27T10:15:17Z

src/vs/editor/common/modes/editorModeContext.ts

@@ -111,6 +114,7 @@ export class EditorModeContext extends Disposable {
 			return;
 		}
 		this._langId.set(model.getLanguageIdentifier().language);
+		this._fileExtension.set(model.uri.path.split('.').pop());


😱 use paths.extname

Krzysztof-Cieslak · 2017-09-27T15:49:09Z

src/vs/workbench/common/resources.ts

 	}

 	set(value: URI) {
 		this._resourceKey.set(value);
 		this._schemeKey.set(value && value.scheme);
 		this._filenameKey.set(value && basename(value.fsPath));
 		this._langIdKey.set(value && this._modeService.getModeIdByFilenameOrFirstLine(value.fsPath));
+		this._extensionKey.set(value && paths.extname(value.fsPath));
 	}

 	reset(): void {


@jrieken. an reason why _filenameKey is not reseted here?

I'd say that is bug cc @bpasero

@jrieken introduced by you via 6110660#diff-cb108a154667420fbda68f22a3d6d90c ?

Should I add this missing reset in this PR?

Krzysztof-Cieslak · 2017-09-27T15:50:46Z

OK, I renamed context to editorExtension and added respective resourceExtension. Also used paths module in this one problematic place (didn't know before that you have those helpers)

Krzysztof-Cieslak · 2017-09-27T15:53:01Z

I just have one question, not connected to this particular PR but to contributing in general. Whenever I try to commit any changes they are failing with hygiene check... which would be OK, but the only reported errors are Missing or bad copyright statement on each file I change. Which seems wrong, and I'm forced to do --no-verify on each commit.

jrieken

Stuff looks good. Still unsure about the name, may fooExtname is better because it's closer to the c/fs functions. I'll collect some feedback here

jrieken · 2017-09-28T07:50:23Z

src/vs/workbench/common/resources.ts

 	}

 	set(value: URI) {
 		this._resourceKey.set(value);
 		this._schemeKey.set(value && value.scheme);
 		this._filenameKey.set(value && basename(value.fsPath));
 		this._langIdKey.set(value && this._modeService.getModeIdByFilenameOrFirstLine(value.fsPath));
+		this._extensionKey.set(value && paths.extname(value.fsPath));
 	}

 	reset(): void {


I'd say that is bug cc @bpasero

jrieken · 2017-09-28T09:39:17Z

re #34889 (comment)

@Krzysztof-Cieslak Make sure to invoke "Format Document" before pushing. We run a formatter as part of hygiene and TypeScript formatting much match, whitespace rules must be happy, and the copyright statement must be correct

jrieken · 2017-10-02T13:54:25Z

src/vs/editor/common/editorContextKeys.ts

@@ -28,6 +28,7 @@ export namespace EditorContextKeys {

 	// -- mode context keys
 	export const languageId = new RawContextKey<string>('editorLangId', undefined);
+	export const editorExtension = new RawContextKey<string>('editorExtension', undefined);


After a second look: we actually don't need to repeat this. Having resourceExtname/Extension is enough has it gets inherited to the editor from its column/slot. The reason for having editorLangId and resourceLangId is that latter is derived from the name while the former is more correct (look at the name and the contents)

jrieken · 2017-10-02T13:55:10Z

src/vs/workbench/common/resources.ts

@@ -23,11 +23,13 @@ export class ResourceContextKey implements IContextKey<URI> {
 	static Filename = new RawContextKey<string>('resourceFilename', undefined);
 	static LangId = new RawContextKey<string>('resourceLangId', undefined);
 	static Resource = new RawContextKey<URI>('resource', undefined);
+	static Extension = new RawContextKey<string>('resourceExtension', undefined);


So, I'd prefer resourceExtname. What do you think?

jrieken · 2017-10-02T13:55:46Z

src/vs/workbench/common/resources.ts

 	}

 	set(value: URI) {
 		this._resourceKey.set(value);
 		this._schemeKey.set(value && value.scheme);
 		this._filenameKey.set(value && basename(value.fsPath));
 		this._langIdKey.set(value && this._modeService.getModeIdByFilenameOrFirstLine(value.fsPath));
+		this._extensionKey.set(value && paths.extname(value.fsPath));


Way to go but we to think if folks expect .do from foo.do or do...

I think typical behavior is to return extension with the dot. At least that's what most standard libraries I know do - Node's path.extname, .Net Framework Path.GetExtension, or Ruby's File.extname

More interesting question is if users expects it to be normalized to lower case (i.e if "ABC.FSX" should return ".FSX" or just ".fsx")

Good questions... I'd say we have it "as is". I can see how a "normalized" version can help but that applies to many values, e.g. filename

Krzysztof-Cieslak · 2017-10-06T10:49:11Z

OK, removed new context from the ediotrContextKeys, leaving only resource one. And I've renamed the resource on to resourceExtname

jrieken · 2017-10-10T08:03:38Z

Thanks @Krzysztof-Cieslak

Add editorFileExtension when clause context

bcf9df5

sandy081 assigned alexdima Sep 26, 2017

alexdima assigned jrieken and unassigned alexdima Sep 27, 2017

jrieken added this to the October 2017 milestone Sep 27, 2017

jrieken requested changes Sep 27, 2017

View reviewed changes

Krzysztof-Cieslak added 2 commits September 27, 2017 17:23

Add extension context to ResourceContextKey

c5d19f5

Rename context and small fixes

e2f198e

Krzysztof-Cieslak commented Sep 27, 2017

View reviewed changes

jrieken reviewed Sep 28, 2017

View reviewed changes

jrieken added editor-contrib Editor collection of extras feature-request Request for new features or functionality workbench and removed editor-contrib Editor collection of extras labels Sep 28, 2017

jrieken requested changes Oct 2, 2017

View reviewed changes

Remove new context from editorContextKeys and rename

0f4fdb8

jrieken approved these changes Oct 10, 2017

View reviewed changes

jrieken merged commit 4a1c847 into microsoft:master Oct 10, 2017

egamma mentioned this pull request Oct 10, 2017

Iteration Plan for October 2017 #35875

Closed

40 tasks

jrieken added info-needed Issue requires more information from poster verification-needed Verification of issue is requested release-notes Release notes issues and removed info-needed Issue requires more information from poster labels Oct 30, 2017

github-actions bot locked and limited conversation to collaborators Mar 27, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `editorFileExtension` when clause context #34889

Add `editorFileExtension` when clause context #34889

Krzysztof-Cieslak commented Sep 23, 2017

vbfox commented Sep 23, 2017

jrieken commented Sep 27, 2017

jrieken left a comment

jrieken Sep 27, 2017 •

edited

Loading

jrieken Sep 27, 2017

Krzysztof-Cieslak Sep 27, 2017

jrieken Sep 28, 2017

bpasero Sep 28, 2017

jrieken Sep 28, 2017

Krzysztof-Cieslak Oct 6, 2017

Krzysztof-Cieslak commented Sep 27, 2017

Krzysztof-Cieslak commented Sep 27, 2017

jrieken left a comment

jrieken Sep 28, 2017

jrieken commented Sep 28, 2017

jrieken Oct 2, 2017

jrieken Oct 2, 2017

jrieken Oct 2, 2017

Krzysztof-Cieslak Oct 6, 2017

Krzysztof-Cieslak Oct 6, 2017

jrieken Oct 6, 2017

Krzysztof-Cieslak commented Oct 6, 2017

jrieken commented Oct 10, 2017

Add editorFileExtension when clause context #34889

Add editorFileExtension when clause context #34889

Conversation

Krzysztof-Cieslak commented Sep 23, 2017

vbfox commented Sep 23, 2017

jrieken commented Sep 27, 2017

jrieken left a comment

Choose a reason for hiding this comment

jrieken Sep 27, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Krzysztof-Cieslak commented Sep 27, 2017

Krzysztof-Cieslak commented Sep 27, 2017

jrieken left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jrieken commented Sep 28, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Krzysztof-Cieslak commented Oct 6, 2017

jrieken commented Oct 10, 2017

Add `editorFileExtension` when clause context #34889

Add `editorFileExtension` when clause context #34889

jrieken Sep 27, 2017 •

edited

Loading