fix(configuration-location): fix filepath when configuration is not explicitely set

Author: SamVerschueren

package.json

@@ -40,7 +40,8 @@
 	},
 	"ava": {
 		"files": [
-			"source/test/**/*"
+			"source/test/**/*",
+			"!source/test/helpers/**/*"
 		],
 		"typescript": {
 			"rewritePaths": {

source/entities/language-definition.ts

@@ -24,8 +24,8 @@ export interface LanguageDefinition {
 	 */
 	grammar?: string | DefinitionLocation;
 	/**
-	 * The name or location of the language configuration file. If not provided, the `base` will be the `id`
-	 * of the language definition and the file will be `language-configuration.json`.
+	 * The name or location of the language configuration file. If not provided, the `base` will be the
+	 * base of the `grammar` and the file will be `language-configuration.json`.
 	 */
 	configuration?: string | DefinitionLocation;
 	/**

source/test/configuration-location.ts

@@ -1,5 +1,6 @@
 import test from 'ava';
-import { getLanguageConfigurationLocation } from '..';
+import { languages, getLanguageConfigurationLocation } from '..';
+import { fileExistsMacro } from './helpers/file-exists';
 
 test('should throw if grammar property is invalid', (t) => {
 	t.throws(
@@ -78,3 +79,12 @@ test('should return location if configuration is a string', (t) => {
 		'jsx-tags/tags-language-configuration.json'
 	);
 });
+
+// Iterate over all languages and test that the configuration file exists
+for (const language of languages) {
+	test(
+		`language configuration should exist for language ${language.language}`,
+		fileExistsMacro,
+		getLanguageConfigurationLocation(language)
+	);
+}

source/test/grammar-location.ts

@@ -1,5 +1,6 @@
 import test from 'ava';
-import { getGrammarLocation } from '..';
+import { languages, grammars, getGrammarLocation } from '..';
+import { fileExistsMacro } from './helpers/file-exists';
 
 test('should throw if grammar property is invalid', (t) => {
 	t.throws(() => getGrammarLocation({ language: 'javascript', extensions: ['.js'], grammar: 1 } as any), {
@@ -104,3 +105,12 @@ test('should return grammar location if definition is a `LanguageDefinition` wit
 		'scss/syntaxes/scss.tmLanguage.json'
 	);
 });
+
+// Iterate over all languages and grammars and test that the grammar file exists
+for (const language of languages) {
+	test(`grammar should exist for language ${language.language}`, fileExistsMacro, getGrammarLocation(language));
+}
+
+for (const grammar of grammars) {
+	test(`grammar should exist for scope ${grammar.scopeName}`, fileExistsMacro, getGrammarLocation(grammar));
+}

source/test/helpers/file-exists.ts

@@ -0,0 +1,14 @@
+/* eslint-disable ava/use-test */
+import * as fs from 'fs';
+import * as path from 'path';
+import { ExecutionContext, Macro } from 'ava';
+
+export const fileExistsMacro: Macro<[string | undefined]> = (t: ExecutionContext, filePath: string | undefined) => {
+	if (!filePath) {
+		t.pass();
+
+		return;
+	}
+
+	t.true(fs.existsSync(path.join(__dirname, '../../../grammars', filePath)));
+};

source/utils.ts

@@ -56,14 +56,17 @@ export const getLanguageConfigurationLocation = (definition: LanguageDefinition)
 		throw new TypeError('Expected `definition` to be `LanguageDefinition` or `GrammarDefinition`');
 	}
 
+	// If the base is not set for the configuration file, use the base from the grammar or the language identifier
+	const base = typeof definition.grammar === 'object' ? definition.grammar.base : definition.language;
+
 	if (!definition.configuration) {
 		// The default configuration name is `language-configuration.json`.
-		return path.join(definition.language, 'language-configuration.json');
+		return path.join(base, 'language-configuration.json');
 	}
 
 	if (typeof definition.configuration === 'string') {
 		// If the configuration name is of type `string`, concatenate with the `language`.
-		return path.join(definition.language, definition.configuration);
+		return path.join(base || definition.language, definition.configuration);
 	}
 
 	// If the `configuration` is defined and not a `string`, it has to be a definition location object.