view-ignored 0.2.2 → 0.3.1

package/out/src/styling.js

@@ -1,40 +1,53 @@
-import { decorCondition } from "./browser/styling.js";
-import { configFilePath, configValueList, isConfigKey, isConfigValue } from "./config.js";
-export * from "./browser/styling.js";
-export function formatConfigConflicts(chalk, decor, error) {
-    if (!(error instanceof TypeError && error.cause?.constructor === Object)) {
-        throw error;
+import ansiRegex from 'ansi-regex';
+export * from './browser/styling.js';
+/**
+ * @public
+ */
+export function highlight(text, chalk) {
+    if (chalk === undefined) {
+        return text;
     }
-    const entries = Object.entries(error.cause);
-    if (entries === undefined) {
-        console.error('An object expected.');
-        return;
+    const rtype = /^(?<=\s*)(switch|boolean|object|string|number|integer)(\[])*(?=\s*)$/;
+    if (rtype.test(text)) {
+        return chalk.hex('#9999ff')(text);
     }
-    if (entries.length === 0) {
-        return;
-    }
-    const badEntries = entries.filter(([key, value]) => {
-        // keys can be undefined
-        if (!isConfigKey(key)) {
-            return false;
+    const rseparator = /([,.\-:="|])/g;
+    const rstring = /'[^']+'/g;
+    const rbracketsSquare = /(\[|])/g;
+    const rnumber = /\d+/g;
+    const rspecial = /(true|false|null|Infinity)/g;
+    const rall = new RegExp(`${[ansiRegex(), rstring, rseparator, rbracketsSquare, rnumber, rspecial]
+        .map(r => `(${typeof r === 'string' ? r : r.source})`)
+        .join('|')}`, 'g');
+    const colored = text.replaceAll(rall, match => {
+        if (match.match(ansiRegex()) !== null) {
+            return match;
+        }
+        if (match.match(rstring) !== null) {
+            return match.replace(/^'[^']*'$/, chalk.hex('#A2D2FF')('$&'));
+        }
+        if (match.match(rseparator) !== null) {
+            return chalk.hex('#D81159')(match);
         }
-        if (isConfigValue(key, value)) {
-            return false;
+        if (match.match(rbracketsSquare) !== null) {
+            return chalk.hex('#B171D9')(match);
         }
-        // bad config value
-        return true;
+        if (match.match(rnumber) !== null) {
+            return chalk.hex('#73DEA7')(match);
+        }
+        if (match.match(rspecial) !== null) {
+            return chalk.hex('#73A7DE')(match);
+        }
+        return match;
     });
-    if (badEntries.length === 0) {
-        return;
+    return colored;
+}
+/**
+ * @public
+ */
+export function stringTime(time, chalk) {
+    if (time < 1000) {
+        return `${highlight(String(time), chalk)} milliseconds`;
     }
-    let message = 'Configuration invalid properties:\n';
-    const prefix = chalk.redBright(decorCondition(decor, { ifNerd: '\udb82\ude15', ifNormal: '-', postfix: ' ', prefix: ' ' }));
-    message += badEntries.map(([key, value]) => {
-        const choices = configValueList(key);
-        const errorMessage = choices === undefined ? '' : decorCondition(decor, { ifNormal: typeof choices === "string" ? choices : `Choices: ${choices.join(', ')}.`, prefix });
-        return '\t' + chalk.reset(`${key}=${value}`) + chalk.red(errorMessage);
-    }).join('\n');
-    console.error(message);
-    console.log();
-    console.log(configFilePath);
+    return `${highlight((time / 1000).toFixed(2), chalk)} seconds`;
 }

package/package.json

@@ -1,107 +1,121 @@
-{
-	"name": "view-ignored",
-	"version": "0.2.2",
-	"description": "Retrieve list of files ignored/included by Git, NPM, Yarn and VSC Extension.",
-	"type": "module",
-	"bin": {
-		"viewig": "./bin/viewig",
-		"view-ignored": "./bin/viewig"
-	},
-	"scripts": {
-		"prerelease": "pnpm lint && pnpm build:pub && pnpm test",
-		"test": "pnpm mocha ./out/test/**/*.test.js",
-		"build": "pnpm shx rm -rf out && pnpm tsc",
-		"build:pub": "pnpm shx rm -rf out && pnpm tsc --sourceMap false",
-		"build:watch": "pnpm tsc --watch",
-		"lint": "pnpm eslint .",
-		"lint:fix": "pnpm eslint . --fix",
-		"release:major": "pnpm release-it --increment=major",
-		"release:minor": "pnpm release-it --increment=minor",
-		"release:patch": "pnpm release-it --increment=patch"
-	},
-	"author": "Mopsgamer",
-	"license": "ISC",
-	"main": "./out/src/index.js",
-	"files": [
-		"out/src"
-	],
-	"repository": {
-		"type": "git",
-		"url": "https://github.com/Mopsgamer/view-ignored.git"
-	},
-	"bugs": {
-		"url": "https://github.com/Mopsgamer/view-ignored/issues"
-	},
-	"homepage": "https://github.com/Mopsgamer/view-ignored",
-	"release-it": {
-		"hooks": {
-			"before:init": "pnpm prerelease"
-		},
-		"plugins": {
-			"@release-it/keep-a-changelog": {
-				"filename": "CHANGELOG.md"
-			}
-		},
-		"github": {
-			"release": true,
-			"draft": false,
-			"releaseName": "${version}"
-		},
-		"npm": {
-			"publish": true
-		}
-	},
-	"publishConfig": {
-		"access": "public"
-	},
-	"directories": {
-		"lib": "out/src"
-	},
-	"dependencies": {
-		"arrify": "^3.0.0",
-		"boxen": "^8.0.1",
-		"chalk": "^5.3.0",
-		"commander": "^12.1.0",
-		"get-value": "^3.0.1",
-		"glob": "^11.0.0",
-		"ignore": "^5.3.1",
-		"jsonify-paths": "^1.1.0",
-		"load-plugin": "^6.0.3",
-		"minimatch": "^10.0.1",
-		"ora": "^8.0.1",
-		"treeify": "^1.1.0",
-		"tslib": "^2.6.3",
-		"yaml": "^2.5.0"
-	},
-	"devDependencies": {
-		"@eslint/js": "^9.4.0",
-		"@release-it/keep-a-changelog": "^5.0.0",
-		"@types/get-value": "^3.0.5",
-		"@types/mocha": "^10.0.6",
-		"@types/node": "^20.14.2",
-		"@types/treeify": "^1.0.3",
-		"eslint": "^8.57.0",
-		"eslint-plugin-only-warn": "^1.1.0",
-		"fs-fixture": "^2.4.0",
-		"globals": "^15.4.0",
-		"mocha": "^10.4.0",
-		"release-it": "^17.3.0",
-		"shx": "^0.3.4",
-		"typescript": "^5.4.5",
-		"typescript-eslint": "^7.13.0"
-	},
-	"keywords": [
-		"tree",
-		"ls-tree",
-		"ignore",
-		"gitignore",
-		"npmignore",
-		"vscodeignore",
-		"cli",
-		"fs",
-		"file-system",
-		"output",
-		"project",
-		"migration"
-	]
-}
+{
+	"name": "view-ignored",
+	"version": "0.3.1",
+	"description": "Retrieve list of files ignored/included by Git, NPM, Yarn and VSC Extension.",
+	"type": "module",
+	"bin": {
+		"viewig": "./bin/viewig",
+		"view-ignored": "./bin/viewig"
+	},
+	"scripts": {
+		"prerelease": "pnpm lint && pnpm build:pub && pnpm test",
+		"test": "pnpm mocha ./out/test/**/*.test.js",
+		"build": "pnpm shx rm -rf out && pnpm tsc",
+		"build:pub": "pnpm shx rm -rf out && pnpm tsc --sourceMap false",
+		"build:watch": "pnpm shx rm -rf out && pnpm tsc --watch",
+		"lint": "pnpm xo",
+		"lint:fix": "pnpm xo --fix",
+		"release:major": "pnpm release-it --increment=major",
+		"release:minor": "pnpm release-it --increment=minor",
+		"release:patch": "pnpm release-it --increment=patch"
+	},
+	"author": "Mopsgamer",
+	"license": "ISC",
+	"main": "./out/src/index.js",
+	"files": [
+		"/bin",
+		"/out/src"
+	],
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/Mopsgamer/view-ignored.git"
+	},
+	"bugs": {
+		"url": "https://github.com/Mopsgamer/view-ignored/issues"
+	},
+	"homepage": "https://github.com/Mopsgamer/view-ignored",
+	"exports": {
+		".": "./out/src/index.js",
+		"./browser": "./out/src/browser/index.js"
+	},
+	"release-it": {
+		"hooks": {
+			"before:init": "pnpm prerelease"
+		},
+		"plugins": {
+			"@release-it/keep-a-changelog": {
+				"filename": "CHANGELOG.md"
+			}
+		},
+		"github": {
+			"release": true,
+			"draft": false,
+			"releaseName": "${version}"
+		},
+		"npm": {
+			"publish": true
+		}
+	},
+	"xo": {
+		"ignores": "/out/",
+		"rules": {
+			"@typescript-eslint/promise-function-async": "off",
+			"@typescript-eslint/use-unknown-in-catch-callback-variable": "off",
+			"@typescript-eslint/no-unused-vars": "error",
+			"n/no-unpublished-bin": "off",
+			"linebreak-style": [
+				"error",
+				"unix"
+			]
+		}
+	},
+	"publishConfig": {
+		"access": "public"
+	},
+	"directories": {
+		"lib": "out/src"
+	},
+	"dependencies": {
+		"@humanwhocodes/gitignore-to-minimatch": "^1.0.2",
+		"@m234/nerd-fonts": "^0.1.3",
+		"ansi-regex": "^6.1.0",
+		"boxen": "^8.0.1",
+		"chalk": "^5.3.0",
+		"commander": "^12.1.0",
+		"jsonify-paths": "^1.1.0",
+		"listr2": "^8.2.5",
+		"load-plugin": "^6.0.3",
+		"minimatch": "^10.0.1",
+		"p-limit": "^6.1.0",
+		"treeify": "^1.1.0",
+		"tslib": "^2.7.0",
+		"yaml": "^2.5.1"
+	},
+	"devDependencies": {
+		"@release-it/keep-a-changelog": "^5.0.0",
+		"@types/mocha": "^10.0.9",
+		"@types/node": "^20.16.11",
+		"@types/treeify": "^1.0.3",
+		"fs-fixture": "^2.4.0",
+		"globals": "^15.11.0",
+		"mocha": "^10.7.3",
+		"release-it": "^17.8.2",
+		"shx": "^0.3.4",
+		"typescript": "^5.6.3",
+		"xo": "^0.59.3"
+	},
+	"keywords": [
+		"tree",
+		"ls-tree",
+		"ignore",
+		"gitignore",
+		"npmignore",
+		"vscodeignore",
+		"cli",
+		"fs",
+		"file-system",
+		"output",
+		"project",
+		"migration"
+	]
+}

package/out/src/bin.d.ts

@@ -1,2 +0,0 @@
-#! /usr/bin/env node
-export {};

package/out/src/bin.js

@@ -1,3 +0,0 @@
-#! /usr/bin/env node
-import { programInit } from "./cli.js";
-programInit();

package/out/src/browser/fileinfo.js

@@ -1,78 +0,0 @@
-import { decorFile } from "./styling.js";
-import path from "path";
-/**
- * The result of the file path scan.
- */
-export class FileInfo {
-    filePath;
-    source;
-    /**
-     * The pattern parser.
-     */
-    scanner;
-    constructor(
-    /**
-     * Relative path to the file.
-    */
-    filePath, 
-    /**
-     * Source of patterns, used by {@link scanner}.
-     */
-    source) {
-        this.filePath = filePath;
-        this.source = source;
-        this.scanner = this.source.scanner;
-    }
-    /**
-     * Determines if ignored file is ignored or not.
-     */
-    isIgnored() {
-        return this.scanner.matches(this.filePath);
-    }
-    static from(arg, sourceInfo) {
-        if (Array.isArray(arg)) {
-            return arg.map(path => FileInfo.from(path, sourceInfo));
-        }
-        return new FileInfo(arg, sourceInfo);
-    }
-    /**
-     * @param options Styling options.
-     * @returns Relative file path. Optionally formatted.
-     */
-    toString(options) {
-        const { fileIcon, chalk, usePrefix = false, source: useSource = false, entire = true } = options ?? {};
-        const parsed = path.parse(this.filePath);
-        const fIcon = decorFile(fileIcon, this.filePath);
-        const ignored = this.isIgnored();
-        let prefix = usePrefix ? (ignored ? '!' : '+') : '';
-        let postfix = useSource ? " << " + this.source.toString() : '';
-        if (chalk) {
-            prefix = chalk.dim(prefix);
-            postfix = chalk.dim(postfix);
-            const clr = chalk[ignored ? "red" : "green"];
-            if (entire) {
-                return fIcon + clr(prefix + this.filePath + postfix);
-            }
-            return parsed.dir + '/' + fIcon + clr(prefix + parsed.base + postfix);
-        }
-        if (entire) {
-            return prefix + this.filePath + postfix;
-        }
-        return parsed.dir + '/' + fIcon + prefix + parsed.base + postfix;
-    }
-    /**
-     * @param filter The group name. Default: `"all"`
-     * @returns `true`, if the file is contained by the filter.
-     */
-    isIncludedBy(filter) {
-        if (typeof filter === "function") {
-            return filter(this);
-        }
-        filter ??= "all";
-        const filterIgnore = (filter === "ignored") && this.isIgnored();
-        const filterInclude = (filter === "included") && !this.isIgnored();
-        const filterAll = filter === "all";
-        const result = filterIgnore || filterInclude || filterAll;
-        return result;
-    }
-}

package/out/src/browser/scanner.d.ts

@@ -1,103 +0,0 @@
-/**
- * Supported matchers/parsers by {@link Scanner}.
- */
-export type PatternType = typeof patternTypeList[number];
-export declare const patternTypeList: readonly ["gitignore", "minimatch"];
-export declare function isPatternType(value: unknown): value is PatternType;
-/**
- * @see {@link Scanner}
- */
-export interface ScannerOptions {
-    /**
-     * Use the patterns for including instead of excluding/ignoring.
-     * @default false
-     */
-    negated?: boolean;
-    /**
-     * The parser for the patterns.
-     * @default "gitignore"
-     */
-    patternType?: PatternType;
-    /**
-     * Git configuration property.
-     * @see {@link https://git-scm.com/docs/git-config#Documentation/git-config.txt-coreignoreCase|git-config ignorecase}.
-     * @default false
-     */
-    ignoreCase?: boolean;
-}
-export type IsValidPatternOptions = Pick<ScannerOptions, "patternType">;
-/**
- * The Glob-like pattern of the specific matcher.
- */
-export type ScannerPattern = string | string[];
-/**
- * The pattern parser. Can check if the file path is ignored.
- */
-export declare class Scanner {
-    /**
-     * If `true`, when calling {@link Scanner.matches}, method will return `true` for ignored path.
-     * @default false
-     */
-    readonly isNegated: boolean;
-    /**
-     * Defines way to check paths.
-     * @default "gitignore"
-     */
-    readonly patternType: PatternType;
-    /**
-     * Git configuration property.
-     * @see {@link https://git-scm.com/docs/git-config#Documentation/git-config.txt-coreignoreCase|git-config ignorecase}.
-     * @default false
-     */
-    readonly ignoreCase: boolean;
-    private patternList;
-    private patternListExclude;
-    private patternListInclude;
-    private ignoreInstance;
-    private ignoreInstanceExclude;
-    private ignoreInstanceInclude;
-    constructor(options?: ScannerOptions);
-    /**
-     * Adds new ignore rule.
-     * @param pattern .gitignore file specification pattern.
-     */
-    add(pattern?: ScannerPattern): this;
-    /**
-     * Force ignore pattern.
-     * @param pattern .gitignore file specification pattern.
-     */
-    addExclude(pattern?: ScannerPattern): this;
-    /**
-     * Force ignore pattern.
-     * @param pattern .gitignore file specification pattern.
-     */
-    addInclude(pattern?: ScannerPattern): this;
-    /**
-     * Checks if the scanner should ignore path.
-     * @see {@link Scanner.isNegated} can change the return value.
-     * @param path Dir entry, path.
-     */
-    matches(path: string): boolean;
-    private matchesReal;
-    private static matchesGitignore;
-    private static matchesMinimatch;
-    /**
-     * Checks if given pattern is valid.
-     * @param pattern Parser pattern.
-     */
-    patternIsValid(pattern: unknown): pattern is ScannerPattern;
-    /**
-     * Checks if given pattern is valid.
-     * @param pattern Parser pattern.
-     */
-    static patternIsValid(pattern: unknown, options?: IsValidPatternOptions): pattern is ScannerPattern;
-    /**
-     * @returns New pattern array: `!pattern` for `pattern`, and `pattern` for `!pattern`.
-     */
-    static patternToNegated(pattern: string[]): string[];
-    /**
-     * @returns New pattern: `!pattern` for `pattern`, and `pattern` for `!pattern`.
-     */
-    static patternToNegated(pattern: string): string;
-    static patternIsNegated(pattern: string): boolean;
-}

package/out/src/browser/scanner.js

@@ -1,161 +0,0 @@
-import ignore from "ignore";
-import { minimatch } from "minimatch";
-export const patternTypeList = ["gitignore", "minimatch"];
-export function isPatternType(value) {
-    return typeof value === "string" && patternTypeList.includes(value);
-}
-/**
- * The pattern parser. Can check if the file path is ignored.
- */
-export class Scanner {
-    /**
-     * If `true`, when calling {@link Scanner.matches}, method will return `true` for ignored path.
-     * @default false
-     */
-    isNegated = false;
-    /**
-     * Defines way to check paths.
-     * @default "gitignore"
-     */
-    patternType;
-    /**
-     * Git configuration property.
-     * @see {@link https://git-scm.com/docs/git-config#Documentation/git-config.txt-coreignoreCase|git-config ignorecase}.
-     * @default false
-     */
-    ignoreCase;
-    patternList = new Set();
-    patternListExclude = new Set();
-    patternListInclude = new Set();
-    ignoreInstance;
-    ignoreInstanceExclude;
-    ignoreInstanceInclude;
-    constructor(options) {
-        this.patternType = options?.patternType ?? "gitignore";
-        this.ignoreCase = options?.ignoreCase ?? false;
-        this.isNegated = options?.negated ?? false;
-        this.ignoreInstance = ignore.default(options);
-        this.ignoreInstanceExclude = ignore.default(options);
-        this.ignoreInstanceInclude = ignore.default(options);
-    }
-    /**
-     * Adds new ignore rule.
-     * @param pattern .gitignore file specification pattern.
-     */
-    add(pattern) {
-        if (typeof pattern === "string") {
-            pattern = pattern.split('\n');
-        }
-        if (Array.isArray(pattern)) {
-            for (const pat of pattern) {
-                this.patternList.add(pat);
-                this.ignoreInstance.add(pat);
-            }
-        }
-        return this;
-    }
-    /**
-     * Force ignore pattern.
-     * @param pattern .gitignore file specification pattern.
-     */
-    addExclude(pattern) {
-        if (typeof pattern === "string") {
-            pattern = pattern.split('\n');
-        }
-        if (Array.isArray(pattern)) {
-            for (const pat of pattern) {
-                this.patternListExclude.add(pat);
-                this.ignoreInstanceExclude.add(pat);
-            }
-        }
-        return this;
-    }
-    /**
-     * Force ignore pattern.
-     * @param pattern .gitignore file specification pattern.
-     */
-    addInclude(pattern) {
-        if (typeof pattern === "string") {
-            pattern = pattern.split('\n');
-        }
-        if (Array.isArray(pattern)) {
-            for (const pat of pattern) {
-                this.patternListInclude.add(pat);
-                this.ignoreInstanceInclude.add(pat);
-            }
-        }
-        return this;
-    }
-    /**
-     * Checks if the scanner should ignore path.
-     * @see {@link Scanner.isNegated} can change the return value.
-     * @param path Dir entry, path.
-     */
-    matches(path) {
-        if (this.patternType === "gitignore") {
-            return this.matchesReal(() => Scanner.matchesGitignore(path, this.ignoreInstanceInclude), () => Scanner.matchesGitignore(path, this.ignoreInstanceExclude), () => Scanner.matchesGitignore(path, this.ignoreInstance));
-        }
-        // minimatch
-        return this.matchesReal(() => Scanner.matchesMinimatch(path, Array.from(this.patternListInclude)), () => Scanner.matchesMinimatch(path, Array.from(this.patternListExclude)), () => Scanner.matchesMinimatch(path, Array.from(this.patternList)));
-    }
-    matchesReal(include, exclude, ignores) {
-        if (include()) {
-            return false;
-        }
-        if (exclude()) {
-            return true;
-        }
-        const ign = ignores();
-        return this.isNegated ? !ign : ign;
-    }
-    static matchesGitignore(path, ignoreInstance) {
-        return ignoreInstance.ignores(path);
-    }
-    static matchesMinimatch(path, patternList) {
-        return Array.from(patternList).some((pattern) => {
-            return minimatch(path, pattern, { dot: true });
-        });
-    }
-    /**
-     * Checks if given pattern is valid.
-     * @param pattern Parser pattern.
-     */
-    patternIsValid(pattern) {
-        return Scanner.patternIsValid(pattern, { patternType: this.patternType });
-    }
-    /**
-     * Checks if given pattern is valid.
-     * @param pattern Parser pattern.
-     */
-    static patternIsValid(pattern, options) {
-        const { patternType = "gitignore" } = options ?? {};
-        if (Array.isArray(pattern)) {
-            return pattern.every(p => this.patternIsValid(p, options));
-        }
-        if (typeof pattern !== "string") {
-            return false;
-        }
-        if (patternType === "gitignore") {
-            return ignore.default.isPathValid(pattern);
-        }
-        if (patternType === "minimatch") {
-            try {
-                minimatch.makeRe(pattern);
-                return true;
-            }
-            catch (error) {
-                return false;
-            }
-        }
-        throw new TypeError(`Unknown pattern type '${patternType}'.`);
-    }
-    static patternToNegated(pattern) {
-        if (Array.isArray(pattern)) {
-            return pattern.map(Scanner.patternToNegated);
-        }
-        return Scanner.patternIsNegated(pattern) ? pattern.replace(/^!/, '') : `!${pattern}`;
-    }
-    static patternIsNegated(pattern) {
-        return pattern.startsWith('!');
-    }
-}