view-ignored 0.2.2 → 0.3.0

package/README.md

@@ -1,7 +1,9 @@
 # view-ignored
 
-[![npm version](https://badge.fury.io/js/view-ignored.svg)](https://www.npmjs.com/package/view-ignored)
-[![Downloads](https://img.shields.io/npm/dm/view-ignored.svg)](https://www.npmjs.com/package/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.
 
@@ -34,10 +36,11 @@ viewig scan . --target=npm
 viewig scan . --parsable
 
 # scan: plugins (space, comma or pipe separated)
-viewig scan . --plugins="vign-p-tsx, vign-p-jsdoc"
-viewig scan . --plugins="vign-p-tsx vign-p-jsdoc"
-viewig scan . --plugins vign-p-tsx vign-p-jsdoc
-viewig scan . --plugins vign-p-tsx, vign-p-jsdoc
+# 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
@@ -50,24 +53,27 @@ viewig config set style=tree
 # config: always use nerdfonts
 viewig config set decor=nerdfonts
 # config: always use plugins
-viewig config set plugins=typescript-viewig,eslint-vign-plugin
+viewig config set plugins=example1,example2
 ```
 
 ### Programmatically
 
+All you need it to add
+
 ```js
-import * as vign from "view-ignored";
-import * as vign from "view-ignored/out/src/browser"; // for web environment apps
+import * as vign from "view-ignored"; // or "view-ignored/browser"
 
-const fileInfoList = await vign.scanProject("git");
-const fileInfo = await vign.scanFile("./path/to/file", "git");
+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
 
-// options available
-const fileInfoList = await vign.scanProject("git", { cwd, ... });
+// 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.filePath, "gray");
+    superCodeEditor.explorer.colorFile(fileInfo.relativePath, "gray");
 }
 ```
 
@@ -75,24 +81,14 @@ if (fileInfo.ignored) {
 
 ```js
 const sorter = vign.Sorting.firstFolders;
-const fileInfoList = await vign.scanProject("npm");
-const fileInfoSorted = fileInfoList.map(String).sort(sorter);
-```
-
-```js
-const sorter = vign.Sorting.modified;
-const fileInfoList = await vign.scanProject("npm");
-
-const cache = new Map<string, number>(fileInfoList.map(String).map(
-    filePath => [filePath, fs.statSync(filePath).mtime.getTime()])
-);
-const lookedSorted = fileInfoList.sort((a, b) => sorter(a.toString(), b.toString(), cache));
+const fileInfoList = await vign.scan(".", {target: "npm"});
+const fileInfoSorted = fileInfoList.sort((a, b) => sorter(String(a), String(b)));
 ```
 
 ### Targets
 
 - `git`
-- `npm` (can be usable for PNPM and Bun)
+- `npm` (use it for PNPM and Bun)
 - `yarn`
 - `vsce`
 - `jsr` *planned*

package/bin/viewig

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

package/out/src/browser/binds/index.d.ts

@@ -1,45 +1,64 @@
-import { TargetBind } from "./targets.js";
-export * from "./targets.js";
+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 interface PluginLoaded {
-    moduleName: string;
+export type PluginLoaded = {
+    resource: string;
     isLoaded: boolean;
     exports: unknown;
-}
+};
 /**
- * If a plugin wants to change something, it must export it as default.
+ * If a plugin wants to change something, it must export default.
+ * @private
  */
-export interface PluginExport {
+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;
 /**
- * No rejects.
- * @param moduleName Plugin name.
- * @returns Import result for the module.
+ * @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 loadPlugin(moduleName: string): Promise<PluginLoaded>;
+export declare function loadPlugins(modulePathList: string[]): Promise<PluginLoaded[]>;
 /**
- * Loads plugins one by one using {@link loadPlugin}.
- * @param moduleNameList The list of plugins.
+ * Load any built-in plugin.
+ * @public
  */
-export declare function loadPluginsQueue(moduleNameList?: string[]): Promise<PluginLoaded[]>;
-export declare const BuiltInGit: Promise<typeof import("./plugins/git.js")>;
-export declare const BuiltInVsce: Promise<typeof import("./plugins/vsce.js")>;
-export declare const BuiltInNpm: Promise<typeof import("./plugins/npm.js")>;
-export declare const BuiltInYarn: Promise<typeof import("./plugins/yarn.js")>;
+export declare function loadBuiltIn(builtIn: BuiltInName): Promise<PluginLoaded>;
 /**
- * Built-in plugins loading queue.
+ * @param modulePathList The plugin name list.
+ * @returns The import result for the list of modules.
+ * @public
  */
-export declare const BuiltIns: Promise<[PromiseSettledResult<typeof import("./plugins/git.js")>, PromiseSettledResult<typeof import("./plugins/vsce.js")>, PromiseSettledResult<typeof import("./plugins/npm.js")>, PromiseSettledResult<typeof import("./plugins/yarn.js")>]>;
+export declare function loadBuiltIns(builtInList?: BuiltInName[]): Promise<PluginLoaded[]>;

package/out/src/browser/binds/index.js

@@ -1,8 +1,25 @@
-import { isTargetBind, targetSet } from "./targets.js";
-import { loadPlugin as load } from "load-plugin";
-export * from "./targets.js";
+import { loadPlugin as load } from 'load-plugin';
+import pLimit from 'p-limit';
+import { isTargetBind, targetSet } from './targets.js';
+export * from './scanner.js';
+export * from './targets.js';
+/**
+ * @private
+ */
+const builtInImportMap = {
+    git: './plugins/git.js',
+    npm: './plugins/npm.js',
+    vsce: './plugins/vsce.js',
+    yarn: './plugins/yarn.js',
+};
+/**
+ * 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) {
@@ -10,10 +27,11 @@ export function isPluginExport(value) {
     }
     const vign = value.viewignored;
     return (vign?.constructor === Object)
-        && 'addTargets' in vign && Array.isArray(vign.addTargets) && vign.addTargets.every(isTargetBind);
+        && 'addTargets' in vign && Array.isArray(vign.addTargets) && vign.addTargets.every(v => isTargetBind(v));
 }
 /**
  * Imports the plugin's exported data.
+ * @public
  */
 export function importPlugin(exportData) {
     const { addTargets } = exportData.viewignored;
@@ -22,57 +40,53 @@ export function importPlugin(exportData) {
     }
 }
 /**
- * No rejects.
- * @param moduleName Plugin name.
- * @returns Import result for the module.
+ * @param modulePath The plugin name.
+ * @returns The import result for the module.
+ * @public
  */
-export function loadPlugin(moduleName) {
+export async function loadPlugin(modulePath, useImport = false) {
     try {
-        return new Promise((resolve) => {
-            load(moduleName)
-                .catch((reason) => {
-                const r = reason;
-                if (r?.code === 'ERR_MODULE_NOT_FOUND') {
-                    reason = r.message;
-                }
-                const fail = { moduleName, isLoaded: false, exports: reason };
-                resolve(fail);
-            })
-                .then((exports) => {
-                const result = { moduleName, isLoaded: true, exports };
-                if (isPluginExport(exports)) {
-                    importPlugin(exports);
-                }
-                resolve(result);
-            });
-        });
+        const exports = useImport ? Object.getOwnPropertyDescriptor(await import(modulePath), 'default')?.value : await load(modulePath);
+        const result = { resource: modulePath, isLoaded: true, exports };
+        if (isPluginExport(exports)) {
+            importPlugin(exports);
+        }
+        return result;
     }
-    catch (reason) {
-        const fail = { moduleName, isLoaded: false, exports: reason };
-        return Promise.resolve(fail);
+    catch (error) {
+        const r = error;
+        let reason = r;
+        if (r?.code === 'ERR_MODULE_NOT_FOUND') {
+            reason = r.message;
+        }
+        const fail = { resource: modulePath, isLoaded: false, exports: reason };
+        return fail;
     }
 }
 /**
- * Loads plugins one by one using {@link loadPlugin}.
- * @param moduleNameList The list of plugins.
+ * @param modulePathList The plugin name list.
+ * @returns The import result for the list of modules.
+ * @public
  */
-export async function loadPluginsQueue(moduleNameList) {
-    const resultList = [];
-    for (const module of moduleNameList ?? []) {
-        const result = await loadPlugin(module);
-        resultList.push(result);
-    }
-    return resultList;
+export async function loadPlugins(modulePathList) {
+    const limit = pLimit(5);
+    const allLoaded = await Promise.all(modulePathList.map(modulePath => limit(() => loadPlugin(modulePath))));
+    return allLoaded;
 }
-export const BuiltInGit = import("./plugins/git.js");
-BuiltInGit.then(e => e.default).then(importPlugin);
-export const BuiltInVsce = import("./plugins/vsce.js");
-BuiltInVsce.then(e => e.default).then(importPlugin);
-export const BuiltInNpm = import("./plugins/npm.js");
-BuiltInNpm.then(e => e.default).then(importPlugin);
-export const BuiltInYarn = import("./plugins/yarn.js");
-BuiltInYarn.then(e => e.default).then(importPlugin);
 /**
- * Built-in plugins loading queue.
+ * Load any built-in plugin.
+ * @public
  */
-export const BuiltIns = Promise.allSettled([BuiltInGit, BuiltInVsce, BuiltInNpm, BuiltInYarn]);
+export function loadBuiltIn(builtIn) {
+    return loadPlugin(builtInImportMap[builtIn], true);
+}
+/**
+ * @param modulePathList The plugin name list.
+ * @returns The import result for the list of modules.
+ * @public
+ */
+export async function loadBuiltIns(builtInList = Array.from(builtInNameList)) {
+    const limit = pLimit(5);
+    const allLoaded = await Promise.all(builtInList.map(modulePath => limit(() => loadBuiltIn(modulePath))));
+    return allLoaded;
+}

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

@@ -1,3 +1,22 @@
-import { Plugins } from "../../index.js";
-declare const _default: Plugins.PluginExport;
-export default _default;
+import { type Plugins, type Methodology, File, SourceInfo, type Scanner } from '../../index.js';
+/**
+ * @private
+ */
+export declare const matcherExclude: string[];
+/**
+ * For the source file parent directory we are getting all the cache recursively for all files.
+ * @param map The output.
+ * @param scanner The scanner.
+ * @param sourceFile This file will be converted to a {@link SourceInfo}.
+ * @private
+ */
+export declare function useSourceFile(map: Map<File, SourceInfo>, sourceFile: File, scanner: Scanner & {
+    pattern: string | string[];
+}): Map<File, SourceInfo>;
+/**
+ * @param base The name for gitignore-like file.
+ * @private
+ */
+export declare const methodologyGitignoreLike: (base: string) => Methodology;
+declare const git: Plugins.PluginExport;
+export default git;

package/out/src/browser/binds/plugins/git.js

@@ -1,24 +1,60 @@
-const id = "git";
-const name = {
-    ifNormal: "Git",
-    ifNerd: "\ue65d Git"
-};
-const testCommand = `git ls-tree -r <git-branch-name> --name-only`;
-const matcherExclude = [
-    ".git/**",
-    ".DS_Store/**"
+import { icons } from '@m234/nerd-fonts';
+import { File, NoSourceError, SourceInfo, InvalidPatternError, Directory, } from '../../index.js';
+import { ScannerGitignore } from '../scanner.js';
+const id = 'git';
+const name = 'Git';
+const icon = { ...icons['nf-seti-git'], color: 0xF4_4E_28 };
+const testCommand = 'git ls-tree -r <git-branch-name> --name-only';
+/**
+ * @private
+ */
+export const matcherExclude = [
+    '**/.git/**',
+    '**/.DS_Store/**',
 ];
-const scan = function (fileInfo) {
-    const { scanner, content } = fileInfo;
-    const pat = content?.toString();
-    if (!scanner.patternIsValid(pat)) {
-        return false;
+/**
+ * For the source file parent directory we are getting all the cache recursively for all files.
+ * @param map The output.
+ * @param scanner The scanner.
+ * @param sourceFile This file will be converted to a {@link SourceInfo}.
+ * @private
+ */
+export function useSourceFile(map, sourceFile, scanner) {
+    const sourceInfo = SourceInfo.from(sourceFile, scanner);
+    for (const file of sourceFile.parent.deepIterator()) {
+        if (file instanceof Directory) {
+            continue;
+        }
+        map.set(file, sourceInfo);
+    }
+    return map;
+}
+/**
+ * @param base The name for gitignore-like file.
+ * @private
+ */
+export const methodologyGitignoreLike = (base) => function (tree, o) {
+    const sourceList = tree.deep(File).filter(dirent => dirent.base === base);
+    const map = new Map();
+    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)) {
+            throw new InvalidPatternError(sourceFile, pattern);
+        }
+        scanner.pattern = pattern;
+        useSourceFile(map, sourceFile, scanner);
     }
-    scanner.add(pat);
-    return true;
+    return map;
 };
-const methodology = [
-    { pattern: "**/.gitignore", matcher: "gitignore", scan, matcherExclude },
-];
-const bind = { id, name, methodology, testCommand };
-export default { viewignored: { addTargets: [bind] } };
+const bind = {
+    id, icon, name, testCommand, scanOptions: {
+        target: methodologyGitignoreLike('.gitignore'),
+    },
+};
+const git = { viewignored: { addTargets: [bind] } };
+export default git;

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

@@ -1,11 +1,38 @@
-import { Plugins, ScanMethod, Methodology } from "../../index.js";
-export declare const id = "npm";
-export declare const name = "NPM";
-export declare const testCommand = "npm pack --dry-run";
+import { type Plugins, type Methodology, type File, Directory, type SourceInfo } from '../../index.js';
+import { type PatternScanner } from '../scanner.js';
+/**
+ * @private
+ */
 export declare const matcherExclude: string[];
+/**
+ * @private
+ */
 export declare const matcherInclude: string[];
-export declare const scanGit: ScanMethod;
-export declare const scanPackageJsonFiles: ScanMethod;
-export declare const methodology: Methodology[];
-declare const _default: Plugins.PluginExport;
-export default _default;
+/**
+ * @private
+ */
+export type ValidManifestNpm = {
+    name: string;
+    version: string;
+    files?: string[];
+};
+/**
+ * @private
+ */
+export declare function isValidManifest(value: unknown): value is ValidManifestNpm;
+/**
+ * @private
+ */
+export declare function useChildren(tree: Directory, map: Map<File, SourceInfo>, getMap: (child: Directory) => Map<File, SourceInfo>): Map<File, SourceInfo>;
+/**
+ * @private
+ */
+export declare const sourceSearch: (priority: string[], scanner: PatternScanner) => Methodology;
+/**
+ * @param priority The list of file names from highest to lowest priority.
+ * @param scanner The pattern scanner.
+ * @private
+ */
+export declare const methodologyManifestNpmLike: (priority: string[], scanner: PatternScanner) => Methodology;
+declare const npm: Plugins.PluginExport;
+export default npm;