view-ignored 0.3.2 → 0.4.1

package/out/{src/browser → browser}/binds/targets.d.ts

@@ -1,37 +1,30 @@
 import { type ScanOptions } from '../lib.js';
 /**
  * The target icon/logo as a {@link https://www.nerdfonts.com/ NF} icon.
- * @public
  */
 export type TargetIcon = {
     /**
      * Glyph character.
      */
-    char: string;
+    value: string;
     /**
      * The icon's color.
      */
-    color?: number;
+    color?: string;
 };
-/**
- * @public
- */
 export type TargetName = string;
 /**
  * Should satisfy RegExp: `/^[-a-zA-Z0-9]+$/`.
- * @public
  */
 export type TargetId = string;
 /**
  * @param value Target's id. Simple name.
  * @returns `true`, if the id is available for binding.
- * @public
  */
 export declare function isTargetId(value: unknown): value is TargetId;
 /**
  * The bind which allows use predefined options for scan functions.
  * @see {@link scanFolder}
- * @public
  */
 export type TargetBind = {
     /**
@@ -61,12 +54,10 @@ export type TargetBind = {
 };
 /**
  * Checks if the value is the {@link TargetBind}.
- * @public
  */
 export declare function isTargetBind(value: unknown): value is TargetBind;
 /**
  * Allows to create targets for view-ignored scan* functions.
- * @public
  * @example
  * scanFolder("abc") // error
  * Bindings.targetSet("abc", {...})
@@ -75,7 +66,6 @@ export declare function isTargetBind(value: unknown): value is TargetBind;
 export declare function targetSet(bind: TargetBind): void;
 /**
  * Get all target ids.
- * @public
  * @example
  * ["git", "npm", "vsce", ...]
  */
@@ -83,6 +73,5 @@ export declare function targetList(): string[];
 /**
  * Get target bind by target id.
  * @param id Target id.
- * @public
  */
 export declare function targetGet(id: TargetId): TargetBind | undefined;

package/out/{src/browser → browser}/binds/targets.js

@@ -1,26 +1,23 @@
 /**
  * @param value Target's id. Simple name.
  * @returns `true`, if the id is available for binding.
- * @public
  */
 export function isTargetId(value) {
     return typeof value === 'string' && (/^[-a-zA-Z\d]+$/.exec(value)) !== null;
 }
 /**
  * Checks if the value is the {@link TargetBind}.
- * @public
  */
 export function isTargetBind(value) {
     return value?.constructor === Object;
 }
 /**
  * The container for binds: id=bind.
- * @private
+ * @internal
  */
 const targetBindMap = new Map();
 /**
  * Allows to create targets for view-ignored scan* functions.
- * @public
  * @example
  * scanFolder("abc") // error
  * Bindings.targetSet("abc", {...})
@@ -31,18 +28,16 @@ export function targetSet(bind) {
 }
 /**
  * Get all target ids.
- * @public
  * @example
  * ["git", "npm", "vsce", ...]
  */
 export function targetList() {
-    const list = Array.from(targetBindMap.keys());
+    const list = [...targetBindMap.keys()];
     return list;
 }
 /**
  * Get target bind by target id.
  * @param id Target id.
- * @public
  */
 export function targetGet(id) {
     return targetBindMap.get(id);

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

@@ -1,13 +1,7 @@
 import { type File } from './lib.js';
-/**
- * @public
- */
 export declare class ViewIgnoredError extends Error {
     name: string;
 }
-/**
- * @public
- */
 export declare class NoSourceError extends ViewIgnoredError {
     static joinOr(fileBaseList: string[]): string;
     static joinAnd(fileBaseList: string[]): string;
@@ -25,9 +19,6 @@ export declare class NoSourceError extends ViewIgnoredError {
      */
     constructor(file: File);
 }
-/**
- * @public
- */
 export declare class BadSourceError extends ViewIgnoredError {
     name: string;
     /**
@@ -45,16 +36,10 @@ export declare class BadSourceError extends ViewIgnoredError {
      */
     constructor(file: File, message: string);
 }
-/**
- * @public
- */
 export declare class InvalidPatternError extends ViewIgnoredError {
     name: string;
     constructor(file: File, pattern?: string | string[]);
 }
-/**
- * @public
- */
 export declare class TargetNotBoundError extends ViewIgnoredError {
     name: string;
     constructor(targetId: string);

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

@@ -1,12 +1,6 @@
-/**
- * @public
- */
 export class ViewIgnoredError extends Error {
     name = 'ViewIgnoredError';
 }
-/**
- * @public
- */
 export class NoSourceError extends ViewIgnoredError {
     static joinOr(fileBaseList) {
         return fileBaseList.map(base => `'${base}'`).join(' or ');
@@ -19,27 +13,18 @@ export class NoSourceError extends ViewIgnoredError {
         super(`There was no configuration file (${typeof argument0 === 'string' ? argument0 : argument0.relativePath}) in the folders and subfolders that would correctly describe the ignoring.`);
     }
 }
-/**
- * @public
- */
 export class BadSourceError extends ViewIgnoredError {
     name = 'BadSourceError';
     constructor(argument0, message) {
         super(`Invalid ${typeof argument0 === 'string' ? argument0 : argument0.relativePath}: ${message}`);
     }
 }
-/**
- * @public
- */
 export class InvalidPatternError extends ViewIgnoredError {
     name = 'InvalidPatternError';
     constructor(file, pattern) {
         super(`Invalid pattern in ${file.relativePath}: ${pattern === undefined ? '' : ` Pattern: ${JSON.stringify(pattern)}`}`);
     }
 }
-/**
- * @public
- */
 export class TargetNotBoundError extends ViewIgnoredError {
     name = 'TargetNotBoundError';
     constructor(targetId) {

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];
+    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;
@@ -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);
@@ -79,7 +76,7 @@ export class Directory {
                     tree.set(file.base, file);
                     return tree;
                 }
-                let directory = Array.from(tree.children.values()).find(c => c instanceof Directory && c.absolutePath === absolutePath);
+                let directory = [...tree.children.values()].find(c => c instanceof Directory && c.absolutePath === absolutePath);
                 if (directory === undefined) {
                     directory = new Directory(tree, relativePath, absolutePath, new Map());
                     tree.set(`${directory.base}/`, directory);
@@ -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.
      */
@@ -198,7 +195,7 @@ export class Directory {
      * @param instanceOf Optionally filter children by type.
      */
     deep(instanceOf) {
-        return Array.from(Directory.deepIterator(this, instanceOf));
+        return [...Directory.deepIterator(this, instanceOf)];
     }
     /**
      * @returns The relative path to the directory.

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

@@ -1,10 +1,9 @@
 import PATH from 'node:path';
-import nf from '@m234/nerd-fonts';
+import * as nf from '@m234/nerd-fonts';
 import { decorCondition } from '../styling.js';
 import { File } from './file.js';
 /**
  * The result of the file path scan.
- * @public
  */
 export class FileInfo extends File {
     source;
@@ -34,7 +33,8 @@ export class FileInfo extends File {
     source) {
         super(parent, relativePath, absolutePath);
         this.source = source;
-        this.status = source === undefined ? 'non-target'
+        this.status = source === undefined
+            ? 'non-target'
             : (source.scanner.ignores(relativePath) ? 'ignored' : 'included');
     }
     /**
@@ -45,18 +45,21 @@ export class FileInfo extends File {
         const { fileIcon, chalk, usePrefix = false, source: useSource = false, entire = true, posix = false } = options ?? {};
         const patha = posix ? PATH.posix : PATH;
         const parsed = PATH.parse(this.relativePath);
-        const glyph = nf.FSC.fromPath(parsed, nf.FSC.mappings.seti);
-        const fIcon = fileIcon ? decorCondition(fileIcon, {
-            ifEmoji: '📄',
-            ifNerd: chalk && glyph.color !== undefined ? chalk.hex(glyph.color.toString(16))(glyph.char) : glyph.char,
-            postfix: ' ',
-        }) : '';
+        const glyph = nf.Seti.fromParsedPath(parsed);
+        const fIcon = fileIcon
+            ? decorCondition(fileIcon, {
+                ifEmoji: '📄',
+                ifNerd: chalk && glyph.color !== undefined ? chalk.hex(glyph.color)(glyph.value) : glyph.value,
+                postfix: ' ',
+            })
+            : '';
         let prefix = usePrefix && this.status !== 'non-target' ? (this.status === 'ignored' ? '!' : '+') : '';
         let postfix = useSource && this.source !== undefined ? ' < ' + this.source.toString() : '';
         if (chalk) {
             prefix = chalk.dim(prefix);
             postfix = chalk.dim(postfix);
-            const clr = this.status === 'non-target' ? chalk.white
+            const clr = this.status === 'non-target'
+                ? chalk.white
                 : (this.status === 'included' ? chalk.green : chalk.white);
             if (entire) {
                 return fIcon + clr(prefix + this.relativePath + postfix);

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 ??= {};
@@ -49,7 +47,7 @@ export async function scan(argument0, options) {
     const fileInfoList = [];
     const promiseList = [];
     const cacheDirectories = new Map();
-    for (const directory of [tree].concat(tree.deep(Directory))) {
+    for (const directory of [tree, ...tree.deep(Directory)]) {
         cacheDirectories.set(directory, pLimit(optionsReal.concurrency));
     }
     for (const entry of tree.deepIterator(File)) {
@@ -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;