view-ignored 0.4.0 → 0.4.1

package/bin/viewig

@@ -1,4 +1,4 @@
 #! /usr/bin/env node
-import {programInit} from '../out/src/cli.js';
+import {programInit} from '../out/cli.js';
 
 programInit();

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

@@ -1,64 +1,45 @@
-import { type TargetBind } from './targets.js';
 export * from './scanner.js';
 export * from './targets.js';
 /**
  * Built-in name list.
- * @public
  */
 export declare const builtInNameList: readonly ["git", "npm", "vsce", "yarn"];
 /**
  * Built-in name type.
- * @public
  */
 export type BuiltInName = typeof builtInNameList[number];
 /**
  * The result of loading.
- * @public
  */
 export type PluginLoaded = {
     resource: string;
     isLoaded: boolean;
     exports: unknown;
 };
-/**
- * If a plugin wants to change something, it must export default.
- * @private
- */
-export type PluginExport = {
-    viewignored: {
-        addTargets: TargetBind[];
-    };
-};
 /**
  * Checks if the value is the {@link PluginExport}.
- * @public
  */
 export declare function isPluginExport(value: unknown): value is PluginExport;
 /**
  * Imports the plugin's exported data.
- * @public
  */
 export declare function importPlugin(exportData: PluginExport): void;
 /**
  * @param modulePath The plugin name.
  * @returns The import result for the module.
- * @public
  */
 export declare function loadPlugin(modulePath: string, useImport?: boolean): Promise<PluginLoaded>;
 /**
  * @param modulePathList The plugin name list.
  * @returns The import result for the list of modules.
- * @public
  */
 export declare function loadPlugins(modulePathList: string[]): Promise<PluginLoaded[]>;
 /**
  * Load any built-in plugin.
- * @public
  */
 export declare function loadBuiltIn(builtIn: BuiltInName): Promise<PluginLoaded>;
 /**
  * @param modulePathList The plugin name list.
  * @returns The import result for the list of modules.
- * @public
  */
 export declare function loadBuiltIns(builtInList?: BuiltInName[]): Promise<PluginLoaded[]>;

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

@@ -4,7 +4,7 @@ import { isTargetBind, targetSet } from './targets.js';
 export * from './scanner.js';
 export * from './targets.js';
 /**
- * @private
+ * @internal
  */
 const builtInImportMap = {
     git: './plugins/git.js',
@@ -14,12 +14,10 @@ const builtInImportMap = {
 };
 /**
  * Built-in name list.
- * @public
  */
 export const builtInNameList = ['git', 'npm', 'vsce', 'yarn'];
 /**
  * Checks if the value is the {@link PluginExport}.
- * @public
  */
 export function isPluginExport(value) {
     if (value?.constructor !== Object) {
@@ -31,7 +29,6 @@ export function isPluginExport(value) {
 }
 /**
  * Imports the plugin's exported data.
- * @public
  */
 export function importPlugin(exportData) {
     const { addTargets } = exportData.viewignored;
@@ -42,7 +39,6 @@ export function importPlugin(exportData) {
 /**
  * @param modulePath The plugin name.
  * @returns The import result for the module.
- * @public
  */
 export async function loadPlugin(modulePath, useImport = false) {
     try {
@@ -66,7 +62,6 @@ export async function loadPlugin(modulePath, useImport = false) {
 /**
  * @param modulePathList The plugin name list.
  * @returns The import result for the list of modules.
- * @public
  */
 export async function loadPlugins(modulePathList) {
     const limit = pLimit(5);
@@ -75,7 +70,6 @@ export async function loadPlugins(modulePathList) {
 }
 /**
  * Load any built-in plugin.
- * @public
  */
 export function loadBuiltIn(builtIn) {
     return loadPlugin(builtInImportMap[builtIn], true);
@@ -83,7 +77,6 @@ export function loadBuiltIn(builtIn) {
 /**
  * @param modulePathList The plugin name list.
  * @returns The import result for the list of modules.
- * @public
  */
 export async function loadBuiltIns(builtInList = [...builtInNameList]) {
     const limit = pLimit(5);

package/out/browser/binds/plugins/git.d.ts

@@ -0,0 +1,3 @@
+import { type Plugins } from '../../index.js';
+declare const git: Plugins.PluginExport;
+export default git;

package/out/{src/browser → browser}/binds/plugins/git.js

@@ -6,7 +6,7 @@ const name = 'Git';
 const icon = { ...icons['nf-seti-git'], color: '#F44E28' };
 const testCommand = 'git ls-tree -r <git-branch-name> --name-only';
 /**
- * @private
+ * @internal
  */
 export const matcherExclude = [
     '**/.git/**',
@@ -17,7 +17,7 @@ export const matcherExclude = [
  * @param map The output.
  * @param scanner The scanner.
  * @param sourceFile This file will be converted to a {@link SourceInfo}.
- * @private
+ * @internal
  */
 export function useSourceFile(map, sourceFile, scanner) {
     const sourceInfo = SourceInfo.from(sourceFile, scanner);
@@ -31,7 +31,7 @@ export function useSourceFile(map, sourceFile, scanner) {
 }
 /**
  * @param base The name for gitignore-like file.
- * @private
+ * @internal
  */
 export const methodologyGitignoreLike = (base) => function (tree, o) {
     const sourceList = tree.deep(File).filter(dirent => dirent.base === base);

package/out/browser/binds/plugins/npm.d.ts

@@ -0,0 +1,3 @@
+import { type Plugins } from '../../index.js';
+declare const npm: Plugins.PluginExport;
+export default npm;

package/out/{src/browser → browser}/binds/plugins/npm.js

@@ -7,7 +7,7 @@ const name = 'NPM';
 const icon = { ...icons['nf-seti-npm'], color: '#CA0404' };
 const testCommand = 'npm pack --dry-run';
 /**
- * @private
+ * @internal
  */
 export const matcherExclude = [
     ...git.matcherExclude,
@@ -28,7 +28,7 @@ export const matcherExclude = [
     '**/npm-debug.log',
 ];
 /**
- * @private
+ * @internal
  */
 export const matcherInclude = [
     'bin/**',
@@ -38,7 +38,7 @@ export const matcherInclude = [
     'LICENCE*',
 ];
 /**
- * @private
+ * @internal
  */
 export function isValidManifest(value) {
     if (value?.constructor !== Object) {
@@ -50,7 +50,7 @@ export function isValidManifest(value) {
         && (value_.files === undefined || (Array.isArray(value_.files) && value_.files.every(element => typeof element === 'string')));
 }
 /**
- * @private
+ * @internal
  */
 export function useChildren(tree, map, getMap) {
     for (const child of tree.children.values()) {
@@ -65,7 +65,7 @@ export function useChildren(tree, map, getMap) {
     return map;
 }
 /**
- * @private
+ * @internal
  */
 export const sourceSearch = (priority, scanner) => function (tree, o) {
     const map = new Map();
@@ -105,7 +105,7 @@ export const sourceSearch = (priority, scanner) => function (tree, o) {
 /**
  * @param priority The list of file names from highest to lowest priority.
  * @param scanner The pattern scanner.
- * @private
+ * @internal
  */
 export const methodologyManifestNpmLike = (priority, scanner) => function (tree, o) {
     const packageJson = tree.get('package.json');

package/out/browser/binds/plugins/vsce.d.ts

@@ -0,0 +1,3 @@
+import { type Plugins } from '../../index.js';
+declare const vsce: Plugins.PluginExport;
+export default vsce;

package/out/{src/browser → browser}/binds/plugins/vsce.js

@@ -6,13 +6,13 @@ const name = 'VSCE';
 const icon = { ...icons['nf-md-microsoft_visual_studio_code'], color: '#23A9F1' };
 const testCommand = 'vsce ls';
 /**
- * @private
+ * @internal
  */
 export const matcherExclude = [
     ...git.matcherExclude,
 ];
 /**
- * @private
+ * @internal
  */
 export function isValidManifest(value) {
     if (value?.constructor !== Object) {
@@ -29,7 +29,7 @@ export function isValidManifest(value) {
     return 'vscode' in engines && typeof engines.vscode === 'string';
 }
 /**
- * @private
+ * @internal
  */
 export const methodologyManifestVsce = function (tree, o) {
     const packageJson = [...tree.deepIterator()].find(dirent => dirent instanceof File && dirent.base === 'package.json');

package/out/browser/binds/plugins/yarn.d.ts

@@ -0,0 +1,3 @@
+import { type Plugins } from '../../index.js';
+declare const yarn: Plugins.PluginExport;
+export default yarn;

package/out/{src/browser → browser}/binds/plugins/yarn.js

@@ -5,7 +5,7 @@ const id = 'yarn';
 const name = 'Yarn';
 const icon = { ...icons['nf-seti-yarn'], color: '#2E2A65' };
 /**
- * @private
+ * @internal
  */
 export const matcherExclude = [
     ...npm.matcherExclude,
@@ -13,7 +13,7 @@ export const matcherExclude = [
     '.yarnrc',
 ];
 /**
- * @private
+ * @internal
  */
 export const matcherInclude = [
     ...npm.matcherInclude,

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

@@ -1,16 +1,10 @@
 import { type Scanner } from '../lib.js';
-/**
- * @public
- */
 export type PatternScannerOptions = {
     pattern?: string | string[];
     exclude?: string | string[];
     include?: string | string[];
     negated?: boolean;
 };
-/**
- * @public
- */
 export type PatternScanner = Scanner & {
     pattern: string | string[];
     exclude: string | string[];
@@ -21,9 +15,6 @@ export type PatternScanner = Scanner & {
     ignores(path: string, options?: PatternScannerOptions): boolean;
     ignores(path: string, argument?: PatternScannerOptions | string | string[]): boolean;
 };
-/**
- * @public
- */
 export declare class ScannerMinimatch implements PatternScanner {
     negated: boolean;
     protected _pattern: string | string[];
@@ -40,9 +31,6 @@ export declare class ScannerMinimatch implements PatternScanner {
     ignores(path: string, pattern: string | string[]): boolean;
     ignores(path: string, options?: PatternScannerOptions): boolean;
 }
-/**
- * @public
- */
 export declare class ScannerGitignore extends ScannerMinimatch {
     private static gitignoreToMinimatch;
     constructor(options?: PatternScannerOptions);

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

@@ -1,8 +1,5 @@
 import { minimatch } from 'minimatch';
 import { gitignoreToMinimatch } from '@humanwhocodes/gitignore-to-minimatch';
-/**
- * @public
- */
 export class ScannerMinimatch {
     negated;
     _pattern;
@@ -69,9 +66,6 @@ export class ScannerMinimatch {
         return (argument?.negated ?? this.negated) ? !check : check;
     }
 }
-/**
- * @public
- */
 export class ScannerGitignore extends ScannerMinimatch {
     static gitignoreToMinimatch(argument) {
         if (typeof argument === 'string') {

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

@@ -1,7 +1,6 @@
 import { type ScanOptions } from '../lib.js';
 /**
  * The target icon/logo as a {@link https://www.nerdfonts.com/ NF} icon.
- * @public
  */
 export type TargetIcon = {
     /**
@@ -13,25 +12,19 @@ export type TargetIcon = {
      */
     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,7 +28,6 @@ export function targetSet(bind) {
 }
 /**
  * Get all target ids.
- * @public
  * @example
  * ["git", "npm", "vsce", ...]
  */
@@ -42,7 +38,6 @@ export function targetList() {
 /**
  * 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];
 };
-/**
- * @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);
@@ -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.
      */