linguist-js 2.6.0 → 2.7.0-pre

package/dist/cli.d.ts

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

package/dist/cli.js

@@ -1,107 +1,141 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const VERSION = require('../package.json').version;
-const commander_1 = require("commander");
-const index_1 = __importDefault(require("./index"));
-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 [<folder>] [<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('-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('-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('-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);
-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:`);
-            let count = 0;
-            if (sortedEntries.length === 0)
-                console.log(`  None`);
-            // List parsed results
-            for (const [lang, { bytes, color }] of sortedEntries) {
-                const fmtd = {
-                    index: (++count).toString().padStart(2, ' '),
-                    lang: lang.padEnd(24, ' '),
-                    percent: (bytes / (totalBytes || 1) * 100).toFixed(2).padStart(5, ' '),
-                    bytes: bytes.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`);
-            }
-            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.`);
-}
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const VERSION = require('../package.json').version;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const commander_1 = require("commander");
+const index_1 = __importDefault(require("./index"));
+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('-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('-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);
+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, 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, ' '),
+                    icon: colouredMsg(hexToRgb(color !== null && color !== void 0 ? color : '#ededed'), '\u2588'),
+                };
+                console.log(`  ${fmtd.index}. ${fmtd.icon} ${fmtd.lang} ${fmtd.percent}% ${fmtd.bytes} B`);
+                // 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 = path_1.default.relative(path_1.default.resolve('.'), file).replace(/\\/g, '/');
+                        if (!relFile.startsWith('../'))
+                            relFile = './' + relFile;
+                        const bytes = (await 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/helpers/convert-pcre.d.ts

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

package/dist/helpers/convert-pcre.js

@@ -1,38 +1,38 @@
-"use strict";
-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, 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(''));
-}
-exports.default = pcre;
+"use strict";
+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, 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(''));
+}
+exports.default = pcre;

package/dist/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/helpers/load-data.js

@@ -1,31 +1,38 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const fs_1 = __importDefault(require("fs"));
-const path_1 = __importDefault(require("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 = path_1.default.resolve(__dirname, '../../ext', file);
-    return fs_1.default.promises.readFile(filePath).then(buffer => buffer.toString());
-}
-/** Load a data file from github-linguist. */
-async function loadFile(file, offline = false) {
-    return offline ? loadLocalFile(file) : loadWebFile(file);
-}
-exports.default = loadFile;
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseGeneratedDataFile = void 0;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("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 = path_1.default.resolve(__dirname, '../../ext', file);
+    return 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 : []];
+}
+exports.parseGeneratedDataFile = parseGeneratedDataFile;
+/** Load a data file from github-linguist. */
+async function loadFile(file, offline = false) {
+    return offline ? loadLocalFile(file) : loadWebFile(file);
+}
+exports.default = loadFile;

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

@@ -0,0 +1,16 @@
+import * as T from '../types';
+export type FlagAttributes = {
+    'vendored': boolean | null;
+    'generated': boolean | null;
+    'documentation': 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/helpers/parse-gitattributes.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 });
+const path_1 = __importDefault(require("path"));
+/**
+ * Parses a gitattributes file.
+ */
+function parseAttributes(content, folderRoot = '.') {
+    var _a, _b;
+    const output = [];
+    for (const line of content.split('\n')) {
+        if (!line)
+            continue;
+        const parts = line.split(/\s+/g);
+        const fileGlob = parts[0];
+        const relFileGlob = path_1.default.join(folderRoot, fileGlob).replace(/\\/g, '/');
+        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 attrs = {
+            'generated': hasTrueParts('linguist-generated') ? true : hasFalseParts('linguist-generated') ? false : null,
+            'vendored': hasTrueParts('linguist-vendored') ? true : hasFalseParts('linguist-vendored') ? false : null,
+            'documentation': hasTrueParts('linguist-documentation') ? true : hasFalseParts('linguist-documentation') ? false : null,
+            '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;
+}
+exports.default = parseAttributes;

package/dist/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 readFile(filename: string, onlyFirstLine?: boolean): Promise<string>;

package/dist/helpers/read-file.js

@@ -1,23 +1,23 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const fs_1 = __importDefault(require("fs"));
-/**
- * Read part of a file on disc.
- * @throws 'EPERM' if the file is not readable.
- */
-async function readFile(filename, onlyFirstLine = false) {
-    const chunkSize = 100;
-    const stream = 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;
-}
-exports.default = readFile;
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs_1 = __importDefault(require("fs"));
+/**
+ * Read part of a file on disc.
+ * @throws 'EPERM' if the file is not readable.
+ */
+async function readFile(filename, onlyFirstLine = false) {
+    const chunkSize = 100;
+    const stream = 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;
+}
+exports.default = readFile;

package/dist/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 {};