view-ignored 0.2.1 → 0.3.0

package/out/src/browser/sorting.js

@@ -1,45 +1,48 @@
-import path from "path";
+import path from 'node:path';
 /**
  * Contains all file sort names.
+ * @public
  */
-export const sortNameList = ["firstFolders", "firstFiles", "type", "mixed", "modified"];
+export const sortNameList = ['firstFolders', 'firstFiles', 'type', 'mixed', 'modified'];
 /**
  * Checks if the value is the {@link SortName}.
+ * @public
  */
 export function isSortName(value) {
-    return typeof value === "string" && sortNameList.includes(value);
+    return typeof value === 'string' && sortNameList.includes(value);
 }
 /**
+ * @public
  * @example
  * "path/to/the/file" -> ["path", "to/the/file", false]
  * "file" -> ["file", "file", true]
  * "file/" -> ["file", "", false]
  */
-function slicePath(p) {
-    const slashIndex = p.indexOf('/');
-    const next = p.substring(0, slashIndex);
-    const other = p.substring(slashIndex + 1);
-    const isLast = next === '' && (p.lastIndexOf('/') === slashIndex);
+export function shiftPath(p) {
+    const slashIndex = p.search(/[/\\]/);
+    const next = p.slice(0, Math.max(0, slashIndex));
+    const other = p.slice(Math.max(0, slashIndex + 1));
+    const isLast = next === '';
     return [slashIndex < 0 ? other : next, other, isLast];
 }
 /**
  * Files and folders are sorted by their names.
  * Folders are displayed before files.
+ * @public
  */
 export function firstFolders(a, b) {
     let comp = 0;
-    let next1, others1, next2, others2, last1, last2;
     for (; comp === 0;) {
-        [next1, others1, last1] = slicePath(a);
-        a = others1;
-        [next2, others2, last2] = slicePath(b);
-        b = others2;
+        const [next1, post1, last1] = shiftPath(a);
+        a = post1;
+        const [next2, post2, last2] = shiftPath(b);
+        b = post2;
         comp = mixed(next1, next2);
         if (last1 || last2) {
             if (last1 === last2) {
                 break;
             }
-            if (last1 === false) {
+            if (!last1) {
                 return -1;
             }
             return +1;
@@ -50,21 +53,21 @@ export function firstFolders(a, b) {
 /**
  * Files and folders are sorted by their names.
  * Files are displayed before folders.
+ * @public
  */
 export function firstFiles(a, b) {
     let comp = 0;
-    let next1, others1, next2, others2, last1, last2;
     for (; comp === 0;) {
-        [next1, others1, last1] = slicePath(a);
-        a = others1;
-        [next2, others2, last2] = slicePath(b);
-        b = others2;
+        const [next1, post1, last1] = shiftPath(a);
+        a = post1;
+        const [next2, post2, last2] = shiftPath(b);
+        b = post2;
         comp = mixed(next1, next2);
         if (last1 || last2) {
             if (last1 === last2) {
                 break;
             }
-            if (last1 === true) {
+            if (last1) {
                 return -1;
             }
             return +1;
@@ -75,21 +78,22 @@ export function firstFiles(a, b) {
 /**
  * Files and folders are sorted by last modified date in descending order.
  * Folders are displayed before files.
+ * @see {@link makeMtimeCache}
+ * @public
  */
 export function modified(a, b, map) {
     let comp = 0;
-    let others1, others2, last1, last2;
     for (; comp === 0;) {
-        [, others1, last1] = slicePath(a);
-        a = others1;
-        [, others2, last2] = slicePath(b);
-        b = others2;
+        const [, post1, last1] = shiftPath(a);
+        a = post1;
+        const [, post2, last2] = shiftPath(b);
+        b = post2;
         comp = (map.get(a) ?? 0) - (map.get(b) ?? 0);
         if (last1 || last2) {
             if (last1 === last2) {
                 break;
             }
-            if (last1 === false) {
+            if (!last1) {
                 return -1;
             }
             return +1;
@@ -100,15 +104,15 @@ export function modified(a, b, map) {
 /**
  * Files and folders are grouped by extension type then sorted by thir names.
  * Folders are displayed before files.
+ * @public
  */
 export function type(a, b) {
     let comp = 0;
-    let next1, others1, next2, others2, last1, last2;
     for (; comp === 0;) {
-        [next1, others1, last1] = slicePath(a);
-        a = others1;
-        [next2, others2, last2] = slicePath(b);
-        b = others2;
+        const [next1, post1, last1] = shiftPath(a);
+        a = post1;
+        const [next2, post2, last2] = shiftPath(b);
+        b = post2;
         const ppa = path.parse(next1);
         const ppb = path.parse(next2);
         comp = mixed(ppa.ext, ppb.ext) || mixed(ppa.name, ppb.name);
@@ -116,7 +120,7 @@ export function type(a, b) {
             if (last1 === last2) {
                 break;
             }
-            if (last1 === false) {
+            if (!last1) {
                 return -1;
             }
             return +1;
@@ -127,6 +131,7 @@ export function type(a, b) {
 /**
  * Files and folders are sorted by their names.
  * Files are interwoven with folders.
+ * @public
  */
 export function mixed(a, b) {
     return a.localeCompare(b, undefined, { ignorePunctuation: false });

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

@@ -1,7 +1,19 @@
-import { FileInfo } from "../index.js";
-import { ChalkInstance } from "chalk";
-import { Options } from "boxen";
-export interface FormatFilesOptions {
+import { type ChalkInstance } from 'chalk';
+import { type Options } from 'boxen';
+import { type FileInfo } from '../index.js';
+/**
+ * @public
+ */
+export type FormatFilesOptions = {
+    /**
+     * On posix systems, this has no effect.  But, on Windows, it means that
+     * paths will be `/` delimited, and absolute paths will be their full
+     * resolved UNC forms, eg instead of `'C:\\foo\\bar'`, it would return
+     * `'//?/C:/foo/bar'`
+     * @default false
+     * @returns `/` delimited paths, even on Windows.
+     */
+    posix?: boolean;
     /**
      * @default false
      */
@@ -14,40 +26,51 @@ export interface FormatFilesOptions {
      * @default "paths"
      */
     decor?: DecorName;
-    chalk: ChalkInstance;
-}
+    /**
+     * @default undefined
+     */
+    chalk?: ChalkInstance;
+};
 /**
  * @returns Prints a readable file list. Here is '\n' ending.
+ * @public
  */
 export declare function formatFiles(files: FileInfo[], options: FormatFilesOptions): string;
 /**
  * Contains all style names.
+ * @public
  */
 export declare const styleNameList: readonly ["tree", "paths"];
 /**
  * Contains all style names as a type.
+ * @public
  */
 export type StyleName = typeof styleNameList[number];
 /**
  * Checks if the value is the {@link StyleName}.
+ * @public
  */
 export declare function isStyleName(value: unknown): value is StyleName;
 /**
  * Contains all decor names.
+ * @public
  */
 export declare const decorNameList: readonly ["normal", "emoji", "nerdfonts"];
 /**
  * Contains all decor names as a type.
+ * @public
  */
 export type DecorName = typeof decorNameList[number];
 /**
  * Checks if the value is the {@link DecorName}.
+ * @public
  */
 export declare function isDecorName(value: unknown): value is DecorName;
 /**
  * Formatting options for the {@link decorCondition}.
+ * @public
  */
-export interface DecorConditionOptions {
+export type DecorConditionOptions = {
     /**
      * @default ""
      */
@@ -71,20 +94,23 @@ export interface DecorConditionOptions {
      * @default ""
      */
     ifNerd?: string;
-}
+};
 /**
  * Formats the string for specific style types.
  * @param decor The decor name.
  * @param condition Formatting options.
+ * @public
  */
 export declare function decorCondition(decor: DecorName, condition: DecorConditionOptions): string;
-export interface BoxOptions extends Options {
+/**
+ * @see {@link boxError}
+ * @public
+ */
+export type BoxOptions = {
     noColor?: boolean;
-}
-export declare function boxError(message: string, options?: BoxOptions): string;
+} & Options;
 /**
- * Returns file icon for the file name & extension.
- * @param decor The decor name.
- * @param filePath The full file path.
+ * Make a message in a red box. Or without color.
+ * @public
  */
-export declare function decorFile(decor: DecorName | undefined, filePath: string): string;
+export declare function boxError(message: string, options?: BoxOptions): string;

package/out/src/browser/styling.js

@@ -1,47 +1,56 @@
-import { default as tree } from "treeify";
-import jsonifyPaths from "jsonify-paths";
-import path from "path";
-import boxen from "boxen";
-import { stripVTControlCharacters } from "util";
+import PATH from 'node:path';
+import { stripVTControlCharacters } from 'node:util';
+import tree from 'treeify';
+import jsonifyPaths from 'jsonify-paths';
+import boxen from 'boxen';
 /**
  * @returns Prints a readable file list. Here is '\n' ending.
+ * @public
  */
 export function formatFiles(files, options) {
-    const { showSources = false, chalk, decor = "normal", style } = options ?? {};
-    const isPaths = style === "paths";
-    const paths = files.map(f => f.toString({ fileIcon: decor, usePrefix: true, chalk: chalk, source: showSources, entire: isPaths }));
+    const { showSources = false, chalk, decor = 'normal', style, posix = false } = options ?? {};
+    const patha = posix ? PATH.posix : PATH;
+    const isPaths = style === 'paths';
+    const paths = files.map(f => f.toString({
+        fileIcon: decor, usePrefix: true, chalk, source: showSources, entire: isPaths,
+    }));
     if (isPaths) {
         return paths.join('\n') + '\n';
     }
-    // isTree
-    const pathsAsObject = jsonifyPaths.from(paths, { delimiter: "/" });
+    // IsTree
+    const pathsAsObject = jsonifyPaths.from(paths, { delimiter: patha.sep });
     const pathsAsTree = tree.asTree(pathsAsObject, true, true);
     return pathsAsTree;
 }
 /**
  * Contains all style names.
+ * @public
  */
 export const styleNameList = ['tree', 'paths'];
 /**
  * Checks if the value is the {@link StyleName}.
+ * @public
  */
 export function isStyleName(value) {
-    return typeof value === "string" && styleNameList.includes(value);
+    return typeof value === 'string' && styleNameList.includes(value);
 }
 /**
  * Contains all decor names.
+ * @public
  */
 export const decorNameList = ['normal', 'emoji', 'nerdfonts'];
 /**
  * Checks if the value is the {@link DecorName}.
+ * @public
  */
 export function isDecorName(value) {
-    return typeof value === "string" && decorNameList.includes(value);
+    return typeof value === 'string' && decorNameList.includes(value);
 }
 /**
  * Formats the string for specific style types.
  * @param decor The decor name.
  * @param condition Formatting options.
+ * @public
  */
 export function decorCondition(decor, condition) {
     let result = condition.ifNormal ?? '';
@@ -56,12 +65,16 @@ export function decorCondition(decor, condition) {
     }
     return result;
 }
+/**
+ * Make a message in a red box. Or without color.
+ * @public
+ */
 export function boxError(message, options) {
     let result = ('\n' + boxen(message, {
-        titleAlignment: "left",
+        titleAlignment: 'left',
         padding: { left: 2, right: 2 },
-        borderColor: "redBright",
-        borderStyle: "round",
+        borderColor: 'redBright',
+        borderStyle: 'round',
         ...options,
     }));
     if (options?.noColor) {
@@ -69,85 +82,3 @@ export function boxError(message, options) {
     }
     return result;
 }
-/**
- * Returns file icon for the file name & extension.
- * @param decor The decor name.
- * @param filePath The full file path.
- */
-export function decorFile(decor, filePath) {
-    const parsed = path.parse(filePath);
-    let icon = '';
-    switch (parsed.ext.toLocaleLowerCase()) {
-        case ".js":
-        case ".cjs":
-        case ".mjs":
-            icon = '\ue60c';
-            break;
-        case ".ts":
-        case ".cts":
-        case ".mts":
-            icon = '\ue628';
-            break;
-        case ".styl":
-            icon = '\ue600';
-            break;
-        case ".less":
-            icon = '\ue60b';
-            break;
-        case ".scss":
-        case ".sass":
-            icon = '\ue603';
-            break;
-        case ".go":
-            icon = '\ue65e';
-            break;
-        case ".json":
-        case ".jsonc":
-        case ".json5":
-            icon = '\ue60b';
-            break;
-        case ".yml":
-        case ".yaml":
-            icon = '\ue6a8';
-            break;
-        case ".gitignore":
-            icon = '\ue65d';
-            break;
-        case ".npmignore":
-            icon = '\ue616';
-            break;
-        case ".dockerignore":
-            icon = '\ue650';
-            break;
-        default:
-            icon = '\ue64e';
-            break;
-    }
-    switch (parsed.name.toLocaleLowerCase()) {
-        case "readme":
-            icon = '\ue66a';
-            break;
-        case "changelog":
-            icon = '\ue641';
-            break;
-        case "tsconfig":
-            icon = '\ue69d';
-            break;
-        case "eslint.config":
-            icon = '\ue655';
-            break;
-        case "stylelint.config":
-            icon = '\ue695';
-            break;
-        default:
-            break;
-    }
-    if (!decor) {
-        return '';
-    }
-    return decorCondition(decor, {
-        ifEmoji: '📄',
-        ifNerd: icon,
-        postfix: ' '
-    });
-}

package/out/src/cli.d.ts

@@ -1,92 +1,131 @@
-import { ChalkInstance, ColorSupportLevel } from "chalk";
-import { Argument, Option, Command } from "commander";
-import * as Config from "./config.js";
-import { DecorName, StyleName } from "./browser/styling.js";
-import { SortName } from "./browser/sorting.js";
-import { FilterName } from "./lib.js";
-import { BoxOptions } from "./styling.js";
-export declare const version: string;
+import { Argument, Option, Command } from 'commander';
+import * as Config from './config.js';
+import { type DecorName, type StyleName } from './browser/styling.js';
+import { type SortName } from './browser/sorting.js';
+import { type BoxOptions } from './styling.js';
+import { type FilterName } from './browser/filtering.js';
+/**
+ * @private
+ */
 export declare function logError(message: string, options?: BoxOptions): void;
 /**
- * Use it instead of {@link program}.parse()
+ * Use it instead of {@link program.parse}.
+ * @private
  */
 export declare function programInit(): Promise<void>;
-/** Chalk, but configured by view-ignored cli. */
-export declare function getColorLevel(flags: ProgramFlags): ColorSupportLevel;
-/** Chalk, but configured by view-ignored cli. */
-export declare function getChalk(flags: ProgramFlags): ChalkInstance;
 /**
  * Command-line entire program flags.
+ * @public
  */
-export interface ProgramFlags {
+export type ProgramFlags = {
+    posix: boolean;
     plugins: string[];
     noColor: boolean;
-    color: string;
     decor: DecorName;
-}
+    parsable: boolean;
+};
 /**
  * Command-line 'scan' command flags.
+ * @public
  */
-export interface ScanFlags {
+export type ScanFlags = {
     target: string;
     filter: FilterName;
     sort: SortName;
     style: StyleName;
     showSources: boolean;
     depth: number;
-    parsable: boolean;
-}
+    concurrency: number;
+};
 /**
  * Command-line 'cfg get' command flags.
+ * @public
  */
-export interface ConfigGetFlags {
+export type ConfigGetFlags = {
     real: boolean;
-}
+    types: boolean;
+};
 /**
  * `view-ignored` command-line programl
+ * @public
  */
 export declare const program: Command;
 /**
  * Command-line 'scan' command.
+ * @public
  */
 export declare const scanProgram: Command;
 /**
-* Command-line 'config' command.
-*/
+ * Command-line 'config' command.
+ * @public
+ */
 export declare const cfgProgram: Command;
 /**
  * Command-line argument: key=value pair.
- * @see {@link parseArgKeyVal}
+ * @see {@link parseArgumentKeyValue}
+ * @public
  */
-export declare const argConfigKeyVal: Argument;
+export declare const argumentConfigKeyValue: Argument;
 /**
  * Command-line argument: config property.
  * @see {@link Config.configKeyList}
+ * @public
+ */
+export declare const argumentConfigKey: Argument;
+/**
+ * @public
+ */
+export declare const cfgRealOption: Option;
+/**
+ * @public
+ */
+export declare const cfgTypesOption: Option;
+/**
+ * @public
+ */
+export declare function parseArgumentArrayString(argument: string): string[];
+/**
+ * @public
+ */
+export declare function parseArgumentBoolean(argument: string): boolean;
+/**
+ * @public
+ */
+export declare function parseArgumentInteger(argument: string): number;
+/**
+ * @public
+ */
+export declare function createArgumentParserStringLiteral(choices: string[]): (argument: string) => string;
+/**
+ * @public
+ */
+export declare function parseArgumentKey(key: string): string;
+/**
+ * @public
  */
-export declare const argConfigKey: Argument;
-export declare const cfgGetOption: Option;
-export declare function parseArgArrStr(arg: string): string[];
-export declare function parseArgBool(arg: string): boolean;
-export declare function parseArgInt(arg: string): number;
-export declare function parseArgKey(key: string): Config.ConfigKey;
-export declare function parseArgKeyVal(pair: string): Config.ConfigPair;
+export declare function parseArgumentKeyValue(pair: string): Config.ConfigPair;
 /**
  * Command-line 'scan' command action.
+ * @public
  */
 export declare function actionScan(): Promise<void>;
 /**
  * Command-line 'config path' command action.
+ * @public
  */
 export declare function actionCfgPath(): void;
 /**
  * Command-line 'config set' command action
+ * @public
  */
-export declare function actionCfgSet(pair?: Config.ConfigPair): void;
+export declare function actionCfgSet(pair: Config.ConfigPair | undefined, options: ConfigGetFlags): void;
 /**
  * Command-line 'config unset' command action
+ * @public
  */
-export declare function actionCfgUnset(key: Config.ConfigKey | undefined): void;
+export declare function actionCfgUnset(key: Config.ConfigKey | undefined, options: ConfigGetFlags): void;
 /**
  * Command-line 'config unset' command action
+ * @public
  */
 export declare function actionCfgGet(key: Config.ConfigKey | undefined, options: ConfigGetFlags): void;