linguist-js 2.8.0 → 2.8.1

package/dist/helpers/convert-pcre.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = pcre;
 /** Convert a PCRE regex into JS. */
 function pcre(regex) {
     let finalRegex = regex;
@@ -35,4 +36,3 @@ function pcre(regex) {
     // Return final regex
     return RegExp(finalRegex, [...finalFlags].join(''));
 }
-exports.default = pcre;

package/dist/helpers/load-data.d.ts

@@ -1,4 +1,4 @@
 /** Nukes unused `generated.rb` file content. */
-export declare function parseGeneratedDataFile(fileContent: string): Promise<string[]>;
+export declare function parseGeneratedDataFile(fileContent: string): string[];
 /** Load a data file from github-linguist. */
 export default function loadFile(file: string, offline?: boolean): Promise<string>;

package/dist/helpers/load-data.js

@@ -3,7 +3,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseGeneratedDataFile = void 0;
+exports.parseGeneratedDataFile = parseGeneratedDataFile;
+exports.default = loadFile;
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const cross_fetch_1 = __importDefault(require("cross-fetch"));
@@ -26,13 +27,11 @@ async function loadLocalFile(file) {
     return fs_1.default.promises.readFile(filePath).then(buffer => buffer.toString());
 }
 /** Nukes unused `generated.rb` file content. */
-async function parseGeneratedDataFile(fileContent) {
+function parseGeneratedDataFile(fileContent) {
     var _a;
     return [...(_a = fileContent.match(/(?<=name\.match\(\/).+?(?=(?<!\\)\/)/gm)) !== null && _a !== void 0 ? _a : []];
 }
-exports.parseGeneratedDataFile = parseGeneratedDataFile;
 /** Load a data file from github-linguist. */
-async function loadFile(file, offline = false) {
+function loadFile(file, offline = false) {
     return offline ? loadLocalFile(file) : loadWebFile(file);
 }
-exports.default = loadFile;

package/dist/helpers/parse-gitattributes.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = parseAttributes;
 const norm_path_1 = require("./norm-path");
 /**
  * Parses a gitattributes file.
@@ -34,4 +35,3 @@ function parseAttributes(content, folderRoot = '.') {
     }
     return output;
 }
-exports.default = parseAttributes;

package/dist/helpers/parse-gitignore.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = parseGitignore;
 function parseGitignore(content) {
     const readableData = content
         // Remove comments unless escaped
@@ -9,4 +10,3 @@ function parseGitignore(content) {
     const arrayData = readableData.split(/\r?\n/).filter(data => data);
     return arrayData;
 }
-exports.default = parseGitignore;

package/dist/helpers/read-file.js

@@ -3,6 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = readFileChunk;
 const fs_1 = __importDefault(require("fs"));
 /**
  * Read part of a file on disc.
@@ -20,4 +21,3 @@ async function readFileChunk(filename, onlyFirstLine = false) {
     }
     return content;
 }
-exports.default = readFileChunk;

package/dist/helpers/walk-tree.js

@@ -3,6 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = walk;
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const parse_gitignore_1 = __importDefault(require("./parse-gitignore"));
@@ -36,7 +37,12 @@ function walk(data) {
         if (fs_1.default.existsSync(gitignoreFilename)) {
             const gitignoreContents = fs_1.default.readFileSync(gitignoreFilename, 'utf-8');
             const ignoredPaths = (0, parse_gitignore_1.default)(gitignoreContents);
-            ignored.add(ignoredPaths);
+            const rootRelIgnoredPaths = ignoredPaths.map(ignorePath => 
+            // get absolute path of the ignore glob
+            (0, norm_path_1.normPath)(folder, ignorePath)
+                // convert abs ignore glob to be relative to the root folder
+                .replace(commonRoot + '/', ''));
+            ignored.add(rootRelIgnoredPaths);
         }
         // Add gitattributes if present
         const gitattributesPath = (0, norm_path_1.normPath)(folder, '.gitattributes');
@@ -82,4 +88,3 @@ function walk(data) {
         folders: [...allFolders],
     };
 }
-exports.default = walk;

package/dist/index.js

@@ -46,7 +46,7 @@ async function analyse(rawPaths, opts = {}) {
     const manualFileContent = [(_a = opts.fileContent) !== null && _a !== void 0 ? _a : []].flat();
     // Normalise input option arguments
     opts = {
-        calculateLines: (_b = opts.calculateLines) !== null && _b !== void 0 ? _b : true,
+        calculateLines: (_b = opts.calculateLines) !== null && _b !== void 0 ? _b : true, // default to true if unset
         checkIgnored: !opts.quick,
         checkDetected: !opts.quick,
         checkAttributes: !opts.quick,

package/dist/package.json

@@ -0,0 +1,56 @@
+{
+    "name": "linguist-js",
+    "version": "2.8.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": {
+        "linguist-js": "bin/index.js",
+        "linguist": "bin/index.js"
+    },
+    "engines": {
+        "node": ">=12"
+    },
+    "scripts": {
+        "download-files": "npx tsx@3 build/download-files",
+        "pre-publish": "npm run download-files && npm test && npm run perf",
+        "perf": "tsc && node test/perf",
+        "test": "tsc && node test/folder && node test/unit"
+    },
+    "files": [
+        "bin/",
+        "dist/",
+        "ext/"
+    ],
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/Nixinova/Linguist.git"
+    },
+    "keywords": [
+        "linguist",
+        "languages",
+        "language-analysis",
+        "language-analyzer"
+    ],
+    "author": "Nixinova (https://nixinova.com)",
+    "license": "ISC",
+    "bugs": {
+        "url": "https://github.com/Nixinova/Linguist/issues"
+    },
+    "homepage": "https://github.com/Nixinova/Linguist#readme",
+    "dependencies": {
+        "binary-extensions": "^2.3.0 <3",
+        "commander": "^9.5.0 <10",
+        "common-path-prefix": "^3.0.0",
+        "cross-fetch": "^3.1.8 <4",
+        "ignore": "^5.3.2",
+        "isbinaryfile": "^4.0.10 <5",
+        "js-yaml": "^4.1.0",
+        "node-cache": "^5.1.2"
+    },
+    "devDependencies": {
+        "@types/js-yaml": "^4.0.9",
+        "@types/node": "ts5.0",
+        "deep-object-diff": "^1.1.9",
+        "typescript": "~5.0.4 <5.1"
+    }
+}

package/dist/src/cli.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/cli.js

@@ -0,0 +1,146 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const package_json_1 = __importDefault(require("../package.json"));
+;
+const node_fs_1 = __importDefault(require("node:fs"));
+const node_path_1 = __importDefault(require("node:path"));
+const commander_1 = require("commander");
+const index_1 = __importDefault(require("./index"));
+const norm_path_1 = require("./helpers/norm-path");
+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
+    .name('linguist')
+    .usage('--analyze [<folders...>] [<options...>]')
+    .option('-a|--analyze|--analyse [folders...]', 'Analyse the languages of all files in a folder')
+    .option('-i|--ignoredFiles <files...>', `A list of file path globs to ignore`)
+    .option('-l|--ignoredLanguages <languages...>', `A list of languages to ignore`)
+    .option('-c|--categories <categories...>', 'Language categories to include in output')
+    .option('-C|--childLanguages [bool]', 'Display child languages instead of their parents', false)
+    .option('-j|--json [bool]', 'Display the output as JSON', false)
+    .option('-t|--tree <traversal>', 'Which part of the output JSON to display (dot-delimited)')
+    .option('-F|--listFiles [bool]', 'Whether to list every matching file under the language results', false)
+    .option('-q|--quick [bool]', 'Skip complex language analysis (alias for -{A|I|H|S}=false)', false)
+    .option('-o|--offline [bool]', 'Use packaged data files instead of fetching latest from GitHub', false)
+    .option('-L|--calculateLines [bool]', 'Calculate lines of code totals', true)
+    .option('-V|--keepVendored [bool]', 'Prevent skipping over vendored/generated files', false)
+    .option('-B|--keepBinary [bool]', 'Prevent skipping over binary files', false)
+    .option('-r|--relativePaths [bool]', 'Convert absolute file paths to relative', false)
+    .option('-A|--checkAttributes [bool]', 'Force the checking of gitattributes files', true)
+    .option('-I|--checkIgnored [bool]', 'Force the checking of gitignore files', true)
+    .option('-D|--checkDetected [bool]', 'Force files marked with linguist-detectable to always appear in output', 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(package_json_1.default.version, '-v|--version', 'Display the installed version of linguist-js');
+commander_1.program.parse(process.argv);
+const args = commander_1.program.opts();
+// Normalise arguments
+for (const arg in args) {
+    const normalise = (val) => {
+        if (typeof val !== 'string')
+            return val;
+        val = val.replace(/^=/, '');
+        if (val.match(/true$|false$/))
+            val = val === 'true';
+        return val;
+    };
+    if (Array.isArray(args[arg]))
+        args[arg] = args[arg].map(normalise);
+    else
+        args[arg] = normalise(args[arg]);
+}
+// Run Linguist
+if (args.analyze)
+    (async () => {
+        // Fetch language data
+        const root = args.analyze === true ? '.' : args.analyze;
+        const data = await (0, index_1.default)(root, args);
+        const { files, languages, unknown } = data;
+        // 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 ${files.count} files with linguist-js`);
+            console.log(`\n Language analysis results: \n`);
+            let count = 0;
+            if (sortedEntries.length === 0)
+                console.log(`  None`);
+            // Collate files per language
+            const filesPerLanguage = {};
+            if (args.listFiles) {
+                for (const language of Object.keys(languages.results)) {
+                    filesPerLanguage[language] = [];
+                }
+                for (const [file, lang] of Object.entries(files.results)) {
+                    if (lang)
+                        filesPerLanguage[lang].push(file);
+                }
+            }
+            // List parsed results
+            for (const [lang, { bytes, lines, color }] of sortedEntries) {
+                const percent = (bytes) => bytes / (totalBytes || 1) * 100;
+                const fmtd = {
+                    index: (++count).toString().padStart(2, ' '),
+                    lang: lang.padEnd(24, ' '),
+                    percent: percent(bytes).toFixed(2).padStart(5, ' '),
+                    bytes: bytes.toLocaleString().padStart(10, ' '),
+                    loc: lines.code.toLocaleString().padStart(10, ' '),
+                    icon: colouredMsg(hexToRgb(color !== null && color !== void 0 ? color : '#ededed'), '\u2588'),
+                };
+                console.log(`  ${fmtd.index}. ${fmtd.icon} ${fmtd.lang} ${fmtd.percent}% ${fmtd.bytes} B ${fmtd.loc} LOC`);
+                // If using `listFiles` option, list all files tagged as this language
+                if (args.listFiles) {
+                    console.log(); // padding
+                    for (const file of filesPerLanguage[lang]) {
+                        let relFile = (0, norm_path_1.normPath)(node_path_1.default.relative(node_path_1.default.resolve('.'), file));
+                        if (!relFile.startsWith('../'))
+                            relFile = './' + relFile;
+                        const bytes = (await node_fs_1.default.promises.stat(file)).size;
+                        const fmtd2 = {
+                            file: relFile.padEnd(42, ' '),
+                            percent: percent(bytes).toFixed(2).padStart(5, ' '),
+                            bytes: bytes.toLocaleString().padStart(10, ' '),
+                        };
+                        console.log(`        ${fmtd.icon} ${fmtd2.file}  ${fmtd2.percent}% ${fmtd2.bytes} B`);
+                    }
+                    console.log(); // padding
+                }
+            }
+            if (!args.listFiles)
+                console.log(); // padding
+            console.log(` Total: ${totalBytes.toLocaleString()} B`);
+            // List unknown files/extensions
+            if (unknown.bytes > 0) {
+                console.log(`\n Unknown files and extensions:`);
+                for (const [name, bytes] of Object.entries(unknown.filenames)) {
+                    console.log(`  '${name}': ${bytes.toLocaleString()} B`);
+                }
+                for (const [ext, bytes] of Object.entries(unknown.extensions)) {
+                    console.log(`  '*${ext}': ${bytes.toLocaleString()} B`);
+                }
+                console.log(` Total: ${unknown.bytes.toLocaleString()} B`);
+            }
+        }
+        else if (args.tree) {
+            const treeParts = args.tree.split('.');
+            let nestedData = data;
+            for (const part of treeParts) {
+                if (!nestedData[part])
+                    throw Error(`TraversalError: Key '${part}' cannot be found on output object.`);
+                nestedData = nestedData[part];
+            }
+            console.log(nestedData);
+        }
+        else {
+            console.dir(data, { depth: null });
+        }
+    })();
+else {
+    console.log(`Welcome to linguist-js, a JavaScript port of GitHub's language analyzer.`);
+    console.log(`Type 'linguist --help' for a list of commands.`);
+}

package/dist/src/helpers/convert-pcre.d.ts

@@ -0,0 +1,2 @@
+/** Convert a PCRE regex into JS. */
+export default function pcre(regex: string): RegExp;

package/dist/src/helpers/convert-pcre.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = pcre;
+/** 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, isNegative, flags] of [...inlineMatches, ...startMatches]) {
+        replace(match, '');
+        const func = (flag) => isNegative ? finalFlags.delete(flag) : finalFlags.add(flag);
+        [...flags].forEach(func);
+    }
+    // Remove PCRE-only syntax
+    replace(/([*+]){2}/g, '$1');
+    replace(/\(\?>/g, '(?:');
+    // Remove start/end-of-file markers
+    if (/\\[AZ]/.test(finalRegex)) {
+        replace(/\\A/g, '^');
+        replace(/\\Z/g, '$');
+        finalFlags.delete('m');
+    }
+    else {
+        finalFlags.add('m');
+    }
+    // Reformat free-spacing mode
+    if (finalFlags.has('x')) {
+        finalFlags.delete('x');
+        replace(/#.+/g, '');
+        replace(/^\s+|\s+$|\n/gm, '');
+        replace(/\s+/g, ' ');
+    }
+    // Return final regex
+    return RegExp(finalRegex, [...finalFlags].join(''));
+}

package/dist/src/helpers/load-data.d.ts

@@ -0,0 +1,4 @@
+/** Nukes unused `generated.rb` file content. */
+export declare function parseGeneratedDataFile(fileContent: string): Promise<string[]>;
+/** Load a data file from github-linguist. */
+export default function loadFile(file: string, offline?: boolean): Promise<string>;

package/dist/src/helpers/load-data.js

@@ -0,0 +1,37 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseGeneratedDataFile = parseGeneratedDataFile;
+exports.default = loadFile;
+const node_fs_1 = __importDefault(require("node:fs"));
+const node_path_1 = __importDefault(require("node:path"));
+const cross_fetch_1 = __importDefault(require("cross-fetch"));
+const node_cache_1 = __importDefault(require("node-cache"));
+const cache = new node_cache_1.default({});
+async function loadWebFile(file) {
+    // Return cache if it exists
+    const cachedContent = cache.get(file);
+    if (cachedContent)
+        return cachedContent;
+    // Otherwise cache the request
+    const dataUrl = (file) => `https://raw.githubusercontent.com/github/linguist/HEAD/lib/linguist/${file}`;
+    // Load file content, falling back to the local file if the request fails
+    const fileContent = await (0, cross_fetch_1.default)(dataUrl(file)).then(data => data.text()).catch(async () => await loadLocalFile(file));
+    cache.set(file, fileContent);
+    return fileContent;
+}
+async function loadLocalFile(file) {
+    const filePath = node_path_1.default.resolve(__dirname, '../../ext', file);
+    return node_fs_1.default.promises.readFile(filePath).then(buffer => buffer.toString());
+}
+/** Nukes unused `generated.rb` file content. */
+async function parseGeneratedDataFile(fileContent) {
+    var _a;
+    return [...(_a = fileContent.match(/(?<=name\.match\(\/).+?(?=(?<!\\)\/)/gm)) !== null && _a !== void 0 ? _a : []];
+}
+/** Load a data file from github-linguist. */
+async function loadFile(file, offline = false) {
+    return offline ? loadLocalFile(file) : loadWebFile(file);
+}

package/dist/src/helpers/norm-path.d.ts

@@ -0,0 +1,2 @@
+export declare const normPath: (...inputPaths: string[]) => string;
+export declare const normAbsPath: (...inputPaths: string[]) => string;

package/dist/src/helpers/norm-path.js

@@ -0,0 +1,15 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normAbsPath = exports.normPath = void 0;
+const node_path_1 = __importDefault(require("node:path"));
+const normPath = function normalisedPath(...inputPaths) {
+    return node_path_1.default.join(...inputPaths).replace(/\\/g, '/');
+};
+exports.normPath = normPath;
+const normAbsPath = function normalisedAbsolutePath(...inputPaths) {
+    return node_path_1.default.resolve(...inputPaths).replace(/\\/g, '/');
+};
+exports.normAbsPath = normAbsPath;

package/dist/src/helpers/parse-gitattributes.d.ts

@@ -0,0 +1,17 @@
+import * as T from '../types';
+export type FlagAttributes = {
+    'vendored': boolean | null;
+    'generated': boolean | null;
+    'documentation': boolean | null;
+    'detectable': boolean | null;
+    'binary': boolean | null;
+    'language': T.LanguageResult;
+};
+export type ParsedGitattributes = Array<{
+    glob: T.FileGlob;
+    attrs: FlagAttributes;
+}>;
+/**
+ * Parses a gitattributes file.
+ */
+export default function parseAttributes(content: string, folderRoot?: string): ParsedGitattributes;

package/dist/src/helpers/parse-gitattributes.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = parseAttributes;
+const norm_path_1 = require("./norm-path");
+/**
+ * Parses a gitattributes file.
+ */
+function parseAttributes(content, folderRoot = '.') {
+    var _a, _b;
+    const output = [];
+    for (const rawLine of content.split('\n')) {
+        const line = rawLine.replace(/#.*/, '').trim();
+        if (!line)
+            continue;
+        const parts = line.split(/\s+/g);
+        const fileGlob = parts[0];
+        const relFileGlob = (0, norm_path_1.normPath)(folderRoot, fileGlob);
+        const attrParts = parts.slice(1);
+        const isTrue = (str) => !str.startsWith('-') && !str.endsWith('=false');
+        const isFalse = (str) => str.startsWith('-') || str.endsWith('=false');
+        const trueParts = (str) => attrParts.filter(part => part.includes(str) && isTrue(part));
+        const falseParts = (str) => attrParts.filter(part => part.includes(str) && isFalse(part));
+        const hasTrueParts = (str) => trueParts(str).length > 0;
+        const hasFalseParts = (str) => falseParts(str).length > 0;
+        const boolOrNullVal = (str) => hasTrueParts(str) ? true : hasFalseParts(str) ? false : null;
+        const attrs = {
+            'generated': boolOrNullVal('linguist-generated'),
+            'vendored': boolOrNullVal('linguist-vendored'),
+            'documentation': boolOrNullVal('linguist-documentation'),
+            'detectable': boolOrNullVal('linguist-detectable'),
+            'binary': hasTrueParts('binary') || hasFalseParts('text') ? true : hasFalseParts('binary') || hasTrueParts('text') ? false : null,
+            'language': (_b = (_a = trueParts('linguist-language').at(-1)) === null || _a === void 0 ? void 0 : _a.split('=')[1]) !== null && _b !== void 0 ? _b : null,
+        };
+        output.push({ glob: relFileGlob, attrs });
+    }
+    return output;
+}

package/dist/src/helpers/parse-gitignore.d.ts

@@ -0,0 +1 @@
+export default function parseGitignore(content: string): string[];

package/dist/src/helpers/parse-gitignore.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = parseGitignore;
+function parseGitignore(content) {
+    const readableData = content
+        // Remove comments unless escaped
+        .replace(/(?<!\\)#.+/g, '')
+        // Remove whitespace unless escaped
+        .replace(/(?:(?<!\\)\s)+$/g, '');
+    const arrayData = readableData.split(/\r?\n/).filter(data => data);
+    return arrayData;
+}

package/dist/src/helpers/read-file.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Read part of a file on disc.
+ * @throws 'EPERM' if the file is not readable.
+ */
+export default function readFileChunk(filename: string, onlyFirstLine?: boolean): Promise<string>;

package/dist/src/helpers/read-file.js

@@ -0,0 +1,23 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = readFileChunk;
+const node_fs_1 = __importDefault(require("node:fs"));
+/**
+ * Read part of a file on disc.
+ * @throws 'EPERM' if the file is not readable.
+ */
+async function readFileChunk(filename, onlyFirstLine = false) {
+    const chunkSize = 100;
+    const stream = node_fs_1.default.createReadStream(filename, { highWaterMark: chunkSize });
+    let content = '';
+    for await (const data of stream) { // may throw
+        content += data.toString();
+        if (onlyFirstLine && content.includes('\n')) {
+            return content.split(/\r?\n/)[0];
+        }
+    }
+    return content;
+}

package/dist/src/helpers/walk-tree.d.ts

@@ -0,0 +1,20 @@
+import { Ignore } from 'ignore';
+interface WalkInput {
+    /** Whether this is walking the tree from the root */
+    init: boolean;
+    /** The common root absolute path of all folders being checked */
+    commonRoot: string;
+    /** The absolute path that each folder is relative to */
+    folderRoots: string[];
+    /** The absolute path of folders being checked */
+    folders: string[];
+    /** An instantiated Ignore object listing ignored files */
+    ignored: Ignore;
+}
+interface WalkOutput {
+    files: string[];
+    folders: string[];
+}
+/** Generate list of files in a directory. */
+export default function walk(data: WalkInput): WalkOutput;
+export {};

package/dist/src/helpers/walk-tree.js

@@ -0,0 +1,85 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = walk;
+const node_fs_1 = __importDefault(require("node:fs"));
+const node_path_1 = __importDefault(require("node:path"));
+const parse_gitignore_1 = __importDefault(require("./parse-gitignore"));
+const norm_path_1 = require("./norm-path");
+let allFiles;
+let allFolders;
+;
+;
+/** Generate list of files in a directory. */
+function walk(data) {
+    const { init, commonRoot, folderRoots, folders, ignored } = data;
+    // Initialise files and folders lists
+    if (init) {
+        allFiles = new Set();
+        allFolders = new Set();
+    }
+    // Walk tree of a folder
+    if (folders.length === 1) {
+        const folder = folders[0];
+        const localRoot = folderRoots[0].replace(commonRoot, '').replace(/^\//, '');
+        // Get list of files and folders inside this folder
+        const files = node_fs_1.default.readdirSync(folder).map(file => {
+            // Create path relative to root
+            const base = (0, norm_path_1.normAbsPath)(folder, file).replace(commonRoot, '.');
+            // Add trailing slash to mark directories
+            const isDir = node_fs_1.default.lstatSync(node_path_1.default.resolve(commonRoot, base)).isDirectory();
+            return isDir ? `${base}/` : base;
+        });
+        // Read and apply gitignores
+        const gitignoreFilename = (0, norm_path_1.normPath)(folder, '.gitignore');
+        if (node_fs_1.default.existsSync(gitignoreFilename)) {
+            const gitignoreContents = node_fs_1.default.readFileSync(gitignoreFilename, 'utf-8');
+            const ignoredPaths = (0, parse_gitignore_1.default)(gitignoreContents);
+            ignored.add(ignoredPaths);
+        }
+        // Add gitattributes if present
+        const gitattributesPath = (0, norm_path_1.normPath)(folder, '.gitattributes');
+        if (node_fs_1.default.existsSync(gitattributesPath)) {
+            allFiles.add(gitattributesPath);
+        }
+        // Loop through files and folders
+        for (const file of files) {
+            // Create absolute path for disc operations
+            const path = (0, norm_path_1.normAbsPath)(commonRoot, file);
+            const localPath = localRoot ? file.replace(`./${localRoot}/`, '') : file.replace('./', '');
+            // Skip if nonexistant
+            const nonExistant = !node_fs_1.default.existsSync(path);
+            if (nonExistant)
+                continue;
+            // Skip if marked in gitignore
+            const isIgnored = ignored.test(localPath).ignored;
+            if (isIgnored)
+                continue;
+            // Add absolute folder path to list
+            allFolders.add((0, norm_path_1.normAbsPath)(folder));
+            // Check if this is a folder or file
+            if (file.endsWith('/')) {
+                // Recurse into subfolders
+                allFolders.add(path);
+                walk({ init: false, commonRoot, folderRoots, folders: [path], ignored });
+            }
+            else {
+                // Add file path to list
+                allFiles.add(path);
+            }
+        }
+    }
+    // Recurse into all folders
+    else {
+        for (const i in folders) {
+            walk({ init: false, commonRoot, folderRoots: [folderRoots[i]], folders: [folders[i]], ignored });
+        }
+    }
+    // Return absolute files and folders lists
+    return {
+        files: [...allFiles].map(file => file.replace(/^\./, commonRoot)),
+        folders: [...allFolders],
+    };
+}

package/dist/src/index.d.ts

@@ -0,0 +1,4 @@
+import * as T from './types';
+declare function analyse(path?: string, opts?: T.Options): Promise<T.Results>;
+declare function analyse(paths?: string[], opts?: T.Options): Promise<T.Results>;
+export default analyse;