view-ignored 0.4.0 → 0.4.2

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

@@ -1,15 +1,12 @@
 /**
  * Contains all filter names.
- * @public
  */
 export declare const filterNameList: readonly ["ignored", "included", "all"];
 /**
  * Contains all filter names as a type.
- * @public
  */
 export type FilterName = typeof filterNameList[number];
 /**
  * Checks if the value is the {@link FilterName}.
- * @public
  */
 export declare function isFilterName(value: unknown): value is FilterName;

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

@@ -1,11 +1,9 @@
 /**
  * Contains all filter names.
- * @public
  */
 export const filterNameList = ['ignored', 'included', 'all'];
 /**
  * Checks if the value is the {@link FilterName}.
- * @public
  */
 export function isFilterName(value) {
     return typeof value === 'string' && filterNameList.includes(value);

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

@@ -2,83 +2,38 @@ import { type ParsedPath } from 'node:path';
 import EventEmitter from 'node:events';
 import { type RealScanOptions } from '../lib.js';
 import { File } from './file.js';
-/**
- * @public
- */
 export type DeepStreamEventEmitter = EventEmitter<DeepStreamEventMap> & {
     endPromise: Promise<DeepStreamDataRoot>;
     run(): void;
 };
-/**
- * @public
- */
 export type DeepStreamDataRoot = {
     tree: Directory;
     progress: DeepStreamProgress;
 };
-/**
- * @public
- */
 export type DeepStreamData = {
     target: Entry;
     progress: DeepStreamProgress;
 };
-/**
- * @public
- */
 export type DeepStreamProgress = {
     directories: number;
     files: number;
     current: number;
     total: number;
 };
-/**
- * @public
- */
 export type DeepStreamEventMap = {
     data: [DeepStreamData];
     end: [DeepStreamDataRoot];
     progress: [DeepStreamProgress];
 };
-/**
- * @public
- */
 export type DeepStream = ReadableStream<Entry>;
-/**
- * @private
- */
-type DeepStreamNestedOptions = DeepStreamOptions & {
-    controller?: DeepStreamEventEmitter;
-    parent?: Directory;
-    progress?: DeepStreamProgress;
-};
-/**
- * @public
- */
 export type DeepCountOptions = Pick<DeepStreamNestedOptions, 'modules' | 'cwd' | 'concurrency' | 'progress'>;
-/**
- * @public
- */
 export type DeepModifiedTimeOptions = Pick<RealScanOptions, 'concurrency' | 'modules'>;
-/**
- * @public
- */
 export type DeepStreamOptions = Pick<RealScanOptions, 'cwd' | 'modules' | 'concurrency'>;
-/**
- * @public
- */
 export type Entry = Directory | File;
-/**
- * @public
- */
 export type EntryClass = typeof Directory | typeof File;
-/**
- * @public
- */
 export type EntryInstanceFrom<T extends undefined | EntryClass> = T extends undefined ? Entry : T extends typeof Directory ? Directory : File;
 /**
  * File system directory representation.
- * @public
  */
 export declare class Directory implements ParsedPath {
     /**
@@ -125,13 +80,6 @@ export declare class Directory implements ParsedPath {
      * Get deep iterator for the directory.
      */
     static deepIterator: <T extends undefined | EntryClass>(directory: Directory, instanceOf?: T) => IterableIterator<EntryInstanceFrom<T>>;
-    /**
-     * Read directories and files progressively.
-     * @private This function should be wrapped by {@link deepStream}.
-     * @param directoryPath Relative path to the directory.
-     * @param options The reader options.
-     */
-    private static deepStreamNested;
     readonly base: string;
     readonly dir: string;
     readonly ext: string;
@@ -178,4 +126,3 @@ export declare class Directory implements ParsedPath {
      */
     deepModifiedTime(out: Map<File, number>, realOptions: DeepModifiedTimeOptions): Promise<Map<File, number>>;
 }
-export {};

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

@@ -1,4 +1,3 @@
-/* eslint-disable unicorn/prefer-event-target */
 import { join, parse, relative, } from 'node:path';
 import EventEmitter from 'node:events';
 import * as FSP from 'node:fs/promises';
@@ -8,7 +7,6 @@ import { configDefault } from '../../config.js';
 import { File } from './file.js';
 /**
  * File system directory representation.
- * @public
  */
 export class Directory {
     parent;
@@ -49,8 +47,8 @@ export class Directory {
      */
     static deepStream(directoryPath, optionsReal) {
         const controller = new EventEmitter();
-        controller.endPromise = new Promise(resolve => {
-            controller.once('end', data => {
+        controller.endPromise = new Promise((resolve) => {
+            controller.once('end', (data) => {
                 resolve(data);
             });
         });
@@ -70,7 +68,6 @@ export class Directory {
         const tree = new Directory(undefined, '.', cwd, new Map());
         for (const path of pathList) {
             const entryNameList = path.toString().split(/[\\/]/);
-            // eslint-disable-next-line unicorn/no-array-reduce
             entryNameList.reduce((tree, entryName, index) => {
                 const absolutePath = join(tree.absolutePath, entryName);
                 const relativePath = relative(cwd, absolutePath);
@@ -108,7 +105,7 @@ export class Directory {
     };
     /**
      * Read directories and files progressively.
-     * @private This function should be wrapped by {@link deepStream}.
+     * @internal This function should be wrapped by {@link deepStream}.
      * @param directoryPath Relative path to the directory.
      * @param options The reader options.
      */

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 {
     /**
@@ -61,7 +56,7 @@ export declare class FileInfo extends File {
     static from(file: File, source?: SourceInfo): FileInfo;
     /**
      * Determines if ignored file is ignored or not.
-    */
+     */
     readonly status: FileInfoStatus;
     constructor(
     /**

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;
@@ -13,7 +12,7 @@ export class FileInfo extends File {
     }
     /**
      * Determines if ignored file is ignored or not.
-    */
+     */
     status;
     constructor(
     /**

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
@@ -11,8 +8,8 @@ export type FormatFilesOptions = {
      * resolved UNC forms, eg instead of `'C:\\foo\\bar'`, it would return
      * `'//?/C:/foo/bar'`
      * @default false
-     * @returns `/` delimited paths, even on Windows.
-     */
+       * @returns `/` delimited paths, even on Windows.
+       */
     posix?: boolean;
     /**
      * @default false
@@ -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, {