Update settings and types

Author: lumaxis

package.json

@@ -42,18 +42,18 @@
 		"configuration": {
 			"title": "Snippet Copy",
 			"properties": {
-				"snippet-copy.markdownCodeBlock.flavor": {
+				"snippet-copy.markdownCodeBlock.includeLanguageIdentifier": {
 					"type": "string",
 					"default": "prompt",
-					"markdownDescription": "Flavor of the generated [fenced Markdown code block](https://help.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks). By default, prompts every time a snippet is copied as a Markdown code block.",
+					"markdownDescription": "Style of the generated [fenced Markdown code block](https://help.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks). By default, prompts every time a snippet is copied as a Markdown code block.",
 					"enum": [
-						"plain",
-						"includeLanguageIdentifier",
+						"never",
+						"always",
 						"prompt"
 					],
 					"markdownEnumDescriptions": [
-						"Copy a plain fenced Markdown code block.",
-						"Copy a fenced Markdown code block that includes the language identifier of the current document.\nThis enables [automatic syntax highlighting](https://help.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks#syntax-highlighting) on e.g. GitHub or StackOverflow but isn't compatible with some apps, for example Slack.",
+						"Copy a regular fenced Markdown code block without language identifier.",
+						"Copy a fenced Markdown code block that includes the language identifier of the current document.  \nThis enables [automatic syntax highlighting](https://help.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks#syntax-highlighting) on e.g. GitHub or StackOverflow but isn't compatible with some apps, for example Slack.",
 						"Always prompt when copying a snippet as a Markdown code block whether to include the language identifier or not."
 					]
 				}

src/lib/textHelpers.ts

@@ -1,10 +1,10 @@
 import { QuickPickItem, Selection, TextDocument, window, workspace } from "vscode";
-import { ExtensionConfig, MarkdownCodeBlockFlavor } from "../types/config";
+import { ExtensionConfig, IncludeLanguageIdentifier } from "../types/config";
 import { contentOfLinesWithAdjustedIndentation, endOfLineCharacter, languageId, minimumIndentationForLineIndexes } from "./documentHelpers";
 import { lineIndexesForSelection } from "./selectionHelpers";
 
 type MarkdownCodeBlockFlavorQuickPickItems = QuickPickItem & {
-	detail: MarkdownCodeBlockFlavor;
+	detail: IncludeLanguageIdentifier;
 };
 
 export async function generateSnippet(document: TextDocument, selections: Selection[], wrapInMarkdownCodeBlock = false): Promise<string> {
@@ -47,27 +47,27 @@ export function wrapTextInMarkdownCodeBlock(document: TextDocument, text: string
 }
 
 export async function includeLanguageIdentifier(config: ExtensionConfig): Promise<boolean> {
-	let markdownCodeBlockFlavor = config.markdownCodeBlock.flavor;
+	let includeLanguageIdentifier = config.markdownCodeBlock.includeLanguageIdentifier;
 
-	if (markdownCodeBlockFlavor === 'prompt') {
+	if (includeLanguageIdentifier === 'prompt') {
 		const prompt = await promptForMarkdownCodeBlockFlavor();
 
 		if (prompt && isMarkdownCodeBlockFlavor(prompt.detail)) {
-			markdownCodeBlockFlavor = prompt.detail;
+			includeLanguageIdentifier = prompt.detail;
 		}
 	}
-	return markdownCodeBlockFlavor === 'includeLanguageIdentifier';
+	return includeLanguageIdentifier === 'always';
 }
 
 export async function promptForMarkdownCodeBlockFlavor(): Promise<MarkdownCodeBlockFlavorQuickPickItems | undefined> {
 	const quickPickItems: MarkdownCodeBlockFlavorQuickPickItems[] = [
 		{
 			label: 'Plain fenced Markdown code block',
-			detail: 'plain',
-			description: 'Copy a plain, default Markdown code block'
+			detail: 'never',
+			description: 'Copy a regular fenced Markdown code block without language identifier'
 		}, {
 			label: 'Include Markdown language identifier',
-			detail: 'includeLanguageIdentifier',
+			detail: 'always',
 			description: "Copy a Markdown code block that includes the language identifier of the current document"
 		}
 	];
@@ -76,7 +76,7 @@ export async function promptForMarkdownCodeBlockFlavor(): Promise<MarkdownCodeBl
 	});
 }
 
-export function isMarkdownCodeBlockFlavor(value: string | undefined): value is MarkdownCodeBlockFlavor {
-	const validValues: MarkdownCodeBlockFlavor[] = ['plain', 'includeLanguageIdentifier'];
-	return !!value && validValues.includes(value as MarkdownCodeBlockFlavor);
+export function isMarkdownCodeBlockFlavor(value: string | undefined): value is IncludeLanguageIdentifier {
+	const validValues: IncludeLanguageIdentifier[] = ['never', 'always'];
+	return !!value && validValues.includes(value as IncludeLanguageIdentifier);
 }

src/test/suite/lib/textHelpers.test.ts

@@ -88,31 +88,31 @@ describe('Text Helpers', () => {
 
 	context('includeLanguageIdentifier', () => {
 		it('returns true if setting is "includeLanguageIdentifier"', async () => {
-			const config: unknown = td.object({ markdownCodeBlock: { flavor: 'includeLanguageIdentifier' } });
+			const config: unknown = td.object({ markdownCodeBlock: { includeLanguageIdentifier: 'always' } });
 
 			assert.strictEqual(await includeLanguageIdentifier(config as ExtensionConfig), true);
 		});
 
 		it('returns false if setting is "plain"', async () => {
-			const config: unknown = td.object({ markdownCodeBlock: { flavor: 'plain' } });
+			const config: unknown = td.object({ markdownCodeBlock: { includeLanguageIdentifier: 'never' } });
 
 			assert.strictEqual(await includeLanguageIdentifier(config as ExtensionConfig), false);
 		});
 
 		it('returns false if setting is true', async () => {
-			const config: unknown = td.object({ markdownCodeBlock: { flavor: true } });
+			const config: unknown = td.object({ markdownCodeBlock: { includeLanguageIdentifier: true } });
 
 			assert.strictEqual(await includeLanguageIdentifier(config as ExtensionConfig), false);
 		});
 	});
 
 	context('isMarkdownCodeBlockFlavor', () => {
-		it('returns true if value is "plain"', () => {
-			assert.equal(isMarkdownCodeBlockFlavor('plain'), true);
+		it('returns true if value is "never"', () => {
+			assert.equal(isMarkdownCodeBlockFlavor('never'), true);
 		});
 
-		it('returns true if value is "includeLanguageIdentifier"', () => {
-			assert.equal(isMarkdownCodeBlockFlavor('plain'), true);
+		it('returns true if value is "always"', () => {
+			assert.equal(isMarkdownCodeBlockFlavor('always'), true);
 		});
 
 		it('returns false if value is any other string', () => {

src/types/config.d.ts

@@ -1,10 +1,10 @@
 import { WorkspaceConfiguration } from "vscode";
 
-export type MarkdownCodeBlockFlavor = 'plain' | 'includeLanguageIdentifier';
+export type IncludeLanguageIdentifier = 'always' | 'never';
 
 export type ExtensionConfig = WorkspaceConfiguration & {
 	markdownCodeBlock: {
-		flavor: MarkdownCodeBlockFlavor | 'prompt'
+		includeLanguageIdentifier: IncludeLanguageIdentifier | 'prompt'
 	};
 	addLanguageIdentifierToMarkdownBlock?: boolean;
 };