view-ignored 0.0.2 → 0.1.1

package/README.md

@@ -10,7 +10,7 @@ Retrieve list of files ignored/included by Git, NPM, Yarn and VSC Extension.
 - **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.** API allows to add new [targets](#targets) programmatically. Command line interface does NOT support plugins.
+- **Plugins.** view-ignored allows you to add new [targets](#targets) programmatically. Command line interface does NOT support plugins.
 
 ## Install
 
@@ -28,15 +28,18 @@ npm i -g view-ignored
 viewig --help
 view-ignored --help
 
-# scan for git and npm
+# scan: git (default) and npm
 viewig scan .
 viewig scan . --target=npm
 
-# always scan npm by default
+# config: print all
+viewig config get
+# config: print with defaults
+viewig config get --safe
+# config: set npm as default target and scan for npm
 viewig config set target=npm
 viewig scan .
-
-# always use nerd font
+# config: always use nerd font
 viewig config set style=treeNerd
 ```
 
@@ -46,19 +49,46 @@ viewig config set style=treeNerd
 import * as vign from "view-ignored";
 import * as vign from "view-ignored/lib/browser"; // for web environment apps
 
-const looked = vign.scanProject("git");
+const fileInfoList = vign.scanProject("git");
+const fileInfoList = vign.scanPaths(pathList, "git");
+const fileInfo = vign.scanFile(pathToFile, "git");
+
+// options available
+const fileInfoList = vign.scanProject("git", { cwd, ... });
+
+// custom
+/**@type {vign.ScanMethod}*/
+export const method = function (data) {
+  const { looker, sourceFile: source } = data
+  if (!looker.isValidPattern(source.content)) {
+      return false
+  }
+  looker.add(source.content)
+  return true
+}
+
+/**@type {vign.Source[]}*/
+export const sources = [
+  { sources: new SourcePattern("**/.gitignore"), patternType: ".*ignore", method, addPatterns: addPatternsExclude },
+]
+vign.scanProject(sources)
+
+// use results
+if (fileInfo.ignored) {
+  vscode.explorer.colorFile(fileInfo.filePath, "gray")
+}
 ```
 
 #### Sorting:
 
 ```js
-const looked = vign.scanProject("npm");
+const fileInfoList = vign.scanProject("npm");
 const sorter = vign.Sorting.Sorters.firstFolders;
-looked.map(String).sort(sorter);
+fileInfoList.map(String).sort(sorter);
 ```
 
 ```js
-const looked = vign.scanProject("npm")
+const fileInfoList = vign.scanProject("npm")
 const sorter = Sorting.Sorters[flags.sort]
 const cacheEditDates = new Map<FileInfo, Date>()
 for (const look of looked) {
@@ -73,13 +103,14 @@ const lookedSorted = looked.sort((a, b) => sorter(
 ### Targets
 
 - `git`
-  - Check: `git ls-tree -r <git-branch-name> --name-only`
+  - Test command: `git ls-tree -r <git-branch-name> --name-only`
   - Sources walkthrough: '.gitignore' and git config `core.excludesFile`.
-- `npm` (btw usable for PNPM and Bun)
-  - Check: `npm pack --dry-run`
-  - Sources walkthrough: 'package.json' otherwise '.npmignore' otherwise '.gitignore'.
+  - `core.excludesFile` does not work at this moment.
+- `npm` (can be usable for PNPM and Bun)
+  - Test command: `npm pack --dry-run`
+  - Sources walkthrough: 'package.json'>"files" otherwise '.npmignore' otherwise '.gitignore'.
 - `yarn`
-  - Sources walkthrough: 'package.json' otherwise '.yarnignore' otherwise '.npmignore' otherwise '.gitignore'.
+  - Sources walkthrough: 'package.json'>"files" otherwise '.yarnignore' otherwise '.npmignore' otherwise '.gitignore'.
 - `vsce`
-  - Check: `vsce ls`
-  - Sources walkthrough: '.vscodeignore' otherwise '.gitignore'.
+  - Test command: `vsce ls`
+  - Sources walkthrough: '.vscodeignore'.

package/lib/browser/binds/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./targets.js";
+//# sourceMappingURL=index.d.ts.map

package/lib/browser/binds/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/browser/binds/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA"}

package/lib/browser/binds/index.js

@@ -0,0 +1,2 @@
+export * from "./targets.js";
+//# sourceMappingURL=index.js.map

package/lib/browser/binds/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/browser/binds/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA"}

package/lib/browser/binds/targets.d.ts

@@ -0,0 +1,52 @@
+import { LookFolderOptions, Source } from "../lib.js";
+export interface TargetBind {
+    /**
+     * The target simple name.
+     * @see {@link isValidId}
+     */
+    id: string;
+    /**
+     * The target readable name.
+     */
+    name: string;
+    /**
+     * The walkthrough. Files including patterns.
+     */
+    sources: Source[];
+    /**
+     * Folder deep scanning options for the target.
+     */
+    scanOptions?: LookFolderOptions;
+    /**
+     * Test command.
+     * @example
+     * "npm pack --dry run"
+     * "vsce ls"
+     */
+    testCommad?: string;
+}
+/**
+ * @param id The target simple name.
+ * @returns `true` if the target id is valid.
+ */
+export declare function isValidId(id: unknown): boolean;
+/**
+ * Allows to create targets for view-ignored scan* functions.
+ * @example
+ * scanProject("abc") // error
+ * Bindings.targetSet("abc", {...})
+ * scanProject("abc") // ok
+ */
+export declare function targetSet(bind: TargetBind): void;
+/**
+ * Get all target ids.
+ * @example
+ * ["git", "npm", "vsce", ...]
+ */
+export declare function targetList(): string[];
+/**
+ * Get target bind by target id.
+ * @param id Target id.
+ */
+export declare function targetGet(id: string): TargetBind | undefined;
+//# sourceMappingURL=targets.d.ts.map

package/lib/browser/binds/targets.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"targets.d.ts","sourceRoot":"","sources":["../../../src/browser/binds/targets.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAErD,MAAM,WAAW,UAAU;IACvB;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,OAAO,EAAE,MAAM,EAAE,CAAA;IAEjB;;OAEG;IACH,WAAW,CAAC,EAAE,iBAAiB,CAAA;IAE/B;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;CACtB;AAED;;;GAGG;AACH,wBAAgB,SAAS,CAAC,EAAE,EAAE,OAAO,GAAG,OAAO,CAE9C;AAOD;;;;;;GAMG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,UAAU,GAAG,IAAI,CAKhD;AAED;;;;GAIG;AACH,wBAAgB,UAAU,IAAI,MAAM,EAAE,CAErC;AAED;;;GAGG;AACH,wBAAgB,SAAS,CAAC,EAAE,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS,CAK5D"}

package/lib/browser/binds/targets.js

@@ -0,0 +1,43 @@
+/**
+ * @param id The target simple name.
+ * @returns `true` if the target id is valid.
+ */
+export function isValidId(id) {
+    return typeof id === "string" && id.match(/^[-a-zA-Z0-9]+$/) != null;
+}
+/**
+ * The container for binds: id=bind.
+ */
+const targetBindMap = new Map();
+/**
+ * Allows to create targets for view-ignored scan* functions.
+ * @example
+ * scanProject("abc") // error
+ * Bindings.targetSet("abc", {...})
+ * scanProject("abc") // ok
+ */
+export function targetSet(bind) {
+    if (!isValidId(bind.id)) {
+        throw TypeError(`view-ignored can not bind target with id '${bind.id}'`);
+    }
+    targetBindMap.set(bind.id, bind);
+}
+/**
+ * Get all target ids.
+ * @example
+ * ["git", "npm", "vsce", ...]
+ */
+export function targetList() {
+    return Array.from(targetBindMap.keys());
+}
+/**
+ * Get target bind by target id.
+ * @param id Target id.
+ */
+export function targetGet(id) {
+    if (!isValidId(id)) {
+        throw TypeError(`view-ignored can not get bind for target with id '${id}'`);
+    }
+    return targetBindMap.get(id);
+}
+//# sourceMappingURL=targets.js.map

package/lib/browser/binds/targets.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"targets.js","sourceRoot":"","sources":["../../../src/browser/binds/targets.ts"],"names":[],"mappings":"AAiCA;;;GAGG;AACH,MAAM,UAAU,SAAS,CAAC,EAAW;IACjC,OAAO,OAAO,EAAE,KAAK,QAAQ,IAAI,EAAE,CAAC,KAAK,CAAC,iBAAiB,CAAC,IAAI,IAAI,CAAA;AACxE,CAAC;AAED;;GAEG;AACH,MAAM,aAAa,GAAG,IAAI,GAAG,EAAsB,CAAA;AAEnD;;;;;;GAMG;AACH,MAAM,UAAU,SAAS,CAAC,IAAgB;IACtC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC;QACtB,MAAM,SAAS,CAAC,6CAA6C,IAAI,CAAC,EAAE,GAAG,CAAC,CAAA;IAC5E,CAAC;IACD,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAA;AACpC,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,UAAU;IACtB,OAAO,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC,CAAA;AAC3C,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,SAAS,CAAC,EAAU;IAChC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE,CAAC;QACjB,MAAM,SAAS,CAAC,qDAAqD,EAAE,GAAG,CAAC,CAAA;IAC/E,CAAC;IACD,OAAO,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;AAChC,CAAC"}

package/lib/browser/fileinfo.d.ts

@@ -1,35 +1,72 @@
 import { ChalkInstance } from "chalk";
 import { StyleName } from "./styling.js";
-import { SourceFile } from "./lib.js";
+import { FilterName, SourceFile } from "./lib.js";
 import { Looker } from "./looker.js";
 export interface FileInfoToStringOptions {
     /**
-     * Determines if file icon should be used.
-     * @default
-     * undefined
+     * The appearance behavior of the file icon.
+     * @default undefined
      */
     styleName?: StyleName;
     /**
-     * `true` if should add prefix: `+` or `!`.
+     * The appearance behavior of the prefix.
+     * `"+"` for included, `"!"` for excluded.
+     * @default false
      */
     usePrefix?: boolean;
+    /**
+     * The behavior of colors.
+     * @default undefined
+     */
     chalk?: ChalkInstance;
 }
 /**
- * Result of the file path scan.
+ * The result of the file path scan.
  */
 export declare class FileInfo {
+    /**
+     * Relative path to the file.
+    */
     readonly filePath: string;
+    /**
+     * Parser instance. Can be used to determine if the file is ignored.
+     * @see {@link ignored} can be used instead of it.
+     */
     readonly looker: Looker;
+    /**
+     * Source of patterns, used by {@link looker}.
+    */
     readonly source: SourceFile;
-    readonly ignored: boolean;
-    constructor(filePath: string, looker: Looker, source: SourceFile);
+    constructor(
+    /**
+     * Relative path to the file.
+    */
+    filePath: string, 
+    /**
+     * Parser instance. Can be used to determine if the file is ignored.
+     * @see {@link ignored} can be used instead of it.
+     */
+    looker: Looker, 
+    /**
+     * Source of patterns, used by {@link looker}.
+    */
+    source: SourceFile);
+    /**
+     * Determines if ignored file is ignored or not.
+     */
+    get ignored(): boolean;
     static from(paths: string[], looker: Looker, source?: SourceFile | string): FileInfo[];
     static from(path: string, looker: Looker, source?: SourceFile | string): FileInfo;
     /**
-     * @param options Styling options.
-     * @param formatEntire Determines if path base or entire file path should be formatted. Default `true`.
+     * @param options Styling options. Default `{}`.
+     * @param formatEntire Determines if the path's base or the entire path should be formatted. Default `true`.
+     * @returns Relative file path. Optionally formatted.
      */
     toString(options?: FileInfoToStringOptions, formatEntire?: boolean): string;
+    /**
+     * @param filter The group name.
+     * @returns `true` if the file is contained by the filter.
+     */
+    isIncludedBy(filter: FilterName): boolean;
 }
 //# sourceMappingURL=fileinfo.d.ts.map

package/lib/browser/fileinfo.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fileinfo.d.ts","sourceRoot":"","sources":["../../src/browser/fileinfo.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAA;AACrC,OAAO,EAAsB,SAAS,EAAE,MAAM,cAAc,CAAA;AAE5D,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AACrC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAEpC,MAAM,WAAW,uBAAuB;IACvC;;;;OAIG;IACH,SAAS,CAAC,EAAE,SAAS,CAAA;IACrB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,KAAK,CAAC,EAAE,aAAa,CAAA;CACrB;AACD;;GAEG;AACH,qBAAa,QAAQ;aAGH,QAAQ,EAAE,MAAM;aAChB,MAAM,EAAE,MAAM;aACd,MAAM,EAAE,UAAU;IAJnC,SAAgB,OAAO,EAAE,OAAO,CAAA;gBAEf,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,UAAU;IAInC,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,UAAU,GAAG,MAAM,GAAG,QAAQ,EAAE;IACtF,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,UAAU,GAAG,MAAM,GAAG,QAAQ;IAQjF;;;OAGG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,uBAAuB,EAAE,YAAY,UAAO,GAAG,MAAM;CAiBxE"}
+{"version":3,"file":"fileinfo.d.ts","sourceRoot":"","sources":["../../src/browser/fileinfo.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAA;AACrC,OAAO,EAAsB,SAAS,EAAE,MAAM,cAAc,CAAA;AAE5D,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AACjD,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAEpC,MAAM,WAAW,uBAAuB;IACvC;;;OAGG;IACH,SAAS,CAAC,EAAE,SAAS,CAAA;IAErB;;;;OAIG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;IAEnB;;;OAGG;IACH,KAAK,CAAC,EAAE,aAAa,CAAA;CACrB;AAED;;GAEG;AACH,qBAAa,QAAQ;IAEnB;;MAEE;aACc,QAAQ,EAAE,MAAM;IAEhC;;;OAGG;aACa,MAAM,EAAE,MAAM;IAE9B;;MAEE;aACc,MAAM,EAAE,UAAU;;IAdlC;;MAEE;IACc,QAAQ,EAAE,MAAM;IAEhC;;;OAGG;IACa,MAAM,EAAE,MAAM;IAE9B;;MAEE;IACc,MAAM,EAAE,UAAU;IAGnC;;OAEG;IACH,IAAI,OAAO,IAAI,OAAO,CAErB;IAED,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,UAAU,GAAG,MAAM,GAAG,QAAQ,EAAE;IACtF,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,UAAU,GAAG,MAAM,GAAG,QAAQ;IASjF;;;;OAIG;IACH,QAAQ,CAAC,OAAO,GAAE,uBAA4B,EAAE,YAAY,UAAO,GAAG,MAAM;IAkB5E;;;OAGG;IACH,YAAY,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO;CAOzC"}

package/lib/browser/fileinfo.js

@@ -1,14 +1,32 @@
 import { styleConditionFile } from "./styling.js";
 import path from "path";
 /**
- * Result of the file path scan.
+ * The result of the file path scan.
  */
 export class FileInfo {
-    constructor(filePath, looker, source) {
+    constructor(
+    /**
+     * Relative path to the file.
+    */
+    filePath, 
+    /**
+     * Parser instance. Can be used to determine if the file is ignored.
+     * @see {@link ignored} can be used instead of it.
+     */
+    looker, 
+    /**
+     * Source of patterns, used by {@link looker}.
+    */
+    source) {
         this.filePath = filePath;
         this.looker = looker;
         this.source = source;
-        this.ignored = looker.ignores(filePath);
+    }
+    /**
+     * Determines if ignored file is ignored or not.
+     */
+    get ignored() {
+        return this.looker.ignores(this.filePath);
     }
     static from(arg, looker, source) {
         if (Array.isArray(arg)) {
@@ -18,11 +36,12 @@ export class FileInfo {
         return new FileInfo(arg, looker, src);
     }
     /**
-     * @param options Styling options.
-     * @param formatEntire Determines if path base or entire file path should be formatted. Default `true`.
+     * @param options Styling options. Default `{}`.
+     * @param formatEntire Determines if the path's base or the entire path should be formatted. Default `true`.
+     * @returns Relative file path. Optionally formatted.
      */
-    toString(options, formatEntire = true) {
-        const { styleName, usePrefix = false, chalk } = options !== null && options !== void 0 ? options : {};
+    toString(options = {}, formatEntire = true) {
+        const { styleName, usePrefix = false, chalk } = options;
         const parsed = path.parse(this.filePath);
         const fileIcon = styleConditionFile(styleName, this.filePath);
         const prefix = usePrefix ? (this.ignored ? '!' : '+') : '';
@@ -38,5 +57,16 @@ export class FileInfo {
         }
         return parsed.dir + '/' + fileIcon + prefix + parsed.base;
     }
+    /**
+     * @param filter The group name.
+     * @returns `true` if the file is contained by the filter.
+     */
+    isIncludedBy(filter) {
+        const filterIgnore = (filter === "ignored") && this.ignored;
+        const filterInclude = (filter === "included") && !this.ignored;
+        const filterAll = filter === "all";
+        const result = filterIgnore || filterInclude || filterAll;
+        return result;
+    }
 }
 //# sourceMappingURL=fileinfo.js.map

package/lib/browser/fileinfo.js.map

@@ -1 +1 @@
-{"version":3,"file":"fileinfo.js","sourceRoot":"","sources":["../../src/browser/fileinfo.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAa,MAAM,cAAc,CAAA;AAC5D,OAAO,IAAI,MAAM,MAAM,CAAA;AAiBvB;;GAEG;AACH,MAAM,OAAO,QAAQ;IAEpB,YACiB,QAAgB,EAChB,MAAc,EACd,MAAkB;QAFlB,aAAQ,GAAR,QAAQ,CAAQ;QAChB,WAAM,GAAN,MAAM,CAAQ;QACd,WAAM,GAAN,MAAM,CAAY;QAElC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;IACxC,CAAC;IAGD,MAAM,CAAC,IAAI,CAAC,GAAsB,EAAE,MAAc,EAAE,MAA4B;QAC/E,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;YACxB,OAAO,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA;QAC5D,CAAC;QACD,MAAM,GAAG,GAAG,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,EAAE,CAAA;QAChG,OAAO,IAAI,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,CAAC,CAAA;IACtC,CAAC;IACD;;;OAGG;IACH,QAAQ,CAAC,OAAiC,EAAE,YAAY,GAAG,IAAI;QAC9D,MAAM,EAAE,SAAS,EAAE,SAAS,GAAG,KAAK,EAAE,KAAK,EAAE,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,CAAC;QAC9D,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QACxC,MAAM,QAAQ,GAAG,kBAAkB,CAAC,SAAS,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAA;QAC7D,MAAM,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;QAC1D,IAAI,KAAK,EAAE,CAAC;YACX,MAAM,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAA;YACjD,IAAI,YAAY,EAAE,CAAC;gBAClB,OAAO,QAAQ,GAAG,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAA;YAC9C,CAAC;YACD,OAAO,MAAM,CAAC,GAAG,GAAG,GAAG,GAAG,QAAQ,GAAG,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,CAAA;QAC/D,CAAC;QACD,IAAI,YAAY,EAAE,CAAC;YAClB,OAAO,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAA;QAC9B,CAAC;QACD,OAAO,MAAM,CAAC,GAAG,GAAG,GAAG,GAAG,QAAQ,GAAG,MAAM,GAAG,MAAM,CAAC,IAAI,CAAA;IAC1D,CAAC;CACD"}
+{"version":3,"file":"fileinfo.js","sourceRoot":"","sources":["../../src/browser/fileinfo.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAa,MAAM,cAAc,CAAA;AAC5D,OAAO,IAAI,MAAM,MAAM,CAAA;AAyBvB;;GAEG;AACH,MAAM,OAAO,QAAQ;IACpB;IACC;;MAEE;IACc,QAAgB;IAEhC;;;OAGG;IACa,MAAc;IAE9B;;MAEE;IACc,MAAkB;QAXlB,aAAQ,GAAR,QAAQ,CAAQ;QAMhB,WAAM,GAAN,MAAM,CAAQ;QAKd,WAAM,GAAN,MAAM,CAAY;IAC/B,CAAC;IAEL;;OAEG;IACH,IAAI,OAAO;QACV,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;IAC1C,CAAC;IAID,MAAM,CAAC,IAAI,CAAC,GAAsB,EAAE,MAAc,EAAE,MAA4B;QAC/E,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;YACxB,OAAO,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA;QAC5D,CAAC;QACD,MAAM,GAAG,GAAG,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,EAAE,CAAA;QAChG,OAAO,IAAI,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,CAAC,CAAA;IACtC,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAAC,UAAmC,EAAE,EAAE,YAAY,GAAG,IAAI;QAClE,MAAM,EAAE,SAAS,EAAE,SAAS,GAAG,KAAK,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC;QACxD,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QACxC,MAAM,QAAQ,GAAG,kBAAkB,CAAC,SAAS,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAA;QAC7D,MAAM,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;QAC1D,IAAI,KAAK,EAAE,CAAC;YACX,MAAM,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAA;YACjD,IAAI,YAAY,EAAE,CAAC;gBAClB,OAAO,QAAQ,GAAG,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAA;YAC9C,CAAC;YACD,OAAO,MAAM,CAAC,GAAG,GAAG,GAAG,GAAG,QAAQ,GAAG,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,CAAA;QAC/D,CAAC;QACD,IAAI,YAAY,EAAE,CAAC;YAClB,OAAO,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAA;QAC9B,CAAC;QACD,OAAO,MAAM,CAAC,GAAG,GAAG,GAAG,GAAG,QAAQ,GAAG,MAAM,GAAG,MAAM,CAAC,IAAI,CAAA;IAC1D,CAAC;IAED;;;OAGG;IACH,YAAY,CAAC,MAAkB;QAC9B,MAAM,YAAY,GAAG,CAAC,MAAM,KAAK,SAAS,CAAC,IAAI,IAAI,CAAC,OAAO,CAAA;QAC3D,MAAM,aAAa,GAAG,CAAC,MAAM,KAAK,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAA;QAC9D,MAAM,SAAS,GAAG,MAAM,KAAK,KAAK,CAAA;QAClC,MAAM,MAAM,GAAG,YAAY,IAAI,aAAa,IAAI,SAAS,CAAA;QACzD,OAAO,MAAM,CAAA;IACd,CAAC;CACD"}

package/lib/browser/lib.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" resolution-mode="require"/>
-import { Looker } from "./looker.js";
+import { Looker, PatternType } from "./looker.js";
 import FastGlob from "fast-glob";
 import { FileInfo } from "./fileinfo.js";
 import { SourcePattern } from "./sourcepattern.js";
@@ -8,51 +8,65 @@ export * from "./fileinfo.js";
 export * from "./sourcepattern.js";
 export * as Styling from "./styling.js";
 export * as Sorting from "./sorting.js";
-export * as Binding from "./binds.js";
+export * as Binding from "./binds/index.js";
 import "./plugins/git.js";
 import "./plugins/npm.js";
 import "./plugins/vsce.js";
 import "./plugins/yarn.js";
-export type PatternType = ".*ignore" | "minimatch";
 export declare const filterNameList: readonly ["ignored", "included", "all"];
 export type FilterName = typeof filterNameList[number];
 export interface FileSystemAdapter extends FastGlob.FileSystemAdapter {
     readFileSync: (path: string) => Buffer;
 }
 /**
- * @see {@link ScanMethod}
+ * The data passed to {@link ScanMethod}.
+ * @todo Rename -> ScanMethodData.
  */
 export interface LookMethodData {
+    /**
+     * The {@link Looker} instance with parsed patterns.
+     */
     looker: Looker;
+    /**
+     * The path to the target file.
+     */
     filePath: string;
+    /**
+     * The information about where the patterns were taken from.
+     */
     sourceFile: SourceFile;
 }
 /**
- * Returns `true` if given source is valid, writes rules to the looker.
+ * Also can write rules to the {@link Looker}.
+ * @returns `true` if the given source is valid.
  */
 export type ScanMethod = (data: LookMethodData) => boolean;
+/**
+ * Contains file path and content.
+ */
 export interface SourceFile {
     /**
-     * Source file path
+     * The source file path.
      */
     path: string;
     /**
-     * Source file content
+     * The source file content.
      */
     content: string;
 }
+/**
+ * Represents the methodology for reading the target source.
+ */
 export interface Source {
     /**
      * Git configuration property.
-     *
-     * @see {@link https://git-scm.com/docs/git-config#Documentation/git-config.txt-coreignoreCase|git-config ignorecase}.
+     * @see Official git documentation: {@link https://git-scm.com/docs/git-config#Documentation/git-config.txt-coreignoreCase|ignorecase}.
      * @default false
      */
     ignoreCase?: boolean;
     /**
      * Additional patterns, which will be used as
      * other patterns in the `.gitignore` file, or `package.json` "files" property.
-     *
      * @default []
      */
     addPatterns?: string[];
@@ -65,57 +79,62 @@ export interface Source {
      */
     patternType: PatternType;
     /**
-     * {@link Looker} maker.
+     * Scanner function. Should return `true` if the given source is valid.
      */
     method: ScanMethod;
 }
+/**
+ * File scanning options.
+ * @see {@link LookFolderOptions}
+ */
 export interface ScanFileOptions {
     /**
      * Custom implementation of methods for working with the file system.
-     *
      * @default fs.*
      */
     fs?: FileSystemAdapter;
     /**
      * The current working directory in which to search.
-     *
      * @default process.cwd()
      */
     cwd?: string;
     /**
      * Specifies the maximum number of concurrent requests from a reader to read
      * directories.
-     *
      * @default os.cpus().length
      */
     concurrency?: number;
     /**
      * Specifies the maximum depth of a read directory relative to the start
      * directory.
-     *
      * @default Infinity
      */
     deep?: number;
 }
+/**
+ * Folder deep scanning options.
+ * @see {@link ScanFileOptions}
+ * @todo Rename -> ScanFolderOptions
+ */
 export interface LookFolderOptions extends ScanFileOptions {
     /**
      * Filter output.
-     *
      * @default "included"
      */
     filter?: FilterName;
 }
 /**
- * Returns `undefined`, if the source is bad.
+ * Gets info about the file: it is ignored or not.
+ * @returns `undefined` if the source is bad.
  */
 export declare function scanFile(filePath: string, sources: Source[], options: ScanFileOptions): Promise<FileInfo | undefined>;
 /**
- * Scan project directory paths with results for each file path.
+ * Scans project directory paths to determine whether they are being ignored.
  */
 export declare function scanPaths(allFilePaths: string[], sources: Source[], options: LookFolderOptions): Promise<FileInfo[] | undefined>;
 export declare function scanPaths(allFilePaths: string[], target: string, options: LookFolderOptions): Promise<FileInfo[] | undefined>;
 /**
- * Scan project directory with results for each file path.
+ * Scans project directory paths to determine whether they are being ignored.
  */
 export declare function scanProject(sources: Source[], options: LookFolderOptions): Promise<FileInfo[] | undefined>;
 export declare function scanProject(target: string, options: LookFolderOptions): Promise<FileInfo[] | undefined>;

package/lib/browser/lib.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"lib.d.ts","sourceRoot":"","sources":["../../src/browser/lib.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,QAAQ,MAAM,WAAW,CAAC;AAEjC,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAkB,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnE,cAAc,aAAa,CAAA;AAC3B,cAAc,eAAe,CAAA;AAC7B,cAAc,oBAAoB,CAAA;AAClC,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AACvC,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AACvC,OAAO,KAAK,OAAO,MAAM,YAAY,CAAA;AAGrC,OAAO,kBAAkB,CAAA;AACzB,OAAO,kBAAkB,CAAA;AACzB,OAAO,mBAAmB,CAAA;AAC1B,OAAO,mBAAmB,CAAA;AAG1B,MAAM,MAAM,WAAW,GAAG,UAAU,GAAG,WAAW,CAAA;AAClD,eAAO,MAAM,cAAc,yCAA0C,CAAA;AACrE,MAAM,MAAM,UAAU,GAAG,OAAO,cAAc,CAAC,MAAM,CAAC,CAAA;AAEtD,MAAM,WAAW,iBAAkB,SAAQ,QAAQ,CAAC,iBAAiB;IACpE,YAAY,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAA;CACtC;AAGD;;GAEG;AACH,MAAM,WAAW,cAAc;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,UAAU,CAAC;CACvB;AACD;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,CAAC,IAAI,EAAE,cAAc,KAAK,OAAO,CAAA;AAC1D,MAAM,WAAW,UAAU;IAC1B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CAChB;AACD,MAAM,WAAW,MAAM;IACtB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB;;OAEG;IACH,OAAO,EAAE,UAAU,EAAE,GAAG,aAAa,CAAC;IACtC;;OAEG;IACH,WAAW,EAAE,WAAW,CAAC;IACzB;;OAEG;IACH,MAAM,EAAE,UAAU,CAAA;CAClB;AAED,MAAM,WAAW,eAAe;IAC/B;;;;OAIG;IACH,EAAE,CAAC,EAAE,iBAAiB,CAAC;IACvB;;;;OAIG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,iBAAkB,SAAQ,eAAe;IACzD;;;;OAIG;IACH,MAAM,CAAC,EAAE,UAAU,CAAA;CACnB;AAED;;GAEG;AACH,wBAAsB,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC,CAuB3H;AAED;;GAEG;AACH,wBAAsB,SAAS,CAAC,YAAY,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,QAAQ,EAAE,GAAG,SAAS,CAAC,CAAA;AACvI,wBAAsB,SAAS,CAAC,YAAY,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,QAAQ,EAAE,GAAG,SAAS,CAAC,CAAA;AAiDpI;;GAEG;AACH,wBAAgB,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,QAAQ,EAAE,GAAG,SAAS,CAAC,CAAA;AAC3G,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,QAAQ,EAAE,GAAG,SAAS,CAAC,CAAA"}
+{"version":3,"file":"lib.d.ts","sourceRoot":"","sources":["../../src/browser/lib.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAClD,OAAO,QAAQ,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAkB,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAGnE,cAAc,aAAa,CAAA;AAC3B,cAAc,eAAe,CAAA;AAC7B,cAAc,oBAAoB,CAAA;AAClC,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AACvC,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AACvC,OAAO,KAAK,OAAO,MAAM,kBAAkB,CAAA;AAG3C,OAAO,kBAAkB,CAAA;AACzB,OAAO,kBAAkB,CAAA;AACzB,OAAO,mBAAmB,CAAA;AAC1B,OAAO,mBAAmB,CAAA;AAG1B,eAAO,MAAM,cAAc,yCAA0C,CAAA;AACrE,MAAM,MAAM,UAAU,GAAG,OAAO,cAAc,CAAC,MAAM,CAAC,CAAA;AAEtD,MAAM,WAAW,iBAAkB,SAAQ,QAAQ,CAAC,iBAAiB;IACpE,YAAY,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAA;CACtC;AAGD;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC9B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,UAAU,EAAE,UAAU,CAAA;CACtB;AAED;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,CAAC,IAAI,EAAE,cAAc,KAAK,OAAO,CAAA;AAE1D;;GAEG;AACH,MAAM,WAAW,UAAU;IAC1B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;CACf;AAED;;GAEG;AACH,MAAM,WAAW,MAAM;IACtB;;;;OAIG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IAEpB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;IAEtB;;OAEG;IACH,OAAO,EAAE,UAAU,EAAE,GAAG,aAAa,CAAA;IAErC;;OAEG;IACH,WAAW,EAAE,WAAW,CAAA;IAExB;;OAEG;IACH,MAAM,EAAE,UAAU,CAAA;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC/B;;;OAGG;IACH,EAAE,CAAC,EAAE,iBAAiB,CAAA;IAEtB;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IAEZ;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;CACb;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAkB,SAAQ,eAAe;IACzD;;;OAGG;IACH,MAAM,CAAC,EAAE,UAAU,CAAA;CACnB;AAED;;;GAGG;AACH,wBAAsB,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC,CAuB3H;AAED;;GAEG;AACH,wBAAsB,SAAS,CAAC,YAAY,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,QAAQ,EAAE,GAAG,SAAS,CAAC,CAAA;AACvI,wBAAsB,SAAS,CAAC,YAAY,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,QAAQ,EAAE,GAAG,SAAS,CAAC,CAAA;AAkDpI;;GAEG;AACH,wBAAgB,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,QAAQ,EAAE,GAAG,SAAS,CAAC,CAAA;AAC3G,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,QAAQ,EAAE,GAAG,SAAS,CAAC,CAAA"}