@zthun/janitor-lint 19.0.0

package/dist/config/config-reader-cosmic.d.mts

@@ -0,0 +1,44 @@
+import { IZConfigDiscovery } from './config-discovery.mjs';
+import { IZConfigExtender } from './config-extender.mjs';
+import { IZConfigReader } from './config-reader.mjs';
+/**
+ * Represents a reader that uses the cosmiconfig standard for files.
+ */
+export declare class ZConfigReaderCosmic implements IZConfigReader, IZConfigDiscovery {
+    name: string;
+    extender: IZConfigExtender;
+    paths: string[];
+    /**
+     * Initializes a new instance of this object.
+     *
+     * @param name -
+     *        The name of the application to load.
+     * @param extender -
+     *        The extender to expand upon the read configuration.
+     * @param paths -
+     *        The additional paths to read if cosmic config does not find a valid config.  Remember that these
+     *        are paths, not modules in this case, so you can't load things from the node modules directory
+     *        using these values.  These only affect the search for the config file, not the actual
+     *        read of the config.
+     */
+    constructor(name: string, extender: IZConfigExtender, paths?: string[]);
+    /**
+     * Runs a search for the appropriate configuration file.
+     *
+     * The extension keyword is deleted from the config.
+     *
+     * @returns
+     *        A promise that resolves with the expanded configuration.
+     */
+    search(): Promise<any>;
+    /**
+     * Reads the config file.
+     *
+     * @param config -
+     *        The optional configuration file.  If this is null then the cosmiconfig path is searched on the name.
+     *
+     * @returns
+     *        A promise that resolves the json object that represents the config.
+     */
+    read(config: string): Promise<any>;
+}

package/dist/config/config-reader-null.class.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/config/config-reader-null.d.mts

@@ -0,0 +1,13 @@
+import { IZConfigReader } from './config-reader.mjs';
+/**
+ * Represents a config reader that returns the empty options.
+ */
+export declare class ZConfigReaderNull implements IZConfigReader {
+    /**
+     * Returns a null resolved promise.
+     *
+     * @returns
+     *        A promise that resolves to null.
+     */
+    read(): Promise<any>;
+}

package/dist/config/config-reader-prettier.class.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/config/config-reader-prettier.d.mts

@@ -0,0 +1,18 @@
+import { Options } from 'prettier';
+import { IZConfigReader } from './config-reader.mjs';
+/**
+ * Represents a configuration reader for prettier.
+ */
+export declare class ZConfigReaderPrettier implements IZConfigReader {
+    /**
+     * Reads the configuration file.
+     *
+     * @param config -
+     *        The config module to load.  If this value is falsy,
+     *        then prettier will be used to retrieve the configuration.
+     *
+     * @returns
+     *        The options for the config file.
+     */
+    read(config: string): Promise<Options>;
+}

package/dist/config/config-reader.d.mts

@@ -0,0 +1,15 @@
+/**
+ * Represents an object that can read a config file.
+ */
+export interface IZConfigReader {
+    /**
+     * Reads the config file and returns the contents as an object.
+     *
+     * @param config -
+     *        The config file to read.
+     *
+     * @returns
+     *        A promise that returns the content of the config file.
+     */
+    read(config: string): Promise<any>;
+}

package/dist/config/config-resolve.d.mts

@@ -0,0 +1,4 @@
+export declare function $require(id: string): any;
+export declare function $resolve(id: string, options?: {
+    paths?: string[];
+}): string;

package/dist/content/content-linter-html.class.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/content/content-linter-html.d.mts

@@ -0,0 +1,21 @@
+import { IZContentLinter } from './content-linter.mjs';
+/**
+ * Represents an object that can be used to hint html files.
+ */
+export declare class ZContentLinterHtml implements IZContentLinter {
+    private readonly _formatOptions;
+    /**
+     * Lints the content.
+     *
+     * @param content -
+     *        The content to check.
+     * @param contentPath -
+     *        The path of the content data.
+     * @param options -
+     *        The htmlhint options.
+     *
+     * @returns
+     *        A promise that resolves if the content is lint free, and rejects if it has lint errors.
+     */
+    lint(content: string, contentPath: string, options?: any): Promise<any>;
+}

package/dist/content/content-linter-json.class.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/content/content-linter-json.d.mts

@@ -0,0 +1,13 @@
+import { IZContentLinter } from './content-linter.mjs';
+/**
+ * Represents the linter for json files.
+ */
+export declare class ZContentLinterJson implements IZContentLinter {
+    /**
+     * Lints the collection of json files.
+     *
+     * @param contents -
+     *        The json file contents.
+     */
+    lint(contents: string): Promise<any>;
+}

package/dist/content/content-linter-pretty.class.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/content/content-linter-pretty.d.mts

@@ -0,0 +1,21 @@
+import { Options } from 'prettier';
+import { IZContentLinter } from './content-linter.mjs';
+/**
+ * Represents an object that can be used to perform prettier checks on files.
+ */
+export declare class ZContentLinterPretty implements IZContentLinter {
+    /**
+     * Lints the content.
+     *
+     * @param content -
+     *        The content to check.
+     * @param contentPath -
+     *        The path of the content data.
+     * @param options -
+     *        The htmlhint options.
+     *
+     * @returns
+     *        A promise that resolves if the content is lint free, and rejects if it has lint errors.
+     */
+    lint(content: string, contentPath: string, options?: Options): Promise<any>;
+}

package/dist/content/content-linter-yaml.class.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/content/content-linter-yaml.d.mts

@@ -0,0 +1,16 @@
+import { IZContentLinter } from './content-linter.mjs';
+/**
+ * Represents a linter for yml files.
+ */
+export declare class ZContentLinterYaml implements IZContentLinter {
+    /**
+     * Lints yml files.
+     *
+     * @param contents -
+     *        Yaml formatted string.
+     *
+     * @returns
+     *        A promise that resolves if successful, or rejects if failed.
+     */
+    lint(contents: string): Promise<any>;
+}

package/dist/content/content-linter.d.mts

@@ -0,0 +1,21 @@
+/**
+ * Represents an object that can be used to lint file contents.
+ */
+export interface IZContentLinter {
+    /**
+     * Lints file content.
+     *
+     * @param content -
+     *        The content to lint.
+     * @param contentPath -
+     *        The path of the content.
+     * @param options -
+     *        The options for the linter.
+     * @param optionsPath -
+     *        The path of the options configuration.
+     *
+     * @returns
+     *        A resolved promise if the lint is successful, a rejected promise if not.
+     */
+    lint(content: string, contentPath: string, options: any, optionsPath: string): Promise<any>;
+}

package/dist/index.cjs

@@ -0,0 +1,58 @@
+'use strict';
+
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+
+const janitorLint = require('./janitor-lint-CA0qEXKV.cjs');
+
+function _define_property(obj, key, value) {
+    if (key in obj) {
+        Object.defineProperty(obj, key, {
+            value: value,
+            enumerable: true,
+            configurable: true,
+            writable: true
+        });
+    } else {
+        obj[key] = value;
+    }
+    return obj;
+}
+/**
+ * Represents a silent linter that always succeeds.
+ */ class ZLinterSilent {
+    /**
+   * Returns a promise that resolves the resolved value.
+   *
+   * @returns
+   *        A promise that resolves the resolved value.
+   */ lint() {
+        return Promise.resolve(this._resolve);
+    }
+    /**
+   * Initializes a new instance of this object.
+   *
+   * @param _resolve -
+   *        The value to resolve.
+   */ constructor(_resolve = true){
+        _define_property(this, "_resolve", void 0);
+        this._resolve = _resolve;
+    }
+}
+
+exports.ZConfigExtender = janitorLint.ZConfigExtender;
+exports.ZConfigReaderCosmic = janitorLint.ZConfigReaderCosmic;
+exports.ZConfigReaderNull = janitorLint.ZConfigReaderNull;
+exports.ZConfigReaderPrettier = janitorLint.ZConfigReaderPrettier;
+exports.ZContentLinterHtml = janitorLint.ZContentLinterHtml;
+exports.ZContentLinterJson = janitorLint.ZContentLinterJson;
+exports.ZContentLinterPretty = janitorLint.ZContentLinterPretty;
+exports.ZContentLinterYaml = janitorLint.ZContentLinterYaml;
+exports.ZJanitorLint = janitorLint.ZJanitorLint;
+exports.ZLinterEs = janitorLint.ZLinterEs;
+exports.ZLinterFile = janitorLint.ZLinterFile;
+exports.ZLinterMarkdown = janitorLint.ZLinterMarkdown;
+exports.ZLinterReport = janitorLint.ZLinterReport;
+exports.ZLinterSpelling = janitorLint.ZLinterSpelling;
+exports.ZLinterStyle = janitorLint.ZLinterStyle;
+exports.ZLinterSilent = ZLinterSilent;
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sources":["../src/linter/linter-silent.mts"],"sourcesContent":["import { IZLinter } from \"./linter.mjs\";\n\n/**\n * Represents a silent linter that always succeeds.\n */\nexport class ZLinterSilent implements IZLinter {\n  /**\n   * Initializes a new instance of this object.\n   *\n   * @param _resolve -\n   *        The value to resolve.\n   */\n  public constructor(private _resolve = true) {}\n\n  /**\n   * Returns a promise that resolves the resolved value.\n   *\n   * @returns\n   *        A promise that resolves the resolved value.\n   */\n  public lint(): Promise<boolean> {\n    return Promise.resolve(this._resolve);\n  }\n}\n"],"names":["ZLinterSilent","Promise","resolve","_resolve"],"mappings":";;;;;;;;;;;;;;;;;;;AAEA;;AAEC,IACM,MAAMA,aAAAA,CAAAA;AASX;;;;;AAKC,MACD,IAAgC,GAAA;AAC9B,QAAA,OAAOC,OAAQC,CAAAA,OAAO,CAAC,IAAI,CAACC,QAAQ,CAAA;AACtC;AAhBA;;;;;AAKC,MACD,WAAmB,CAAQA,QAAW,GAAA,IAAI,CAAE;;aAAjBA,QAAAA,GAAAA,QAAAA;AAAkB;AAW/C;;;;;;;;;;;;;;;;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,21 @@
+export * from './app/janitor-lint-args.mjs';
+export * from './app/janitor-lint.mjs';
+export * from './config/config-discovery.mjs';
+export * from './config/config-extender.mjs';
+export * from './config/config-reader-cosmic.mjs';
+export * from './config/config-reader-null.mjs';
+export * from './config/config-reader-prettier.mjs';
+export * from './config/config-reader.mjs';
+export * from './content/content-linter-html.mjs';
+export * from './content/content-linter-json.mjs';
+export * from './content/content-linter-pretty.mjs';
+export * from './content/content-linter-yaml.mjs';
+export * from './content/content-linter.mjs';
+export * from './linter/linter-es.mjs';
+export * from './linter/linter-file.mjs';
+export * from './linter/linter-markdown.mjs';
+export * from './linter/linter-report.mjs';
+export * from './linter/linter-silent.mjs';
+export * from './linter/linter-spelling.mjs';
+export * from './linter/linter-style.mjs';
+export * from './linter/linter.mjs';

package/dist/index.js

@@ -0,0 +1,39 @@
+export { a as ZConfigExtender, b as ZConfigReaderCosmic, c as ZConfigReaderNull, d as ZConfigReaderPrettier, e as ZContentLinterHtml, f as ZContentLinterJson, g as ZContentLinterPretty, h as ZContentLinterYaml, Z as ZJanitorLint, i as ZLinterEs, j as ZLinterFile, k as ZLinterMarkdown, l as ZLinterReport, m as ZLinterSpelling, n as ZLinterStyle } from './janitor-lint-QMZ00oXe.js';
+
+function _define_property(obj, key, value) {
+    if (key in obj) {
+        Object.defineProperty(obj, key, {
+            value: value,
+            enumerable: true,
+            configurable: true,
+            writable: true
+        });
+    } else {
+        obj[key] = value;
+    }
+    return obj;
+}
+/**
+ * Represents a silent linter that always succeeds.
+ */ class ZLinterSilent {
+    /**
+   * Returns a promise that resolves the resolved value.
+   *
+   * @returns
+   *        A promise that resolves the resolved value.
+   */ lint() {
+        return Promise.resolve(this._resolve);
+    }
+    /**
+   * Initializes a new instance of this object.
+   *
+   * @param _resolve -
+   *        The value to resolve.
+   */ constructor(_resolve = true){
+        _define_property(this, "_resolve", void 0);
+        this._resolve = _resolve;
+    }
+}
+
+export { ZLinterSilent };
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../src/linter/linter-silent.mts"],"sourcesContent":["import { IZLinter } from \"./linter.mjs\";\n\n/**\n * Represents a silent linter that always succeeds.\n */\nexport class ZLinterSilent implements IZLinter {\n  /**\n   * Initializes a new instance of this object.\n   *\n   * @param _resolve -\n   *        The value to resolve.\n   */\n  public constructor(private _resolve = true) {}\n\n  /**\n   * Returns a promise that resolves the resolved value.\n   *\n   * @returns\n   *        A promise that resolves the resolved value.\n   */\n  public lint(): Promise<boolean> {\n    return Promise.resolve(this._resolve);\n  }\n}\n"],"names":["ZLinterSilent","Promise","resolve","_resolve"],"mappings":";;;;;;;;;;;;;;;AAEA;;AAEC,IACM,MAAMA,aAAAA,CAAAA;AASX;;;;;AAKC,MACD,IAAgC,GAAA;AAC9B,QAAA,OAAOC,OAAQC,CAAAA,OAAO,CAAC,IAAI,CAACC,QAAQ,CAAA;AACtC;AAhBA;;;;;AAKC,MACD,WAAmB,CAAQA,QAAW,GAAA,IAAI,CAAE;;aAAjBA,QAAAA,GAAAA,QAAAA;AAAkB;AAW/C;;;;"}