@zthun/janitor-options 19.2.0 → 19.2.2

package/dist/index.cjs

@@ -1,10 +1,26 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-class ZJanitorOptionsLintBuilder {
-  constructor() {
-    this.lint = {};
-  }
-  /**
+'use strict';
+
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+
+/**
+ * Represents options for linting in the zthunworks janitor system.
+ */ function _define_property$1(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;
+}
+/**
+ * A builder for creating linting options for the zthunworks janitor system.
+ */ class ZJanitorOptionsLintBuilder {
+    /**
    * Sets the path to the config file for eslint.
    *
    * @param esConfig -
@@ -12,12 +28,11 @@ class ZJanitorOptionsLintBuilder {
    *
    * @returns
    *        This object.
-   */
-  esConfig(esConfig) {
-    this.lint.esConfig = esConfig;
-    return this;
-  }
-  /**
+   */ esConfig(esConfig) {
+        this.lint.esConfig = esConfig;
+        return this;
+    }
+    /**
    * Sets the path to the config file for htmlhint.
    *
    * @param htmlConfig -
@@ -25,12 +40,11 @@ class ZJanitorOptionsLintBuilder {
    *
    * @returns
    *        This object.
-   */
-  htmlConfig(htmlConfig) {
-    this.lint.htmlConfig = htmlConfig;
-    return this;
-  }
-  /**
+   */ htmlConfig(htmlConfig) {
+        this.lint.htmlConfig = htmlConfig;
+        return this;
+    }
+    /**
    * Sets the path to the config file for markdownlint.
    *
    * @param markdownConfig -
@@ -38,12 +52,11 @@ class ZJanitorOptionsLintBuilder {
    *
    * @returns
    *        This object.
-   */
-  markdownConfig(markdownConfig) {
-    this.lint.markdownConfig = markdownConfig;
-    return this;
-  }
-  /**
+   */ markdownConfig(markdownConfig) {
+        this.lint.markdownConfig = markdownConfig;
+        return this;
+    }
+    /**
    * Sets the path to the config file for prettier.
    *
    * @param prettyConfig -
@@ -51,12 +64,11 @@ class ZJanitorOptionsLintBuilder {
    *
    * @returns
    *        This object.
-   */
-  prettyConfig(prettyConfig) {
-    this.lint.prettyConfig = prettyConfig;
-    return this;
-  }
-  /**
+   */ prettyConfig(prettyConfig) {
+        this.lint.prettyConfig = prettyConfig;
+        return this;
+    }
+    /**
    * Sets the path to the config file for cspell.
    *
    * @param spellingConfig -
@@ -64,12 +76,11 @@ class ZJanitorOptionsLintBuilder {
    *
    * @returns
    *        This object.
-   */
-  spellingConfig(spellingConfig) {
-    this.lint.spellingConfig = spellingConfig;
-    return this;
-  }
-  /**
+   */ spellingConfig(spellingConfig) {
+        this.lint.spellingConfig = spellingConfig;
+        return this;
+    }
+    /**
    * Sets the path to the config file for stylelint.
    *
    * @param styleConfig -
@@ -77,12 +88,11 @@ class ZJanitorOptionsLintBuilder {
    *
    * @returns
    *        This object.
-   */
-  styleConfig(styleConfig) {
-    this.lint.styleConfig = styleConfig;
-    return this;
-  }
-  /**
+   */ styleConfig(styleConfig) {
+        this.lint.styleConfig = styleConfig;
+        return this;
+    }
+    /**
    * Adds a list of globs to the list of files to lint with eslint.
    *
    * @param file -
@@ -90,13 +100,13 @@ class ZJanitorOptionsLintBuilder {
    *
    * @returns
    *        This object.
-   */
-  esFile(file = []) {
-    const files = this.lint.esFiles ?? [];
-    this.lint.esFiles = files.concat(file);
-    return this;
-  }
-  /**
+   */ esFile(file = []) {
+        var _this_lint_esFiles;
+        const files = (_this_lint_esFiles = this.lint.esFiles) !== null && _this_lint_esFiles !== void 0 ? _this_lint_esFiles : [];
+        this.lint.esFiles = files.concat(file);
+        return this;
+    }
+    /**
    * Adds a list of globs to the list of files to lint with htmlhint.
    *
    * @param file -
@@ -104,13 +114,13 @@ class ZJanitorOptionsLintBuilder {
    *
    * @returns
    *        This object.
-   */
-  htmlFile(file = []) {
-    const files = this.lint.htmlFiles ?? [];
-    this.lint.htmlFiles = files.concat(file);
-    return this;
-  }
-  /**
+   */ htmlFile(file = []) {
+        var _this_lint_htmlFiles;
+        const files = (_this_lint_htmlFiles = this.lint.htmlFiles) !== null && _this_lint_htmlFiles !== void 0 ? _this_lint_htmlFiles : [];
+        this.lint.htmlFiles = files.concat(file);
+        return this;
+    }
+    /**
    * Adds a list of globs to the list of files to lint with json.
    *
    * @param file -
@@ -118,13 +128,13 @@ class ZJanitorOptionsLintBuilder {
    *
    * @returns
    *        This object.
-   */
-  jsonFile(file = []) {
-    const files = this.lint.jsonFiles ?? [];
-    this.lint.jsonFiles = files.concat(file);
-    return this;
-  }
-  /**
+   */ jsonFile(file = []) {
+        var _this_lint_jsonFiles;
+        const files = (_this_lint_jsonFiles = this.lint.jsonFiles) !== null && _this_lint_jsonFiles !== void 0 ? _this_lint_jsonFiles : [];
+        this.lint.jsonFiles = files.concat(file);
+        return this;
+    }
+    /**
    * Adds a list of globs to the list of files to lint with markdownlint.
    *
    * @param file -
@@ -132,13 +142,13 @@ class ZJanitorOptionsLintBuilder {
    *
    * @returns
    *        This object.
-   */
-  markdownFile(file = []) {
-    const files = this.lint.markdownFiles ?? [];
-    this.lint.markdownFiles = files.concat(file);
-    return this;
-  }
-  /**
+   */ markdownFile(file = []) {
+        var _this_lint_markdownFiles;
+        const files = (_this_lint_markdownFiles = this.lint.markdownFiles) !== null && _this_lint_markdownFiles !== void 0 ? _this_lint_markdownFiles : [];
+        this.lint.markdownFiles = files.concat(file);
+        return this;
+    }
+    /**
    * Adds a list of globs to the list of files to lint with prettier.
    *
    * @param file -
@@ -146,13 +156,13 @@ class ZJanitorOptionsLintBuilder {
    *
    * @returns
    *        This object.
-   */
-  prettyFile(file = []) {
-    const files = this.lint.prettyFiles ?? [];
-    this.lint.prettyFiles = files.concat(file);
-    return this;
-  }
-  /**
+   */ prettyFile(file = []) {
+        var _this_lint_prettyFiles;
+        const files = (_this_lint_prettyFiles = this.lint.prettyFiles) !== null && _this_lint_prettyFiles !== void 0 ? _this_lint_prettyFiles : [];
+        this.lint.prettyFiles = files.concat(file);
+        return this;
+    }
+    /**
    * Adds a list of globs to the list of files to lint with cspell.
    *
    * @param file -
@@ -160,13 +170,13 @@ class ZJanitorOptionsLintBuilder {
    *
    * @returns
    *        This object.
-   */
-  spellingFile(file = []) {
-    const files = this.lint.spellingFiles ?? [];
-    this.lint.spellingFiles = files.concat(file);
-    return this;
-  }
-  /**
+   */ spellingFile(file = []) {
+        var _this_lint_spellingFiles;
+        const files = (_this_lint_spellingFiles = this.lint.spellingFiles) !== null && _this_lint_spellingFiles !== void 0 ? _this_lint_spellingFiles : [];
+        this.lint.spellingFiles = files.concat(file);
+        return this;
+    }
+    /**
    * Adds a list of globs to the list of files to lint with stylelint.
    *
    * @param file -
@@ -174,13 +184,13 @@ class ZJanitorOptionsLintBuilder {
    *
    * @returns
    *        This object.
-   */
-  styleFile(file = []) {
-    const files = this.lint.styleFiles ?? [];
-    this.lint.styleFiles = files.concat(file);
-    return this;
-  }
-  /**
+   */ styleFile(file = []) {
+        var _this_lint_styleFiles;
+        const files = (_this_lint_styleFiles = this.lint.styleFiles) !== null && _this_lint_styleFiles !== void 0 ? _this_lint_styleFiles : [];
+        this.lint.styleFiles = files.concat(file);
+        return this;
+    }
+    /**
    * Adds a list of globs to the list of files to lint with yaml.
    *
    * @param file -
@@ -188,13 +198,13 @@ class ZJanitorOptionsLintBuilder {
    *
    * @returns
    *        This object.
-   */
-  yamlFile(file = []) {
-    const files = this.lint.yamlFiles ?? [];
-    this.lint.yamlFiles = files.concat(file);
-    return this;
-  }
-  /**
+   */ yamlFile(file = []) {
+        var _this_lint_yamlFiles;
+        const files = (_this_lint_yamlFiles = this.lint.yamlFiles) !== null && _this_lint_yamlFiles !== void 0 ? _this_lint_yamlFiles : [];
+        this.lint.yamlFiles = files.concat(file);
+        return this;
+    }
+    /**
    * Adds a list of globs to the list of files to exclude from linting with htmlhint.
    *
    * @param files -
@@ -202,13 +212,13 @@ class ZJanitorOptionsLintBuilder {
    *
    * @returns
    *        This object.
-   */
-  htmlExclude(files = []) {
-    const excludes = this.lint.htmlFilesExclude ?? [];
-    this.lint.htmlFilesExclude = excludes.concat(files);
-    return this;
-  }
-  /**
+   */ htmlExclude(files = []) {
+        var _this_lint_htmlFilesExclude;
+        const excludes = (_this_lint_htmlFilesExclude = this.lint.htmlFilesExclude) !== null && _this_lint_htmlFilesExclude !== void 0 ? _this_lint_htmlFilesExclude : [];
+        this.lint.htmlFilesExclude = excludes.concat(files);
+        return this;
+    }
+    /**
    * Adds a list of globs to the list of files to exclude from linting with json.
    *
    * @param file -
@@ -216,13 +226,13 @@ class ZJanitorOptionsLintBuilder {
    *
    * @returns
    *        This object.
-   */
-  jsonExclude(file = []) {
-    const excludes = this.lint.jsonFilesExclude ?? [];
-    this.lint.jsonFilesExclude = excludes.concat(file);
-    return this;
-  }
-  /**
+   */ jsonExclude(file = []) {
+        var _this_lint_jsonFilesExclude;
+        const excludes = (_this_lint_jsonFilesExclude = this.lint.jsonFilesExclude) !== null && _this_lint_jsonFilesExclude !== void 0 ? _this_lint_jsonFilesExclude : [];
+        this.lint.jsonFilesExclude = excludes.concat(file);
+        return this;
+    }
+    /**
    * Adds a list of globs to the list of files to exclude from linting with markdownlint.
    *
    * @param file -
@@ -230,13 +240,13 @@ class ZJanitorOptionsLintBuilder {
    *
    * @returns
    *        This object.
-   */
-  markdownExclude(file = []) {
-    const excludes = this.lint.markdownFilesExclude ?? [];
-    this.lint.markdownFilesExclude = excludes.concat(file);
-    return this;
-  }
-  /**
+   */ markdownExclude(file = []) {
+        var _this_lint_markdownFilesExclude;
+        const excludes = (_this_lint_markdownFilesExclude = this.lint.markdownFilesExclude) !== null && _this_lint_markdownFilesExclude !== void 0 ? _this_lint_markdownFilesExclude : [];
+        this.lint.markdownFilesExclude = excludes.concat(file);
+        return this;
+    }
+    /**
    * Adds a list of globs to the list of files to exclude from linting with prettier.
    *
    * @param file -
@@ -244,13 +254,13 @@ class ZJanitorOptionsLintBuilder {
    *
    * @returns
    *        This object.
-   */
-  prettyExclude(file = []) {
-    const excludes = this.lint.prettyFilesExclude ?? [];
-    this.lint.prettyFilesExclude = excludes.concat(file);
-    return this;
-  }
-  /**
+   */ prettyExclude(file = []) {
+        var _this_lint_prettyFilesExclude;
+        const excludes = (_this_lint_prettyFilesExclude = this.lint.prettyFilesExclude) !== null && _this_lint_prettyFilesExclude !== void 0 ? _this_lint_prettyFilesExclude : [];
+        this.lint.prettyFilesExclude = excludes.concat(file);
+        return this;
+    }
+    /**
    * Adds a list of globs to the list of files to exclude from linting with cspell.
    *
    * @param file -
@@ -258,13 +268,13 @@ class ZJanitorOptionsLintBuilder {
    *
    * @returns
    *        This object.
-   */
-  spellingExclude(file = []) {
-    const excludes = this.lint.spellingFilesExclude ?? [];
-    this.lint.spellingFilesExclude = excludes.concat(file);
-    return this;
-  }
-  /**
+   */ spellingExclude(file = []) {
+        var _this_lint_spellingFilesExclude;
+        const excludes = (_this_lint_spellingFilesExclude = this.lint.spellingFilesExclude) !== null && _this_lint_spellingFilesExclude !== void 0 ? _this_lint_spellingFilesExclude : [];
+        this.lint.spellingFilesExclude = excludes.concat(file);
+        return this;
+    }
+    /**
    * Adds a list of globs to the list of files to exclude from linting with stylelint.
    *
    * @param file -
@@ -272,13 +282,13 @@ class ZJanitorOptionsLintBuilder {
    *
    * @returns
    *        This object.
-   */
-  styleExclude(file = []) {
-    const excludes = this.lint.styleFilesExclude ?? [];
-    this.lint.styleFilesExclude = excludes.concat(file);
-    return this;
-  }
-  /**
+   */ styleExclude(file = []) {
+        var _this_lint_styleFilesExclude;
+        const excludes = (_this_lint_styleFilesExclude = this.lint.styleFilesExclude) !== null && _this_lint_styleFilesExclude !== void 0 ? _this_lint_styleFilesExclude : [];
+        this.lint.styleFilesExclude = excludes.concat(file);
+        return this;
+    }
+    /**
    * Adds a single file glob to the list of files to exclude from linting with yaml.
    *
    * @param file -
@@ -286,13 +296,13 @@ class ZJanitorOptionsLintBuilder {
    *
    * @returns
    *        This object.
-   */
-  yamlExclude(file = []) {
-    const excludes = this.lint.yamlFilesExclude ?? [];
-    this.lint.yamlFilesExclude = excludes.concat(file);
-    return this;
-  }
-  /**
+   */ yamlExclude(file = []) {
+        var _this_lint_yamlFilesExclude;
+        const excludes = (_this_lint_yamlFilesExclude = this.lint.yamlFilesExclude) !== null && _this_lint_yamlFilesExclude !== void 0 ? _this_lint_yamlFilesExclude : [];
+        this.lint.yamlFilesExclude = excludes.concat(file);
+        return this;
+    }
+    /**
    * Adds a file to all exclusion lists.
    *
    * @param file -
@@ -300,129 +310,130 @@ class ZJanitorOptionsLintBuilder {
    *
    * @returns
    *        This object.
-   */
-  excludeAll(file = []) {
-    return this.htmlExclude(file).jsonExclude(file).markdownExclude(file).prettyExclude(file).spellingExclude(file).styleExclude(file).yamlExclude(file);
-  }
-  /**
+   */ excludeAll(file = []) {
+        return this.htmlExclude(file).jsonExclude(file).markdownExclude(file).prettyExclude(file).spellingExclude(file).styleExclude(file).yamlExclude(file);
+    }
+    /**
    * Generates the spelling files based on the other files that have been set.
    *
    * @returns
    *        This object.
-   */
-  generateSpellingFiles() {
-    return this.spellingFile(this.lint.esFiles).spellingFile(this.lint.htmlFiles).spellingFile(this.lint.jsonFiles).spellingFile(this.lint.markdownFiles).spellingFile(this.lint.styleFiles).spellingFile(this.lint.yamlFiles);
-  }
-  /**
+   */ generateSpellingFiles() {
+        return this.spellingFile(this.lint.esFiles).spellingFile(this.lint.htmlFiles).spellingFile(this.lint.jsonFiles).spellingFile(this.lint.markdownFiles).spellingFile(this.lint.styleFiles).spellingFile(this.lint.yamlFiles);
+    }
+    /**
    * Generates the pretty files based on the other files that have been set.
    *
    * @returns
    *        This object.
-   */
-  generatePrettyFiles() {
-    return this.prettyFile(this.lint.esFiles).prettyFile(this.lint.htmlFiles).prettyFile(this.lint.jsonFiles).prettyFile(this.lint.markdownFiles).prettyFile(this.lint.styleFiles).prettyFile(this.lint.yamlFiles);
-  }
-  /**
+   */ generatePrettyFiles() {
+        return this.prettyFile(this.lint.esFiles).prettyFile(this.lint.htmlFiles).prettyFile(this.lint.jsonFiles).prettyFile(this.lint.markdownFiles).prettyFile(this.lint.styleFiles).prettyFile(this.lint.yamlFiles);
+    }
+    /**
    * Adds conventional es files.
    *
    * @returns
    *        This object
-   */
-  commonEsFiles() {
-    const extensions = "js,cjs,mjs,ts,mts,jsx,tsx";
-    return this.esFile(`*.{${extensions}}`).esFile(`src/**/*.{${extensions}}`).esFile(`features/**/*.{${extensions}}`).esFile(`packages/**/src/**/*.{${extensions}}`).esFile(`packages/**/features/**/*.{${extensions}}`).esFile(`packages/*/vite.config.{${extensions}}`).esFile(`packages/*/vitest.config.{${extensions}}`).esFile(`.config/*.{${extensions}}`);
-  }
-  /**
+   */ commonEsFiles() {
+        const extensions = "js,cjs,mjs,ts,mts,jsx,tsx";
+        return this.esFile(`*.{${extensions}}`).esFile(`src/**/*.{${extensions}}`).esFile(`features/**/*.{${extensions}}`).esFile(`packages/**/src/**/*.{${extensions}}`).esFile(`packages/**/features/**/*.{${extensions}}`).esFile(`packages/*/vite.config.{${extensions}}`).esFile(`packages/*/vitest.config.{${extensions}}`).esFile(`.config/*.{${extensions}}`);
+    }
+    /**
    * Adds conventional css files.
    *
    * @returns
    *        This object.
-   */
-  commonCssFiles() {
-    return this.styleFile(`src/**/*.css`).styleFile(`packages/**/*.css`).styleFile("styles/**/*.css");
-  }
-  /**
+   */ commonCssFiles() {
+        return this.styleFile(`src/**/*.css`).styleFile(`packages/**/*.css`).styleFile("styles/**/*.css");
+    }
+    /**
    * Adds conventional sass files.
    *
    * @returns
    *        This object.
-   */
-  commonSassFiles() {
-    return this.styleFile(`src/**/*.{sass,scss}`).styleFile(`packages/**/src/**/*.{sass,scss}`).styleFile("styles/**/*.{sass,scss}");
-  }
-  /**
+   */ commonSassFiles() {
+        return this.styleFile(`src/**/*.{sass,scss}`).styleFile(`packages/**/src/**/*.{sass,scss}`).styleFile("styles/**/*.{sass,scss}");
+    }
+    /**
    * Adds conventional less files.
    *
    * @returns
    *        This object.
-   */
-  commonLessFiles() {
-    return this.styleFile(`src/**/*.less`).styleFile("packages/**/src/**/*.less").styleFile("styles/**/*.less");
-  }
-  /**
+   */ commonLessFiles() {
+        return this.styleFile(`src/**/*.less`).styleFile("packages/**/src/**/*.less").styleFile("styles/**/*.less");
+    }
+    /**
    * Adds conventional less files.
    *
    * @returns
    *        This object.
-   */
-  commonHtmlFiles() {
-    const extensions = "html,htm";
-    return this.htmlFile(`src/**/*.{${extensions}}`).htmlFile(
-      `packages/**/src/**/*.{${extensions}}`
-    );
-  }
-  /**
+   */ commonHtmlFiles() {
+        const extensions = "html,htm";
+        return this.htmlFile(`src/**/*.{${extensions}}`).htmlFile(`packages/**/src/**/*.{${extensions}}`);
+    }
+    /**
    * Adds conventional markdown files.
    *
    * @returns
    *        This object.
-   */
-  commonMarkdownFiles() {
-    return this.markdownFile("LICENSE").markdownFile(`*.md`).markdownFile(`src/**/*.md`).markdownFile(`packages/**/*.md`).markdownFile(`packages/**/LICENSE`);
-  }
-  /**
+   */ commonMarkdownFiles() {
+        return this.markdownFile(`*.md`).markdownFile(`src/**/*.md`).markdownFile(`packages/**/*.md`);
+    }
+    /**
    * Add conventional json files.
    *
    * @returns
    *        This object.
-   */
-  commonJsonFiles() {
-    return this.jsonFile("*.json").jsonFile("src/**/*.json").jsonFile("packages/**/*.json").jsonFile(".config/*.json");
-  }
-  /**
+   */ commonJsonFiles() {
+        return this.jsonFile("*.json").jsonFile("src/**/*.json").jsonFile("packages/**/*.json").jsonFile(".config/*.json");
+    }
+    /**
    * Adds conventional yaml files.
    *
    * @returns
    *        This object.
-   */
-  commonYamlFiles() {
-    const extensions = "yml,yaml";
-    return this.yamlFile(`*.{${extensions}}`).yamlFile(`src/**/*.{${extensions}}`).yamlFile(`packages/**/*.{${extensions}}`).yamlFile(`.config/*.{${extensions}}`).yamlFile(`.circleci/*.{${extensions}}`);
-  }
-  /**
+   */ commonYamlFiles() {
+        const extensions = "yml,yaml";
+        return this.yamlFile(`*.{${extensions}}`).yamlFile(`src/**/*.{${extensions}}`).yamlFile(`packages/**/*.{${extensions}}`).yamlFile(`.config/*.{${extensions}}`).yamlFile(`.circleci/*.{${extensions}}`);
+    }
+    /**
    * Adds conventional exclude files.
    *
    * @returns
    *        This object.
-   */
-  commonExcludes() {
-    return this.excludeAll("**/CHANGELOG.md").excludeAll("**/dist/**").excludeAll("**/node_modules/**").excludeAll("package-lock.json").excludeAll("lerna.json").excludeAll("**/cspell.json");
-  }
-  /**
+   */ commonExcludes() {
+        return this.excludeAll("**/CHANGELOG.md").excludeAll("**/dist/**").excludeAll("**/node_modules/**").excludeAll("package-lock.json").excludeAll("lerna.json").excludeAll("**/cspell.json");
+    }
+    /**
    * Returns the built linting options object.
    *
    * @returns
    *        A clone of the current linting options object.
-   */
-  build() {
-    return structuredClone(this.lint);
-  }
+   */ build() {
+        return structuredClone(this.lint);
+    }
+    constructor(){
+        _define_property$1(this, "lint", {});
+    }
+}
+
+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;
 }
-class ZJanitorOptionsBuilder {
-  constructor() {
-    this.options = {};
-  }
-  /**
+/**
+ * A builder for creating janitor options.
+ */ class ZJanitorOptionsBuilder {
+    /**
    * Sets the linting options for the janitor system.
    *
    * @param lint -
@@ -430,21 +441,23 @@ class ZJanitorOptionsBuilder {
    *
    * @returns
    *        This object.
-   */
-  lint(lint) {
-    this.options.lint = lint;
-    return this;
-  }
-  /**
+   */ lint(lint) {
+        this.options.lint = lint;
+        return this;
+    }
+    /**
    * Builds the options object.
    *
    * @returns
    *       A clone of the current options object.
-   */
-  build() {
-    return structuredClone(this.options);
-  }
+   */ build() {
+        return structuredClone(this.options);
+    }
+    constructor(){
+        _define_property(this, "options", {});
+    }
 }
+
 exports.ZJanitorOptionsBuilder = ZJanitorOptionsBuilder;
 exports.ZJanitorOptionsLintBuilder = ZJanitorOptionsLintBuilder;
 //# sourceMappingURL=index.cjs.map