view-ignored 0.4.0 → 0.4.1

package/out/{src/browser → browser}/fs/file-info.d.ts

@@ -6,7 +6,6 @@ import { type SourceInfo } from './source-info.js';
 import { type Directory } from './directory.js';
 /**
  * @see {@link FileInfo.prototype.toString}
- * @public
  */
 export type FileInfoToStringOptions = {
     /**
@@ -45,13 +44,9 @@ export type FileInfoToStringOptions = {
      */
     entire?: boolean;
 };
-/**
- * @public
- */
 export type FileInfoStatus = 'ignored' | 'included' | 'non-target';
 /**
  * The result of the file path scan.
- * @public
  */
 export declare class FileInfo extends File {
     /**

package/out/{src/browser → browser}/fs/file-info.js

@@ -4,7 +4,6 @@ import { decorCondition } from '../styling.js';
 import { File } from './file.js';
 /**
  * The result of the file path scan.
- * @public
  */
 export class FileInfo extends File {
     source;

package/out/{src/browser → browser}/fs/file.d.ts

@@ -1,8 +1,5 @@
 import { type ParsedPath } from 'node:path';
 import { type Directory } from './directory.js';
-/**
- * @public
- */
 export declare class File implements ParsedPath {
     /**
      * The parent of the file.

package/out/{src/browser → browser}/fs/file.js

@@ -1,7 +1,4 @@
 import { parse } from 'node:path';
-/**
- * @public
- */
 export class File {
     parent;
     relativePath;

package/out/{src/browser → browser}/fs/source-info.d.ts

@@ -1,7 +1,6 @@
 import { type Directory, File, type Scanner } from '../lib.js';
 /**
  * The source of patterns.
- * @public
  */
 export declare class SourceInfo extends File {
     /**

package/out/{src/browser → browser}/fs/source-info.js

@@ -1,7 +1,6 @@
 import { File, } from '../lib.js';
 /**
  * The source of patterns.
- * @public
  */
 export class SourceInfo extends File {
     scanner;

package/out/{src/browser → browser}/lib.d.ts

@@ -10,12 +10,10 @@ export * as Sorting from './sorting.js';
 export * as Plugins from './binds/index.js';
 /**
  * ViewIgnored's package.json.
- * @public
-*/
+ */
 export declare const package_: typeof import("../../package.json");
 /**
  * Uses `node:fs` and `node:fs/promises` by default.
- * @public
  */
 export type FileSystemAdapter = {
     readFileSync?: typeof FS.readFileSync;
@@ -29,7 +27,6 @@ export type FileSystemAdapter = {
 };
 /**
  * The custom scanner.
- * @public
  */
 export type Scanner = {
     /**
@@ -42,12 +39,10 @@ export type Scanner = {
  * @throws If the target does not allow the current ignore configurations: {@link ViewIgnoredError}.
  * For example, {@link https://www.npmjs.com/package/@vscode/vsce vsce} considers it invalid if your manifest is missing the 'engines' field.
  * Similarly, npm will raise an error if you attempt to publish a package without a basic 'package.json'.
- * @public
  */
 export type Methodology = (tree: Directory, realOptions: RealScanOptions) => Map<File, SourceInfo>;
 /**
  * Options with defaults and additional properties.
- * @public
  */
 export type RealScanOptions = Required<Omit<ScanOptions, 'fsa'>> & {
     modules: {
@@ -63,7 +58,6 @@ export type RealScanOptions = Required<Omit<ScanOptions, 'fsa'>> & {
 };
 /**
  * Folder deep scanning options.
- * @public
  */
 export type ScanOptions = {
     /**
@@ -111,32 +105,27 @@ export type ScanOptions = {
  * Gets info about the each file: it is ignored or not.
  * @param directoryPath The relative path to the directory.
  * @throws If no valid sources: {@link ErrorNoSources}.
- * @public
  */
 export declare function scan(directoryPath: string, options?: ScanOptions): Promise<FileInfo[]>;
 /**
  * Gets info about the each file: it is ignored or not.
  * @param directory The current working directory.
  * @throws If no valid sources: {@link ErrorNoSources}.
- * @public
  */
 export declare function scan(directory: Directory, options?: ScanOptions): Promise<FileInfo[]>;
 /**
  * Gets info about the each file: it is ignored or not.
  * @param stream The stream of the current working directory reading.
  * @throws If no valid sources: {@link ErrorNoSources}.
- * @public
  */
 export declare function scan(stream: DeepStreamEventEmitter, options?: ScanOptions): Promise<FileInfo[]>;
 /**
  * Gets info about the each file: it is ignored or not.
  * @param pathList The list of relative paths. The should be relative to the current working directory.
  * @throws If no valid sources: {@link ErrorNoSources}.
- * @public
  */
 export declare function scan(pathList: string[], options?: ScanOptions): Promise<FileInfo[]>;
 /**
  * @returns Options with defaults and additional properties.
- * @public
  */
 export declare function makeOptionsReal(options?: ScanOptions): RealScanOptions;

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

@@ -16,9 +16,7 @@ export * as Sorting from './sorting.js';
 export * as Plugins from './binds/index.js';
 /**
  * ViewIgnored's package.json.
- * @public
-*/
-// eslint-disable-next-line @typescript-eslint/consistent-type-imports
+ */
 export const package_ = createRequire(import.meta.url)('../../package.json');
 export async function scan(argument0, options) {
     options ??= {};
@@ -69,7 +67,6 @@ export async function scan(argument0, options) {
 }
 /**
  * @returns Options with defaults and additional properties.
- * @public
  */
 export function makeOptionsReal(options) {
     options ??= {};

package/out/{src/browser → browser}/sorting.d.ts

@@ -1,25 +1,20 @@
 /**
  * Contains all file sort names.
- * @public
  */
 export declare const sortNameList: readonly ["firstFolders", "firstFiles", "type", "mixed", "modified"];
 /**
  * Contains all file sort names as a type.
- * @public
  */
 export type SortName = typeof sortNameList[number];
 /**
  * {@link Array.prototype.sort}'s file path comparator.
- * @public
  */
 export type SortFunction = (a: string, b: string) => number;
 /**
  * Checks if the value is the {@link SortName}.
- * @public
  */
 export declare function isSortName(value: unknown): value is SortName;
 /**
- * @public
  * @example
  * "path/to/the/file" -> ["path", "to/the/file", false]
  * "file" -> ["file", "file", true]
@@ -29,20 +24,17 @@ export declare function shiftPath(p: string): [next: string, other: string, isLa
 /**
  * Files and folders are sorted by their names.
  * Folders are displayed before files.
- * @public
  */
 export declare function firstFolders(a: string, b: string): number;
 /**
  * Files and folders are sorted by their names.
  * Files are displayed before folders.
- * @public
  */
 export declare function firstFiles(a: string, b: string): number;
 /**
  * Files and folders are sorted by last modified date in descending order.
  * Folders are displayed before files.
  * @see {@link makeMtimeCache}
- * @public
  */
 export declare function modified(a: string, b: string, map: Map<{
     toString(): string;
@@ -50,12 +42,10 @@ export declare function modified(a: string, b: string, map: Map<{
 /**
  * Files and folders are grouped by extension type then sorted by thir names.
  * Folders are displayed before files.
- * @public
  */
 export declare function type(a: string, b: string): number;
 /**
  * Files and folders are sorted by their names.
  * Files are interwoven with folders.
- * @public
  */
 export declare function mixed(a: string, b: string): number;

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 {
@@ -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();
@@ -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();