linguist-js 2.2.1 → 2.3.0

package/dist/cli.js

@@ -54,7 +54,7 @@ if (args.analyze)
         const data = await (0, index_1.default)(root, args);
         const { files, languages, unknown } = data;
         // Get file count
-        let totalFiles = (0, walk_tree_1.default)(root).files.length;
+        const totalFiles = (0, walk_tree_1.default)(root).files.length;
         // Print output
         if (!args.json) {
             const sortedEntries = Object.entries(languages.results).sort((a, b) => a[1].bytes < b[1].bytes ? +1 : -1);

package/dist/index.js

@@ -14,8 +14,8 @@ const read_file_1 = __importDefault(require("./helpers/read-file"));
 const convert_pcre_1 = __importDefault(require("./helpers/convert-pcre"));
 const convert_glob_1 = __importDefault(require("./helpers/convert-glob"));
 async function analyse(input, opts = {}) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j;
-    var _k, _l, _m;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q;
+    var _r, _s, _t;
     const langData = await (0, load_data_1.default)('languages.yml').then(js_yaml_1.default.load);
     const vendorData = await (0, load_data_1.default)('vendor.yml').then(js_yaml_1.default.load);
     const heuristicsData = await (0, load_data_1.default)('heuristics.yml').then(js_yaml_1.default.load);
@@ -34,7 +34,16 @@ async function analyse(input, opts = {}) {
         opts.keepVendored ? [] : vendorData.map(path => RegExp(path)),
         (_b = (_a = opts.ignoredFiles) === null || _a === void 0 ? void 0 : _a.map(path => (0, glob_to_regexp_1.default)('*' + path + '*', { extended: true }))) !== null && _b !== void 0 ? _b : [],
     ].flat();
-    let { files, folders } = (0, walk_tree_1.default)(input !== null && input !== void 0 ? input : '.', ignoredFiles);
+    let files, folders;
+    if (opts.fileContent) {
+        opts.fileContent = Array.isArray(opts.fileContent) ? opts.fileContent : [opts.fileContent];
+        files = [`${input}`];
+        folders = [''];
+    }
+    else {
+        const data = (0, walk_tree_1.default)(input !== null && input !== void 0 ? input : '.', ignoredFiles);
+        ({ files, folders } = data);
+    }
     // Apply aliases
     opts = { checkIgnored: !opts.quick, checkAttributes: !opts.quick, checkHeuristics: !opts.quick, checkShebang: !opts.quick, ...opts };
     // Ignore specific languages
@@ -50,7 +59,7 @@ async function analyse(input, opts = {}) {
     const customIgnored = [];
     const customBinary = [];
     const customText = [];
-    if (!opts.quick) {
+    if (!opts.fileContent && !opts.quick) {
         for (const folder of folders) {
             // Skip if folder is marked in gitattributes
             if (customIgnored.some(path => (0, convert_glob_1.default)(path).test(folder)))
@@ -97,7 +106,7 @@ async function analyse(input, opts = {}) {
         }
     }
     // Check vendored files
-    if (!opts.keepVendored) {
+    if (!opts.fileContent && !opts.keepVendored) {
         // Filter out any files that match a vendor file path
         const matcher = (match) => RegExp(match.replace(/\/$/, '/.+$').replace(/^\.\//, ''));
         files = files.filter(file => !customIgnored.some(pattern => matcher(pattern).test(file)));
@@ -115,9 +124,15 @@ async function analyse(input, opts = {}) {
     const overridesArray = Object.entries(overrides);
     // List all languages that could be associated with a given file
     for (const file of files) {
-        if (!fs_1.default.existsSync(file) || fs_1.default.lstatSync(file).isDirectory())
-            continue;
-        const firstLine = await (0, read_file_1.default)(file, true).catch(() => null);
+        let firstLine;
+        if (opts.fileContent) {
+            firstLine = (_f = (_e = (_d = opts.fileContent) === null || _d === void 0 ? void 0 : _d[files.indexOf(file)]) === null || _e === void 0 ? void 0 : _e.split('\n')[0]) !== null && _f !== void 0 ? _f : null;
+        }
+        else {
+            if (!fs_1.default.existsSync(file) || fs_1.default.lstatSync(file).isDirectory())
+                continue;
+            firstLine = await (0, read_file_1.default)(file, true).catch(() => null);
+        }
         // Skip if file is unreadable
         if (firstLine === null)
             continue;
@@ -132,7 +147,7 @@ async function analyse(input, opts = {}) {
             }
         }
         // Check override for manual language classification
-        if (!opts.quick && opts.checkAttributes) {
+        if (!opts.fileContent && !opts.quick && opts.checkAttributes) {
             const match = overridesArray.find(item => RegExp(item[0]).test(file));
             if (match) {
                 const forcedLang = match[1];
@@ -144,7 +159,7 @@ async function analyse(input, opts = {}) {
         let skipExts = false;
         for (const lang in langData) {
             // Check if filename is a match
-            const matchesName = (_d = langData[lang].filenames) === null || _d === void 0 ? void 0 : _d.some(name => path_1.default.basename(file.toLowerCase()) === name.toLowerCase());
+            const matchesName = (_g = langData[lang].filenames) === null || _g === void 0 ? void 0 : _g.some(name => path_1.default.basename(file.toLowerCase()) === name.toLowerCase());
             if (matchesName) {
                 addResult(file, lang);
                 skipExts = true;
@@ -153,7 +168,7 @@ async function analyse(input, opts = {}) {
         if (!skipExts)
             for (const lang in langData) {
                 // Check if extension is a match
-                const matchesExt = (_e = langData[lang].extensions) === null || _e === void 0 ? void 0 : _e.some(ext => file.toLowerCase().endsWith(ext.toLowerCase()));
+                const matchesExt = (_h = langData[lang].extensions) === null || _h === void 0 ? void 0 : _h.some(ext => file.toLowerCase().endsWith(ext.toLowerCase()));
                 if (matchesExt)
                     addResult(file, lang);
             }
@@ -164,7 +179,7 @@ async function analyse(input, opts = {}) {
     // Narrow down file associations to the best fit
     for (const file in fileAssociations) {
         // Skip binary files
-        if (!opts.keepBinary) {
+        if (!opts.fileContent && !opts.keepBinary) {
             const isCustomText = customText.some(path => RegExp(path).test(file));
             const isCustomBinary = customBinary.some(path => RegExp(path).test(file));
             const isBinaryExt = binary_extensions_1.default.some(ext => file.endsWith('.' + ext));
@@ -208,10 +223,10 @@ async function analyse(input, opts = {}) {
                 }
             }
         // If no heuristics, assign a language
-        (_f = (_k = results.files.results)[file]) !== null && _f !== void 0 ? _f : (_k[file] = fileAssociations[file][0]);
+        (_j = (_r = results.files.results)[file]) !== null && _j !== void 0 ? _j : (_r[file] = fileAssociations[file][0]);
     }
     // Skip specified categories
-    if ((_g = opts.categories) === null || _g === void 0 ? void 0 : _g.length) {
+    if ((_k = opts.categories) === null || _k === void 0 ? void 0 : _k.length) {
         const categories = ['data', 'markup', 'programming', 'prose'];
         const hiddenCategories = categories.filter(cat => !opts.categories.includes(cat));
         for (const [file, lang] of Object.entries(results.files.results)) {
@@ -229,7 +244,7 @@ async function analyse(input, opts = {}) {
         }
     }
     // Convert paths to relative
-    if (opts.relativePaths) {
+    if (!opts.fileContent && opts.relativePaths) {
         const newMap = {};
         for (const [file, lang] of Object.entries(results.files.results)) {
             let relPath = path_1.default.relative(process.cwd(), file).replace(/\\/g, '/');
@@ -243,21 +258,21 @@ async function analyse(input, opts = {}) {
     for (const [file, lang] of Object.entries(results.files.results)) {
         if (lang && !langData[lang])
             continue;
-        const fileSize = fs_1.default.statSync(file).size;
+        const fileSize = (_o = (_m = (_l = opts.fileContent) === null || _l === void 0 ? void 0 : _l[files.indexOf(file)]) === null || _m === void 0 ? void 0 : _m.length) !== null && _o !== void 0 ? _o : fs_1.default.statSync(file).size;
         results.files.bytes += fileSize;
         // If no language found, add extension in other section
         if (!lang) {
             const ext = path_1.default.extname(file);
             const unknownType = ext === '' ? 'filenames' : 'extensions';
             const name = ext === '' ? path_1.default.basename(file) : ext;
-            (_h = (_l = results.unknown[unknownType])[name]) !== null && _h !== void 0 ? _h : (_l[name] = 0);
+            (_p = (_s = results.unknown[unknownType])[name]) !== null && _p !== void 0 ? _p : (_s[name] = 0);
             results.unknown[unknownType][name] += fileSize;
             results.unknown.bytes += fileSize;
             continue;
         }
         // Add language and bytes data to corresponding section
         const { type } = langData[lang];
-        (_j = (_m = results.languages.results)[lang]) !== null && _j !== void 0 ? _j : (_m[lang] = { type, bytes: 0, color: langData[lang].color });
+        (_q = (_t = results.languages.results)[lang]) !== null && _q !== void 0 ? _q : (_t[lang] = { type, bytes: 0, color: langData[lang].color });
         if (opts.childLanguages)
             results.languages.results[lang].parent = langData[lang].group;
         results.languages.results[lang].bytes += fileSize;

package/dist/types.d.ts

@@ -5,6 +5,7 @@ export declare type FilePath = string;
 export declare type Bytes = Integer;
 export declare type Integer = number;
 export interface Options {
+    fileContent?: string | string[];
     ignoredFiles?: string[];
     ignoredLanguages?: Language[];
     categories?: Category[];

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "linguist-js",
-	"version": "2.2.1",
+	"version": "2.3.0",
 	"description": "Analyse languages used in a folder. Powered by GitHub Linguist, although it doesn't need to be installed.",
 	"main": "dist/index.js",
 	"bin": {
@@ -45,10 +45,10 @@
 		"node-cache": "^5.1.2"
 	},
 	"devDependencies": {
-		"@types/glob-to-regexp": "ts4.4",
-		"@types/js-yaml": "ts4.4",
-		"@types/node": "ts4.4",
+		"@types/glob-to-regexp": "ts4.6",
+		"@types/js-yaml": "ts4.6",
+		"@types/node": "ts4.6",
 		"deep-object-diff": "^1.1.7",
-		"typescript": "~4.5.5"
+		"typescript": "~4.6.1-rc"
 	}
 }

package/readme.md

@@ -77,6 +77,7 @@ Running Linguist on this folder will return the following JSON:
 ### Notes
 
 - File paths in the output use only forward slashes as delimiters, even on Windows.
+- This tool does not work when offline.
 - Do not rely on any language classification output from Linguist being unchanged between runs.
   Language data is fetched each run from the latest classifications of [`github-linguist`](https://github.com/github/linguist).
   This data is subject to change at any time and may change the results of a run even when using the same version of Linguist.
@@ -99,6 +100,8 @@ const { files, languages, unknown } = linguist(folder, options);
     Analyse multiple folders using the syntax `"{folder1,folder2,...}"`.
   - `opts` (optional; object):
     An object containing analyser options.
+    - `fileContent` (string or string array):
+      Provides the file content associated with the file name(s) given as `entry` to analyse instead of reading from a folder on disk.
     - `ignoredFiles` (string array):
       A list of file path globs to explicitly ignore.
     - `ignoredLanguages` (string array):