linguist-js 2.2.1 → 2.4.0

package/dist/cli.js

@@ -6,7 +6,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const VERSION = require('../package.json').version;
 const commander_1 = require("commander");
 const index_1 = __importDefault(require("./index"));
-const walk_tree_1 = __importDefault(require("./helpers/walk-tree"));
 const colouredMsg = ([r, g, b], msg) => `\u001B[${38};2;${r};${g};${b}m${msg}${'\u001b[0m'}`;
 const hexToRgb = (hex) => [parseInt(hex.slice(1, 3), 16), parseInt(hex.slice(3, 5), 16), parseInt(hex.slice(5, 7), 16)];
 commander_1.program
@@ -27,6 +26,7 @@ commander_1.program
     .option('-I|--checkIgnored [bool]', 'Force the checking of gitignore files', true)
     .option('-H|--checkHeuristics [bool]', 'Apply heuristics to ambiguous languages', true)
     .option('-S|--checkShebang [bool]', 'Check shebang lines for explicit classification', true)
+    .option('-M|--checkModeline [bool]', 'Check modelines for explicit classification', true)
     .helpOption(`-h|--help`, 'Display this help message')
     .version(VERSION, '-v|--version', 'Display the installed version of linguist-js');
 commander_1.program.parse(process.argv);
@@ -53,13 +53,11 @@ if (args.analyze)
         const root = args.analyze === true ? '.' : 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;
         // Print output
         if (!args.json) {
             const sortedEntries = Object.entries(languages.results).sort((a, b) => a[1].bytes < b[1].bytes ? +1 : -1);
             const totalBytes = languages.bytes;
-            console.log(`\n Analysed ${files.bytes.toLocaleString()} B from ${totalFiles} files (${totalFiles - files.count} ignored) with linguist-js`);
+            console.log(`\n Analysed ${files.bytes.toLocaleString()} B from ${files.count} files with linguist-js`);
             console.log(`\n Language analysis results:`);
             let count = 0;
             if (sortedEntries.length === 0)

package/dist/helpers/convert-pcre.js

@@ -3,23 +3,26 @@ Object.defineProperty(exports, "__esModule", { value: true });
 /** Convert a PCRE regex into JS. */
 function pcre(regex) {
     let finalRegex = regex;
+    const replace = (search, replace) => finalRegex = finalRegex.replace(search, replace);
     const finalFlags = new Set();
     // Convert inline flag declarations
     const inlineMatches = regex.matchAll(/\?([a-z]):/g);
     const startMatches = regex.matchAll(/\(\?([a-z]+)\)/g);
     for (const [match, flags] of [...inlineMatches, ...startMatches]) {
-        finalRegex = finalRegex.replace(match, '');
+        replace(match, '');
         [...flags].forEach(flag => finalFlags.add(flag));
     }
-    // Remove invalid modifiers
-    finalRegex = finalRegex.replace(/([*+]){2}/g, '$1');
+    // Remove invalid syntax
+    replace(/([*+]){2}/g, '$1');
+    replace(/\(\?>/g, '(?:');
     // Remove start/end-of-file markers
     if (/\\[AZ]/.test(finalRegex)) {
-        finalRegex = finalRegex.replace(/\\A/g, '^').replace(/\\Z/g, '$');
+        replace(/\\A/g, '^').replace(/\\Z/g, '$');
         finalFlags.delete('m');
     }
     else
         finalFlags.add('m');
+    // Return final regex
     return RegExp(finalRegex, [...finalFlags].join(''));
 }
 exports.default = pcre;

package/dist/helpers/walk-tree.js

@@ -8,28 +8,50 @@ const path_1 = __importDefault(require("path"));
 const allFiles = new Set();
 const allFolders = new Set();
 /** Generate list of files in a directory. */
-function walk(folder, ignored = []) {
-    if (Array.isArray(folder)) {
-        for (const path of folder)
-            walk(path, ignored);
-    }
-    else {
-        const files = fs_1.default.readdirSync(folder);
+function walk(root, folders, ignored = []) {
+    // Switch out paths that expect being in root
+    ignored = ignored.map(match => match.replace(/^\^/, '^\\./'));
+    // Walk tree of a folder
+    if (folders.length === 1) {
+        const folder = folders[0];
+        // Get list of files and folders inside this folder
+        const files = fs_1.default.readdirSync(folder).map(file => {
+            // Create path relative to root
+            const base = path_1.default.resolve(folder, file).replace(/\\/g, '/').replace(root, '.');
+            // Add trailing slash to mark directories
+            const isDir = fs_1.default.lstatSync(path_1.default.resolve(root, base)).isDirectory();
+            return isDir ? `${base}/` : base;
+        });
+        // Loop through files and folders
         for (const file of files) {
-            const path = path_1.default.resolve(folder, file).replace(/\\/g, '/');
-            if (!fs_1.default.existsSync(path) || ignored.some(pattern => pattern.test(path)))
+            // Create absolute path for disc operations
+            const path = path_1.default.resolve(root, file).replace(/\\/g, '/');
+            // Skip if nonexistant or ignored
+            if (!fs_1.default.existsSync(path) || ignored.some(pattern => RegExp(pattern).test(file)))
                 continue;
-            allFolders.add(folder.replace(/\\/g, '/'));
-            if (fs_1.default.lstatSync(path).isDirectory()) {
+            // Add absolute folder path to list
+            allFolders.add(path_1.default.resolve(folder).replace(/\\/g, '/'));
+            // Check if this is a folder or file
+            if (file.endsWith('/')) {
+                // Recurse into subfolders
                 allFolders.add(path);
-                walk(path, ignored);
-                continue;
+                walk(root, [path], ignored);
+            }
+            else {
+                // Add relative file path to list
+                allFiles.add(path);
             }
-            allFiles.add(path);
         }
     }
+    // Recurse into all folders
+    else {
+        for (const path of folders) {
+            walk(root, [path], ignored);
+        }
+    }
+    // Return absolute files and folders lists
     return {
-        files: [...allFiles],
+        files: [...allFiles].map(file => file.replace(/^\./, root)),
         folders: [...allFolders],
     };
 }

package/dist/index.js

@@ -6,6 +6,7 @@ const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const js_yaml_1 = __importDefault(require("js-yaml"));
 const glob_to_regexp_1 = __importDefault(require("glob-to-regexp"));
+const common_path_prefix_1 = __importDefault(require("common-path-prefix"));
 const binary_extensions_1 = __importDefault(require("binary-extensions"));
 const isbinaryfile_1 = require("isbinaryfile");
 const walk_tree_1 = __importDefault(require("./helpers/walk-tree"));
@@ -14,14 +15,21 @@ 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, _r, _s;
+    var _t, _u, _v;
+    const useRawContent = opts.fileContent !== undefined;
+    input = [input !== null && input !== void 0 ? input : []].flat();
+    opts.fileContent = [(_a = opts.fileContent) !== null && _a !== void 0 ? _a : []].flat();
+    // Load data from github-linguist web repo
     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 docData = await (0, load_data_1.default)('documentation.yml').then(js_yaml_1.default.load);
     const heuristicsData = await (0, load_data_1.default)('heuristics.yml').then(js_yaml_1.default.load);
     const generatedData = await (0, load_data_1.default)('generated.rb').then(text => { var _a; return (_a = text.match(/(?<=name\.match\(\/).+?(?=(?<!\\)\/\))/gm)) !== null && _a !== void 0 ? _a : []; });
-    vendorData.push(...generatedData);
+    const vendorPaths = [...vendorData, ...docData, ...generatedData];
+    // Setup main variables
     const fileAssociations = {};
+    const definiteness = {};
     const extensions = {};
     const overrides = {};
     const results = {
@@ -29,16 +37,41 @@ async function analyse(input, opts = {}) {
         languages: { count: 0, bytes: 0, results: {} },
         unknown: { count: 0, bytes: 0, extensions: {}, filenames: {} },
     };
-    const ignoredFiles = [
-        /\/\.git\//,
-        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);
+    // Prepare list of ignored files
+    const ignoredFiles = ['(^|\\/)\\.git\\/'];
+    if (!opts.keepVendored) {
+        ignoredFiles.push(...vendorPaths);
+    }
+    if (opts.ignoredFiles) {
+        ignoredFiles.push(...opts.ignoredFiles.map(path => (0, glob_to_regexp_1.default)('*' + path + '*', { extended: true }).source));
+    }
+    // Load file paths and folders
+    let files, folders;
+    if (useRawContent) {
+        // Uses raw file content
+        files = input;
+        folders = [''];
+    }
+    else {
+        // Uses directory on disc
+        // Set a common root path so that vendor paths do not incorrectly match parent folders
+        const resolvedInput = input.map(path => path_1.default.resolve(path).replace(/\\/g, '/'));
+        const commonRoot = (input.length > 1 ? (0, common_path_prefix_1.default)(resolvedInput) : resolvedInput[0]).replace(/\/?$/, '');
+        const data = (0, walk_tree_1.default)(commonRoot, input, ignoredFiles);
+        files = data.files;
+        folders = data.folders;
+    }
     // Apply aliases
-    opts = { checkIgnored: !opts.quick, checkAttributes: !opts.quick, checkHeuristics: !opts.quick, checkShebang: !opts.quick, ...opts };
+    opts = {
+        checkIgnored: !opts.quick,
+        checkAttributes: !opts.quick,
+        checkHeuristics: !opts.quick,
+        checkShebang: !opts.quick,
+        checkModeline: !opts.quick,
+        ...opts
+    };
     // Ignore specific languages
-    for (const lang of (_c = opts.ignoredLanguages) !== null && _c !== void 0 ? _c : []) {
+    for (const lang of (_b = opts.ignoredLanguages) !== null && _b !== void 0 ? _b : []) {
         for (const key in langData) {
             if (lang.toLowerCase() === key.toLowerCase()) {
                 delete langData[key];
@@ -50,7 +83,7 @@ async function analyse(input, opts = {}) {
     const customIgnored = [];
     const customBinary = [];
     const customText = [];
-    if (!opts.quick) {
+    if (!useRawContent && opts.checkAttributes) {
         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 +130,7 @@ async function analyse(input, opts = {}) {
         }
     }
     // Check vendored files
-    if (!opts.keepVendored) {
+    if (!useRawContent && !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)));
@@ -110,33 +143,56 @@ async function analyse(input, opts = {}) {
         }
         const parent = !opts.childLanguages && result && langData[result].group || false;
         fileAssociations[file].push(parent || result);
-        extensions[file] = path_1.default.extname(file);
+        extensions[file] = path_1.default.extname(file).toLowerCase();
     };
     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 (useRawContent) {
+            firstLine = (_e = (_d = (_c = opts.fileContent) === null || _c === void 0 ? void 0 : _c[files.indexOf(file)]) === null || _d === void 0 ? void 0 : _d.split('\n')[0]) !== null && _e !== void 0 ? _e : 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;
-        // Check shebang line for explicit classification
-        if (!opts.quick && opts.checkShebang && firstLine.startsWith('#!')) {
-            // Find matching interpreters
-            const matches = Object.entries(langData).filter(([, data]) => { var _a; return (_a = data.interpreters) === null || _a === void 0 ? void 0 : _a.some(interpreter => firstLine.match('\\b' + interpreter + '\\b')); });
+        // Check first line for explicit classification
+        const hasShebang = opts.checkShebang && /^#!/.test(firstLine);
+        const hasModeline = opts.checkModeline && /-\*-|(syntax|filetype|ft)\s*=/.test(firstLine);
+        if (!opts.quick && (hasShebang || hasModeline)) {
+            const matches = [];
+            for (const [lang, data] of Object.entries(langData)) {
+                const langMatcher = (lang) => `\\b${lang.toLowerCase().replace(/\W/g, '\\$&')}\\b`;
+                // Check for interpreter match
+                const matchesInterpretor = (_f = data.interpreters) === null || _f === void 0 ? void 0 : _f.some(interpreter => firstLine.match(`\\b${interpreter}\\b`));
+                // Check modeline declaration
+                const matchesLang = firstLine.toLowerCase().match(langMatcher(lang));
+                const matchesAlias = (_g = data.aliases) === null || _g === void 0 ? void 0 : _g.some(lang => firstLine.toLowerCase().match(langMatcher(lang)));
+                // Add language
+                if (opts.checkShebang && matchesInterpretor)
+                    matches.push(lang);
+                if (opts.checkModeline && (matchesLang || matchesAlias))
+                    matches.push(lang);
+            }
             if (matches.length) {
                 // Add explicitly-identified language
-                const forcedLang = matches[0][0];
+                const forcedLang = matches[0];
                 addResult(file, forcedLang);
+                definiteness[file] = true;
+                continue;
             }
         }
         // Check override for manual language classification
-        if (!opts.quick && opts.checkAttributes) {
+        if (!useRawContent && !opts.quick && opts.checkAttributes) {
             const match = overridesArray.find(item => RegExp(item[0]).test(file));
             if (match) {
                 const forcedLang = match[1];
                 addResult(file, forcedLang);
+                definiteness[file] = true;
                 continue;
             }
         }
@@ -144,7 +200,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 = (_h = langData[lang].filenames) === null || _h === void 0 ? void 0 : _h.some(name => path_1.default.basename(file.toLowerCase()) === name.toLowerCase());
             if (matchesName) {
                 addResult(file, lang);
                 skipExts = true;
@@ -153,7 +209,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 = (_j = langData[lang].extensions) === null || _j === void 0 ? void 0 : _j.some(ext => file.toLowerCase().endsWith(ext.toLowerCase()));
                 if (matchesExt)
                     addResult(file, lang);
             }
@@ -163,8 +219,13 @@ async function analyse(input, opts = {}) {
     }
     // Narrow down file associations to the best fit
     for (const file in fileAssociations) {
+        // Skip if file has explicit association
+        if (definiteness[file]) {
+            results.files.results[file] = fileAssociations[file][0];
+            continue;
+        }
         // Skip binary files
-        if (!opts.keepBinary) {
+        if (!useRawContent && !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));
@@ -186,13 +247,14 @@ async function analyse(input, opts = {}) {
                         heuristic.language = heuristic.language[0];
                     }
                     // Make sure the results includes this language
+                    const languageGroup = (_k = langData[heuristic.language]) === null || _k === void 0 ? void 0 : _k.group;
                     const matchesLang = fileAssociations[file].includes(heuristic.language);
-                    const matchesParent = langData[heuristic.language].group && fileAssociations[file].includes(langData[heuristic.language].group);
+                    const matchesParent = languageGroup && fileAssociations[file].includes(languageGroup);
                     if (!matchesLang && !matchesParent)
                         continue;
                     // Normalise heuristic data
                     const patterns = [];
-                    const normalise = (contents) => patterns.push(...(Array.isArray(contents) ? contents : [contents]));
+                    const normalise = (contents) => patterns.push(...[contents].flat());
                     if (heuristic.pattern)
                         normalise(heuristic.pattern);
                     if (heuristic.named_pattern)
@@ -208,10 +270,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]);
+        (_l = (_t = results.files.results)[file]) !== null && _l !== void 0 ? _l : (_t[file] = fileAssociations[file][0]);
     }
     // Skip specified categories
-    if ((_g = opts.categories) === null || _g === void 0 ? void 0 : _g.length) {
+    if ((_m = opts.categories) === null || _m === void 0 ? void 0 : _m.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 +291,7 @@ async function analyse(input, opts = {}) {
         }
     }
     // Convert paths to relative
-    if (opts.relativePaths) {
+    if (!useRawContent && 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 +305,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 = (_q = (_p = (_o = opts.fileContent) === null || _o === void 0 ? void 0 : _o[files.indexOf(file)]) === null || _p === void 0 ? void 0 : _p.length) !== null && _q !== void 0 ? _q : 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);
+            (_r = (_u = results.unknown[unknownType])[name]) !== null && _r !== void 0 ? _r : (_u[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 });
+        (_s = (_v = results.languages.results)[lang]) !== null && _s !== void 0 ? _s : (_v[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[];
@@ -17,6 +18,7 @@ export interface Options {
     checkAttributes?: boolean;
     checkHeuristics?: boolean;
     checkShebang?: boolean;
+    checkModeline?: boolean;
 }
 export interface Results {
     files: {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "linguist-js",
-	"version": "2.2.1",
+	"version": "2.4.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": {
@@ -38,6 +38,7 @@
 	"dependencies": {
 		"binary-extensions": "^2.2.0",
 		"commander": "^9.0.0",
+		"common-path-prefix": "^3.0.0",
 		"cross-fetch": "^3.1.5",
 		"glob-to-regexp": "~0.4.1",
 		"isbinaryfile": "^4.0.8",
@@ -45,10 +46,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):
@@ -110,21 +113,26 @@ const { files, languages, unknown } = linguist(folder, options);
       Whether to display sub-languages instead of their parents when possible (defaults to `false`).
     - `quick` (boolean):
       Whether to skip complex language analysis such as the checking of heuristics and gitattributes statements (defaults to `false`).
-      Alias for `checkAttributes:false, checkIgnored:false, checkHeuristics:false, checkShebang:false`.
+      Alias for `checkAttributes:false, checkIgnored:false, checkHeuristics:false, checkShebang:false, checkModeline:false`.
     - `keepVendored` (boolean):
       Whether to keep vendored files (dependencies, etc) (defaults to `false`).
+      Does nothing when `fileContent` is set.
     - `keepBinary` (boolean):
       Whether binary files should be included in the output (defaults to `false`).
     - `relativePaths` (boolean):
       Change the absolute file paths in the output to be relative to the current working directory (defaults to `false`).
     - `checkAttributes` (boolean):
       Force the checking of `.gitattributes` files (defaults to `true` unless `quick` is set).
+      Does nothing when `fileContent` is set.
     - `checkIgnored` (boolean):
       Force the checking of `.gitignore` files (defaults to `true` unless `quick` is set).
+      Does nothing when `fileContent` is set.
     - `checkHeuristics` (boolean):
       Apply heuristics to ambiguous languages (defaults to `true` unless `quick` is set).
     - `checkShebang` (boolean):
       Check shebang (`#!`) lines for explicit language classification (defaults to `true` unless `quick` is set).
+    - `checkModeline` (boolean):
+      Check modelines for explicit language classification (defaults to `true` unless `quick` is set).
 
 ### Command-line
 
@@ -152,7 +160,7 @@ linguist --help
     Requires `--json` to be specified.
   - `--quick`:
     Whether to skip the checking of `.gitattributes` and `.gitignore` files for manual language classifications.
-    Alias for `--checkAttributes=false --checkIgnored=false --checkHeuristics=false --checkShebang=false`.
+    Alias for `--checkAttributes=false --checkIgnored=false --checkHeuristics=false --checkExplicit=false --checkModeline=false`.
   - `--keepVendored`:
     Whether to include vendored files (auto-generated files, dependencies folder, etc).
   - `--keepBinary`:
@@ -167,6 +175,8 @@ linguist --help
     Apply heuristics to ambiguous languages (use alongside `--quick` to overwrite).
   - `--checkShebang`:
     Check shebang (`#!`) lines for explicit classification (use alongside `--quick` to overwrite).
+  - `--checkModeline`:
+    Check modelines for explicit classification (use alongside `--quick` to overwrite).
 - `--help`:
   Display a help message.
 - `--version`: