view-ignored 0.3.2 → 0.4.1

package/out/{src/browser → browser}/sorting.js

@@ -1,18 +1,15 @@
 import path from 'node:path';
 /**
  * Contains all file sort names.
- * @public
  */
 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);
 }
 /**
- * @public
  * @example
  * "path/to/the/file" -> ["path", "to/the/file", false]
  * "file" -> ["file", "file", true]
@@ -28,7 +25,6 @@ export function shiftPath(p) {
 /**
  * Files and folders are sorted by their names.
  * Folders are displayed before files.
- * @public
  */
 export function firstFolders(a, b) {
     let comp = 0;
@@ -53,7 +49,6 @@ 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;
@@ -79,7 +74,6 @@ 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;
@@ -104,7 +98,6 @@ 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;
@@ -131,7 +124,6 @@ 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 → browser}/styling.d.ts

@@ -1,9 +1,6 @@
 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
@@ -33,42 +30,34 @@ export type FormatFilesOptions = {
 };
 /**
  * @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 type DecorConditionOptions = {
     /**
@@ -99,18 +88,15 @@ export type DecorConditionOptions = {
  * 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;
 /**
  * @see {@link boxError}
- * @public
  */
 export type BoxOptions = {
     noColor?: boolean;
 } & Options;
 /**
  * Make a message in a red box. Or without color.
- * @public
  */
 export declare function boxError(message: string, options?: BoxOptions): string;

package/out/{src/browser → browser}/styling.js

@@ -5,7 +5,6 @@ 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, posix = false } = options ?? {};
@@ -24,24 +23,20 @@ export function formatFiles(files, options) {
 }
 /**
  * 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);
 }
 /**
  * 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);
@@ -50,7 +45,6 @@ export function isDecorName(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 ?? '';
@@ -67,7 +61,6 @@ export function decorCondition(decor, condition) {
 }
 /**
  * Make a message in a red box. Or without color.
- * @public
  */
 export function boxError(message, options) {
     let result = ('\n' + boxen(message, {

package/out/{src/cli.d.ts → cli.d.ts}

@@ -2,20 +2,9 @@ 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}.
- * @private
- */
-export declare function programInit(): Promise<void>;
 /**
  * Command-line entire program flags.
- * @public
  */
 export type ProgramFlags = {
     posix: boolean;
@@ -26,7 +15,6 @@ export type ProgramFlags = {
 };
 /**
  * Command-line 'scan' command flags.
- * @public
  */
 export type ScanFlags = {
     target: string;
@@ -39,7 +27,6 @@ export type ScanFlags = {
 };
 /**
  * Command-line 'cfg get' command flags.
- * @public
  */
 export type ConfigGetFlags = {
     real: boolean;
@@ -47,85 +34,51 @@ export type ConfigGetFlags = {
 };
 /**
  * `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.
- * @public
  */
 export declare const cfgProgram: Command;
 /**
  * Command-line argument: key=value pair.
  * @see {@link parseArgumentKeyValue}
- * @public
  */
 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 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 | undefined, options: ConfigGetFlags): void;
 /**
  * Command-line 'config unset' command action
- * @public
  */
 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;

package/out/{src/cli.js → cli.js}

@@ -1,4 +1,3 @@
-/* eslint-disable unicorn/no-process-exit */
 import { format } from 'node:util';
 import * as process from 'node:process';
 import { icons } from '@m234/nerd-fonts';
@@ -13,14 +12,14 @@ import { boxError, decorNameList, highlight, stringTime, styleNameList, } from '
 import { Directory, package_, makeOptionsReal, scan, Sorting, ViewIgnoredError, } from './lib.js';
 import { filterNameList } from './browser/filtering.js';
 /**
- * @private
+ * @internal
  */
 export function logError(message, options) {
     console.log(boxError(message, { ...options }));
 }
 /**
  * Use it instead of {@link program.parse}.
- * @private
+ * @internal
  */
 export async function programInit() {
     try {
@@ -31,7 +30,7 @@ export async function programInit() {
         const loadResultConfig = configManager.load();
         const builtInPlugins = await loadBuiltIns();
         const configPlugins = configManager.get('plugins');
-        const loadResultPlugins = (flags.plugins ? await loadPlugins(flags.plugins) : []).concat(builtInPlugins);
+        const loadResultPlugins = [...(flags.plugins ? await loadPlugins(flags.plugins) : []), ...builtInPlugins];
         for (const loadResult of loadResultPlugins) {
             if (loadResult.isLoaded) {
                 continue;
@@ -48,9 +47,9 @@ export async function programInit() {
         configManager.keySetValidator('target', configDefault.target, configValueLiteral(targets));
         {
             const title = 'view-ignored - Configuration loading failed.';
-            const infoSymbol = decorCondition(flags.decor, { ifEmoji: 'ℹ️', ifNerd: icons['nf-seti-info'].char, postfix: ' ' });
+            const infoSymbol = decorCondition(flags.decor, { ifEmoji: 'ℹ️', ifNerd: icons['nf-seti-info'].value, postfix: ' ' });
             const errorIcon = decorCondition(flags.decor, {
-                ifNerd: icons['nf-seti-error'].char, ifEmoji: '⚠️', postfix: ' ',
+                ifNerd: icons['nf-seti-error'].value, ifEmoji: '⚠️', postfix: ' ',
             });
             const footer = `\n\n${chalk.blue(infoSymbol)}Configuration path: ${Config.configManager.path}`;
             if (typeof loadResultConfig === 'string') {
@@ -58,7 +57,10 @@ export async function programInit() {
                 process.exit(1);
             }
             if (loadResultConfig && loadResultConfig?.size > 0) {
-                const propertiesErrors = Array.from(loadResultConfig.entries()).map(([key, message]) => `${Config.configManager.getPairString(key, { chalk, types: false, real: true })} - ${chalk.red(errorIcon)}${message}`).join('\n');
+                const propertiesErrors = [...loadResultConfig.entries()].map(([key, message]) => {
+                    const pair = Config.configManager.getPairString(key, { chalk, types: false, real: true });
+                    return `${pair} - ${chalk.red(errorIcon)}${message}`;
+                }).join('\n');
                 logError(`Invalid properties:\n${propertiesErrors}${footer}`, { title });
                 process.exit(1);
             }
@@ -85,12 +87,10 @@ export async function programInit() {
 }
 /**
  * `view-ignored` command-line programl
- * @public
  */
 export const program = new Command();
 /**
  * Command-line 'scan' command.
- * @public
  */
 export const scanProgram = program
     .command('scan')
@@ -99,7 +99,6 @@ export const scanProgram = program
     .action(actionScan);
 /**
  * Command-line 'config' command.
- * @public
  */
 export const cfgProgram = program
     .command('config')
@@ -108,22 +107,14 @@ export const cfgProgram = program
 /**
  * Command-line argument: key=value pair.
  * @see {@link parseArgumentKeyValue}
- * @public
  */
 export const argumentConfigKeyValue = new Argument('[pair]', 'the configuration entry key=value\'').argParser(parseArgumentKeyValue);
 /**
  * Command-line argument: config property.
  * @see {@link Config.configKeyList}
- * @public
  */
 export const argumentConfigKey = new Argument('[key]', 'the configuration setting name').choices(Config.configKeyList);
-/**
- * @public
- */
 export const cfgRealOption = new Option('--real', 'use default value(s) as fallback').default(false);
-/**
- * @public
- */
 export const cfgTypesOption = new Option('--types', 'use default value(s) as fallback').default(false);
 cfgProgram
     .command('path').description('print the config file path')
@@ -146,15 +137,9 @@ cfgProgram
     .addOption(cfgTypesOption)
     .addArgument(argumentConfigKey)
     .action(actionCfgGet);
-/**
- * @public
- */
 export function parseArgumentArrayString(argument) {
     return argument.split(/[ ,|]/).filter(Boolean);
 }
-/**
- * @public
- */
 export function parseArgumentBoolean(argument) {
     const errorMessage = Config.configValueSwitch()(argument);
     if (errorMessage !== undefined) {
@@ -162,9 +147,6 @@ export function parseArgumentBoolean(argument) {
     }
     return Config.switchTrueValues.includes(argument);
 }
-/**
- * @public
- */
 export function parseArgumentInteger(argument) {
     const value = Number.parseInt(argument, 10);
     const errorMessage = Config.configValueInteger()(value);
@@ -173,9 +155,6 @@ export function parseArgumentInteger(argument) {
     }
     return value;
 }
-/**
- * @public
- */
 export function createArgumentParserStringLiteral(choices) {
     return function (argument) {
         const errorMessage = Config.configValueLiteral(choices)(argument);
@@ -185,9 +164,6 @@ export function createArgumentParserStringLiteral(choices) {
         return argument;
     };
 }
-/**
- * @public
- */
 export function parseArgumentKey(key) {
     const errorMessage = Config.configManager.checkKey(key);
     if (errorMessage !== undefined) {
@@ -195,9 +171,6 @@ export function parseArgumentKey(key) {
     }
     return key;
 }
-/**
- * @public
- */
 export function parseArgumentKeyValue(pair) {
     const result = pair.split('=');
     if (result.length > 2) {
@@ -221,7 +194,6 @@ export function parseArgumentKeyValue(pair) {
 }
 /**
  * Command-line 'scan' command action.
- * @public
  */
 export async function actionScan() {
     const flags = scanProgram.optsWithGlobals();
@@ -249,9 +221,9 @@ export async function actionScan() {
         console.log(fileInfoList.map(fileInfo => fileInfo.relativePath + (flags.showSources && fileInfo.source !== undefined ? '<' + (fileInfo.source.relativePath) : '')).join(','));
     }
     else {
-        let name = decorCondition(flags.decor, { ifNerd: bind.icon?.char, postfix: ' ' }) + bind.name;
+        let name = decorCondition(flags.decor, { ifNerd: bind.icon?.value, postfix: ' ' }) + bind.name;
         if (bind.icon?.color !== undefined) {
-            name = chalk.hex('#' + bind.icon.color.toString(16))(name);
+            name = chalk.hex('#' + bind.icon.color)(name);
         }
         const context = {
             count: {
@@ -307,8 +279,8 @@ export async function actionScan() {
                                     decor: flags.decor,
                                     showSources: flags.showSources,
                                 });
-                                const fastSymbol = decorCondition(flags.decor, { ifEmoji: '⚡', ifNerd: icons['nf-md-lightning_bolt'].char });
-                                const infoSymbol = decorCondition(flags.decor, { ifEmoji: 'ℹ️', ifNerd: icons['nf-seti-info'].char, postfix: ' ' });
+                                const fastSymbol = decorCondition(flags.decor, { ifEmoji: '⚡', ifNerd: icons['nf-md-lightning_bolt'].value });
+                                const infoSymbol = decorCondition(flags.decor, { ifEmoji: 'ℹ️', ifNerd: icons['nf-seti-info'].value, postfix: ' ' });
                                 let message = '';
                                 message += files;
                                 message += '\n';
@@ -347,14 +319,12 @@ export async function actionScan() {
 }
 /**
  * Command-line 'config path' command action.
- * @public
  */
 export function actionCfgPath() {
     console.log(Config.configManager.path);
 }
 /**
  * Command-line 'config set' command action
- * @public
  */
 export function actionCfgSet(pair, options) {
     if (pair === undefined) {
@@ -376,7 +346,6 @@ export function actionCfgSet(pair, options) {
 }
 /**
  * Command-line 'config unset' command action
- * @public
  */
 export function actionCfgUnset(key, options) {
     if (key === undefined) {
@@ -391,7 +360,6 @@ export function actionCfgUnset(key, options) {
 }
 /**
  * Command-line 'config unset' command action
- * @public
  */
 export function actionCfgGet(key, options) {
     const flags = scanProgram.optsWithGlobals();

package/out/{src/config.d.ts → config.d.ts}

@@ -6,40 +6,26 @@ import { type SortName } from './browser/sorting.js';
 import { type FilterName } from './browser/filtering.js';
 /**
  * The full config file name - `".view-ignored"`.
- * @public
  */
 export declare const configFileName = ".view-ignored";
 /**
  * Command-line configuration property list.
- * @public
  */
 export declare const configKeyList: readonly ["posix", "noColor", "target", "filter", "sort", "style", "decor", "depth", "showSources", "plugins", "parsable", "concurrency"];
 /**
  * Command-line configuration's property type.
- * @public
  */
 export type ConfigKey = typeof configKeyList[number] & keyof Config;
-/**
- * @public
- */
 export type ConfigValue<KeyT extends ConfigKey = ConfigKey> = Config[KeyT];
-/**
- * @public
- */
 export type ShowSourcesType = boolean;
-/**
- * @public
- */
 export declare function isShowSources(value: unknown): value is ShowSourcesType;
 /**
  * Represents array with the key nad the value.
- * @public
  */
 export type ConfigPair<KeyT extends ConfigKey = ConfigKey> = [key: KeyT, value: ConfigValue<KeyT>];
 /**
  * Command-line configuration structure.
  * @see {@link configKeyList} Before adding new properties.
- * @public
  */
 export type Config = {
     [key: string]: unknown;
@@ -58,63 +44,25 @@ export type Config = {
 };
 /**
  * Command-line default config values.
- * @public
  */
 export declare const configDefault: Readonly<Config>;
 /**
  * @returns Error message and parsed value.
- * @public
  */
 export type ConfigValidator = ((value: unknown) => string | undefined) & {
     typeName: string;
 };
-/**
- * @public
- */
 export declare const configValueArray: <T extends ConfigValidator>(type?: T) => ConfigValidator;
-/**
- * @public
- */
 export declare const configValueLiteral: (choices: readonly unknown[]) => ConfigValidator;
-/**
- * @public
- */
 export declare const switchTrueValues: string[];
-/**
- * @public
- */
 export declare const switchFalseValues: string[];
-/**
- * @public
- */
 export declare const booleanValues: string[];
-/**
- * @public
- */
 export declare const configValueSwitch: () => ConfigValidator;
-/**
- * @public
- */
 export declare const configValueBoolean: () => ConfigValidator;
-/**
- * @public
- */
 export declare const configValueObject: () => ConfigValidator;
-/**
- * @public
- */
 export declare const configValueString: () => ConfigValidator;
-/**
- * @public
- */
 export declare const configValueNumber: () => ConfigValidator;
-/**
- * @public
- */
 export declare const configValueInteger: () => ConfigValidator;
-/**
- * @public
- */
 export type ConfigManagerGetOptions = {
     /**
      * Use default value as fallback.
@@ -122,9 +70,6 @@ export type ConfigManagerGetOptions = {
      */
     real?: boolean;
 };
-/**
- * @public
- */
 export type ConfigManagerGetPairStringOptions = ConfigManagerGetOptions & {
     /**
      * Add the type postfix.
@@ -144,7 +89,6 @@ export type ConfigManagerGetPairStringOptions = ConfigManagerGetOptions & {
 };
 /**
  * File-specific actions container.
- * @public
  */
 export declare class ConfigManager<ConfigType extends Config = Config> {
     readonly path: string;
@@ -234,6 +178,5 @@ export declare class ConfigManager<ConfigType extends Config = Config> {
 }
 /**
  * File-specific actions container. Contains get, set, unset, save, load and other configuration actions.
- * @public
  */
 export declare const configManager: ConfigManager<Config>;