view-ignored 0.4.0 → 0.4.2

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 {
@@ -88,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')
@@ -102,7 +99,6 @@ export const scanProgram = program
     .action(actionScan);
 /**
  * Command-line 'config' command.
- * @public
  */
 export const cfgProgram = program
     .command('config')
@@ -111,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')
@@ -149,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) {
@@ -165,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);
@@ -176,9 +155,6 @@ export function parseArgumentInteger(argument) {
     }
     return value;
 }
-/**
- * @public
- */
 export function createArgumentParserStringLiteral(choices) {
     return function (argument) {
         const errorMessage = Config.configValueLiteral(choices)(argument);
@@ -188,9 +164,6 @@ export function createArgumentParserStringLiteral(choices) {
         return argument;
     };
 }
-/**
- * @public
- */
 export function parseArgumentKey(key) {
     const errorMessage = Config.configManager.checkKey(key);
     if (errorMessage !== undefined) {
@@ -198,9 +171,6 @@ export function parseArgumentKey(key) {
     }
     return key;
 }
-/**
- * @public
- */
 export function parseArgumentKeyValue(pair) {
     const result = pair.split('=');
     if (result.length > 2) {
@@ -224,7 +194,6 @@ export function parseArgumentKeyValue(pair) {
 }
 /**
  * Command-line 'scan' command action.
- * @public
  */
 export async function actionScan() {
     const flags = scanProgram.optsWithGlobals();
@@ -263,8 +232,8 @@ export async function actionScan() {
             fileInfoList: [],
             stream,
             message: '',
-            reading: new Promise(resolve => {
-                stream.on('end', data => {
+            reading: new Promise((resolve) => {
+                stream.on('end', (data) => {
                     resolve(data);
                 });
             }),
@@ -350,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) {
@@ -379,7 +346,6 @@ export function actionCfgSet(pair, options) {
 }
 /**
  * Command-line 'config unset' command action
- * @public
  */
 export function actionCfgUnset(key, options) {
     if (key === undefined) {
@@ -394,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>;

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

@@ -8,18 +8,16 @@ import { sortNameList } from './browser/sorting.js';
 import { filterNameList } from './browser/filtering.js';
 /**
  * The full config file name - `".view-ignored"`.
- * @public
  */
 export const configFileName = '.view-ignored';
 /**
  * The user's home directory + the config file name.
  * @see {@link os.homedir}
- * @private
+ * @internal
  */
 const configFilePath = path.join(os.homedir(), configFileName);
 /**
  * Command-line configuration property list.
- * @public
  */
 export const configKeyList = [
     'posix',
@@ -35,15 +33,11 @@ export const configKeyList = [
     'parsable',
     'concurrency',
 ];
-/**
- * @public
- */
 export function isShowSources(value) {
     return typeof value === 'boolean';
 }
 /**
  * Command-line default config values.
- * @public
  */
 export const configDefault = {
     parsable: false,
@@ -59,11 +53,8 @@ export const configDefault = {
     showSources: false,
     concurrency: 8,
 };
-/**
- * @public
- */
 export const configValueArray = (type) => {
-    const validator = value => {
+    const validator = (value) => {
         if (Array.isArray(value)) {
             if (type === undefined) {
                 return;
@@ -80,11 +71,8 @@ export const configValueArray = (type) => {
     validator.typeName = `${type?.typeName ?? 'any'}[]`;
     return validator;
 };
-/**
- * @public
- */
 export const configValueLiteral = (choices) => {
-    const validator = value => {
+    const validator = (value) => {
         if (choices.includes(value)) {
             return;
         }
@@ -93,23 +81,11 @@ export const configValueLiteral = (choices) => {
     validator.typeName = choices.map(choice => format('%o', choice)).join('|');
     return validator;
 };
-/**
- * @public
- */
 export const switchTrueValues = ['true', 'on', 'yes', 'y', 'enable', 'enabled', '1'];
-/**
- * @public
- */
 export const switchFalseValues = ['false', 'off', 'no', 'n', 'disable', 'disabled', '0'];
-/**
- * @public
- */
 export const booleanValues = [...switchTrueValues, ...switchFalseValues];
-/**
- * @public
- */
 export const configValueSwitch = () => {
-    const validator = value => {
+    const validator = (value) => {
         if (booleanValues.includes(value)) {
             return;
         }
@@ -118,11 +94,8 @@ export const configValueSwitch = () => {
     validator.typeName = 'switch';
     return validator;
 };
-/**
- * @public
- */
 export const configValueBoolean = () => {
-    const validator = value => {
+    const validator = (value) => {
         if (typeof value === 'boolean') {
             return;
         }
@@ -131,11 +104,8 @@ export const configValueBoolean = () => {
     validator.typeName = 'boolean';
     return validator;
 };
-/**
- * @public
- */
 export const configValueObject = () => {
-    const validator = value => {
+    const validator = (value) => {
         if (value?.constructor === Object) {
             return;
         }
@@ -144,11 +114,8 @@ export const configValueObject = () => {
     validator.typeName = 'object';
     return validator;
 };
-/**
- * @public
- */
 export const configValueString = () => {
-    const validator = value => {
+    const validator = (value) => {
         if (typeof value === 'string') {
             return;
         }
@@ -157,11 +124,8 @@ export const configValueString = () => {
     validator.typeName = 'string';
     return validator;
 };
-/**
- * @public
- */
 export const configValueNumber = () => {
-    const validator = value => {
+    const validator = (value) => {
         if (typeof value === 'number') {
             return;
         }
@@ -170,11 +134,8 @@ export const configValueNumber = () => {
     validator.typeName = 'number';
     return validator;
 };
-/**
- * @public
- */
 export const configValueInteger = () => {
-    const validator = value => {
+    const validator = (value) => {
         if (typeof value === 'number' && (Number.isSafeInteger(value) || Math.abs(value) === Infinity)) {
             return;
         }
@@ -185,7 +146,6 @@ export const configValueInteger = () => {
 };
 /**
  * File-specific actions container.
- * @public
  */
 export class ConfigManager {
     path;
@@ -323,11 +283,11 @@ export class ConfigManager {
     unset(key) {
         if (key === undefined) {
             for (const key of Object.keys(this.data)) {
-                delete this.data[key]; // eslint-disable-line @typescript-eslint/no-dynamic-delete
+                delete this.data[key];
             }
             return this;
         }
-        delete this.data[key]; // eslint-disable-line @typescript-eslint/no-dynamic-delete
+        delete this.data[key];
         return this;
     }
     /**
@@ -366,7 +326,6 @@ export class ConfigManager {
                 return `${key}\n${value}`;
             }).join('\n');
         }
-        // eslint-disable-next-line unicorn/no-array-reduce
         const keyMaxLength = keys.reduce((maxLength, key) => Math.max(maxLength, key.length), 0);
         return keys.map((key) => {
             const value = format('%o', this.get(key, options));
@@ -381,6 +340,5 @@ export class ConfigManager {
 }
 /**
  * File-specific actions container. Contains get, set, unset, save, load and other configuration actions.
- * @public
  */
 export const configManager = new ConfigManager(configFilePath);

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

@@ -2,6 +2,5 @@ import { type ConfigKey } from './config.js';
 export * from './browser/errors.js';
 /**
  * For each property of the configuration we have an error message.
- * @public
  */
 export type ConfigCheckMap = Map<string | ConfigKey, string>;

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

@@ -1,10 +1,4 @@
 import { type ChalkInstance } from 'chalk';
 export * from './browser/styling.js';
-/**
- * @public
- */
 export declare function highlight(text: string, chalk?: ChalkInstance): string;
-/**
- * @public
- */
 export declare function stringTime(time: number, chalk: ChalkInstance): string;

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

@@ -1,8 +1,5 @@
 import ansiRegex from 'ansi-regex';
 export * from './browser/styling.js';
-/**
- * @public
- */
 export function highlight(text, chalk) {
     if (chalk === undefined) {
         return text;
@@ -19,7 +16,7 @@ export function highlight(text, chalk) {
     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 => {
+    const colored = text.replaceAll(rall, (match) => {
         if (match.match(ansiRegex()) !== null) {
             return match;
         }
@@ -42,9 +39,6 @@ export function highlight(text, chalk) {
     });
     return colored;
 }
-/**
- * @public
- */
 export function stringTime(time, chalk) {
     if (time < 1000) {
         return `${highlight(String(time), chalk)} milliseconds`;