view-ignored 0.3.2 → 0.4.1

package/LICENSE.txt

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2024 Mopsgamer
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2024 Mopsgamer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,95 +1,95 @@
-# view-ignored
-
-[![npm version](https://img.shields.io/npm/v/view-ignored.svg?style=flat)](https://www.npmjs.com/package/view-ignored)
-[![npm downloads](https://img.shields.io/npm/dm/view-ignored.svg?style=flat)](https://www.npmjs.com/package/view-ignored)
-[![github](https://img.shields.io/github/stars/Mopsgamer/view-ignored.svg?style=flat)](https://github.com/Mopsgamer/view-ignored)
-[![github issues](https://img.shields.io/github/issues/Mopsgamer/view-ignored.svg?style=flat)](https://github.com/Mopsgamer/view-ignored/issues)
-
-Retrieve list of files ignored/included by Git, NPM, Yarn and VSC Extension.
-
-## Highlights
-
-- **Multi-target.** Get list of included files, using configuration files reader, not command-line wrapper.
-- **Use in browser.** view-ignored supports file system adapter.
-- **Command-line.** Supports no-color and multiple output styles, including [nerd fonts](https://github.com/ryanoasis/nerd-fonts).
-- **Plugins.** view-ignored allows you to add new [targets](#targets) programmatically. Command-line interface supports plugins throught `--plugin` option.
-
-## Install
-
-```bash
-npm i view-ignored
-```
-
-## Usage
-
-### Command-line
-
-```bash
-# get started
-npm i -g view-ignored
-viewig --help
-view-ignored --help
-
-# scan: git (default) and npm
-viewig scan .
-viewig scan . --target=npm
-viewig scan . --parsable
-
-# scan: plugins (space, comma or pipe separated)
-# all built-in plugins loaded automatically
-viewig scan . --plugins="example1, example2"
-viewig scan . --plugins="example1 example2"
-viewig scan . --plugins example1 example2
-viewig scan . --plugins example1, example2
-
-# config: print configuration entries
-viewig config get
-viewig config get --real
-# config: set npm as default target and scan for npm
-viewig config set target=npm
-viewig scan .
-# config: always use nerdfonts
-viewig config set style=tree
-# config: always use nerdfonts
-viewig config set decor=nerdfonts
-# config: always use plugins
-viewig config set plugins=example1,example2
-```
-
-### Programmatically
-
-All you need it to add
-
-```js
-import * as vign from "view-ignored"; // or "view-ignored/browser"
-
-await vign.Plugins.loadBuiltIns(["git", "npm"]); // load built-in plugins
-await vign.Plugins.loadBuiltIns(); // load all built-in plugins
-await vign.Plugins.loadPlugins(["example"]); // load third-party plugins
-
-// scan - options available
-const fileInfoList = await vign.scan(".", { target: "git", cwd: process.cwd() });
-const fileInfoList = await vign.scan(["./path/to/file"], { target: "git", process.cwd() });
-
-// use results
-if (fileInfo.ignored) {
-    superCodeEditor.explorer.colorFile(fileInfo.relativePath, "gray");
-}
-```
-
-#### Sorting
-
-```js
-const sorter = vign.Sorting.firstFolders;
-const fileInfoList = await vign.scan(".", {target: "npm"});
-const fileInfoSorted = fileInfoList.sort((a, b) => sorter(String(a), String(b)));
-```
-
-### Targets
-
-- `git`
-- `npm` (use it for PNPM and Bun)
-- `yarn`
-- `vsce`
-- `jsr` *planned*
-- `deno` *planned*
+# view-ignored
+
+[![npm version](https://img.shields.io/npm/v/view-ignored.svg?style=flat)](https://www.npmjs.com/package/view-ignored)
+[![npm downloads](https://img.shields.io/npm/dm/view-ignored.svg?style=flat)](https://www.npmjs.com/package/view-ignored)
+[![github](https://img.shields.io/github/stars/Mopsgamer/view-ignored.svg?style=flat)](https://github.com/Mopsgamer/view-ignored)
+[![github issues](https://img.shields.io/github/issues/Mopsgamer/view-ignored.svg?style=flat)](https://github.com/Mopsgamer/view-ignored/issues)
+
+Retrieve list of files ignored/included by Git, NPM, Yarn and VSC Extension.
+
+## Highlights
+
+- **Multi-target.** Get list of included files, using configuration files reader, not command-line wrapper.
+- **Use in browser.** view-ignored supports file system adapter.
+- **Command-line.** Supports no-color and multiple output styles, including [nerd fonts](https://github.com/ryanoasis/nerd-fonts).
+- **Plugins.** view-ignored allows you to add new [targets](#targets) programmatically. Command-line interface supports plugins throught `--plugin` option.
+
+## Install
+
+```bash
+npm i view-ignored
+```
+
+## Usage
+
+### Command-line
+
+```bash
+# get started
+npm i -g view-ignored
+viewig --help
+view-ignored --help
+
+# scan: git (default) and npm
+viewig scan .
+viewig scan . --target=npm
+viewig scan . --parsable
+
+# scan: plugins (space, comma or pipe separated)
+# all built-in plugins loaded automatically
+viewig scan . --plugins="example1, example2"
+viewig scan . --plugins="example1 example2"
+viewig scan . --plugins example1 example2
+viewig scan . --plugins example1, example2
+
+# config: print configuration entries
+viewig config get
+viewig config get --real
+# config: set npm as default target and scan for npm
+viewig config set target=npm
+viewig scan .
+# config: always use nerdfonts
+viewig config set style=tree
+# config: always use nerdfonts
+viewig config set decor=nerdfonts
+# config: always use plugins
+viewig config set plugins=example1,example2
+```
+
+### Programmatically
+
+All you need it to add
+
+```js
+import * as vign from "view-ignored"; // or "view-ignored/browser"
+
+await vign.Plugins.loadBuiltIns(["git", "npm"]); // load built-in plugins
+await vign.Plugins.loadBuiltIns(); // load all built-in plugins
+await vign.Plugins.loadPlugins(["example"]); // load third-party plugins
+
+// scan - options available
+const fileInfoList = await vign.scan(".", { target: "git", cwd: process.cwd() });
+const fileInfoList = await vign.scan(["./path/to/file"], { target: "git", cwd: process.cwd() });
+
+// use results
+if (fileInfo.ignored) {
+    superCodeEditor.explorer.colorFile(fileInfo.relativePath, "gray");
+}
+```
+
+#### Sorting
+
+```js
+const sorter = vign.Sorting.firstFolders;
+const fileInfoList = await vign.scan(".", {target: "npm"});
+const fileInfoSorted = fileInfoList.sort((a, b) => sorter(String(a), String(b)));
+```
+
+### Targets
+
+- `git`
+- `npm` (use it for PNPM and Bun)
+- `yarn`
+- `vsce`
+- `jsr` *planned*
+- `deno` *planned*

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,9 +77,8 @@ 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 = Array.from(builtInNameList)) {
+export async function loadBuiltIns(builtInList = [...builtInNameList]) {
     const limit = pLimit(5);
     const allLoaded = await Promise.all(builtInList.map(modulePath => limit(() => loadBuiltIn(modulePath))));
     return allLoaded;

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

@@ -3,10 +3,10 @@ import { File, NoSourceError, SourceInfo, InvalidPatternError, Directory, } from
 import { ScannerGitignore } from '../scanner.js';
 const id = 'git';
 const name = 'Git';
-const icon = { ...icons['nf-seti-git'], color: 0xF4_4E_28 };
+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,16 +31,16 @@ 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);
     const map = new Map();
+    if (sourceList.length === 0) {
+        throw new NoSourceError(base);
+    }
     for (const sourceFile of sourceList) {
         const scanner = new ScannerGitignore({ exclude: matcherExclude });
-        if (sourceFile === undefined) {
-            throw new NoSourceError(base);
-        }
         const content = o.modules.fs.readFileSync(sourceFile.absolutePath).toString();
         const pattern = content;
         if (!scanner.isValid(pattern)) {

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

@@ -4,10 +4,10 @@ import { ScannerGitignore } from '../scanner.js';
 import * as git from './git.js';
 const id = 'npm';
 const name = 'NPM';
-const icon = { ...icons['nf-seti-npm'], color: 0xCA_04_04 };
+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,10 +50,10 @@ 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 Array.from(tree.children.values())) {
+    for (const child of tree.children.values()) {
         if (!(child instanceof Directory)) {
             continue;
         }
@@ -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

@@ -3,16 +3,16 @@ import { NoSourceError, File, BadSourceError, } from '../../index.js';
 import * as git from './git.js';
 const id = 'vsce';
 const name = 'VSCE';
-const icon = { ...icons['nf-md-microsoft_visual_studio_code'], color: 0x23_A9_F1 };
+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,10 +29,10 @@ export function isValidManifest(value) {
     return 'vscode' in engines && typeof engines.vscode === 'string';
 }
 /**
- * @private
+ * @internal
  */
 export const methodologyManifestVsce = function (tree, o) {
-    const packageJson = Array.from(tree.deepIterator()).find(dirent => dirent instanceof File && dirent.base === 'package.json');
+    const packageJson = [...tree.deepIterator()].find(dirent => dirent instanceof File && dirent.base === 'package.json');
     if (packageJson === undefined) {
         throw new NoSourceError('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

@@ -3,10 +3,9 @@ import { ScannerGitignore } from '../scanner.js';
 import * as npm from './npm.js';
 const id = 'yarn';
 const name = 'Yarn';
-const icon = { ...icons['nf-seti-yarn'], color: 0x2E_2A_65 };
-// FIXME: Yarn can all this stuff another way.
+const icon = { ...icons['nf-seti-yarn'], color: '#2E2A65' };
 /**
- * @private
+ * @internal
  */
 export const matcherExclude = [
     ...npm.matcherExclude,
@@ -14,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,13 +1,10 @@
 import { minimatch } from 'minimatch';
 import { gitignoreToMinimatch } from '@humanwhocodes/gitignore-to-minimatch';
-/**
- * @public
- */
 export class ScannerMinimatch {
     negated;
     _pattern;
     get pattern() {
-        return this.pattern;
+        return this._pattern;
     }
     set pattern(value) {
         this._pattern = value;
@@ -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') {