Add unsure output object

Contains files that are classified using the fallback language and lists what languages it could be.
Nixinova · Jan 10, 2023 · 31a44cd · 31a44cd
1 parent f5d59a8
commit 31a44cd
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 3 deletions.
diff --git a/readme.md b/readme.md
@@ -52,7 +52,8 @@ Running LinguistJS on this folder will return the following JSON:
       "/src/cli.js": "JavaScript",
       "/readme.md": "Markdown",
       "/no-lang": null,
-    }
+    },
+	"unsure": {},
   },
   "languages": {
     "count": 3,

diff --git a/src/index.ts b/src/index.ts
@@ -33,7 +33,7 @@ async function analyse(input?: string | string[], opts: T.Options = {}): Promise
 	const extensions: Record<T.FilePath, string> = {};
 	const overrides: Record<T.FilePath, T.LanguageResult> = {};
 	const results: T.Results = {
-		files: { count: 0, bytes: 0, results: {} },
+		files: { count: 0, bytes: 0, results: {}, unsure: {} },
 		languages: { count: 0, bytes: 0, results: {} },
 		unknown: { count: 0, bytes: 0, extensions: {}, filenames: {} },
 	};
@@ -306,7 +306,12 @@ async function analyse(input?: string | string[], opts: T.Options = {}): Promise
 			}
 		}
 		// If no heuristics, assign a language
-		results.files.results[file] ??= fileAssociations[file][0];
+		if (!results.files.results[file]) {
+			const possibleLangs = fileAssociations[file];
+			results.files.results[file] = possibleLangs[0];
+			if (possibleLangs.length > 1)
+				results.files.unsure[file] = possibleLangs;
+		}
 	}
 
 	// Skip specified categories

diff --git a/src/types.ts b/src/types.ts
@@ -29,6 +29,7 @@ export interface Results {
 		bytes: Bytes
 		/** Note: Results use slashes as delimiters even on Windows. */
 		results: Record<FilePath, LanguageResult>
+		unsure: Record<FilePath, LanguageResult[]>
 	}
 	languages: {
 		count: Integer

diff --git a/test/unit.js b/test/unit.js
@@ -13,6 +13,7 @@ async function test([filename, fileContent = ''], [type, testVal]) {
 		'files': actual.files.results[filename],
 		'size': actual.files.bytes,
 		'count': actual.files.count,
+		'unsure_count': Object.entries(actual.files.unsure).length,
 	}[type];
 	const result = testContent === testVal;
 	i = `${+i + 1}`.padStart(2, '0');
@@ -36,6 +37,7 @@ async function unitTest() {
 	await test(['x.cpp'], ['files', 'C++']);
 	await test(['x.c'], ['files', 'C']);
 	await test(['x.R'], ['files', 'R']);
+	await test(['.m'], ['unsure_count', 1])
 	desc('filenames');
 	await test(['Dockerfile'], ['files', 'Dockerfile']);
 	await test(['CMakeLists.txt'], ['files', 'CMake']);