@zthun/janitor-build-config 19.0.0

package/LICENSE.md

@@ -0,0 +1,20 @@
+# MIT License
+
+Copyright (c) 2024 Anthony Bonta
+
+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

@@ -0,0 +1,13 @@
+# Janitor Build Config
+
+This is a set of common configurations for vite and vitest to simplify
+build configuration files.
+
+## Getting Started
+
+```sh
+# NPM
+npm install @zthun/janitor-build-config --save-dev
+# Yarn
+yarn add @zthun/janitor-build-config --dev
+```

package/dist/typedoc/index.d.ts

@@ -0,0 +1 @@
+export * from './typedoc-config-builder.mjs';

package/dist/typedoc/typedoc-config-builder.d.mts

@@ -0,0 +1,142 @@
+import { EntryPointStrategy, TypeDocOptions } from 'typedoc';
+/**
+ * A builder for TypeDoc configurations.
+ */
+export declare class ZTypedocConfigBuilder {
+    static readonly OutputDist = "./dist";
+    static readonly EntryPointIndex = "./src/index.ts";
+    private typedoc;
+    /**
+     * Sets the output directory for the documentation.
+     *
+     * @param path -
+     *        The output directory path.
+     * @returns
+     *        This object.
+     */
+    out(path: string): this;
+    /**
+     * Sets the output directory to "./dist".
+     *
+     * @returns
+     *        This object.
+     */
+    dist: () => this;
+    /**
+     * Adds a list of entry point glob to the existing entry points.
+     *
+     * @param glob -
+     *        The entry point glob pattern.
+     *
+     * @returns
+     *        This object.
+     */
+    entry(glob: string | string): this;
+    /**
+     * Adds an entry point for './src/index.ts'.
+     *
+     * @returns
+     *        This object.
+     */
+    index: () => this;
+    /**
+     * Sets the entry point strategy.
+     *
+     * See {@link https://typedoc.org/api/enums/EntryPointStrategy.html | EntryPointStrategy}
+     * for more details.
+     *
+     * @param strategy -
+     *        The entry point strategy to use.
+     *
+     * @returns
+     *        This object.
+     */
+    entryPointStrategy(strategy: EntryPointStrategy): this;
+    /**
+     * Sets the entry point strategy to "resolve".
+     *
+     * @returns
+     *        This object.
+     */
+    resolve: () => this;
+    /**
+     * Sets the entry point strategy to "packages".
+     *
+     * @returns
+     *        This object.
+     */
+    packages: () => this;
+    /**
+     * Sets the excludeNotDocumented flag.
+     *
+     * @returns
+     *        This object.
+     */
+    excludeNotDocumented(): this;
+    /**
+     * Sets the categorizeByGroup flag.
+     *
+     * @returns
+     *        This object.
+     */
+    categorizeByGroup(): this;
+    /**
+     * Sets the name of the project.
+     *
+     * @param name -
+     *        The name of the project.
+     *
+     * @returns
+     *        This object.
+     */
+    name(name: string): this;
+    /**
+     * Sets the favicon for the project.
+     *
+     * @param path -
+     *        The path to the favicon file.
+     *
+     * @returns
+     *        This object.
+     */
+    favicon(path: string): this;
+    /**
+     * Adds a single exclude glob to the existing excludes.
+     *
+     * @param glob -
+     *        The exclude glob pattern.
+     *
+     * @returns
+     *        This object.
+     */
+    exclude(glob: string | string[]): this;
+    /**
+     * Sets the typedoc configuration to be used for an individual project.
+     *
+     * An individual project typedoc does not output any documentation by itself,
+     * but is part of a larger project that does.
+     *
+     * @returns
+     *        This object.
+     */
+    project(): this;
+    /**
+     * Sets the typedoc configuration to be used a web project that outputs
+     * final documentation for a monorepo of packages.
+     *
+     * Normally, your monorepo will have a single web or doc project that outputs
+     * the typescript for every package in the monorepo.  Use this configuration
+     * for that project.
+     *
+     * @returns
+     *        This object.
+     */
+    web(): this;
+    /**
+     * Builds the final typedoc configuration object.
+     *
+     * @returns
+     *        The final typedoc configuration object.
+     */
+    build(): TypeDocOptions;
+}

package/dist/typedoc/typedoc-config-builder.spec.d.ts

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

package/dist/typedoc.cjs

@@ -0,0 +1,181 @@
+'use strict';
+
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+
+const lodashEs = require('lodash-es');
+
+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;
+}
+/**
+ * A builder for TypeDoc configurations.
+ */ class ZTypedocConfigBuilder {
+    /**
+   * Sets the output directory for the documentation.
+   *
+   * @param path -
+   *        The output directory path.
+   * @returns
+   *        This object.
+   */ out(path) {
+        this.typedoc.out = path;
+        return this;
+    }
+    /**
+   * Adds a list of entry point glob to the existing entry points.
+   *
+   * @param glob -
+   *        The entry point glob pattern.
+   *
+   * @returns
+   *        This object.
+   */ entry(glob) {
+        const entry = this.typedoc.entryPoints || [];
+        this.typedoc.entryPoints = entry.concat(glob);
+        return this;
+    }
+    /**
+   * Sets the entry point strategy.
+   *
+   * See {@link https://typedoc.org/api/enums/EntryPointStrategy.html | EntryPointStrategy}
+   * for more details.
+   *
+   * @param strategy -
+   *        The entry point strategy to use.
+   *
+   * @returns
+   *        This object.
+   */ entryPointStrategy(strategy) {
+        this.typedoc.entryPointStrategy = strategy;
+        return this;
+    }
+    /**
+   * Sets the excludeNotDocumented flag.
+   *
+   * @returns
+   *        This object.
+   */ excludeNotDocumented() {
+        this.typedoc.excludeNotDocumented = true;
+        return this;
+    }
+    /**
+   * Sets the categorizeByGroup flag.
+   *
+   * @returns
+   *        This object.
+   */ categorizeByGroup() {
+        this.typedoc.categorizeByGroup = true;
+        return this;
+    }
+    /**
+   * Sets the name of the project.
+   *
+   * @param name -
+   *        The name of the project.
+   *
+   * @returns
+   *        This object.
+   */ name(name) {
+        this.typedoc.name = name;
+        return this;
+    }
+    /**
+   * Sets the favicon for the project.
+   *
+   * @param path -
+   *        The path to the favicon file.
+   *
+   * @returns
+   *        This object.
+   */ favicon(path) {
+        this.typedoc.favicon = path;
+        return this;
+    }
+    /**
+   * Adds a single exclude glob to the existing excludes.
+   *
+   * @param glob -
+   *        The exclude glob pattern.
+   *
+   * @returns
+   *        This object.
+   */ exclude(glob) {
+        const excludes = this.typedoc.exclude || [];
+        this.typedoc.exclude = excludes.concat(glob);
+        return this;
+    }
+    /**
+   * Sets the typedoc configuration to be used for an individual project.
+   *
+   * An individual project typedoc does not output any documentation by itself,
+   * but is part of a larger project that does.
+   *
+   * @returns
+   *        This object.
+   */ project() {
+        return this.resolve().dist();
+    }
+    /**
+   * Sets the typedoc configuration to be used a web project that outputs
+   * final documentation for a monorepo of packages.
+   *
+   * Normally, your monorepo will have a single web or doc project that outputs
+   * the typescript for every package in the monorepo.  Use this configuration
+   * for that project.
+   *
+   * @returns
+   *        This object.
+   */ web() {
+        return this.packages().excludeNotDocumented().categorizeByGroup().dist().exclude("./");
+    }
+    /**
+   * Builds the final typedoc configuration object.
+   *
+   * @returns
+   *        The final typedoc configuration object.
+   */ build() {
+        return lodashEs.cloneDeep(this.typedoc);
+    }
+    constructor(){
+        _define_property(this, "typedoc", {});
+        /**
+   * Sets the output directory to "./dist".
+   *
+   * @returns
+   *        This object.
+   */ _define_property(this, "dist", this.out.bind(this, ZTypedocConfigBuilder.OutputDist));
+        /**
+   * Adds an entry point for './src/index.ts'.
+   *
+   * @returns
+   *        This object.
+   */ _define_property(this, "index", this.entry.bind(this, ZTypedocConfigBuilder.EntryPointIndex));
+        /**
+   * Sets the entry point strategy to "resolve".
+   *
+   * @returns
+   *        This object.
+   */ _define_property(this, "resolve", this.entryPointStrategy.bind(this, "resolve"));
+        /**
+   * Sets the entry point strategy to "packages".
+   *
+   * @returns
+   *        This object.
+   */ _define_property(this, "packages", this.entryPointStrategy.bind(this, "packages"));
+    }
+}
+_define_property(ZTypedocConfigBuilder, "OutputDist", "./dist");
+_define_property(ZTypedocConfigBuilder, "EntryPointIndex", "./src/index.ts");
+
+exports.ZTypedocConfigBuilder = ZTypedocConfigBuilder;
+//# sourceMappingURL=typedoc.cjs.map

package/dist/typedoc.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"typedoc.cjs","sources":["../src/typedoc/typedoc-config-builder.mts"],"sourcesContent":["import { cloneDeep } from \"lodash-es\";\nimport { EntryPointStrategy, TypeDocOptions } from \"typedoc\";\n\n/**\n * A builder for TypeDoc configurations.\n */\nexport class ZTypedocConfigBuilder {\n  public static readonly OutputDist = \"./dist\";\n  public static readonly EntryPointIndex = \"./src/index.ts\";\n\n  private typedoc: TypeDocOptions = {};\n\n  /**\n   * Sets the output directory for the documentation.\n   *\n   * @param path -\n   *        The output directory path.\n   * @returns\n   *        This object.\n   */\n  public out(path: string) {\n    this.typedoc.out = path;\n    return this;\n  }\n\n  /**\n   * Sets the output directory to \"./dist\".\n   *\n   * @returns\n   *        This object.\n   */\n  public dist = this.out.bind(this, ZTypedocConfigBuilder.OutputDist);\n\n  /**\n   * Adds a list of entry point glob to the existing entry points.\n   *\n   * @param glob -\n   *        The entry point glob pattern.\n   *\n   * @returns\n   *        This object.\n   */\n  public entry(glob: string | string) {\n    const entry = this.typedoc.entryPoints || [];\n    this.typedoc.entryPoints = entry.concat(glob);\n    return this;\n  }\n\n  /**\n   * Adds an entry point for './src/index.ts'.\n   *\n   * @returns\n   *        This object.\n   */\n  public index = this.entry.bind(this, ZTypedocConfigBuilder.EntryPointIndex);\n\n  /**\n   * Sets the entry point strategy.\n   *\n   * See {@link https://typedoc.org/api/enums/EntryPointStrategy.html | EntryPointStrategy}\n   * for more details.\n   *\n   * @param strategy -\n   *        The entry point strategy to use.\n   *\n   * @returns\n   *        This object.\n   */\n  public entryPointStrategy(strategy: EntryPointStrategy) {\n    this.typedoc.entryPointStrategy = strategy;\n    return this;\n  }\n\n  /**\n   * Sets the entry point strategy to \"resolve\".\n   *\n   * @returns\n   *        This object.\n   */\n  public resolve = this.entryPointStrategy.bind(this, \"resolve\");\n\n  /**\n   * Sets the entry point strategy to \"packages\".\n   *\n   * @returns\n   *        This object.\n   */\n  public packages = this.entryPointStrategy.bind(this, \"packages\");\n\n  /**\n   * Sets the excludeNotDocumented flag.\n   *\n   * @returns\n   *        This object.\n   */\n  public excludeNotDocumented() {\n    this.typedoc.excludeNotDocumented = true;\n    return this;\n  }\n\n  /**\n   * Sets the categorizeByGroup flag.\n   *\n   * @returns\n   *        This object.\n   */\n  public categorizeByGroup() {\n    this.typedoc.categorizeByGroup = true;\n    return this;\n  }\n\n  /**\n   * Sets the name of the project.\n   *\n   * @param name -\n   *        The name of the project.\n   *\n   * @returns\n   *        This object.\n   */\n  public name(name: string) {\n    this.typedoc.name = name;\n    return this;\n  }\n\n  /**\n   * Sets the favicon for the project.\n   *\n   * @param path -\n   *        The path to the favicon file.\n   *\n   * @returns\n   *        This object.\n   */\n  public favicon(path: string) {\n    this.typedoc.favicon = path;\n    return this;\n  }\n\n  /**\n   * Adds a single exclude glob to the existing excludes.\n   *\n   * @param glob -\n   *        The exclude glob pattern.\n   *\n   * @returns\n   *        This object.\n   */\n  public exclude(glob: string | string[]) {\n    const excludes = this.typedoc.exclude || [];\n    this.typedoc.exclude = excludes.concat(glob);\n    return this;\n  }\n\n  /**\n   * Sets the typedoc configuration to be used for an individual project.\n   *\n   * An individual project typedoc does not output any documentation by itself,\n   * but is part of a larger project that does.\n   *\n   * @returns\n   *        This object.\n   */\n  public project() {\n    return this.resolve().dist();\n  }\n\n  /**\n   * Sets the typedoc configuration to be used a web project that outputs\n   * final documentation for a monorepo of packages.\n   *\n   * Normally, your monorepo will have a single web or doc project that outputs\n   * the typescript for every package in the monorepo.  Use this configuration\n   * for that project.\n   *\n   * @returns\n   *        This object.\n   */\n  public web() {\n    return this.packages()\n      .excludeNotDocumented()\n      .categorizeByGroup()\n      .dist()\n      .exclude(\"./\");\n  }\n\n  /**\n   * Builds the final typedoc configuration object.\n   *\n   * @returns\n   *        The final typedoc configuration object.\n   */\n  public build() {\n    return cloneDeep(this.typedoc);\n  }\n}\n"],"names":["ZTypedocConfigBuilder","out","path","typedoc","entry","glob","entryPoints","concat","entryPointStrategy","strategy","excludeNotDocumented","categorizeByGroup","name","favicon","exclude","excludes","resolve","dist","packages","cloneDeep","bind","OutputDist","index","EntryPointIndex"],"mappings":";;;;;;;;;;;;;;;;;;;AAGA;;AAEC,IACM,MAAMA,qBAAAA,CAAAA;AAMX;;;;;;;MAQOC,GAAIC,CAAAA,IAAY,EAAE;AACvB,QAAA,IAAI,CAACC,OAAO,CAACF,GAAG,GAAGC,IAAAA;AACnB,QAAA,OAAO,IAAI;AACb;AAUA;;;;;;;;MASOE,KAAMC,CAAAA,IAAqB,EAAE;AAClC,QAAA,MAAMD,QAAQ,IAAI,CAACD,OAAO,CAACG,WAAW,IAAI,EAAE;AAC5C,QAAA,IAAI,CAACH,OAAO,CAACG,WAAW,GAAGF,KAAAA,CAAMG,MAAM,CAACF,IAAAA,CAAAA;AACxC,QAAA,OAAO,IAAI;AACb;AAUA;;;;;;;;;;;MAYOG,kBAAmBC,CAAAA,QAA4B,EAAE;AACtD,QAAA,IAAI,CAACN,OAAO,CAACK,kBAAkB,GAAGC,QAAAA;AAClC,QAAA,OAAO,IAAI;AACb;AAkBA;;;;;AAKC,MACD,oBAA8B,GAAA;AAC5B,QAAA,IAAI,CAACN,OAAO,CAACO,oBAAoB,GAAG,IAAA;AACpC,QAAA,OAAO,IAAI;AACb;AAEA;;;;;AAKC,MACD,iBAA2B,GAAA;AACzB,QAAA,IAAI,CAACP,OAAO,CAACQ,iBAAiB,GAAG,IAAA;AACjC,QAAA,OAAO,IAAI;AACb;AAEA;;;;;;;;MASOC,IAAKA,CAAAA,IAAY,EAAE;AACxB,QAAA,IAAI,CAACT,OAAO,CAACS,IAAI,GAAGA,IAAAA;AACpB,QAAA,OAAO,IAAI;AACb;AAEA;;;;;;;;MASOC,OAAQX,CAAAA,IAAY,EAAE;AAC3B,QAAA,IAAI,CAACC,OAAO,CAACU,OAAO,GAAGX,IAAAA;AACvB,QAAA,OAAO,IAAI;AACb;AAEA;;;;;;;;MASOY,OAAQT,CAAAA,IAAuB,EAAE;AACtC,QAAA,MAAMU,WAAW,IAAI,CAACZ,OAAO,CAACW,OAAO,IAAI,EAAE;AAC3C,QAAA,IAAI,CAACX,OAAO,CAACW,OAAO,GAAGC,QAAAA,CAASR,MAAM,CAACF,IAAAA,CAAAA;AACvC,QAAA,OAAO,IAAI;AACb;AAEA;;;;;;;;AAQC,MACD,OAAiB,GAAA;AACf,QAAA,OAAO,IAAI,CAACW,OAAO,EAAA,CAAGC,IAAI,EAAA;AAC5B;AAEA;;;;;;;;;;AAUC,MACD,GAAa,GAAA;QACX,OAAO,IAAI,CAACC,QAAQ,EACjBR,CAAAA,oBAAoB,EACpBC,CAAAA,iBAAiB,EACjBM,CAAAA,IAAI,EACJH,CAAAA,OAAO,CAAC,IAAA,CAAA;AACb;AAEA;;;;;AAKC,MACD,KAAe,GAAA;QACb,OAAOK,kBAAAA,CAAU,IAAI,CAAChB,OAAO,CAAA;AAC/B;;AAxLA,QAAA,gBAAA,CAAA,IAAA,EAAQA,WAA0B,EAAC,CAAA;AAenC;;;;;MAMA,gBAAA,CAAA,IAAA,EAAOc,MAAO,EAAA,IAAI,CAAChB,GAAG,CAACmB,IAAI,CAAC,IAAI,EAAEpB,qBAAAA,CAAsBqB,UAAU,CAAA,CAAA;AAiBlE;;;;;MAMA,gBAAA,CAAA,IAAA,EAAOC,OAAQ,EAAA,IAAI,CAAClB,KAAK,CAACgB,IAAI,CAAC,IAAI,EAAEpB,qBAAAA,CAAsBuB,eAAe,CAAA,CAAA;AAmB1E;;;;;MAMA,gBAAA,CAAA,IAAA,EAAOP,WAAU,IAAI,CAACR,kBAAkB,CAACY,IAAI,CAAC,IAAI,EAAE,SAAA,CAAA,CAAA;AAEpD;;;;;MAMA,gBAAA,CAAA,IAAA,EAAOF,YAAW,IAAI,CAACV,kBAAkB,CAACY,IAAI,CAAC,IAAI,EAAE,UAAA,CAAA,CAAA;;AA4GvD;AA5LE,gBAAA,CADWpB,uBACYqB,YAAa,EAAA,QAAA,CAAA;AACpC,gBAAA,CAFWrB,uBAEYuB,iBAAkB,EAAA,gBAAA,CAAA;;;;"}

package/dist/typedoc.js

@@ -0,0 +1,177 @@
+import { cloneDeep } from 'lodash-es';
+
+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;
+}
+/**
+ * A builder for TypeDoc configurations.
+ */ class ZTypedocConfigBuilder {
+    /**
+   * Sets the output directory for the documentation.
+   *
+   * @param path -
+   *        The output directory path.
+   * @returns
+   *        This object.
+   */ out(path) {
+        this.typedoc.out = path;
+        return this;
+    }
+    /**
+   * Adds a list of entry point glob to the existing entry points.
+   *
+   * @param glob -
+   *        The entry point glob pattern.
+   *
+   * @returns
+   *        This object.
+   */ entry(glob) {
+        const entry = this.typedoc.entryPoints || [];
+        this.typedoc.entryPoints = entry.concat(glob);
+        return this;
+    }
+    /**
+   * Sets the entry point strategy.
+   *
+   * See {@link https://typedoc.org/api/enums/EntryPointStrategy.html | EntryPointStrategy}
+   * for more details.
+   *
+   * @param strategy -
+   *        The entry point strategy to use.
+   *
+   * @returns
+   *        This object.
+   */ entryPointStrategy(strategy) {
+        this.typedoc.entryPointStrategy = strategy;
+        return this;
+    }
+    /**
+   * Sets the excludeNotDocumented flag.
+   *
+   * @returns
+   *        This object.
+   */ excludeNotDocumented() {
+        this.typedoc.excludeNotDocumented = true;
+        return this;
+    }
+    /**
+   * Sets the categorizeByGroup flag.
+   *
+   * @returns
+   *        This object.
+   */ categorizeByGroup() {
+        this.typedoc.categorizeByGroup = true;
+        return this;
+    }
+    /**
+   * Sets the name of the project.
+   *
+   * @param name -
+   *        The name of the project.
+   *
+   * @returns
+   *        This object.
+   */ name(name) {
+        this.typedoc.name = name;
+        return this;
+    }
+    /**
+   * Sets the favicon for the project.
+   *
+   * @param path -
+   *        The path to the favicon file.
+   *
+   * @returns
+   *        This object.
+   */ favicon(path) {
+        this.typedoc.favicon = path;
+        return this;
+    }
+    /**
+   * Adds a single exclude glob to the existing excludes.
+   *
+   * @param glob -
+   *        The exclude glob pattern.
+   *
+   * @returns
+   *        This object.
+   */ exclude(glob) {
+        const excludes = this.typedoc.exclude || [];
+        this.typedoc.exclude = excludes.concat(glob);
+        return this;
+    }
+    /**
+   * Sets the typedoc configuration to be used for an individual project.
+   *
+   * An individual project typedoc does not output any documentation by itself,
+   * but is part of a larger project that does.
+   *
+   * @returns
+   *        This object.
+   */ project() {
+        return this.resolve().dist();
+    }
+    /**
+   * Sets the typedoc configuration to be used a web project that outputs
+   * final documentation for a monorepo of packages.
+   *
+   * Normally, your monorepo will have a single web or doc project that outputs
+   * the typescript for every package in the monorepo.  Use this configuration
+   * for that project.
+   *
+   * @returns
+   *        This object.
+   */ web() {
+        return this.packages().excludeNotDocumented().categorizeByGroup().dist().exclude("./");
+    }
+    /**
+   * Builds the final typedoc configuration object.
+   *
+   * @returns
+   *        The final typedoc configuration object.
+   */ build() {
+        return cloneDeep(this.typedoc);
+    }
+    constructor(){
+        _define_property(this, "typedoc", {});
+        /**
+   * Sets the output directory to "./dist".
+   *
+   * @returns
+   *        This object.
+   */ _define_property(this, "dist", this.out.bind(this, ZTypedocConfigBuilder.OutputDist));
+        /**
+   * Adds an entry point for './src/index.ts'.
+   *
+   * @returns
+   *        This object.
+   */ _define_property(this, "index", this.entry.bind(this, ZTypedocConfigBuilder.EntryPointIndex));
+        /**
+   * Sets the entry point strategy to "resolve".
+   *
+   * @returns
+   *        This object.
+   */ _define_property(this, "resolve", this.entryPointStrategy.bind(this, "resolve"));
+        /**
+   * Sets the entry point strategy to "packages".
+   *
+   * @returns
+   *        This object.
+   */ _define_property(this, "packages", this.entryPointStrategy.bind(this, "packages"));
+    }
+}
+_define_property(ZTypedocConfigBuilder, "OutputDist", "./dist");
+_define_property(ZTypedocConfigBuilder, "EntryPointIndex", "./src/index.ts");
+
+export { ZTypedocConfigBuilder };
+//# sourceMappingURL=typedoc.js.map

package/dist/typedoc.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"typedoc.js","sources":["../src/typedoc/typedoc-config-builder.mts"],"sourcesContent":["import { cloneDeep } from \"lodash-es\";\nimport { EntryPointStrategy, TypeDocOptions } from \"typedoc\";\n\n/**\n * A builder for TypeDoc configurations.\n */\nexport class ZTypedocConfigBuilder {\n  public static readonly OutputDist = \"./dist\";\n  public static readonly EntryPointIndex = \"./src/index.ts\";\n\n  private typedoc: TypeDocOptions = {};\n\n  /**\n   * Sets the output directory for the documentation.\n   *\n   * @param path -\n   *        The output directory path.\n   * @returns\n   *        This object.\n   */\n  public out(path: string) {\n    this.typedoc.out = path;\n    return this;\n  }\n\n  /**\n   * Sets the output directory to \"./dist\".\n   *\n   * @returns\n   *        This object.\n   */\n  public dist = this.out.bind(this, ZTypedocConfigBuilder.OutputDist);\n\n  /**\n   * Adds a list of entry point glob to the existing entry points.\n   *\n   * @param glob -\n   *        The entry point glob pattern.\n   *\n   * @returns\n   *        This object.\n   */\n  public entry(glob: string | string) {\n    const entry = this.typedoc.entryPoints || [];\n    this.typedoc.entryPoints = entry.concat(glob);\n    return this;\n  }\n\n  /**\n   * Adds an entry point for './src/index.ts'.\n   *\n   * @returns\n   *        This object.\n   */\n  public index = this.entry.bind(this, ZTypedocConfigBuilder.EntryPointIndex);\n\n  /**\n   * Sets the entry point strategy.\n   *\n   * See {@link https://typedoc.org/api/enums/EntryPointStrategy.html | EntryPointStrategy}\n   * for more details.\n   *\n   * @param strategy -\n   *        The entry point strategy to use.\n   *\n   * @returns\n   *        This object.\n   */\n  public entryPointStrategy(strategy: EntryPointStrategy) {\n    this.typedoc.entryPointStrategy = strategy;\n    return this;\n  }\n\n  /**\n   * Sets the entry point strategy to \"resolve\".\n   *\n   * @returns\n   *        This object.\n   */\n  public resolve = this.entryPointStrategy.bind(this, \"resolve\");\n\n  /**\n   * Sets the entry point strategy to \"packages\".\n   *\n   * @returns\n   *        This object.\n   */\n  public packages = this.entryPointStrategy.bind(this, \"packages\");\n\n  /**\n   * Sets the excludeNotDocumented flag.\n   *\n   * @returns\n   *        This object.\n   */\n  public excludeNotDocumented() {\n    this.typedoc.excludeNotDocumented = true;\n    return this;\n  }\n\n  /**\n   * Sets the categorizeByGroup flag.\n   *\n   * @returns\n   *        This object.\n   */\n  public categorizeByGroup() {\n    this.typedoc.categorizeByGroup = true;\n    return this;\n  }\n\n  /**\n   * Sets the name of the project.\n   *\n   * @param name -\n   *        The name of the project.\n   *\n   * @returns\n   *        This object.\n   */\n  public name(name: string) {\n    this.typedoc.name = name;\n    return this;\n  }\n\n  /**\n   * Sets the favicon for the project.\n   *\n   * @param path -\n   *        The path to the favicon file.\n   *\n   * @returns\n   *        This object.\n   */\n  public favicon(path: string) {\n    this.typedoc.favicon = path;\n    return this;\n  }\n\n  /**\n   * Adds a single exclude glob to the existing excludes.\n   *\n   * @param glob -\n   *        The exclude glob pattern.\n   *\n   * @returns\n   *        This object.\n   */\n  public exclude(glob: string | string[]) {\n    const excludes = this.typedoc.exclude || [];\n    this.typedoc.exclude = excludes.concat(glob);\n    return this;\n  }\n\n  /**\n   * Sets the typedoc configuration to be used for an individual project.\n   *\n   * An individual project typedoc does not output any documentation by itself,\n   * but is part of a larger project that does.\n   *\n   * @returns\n   *        This object.\n   */\n  public project() {\n    return this.resolve().dist();\n  }\n\n  /**\n   * Sets the typedoc configuration to be used a web project that outputs\n   * final documentation for a monorepo of packages.\n   *\n   * Normally, your monorepo will have a single web or doc project that outputs\n   * the typescript for every package in the monorepo.  Use this configuration\n   * for that project.\n   *\n   * @returns\n   *        This object.\n   */\n  public web() {\n    return this.packages()\n      .excludeNotDocumented()\n      .categorizeByGroup()\n      .dist()\n      .exclude(\"./\");\n  }\n\n  /**\n   * Builds the final typedoc configuration object.\n   *\n   * @returns\n   *        The final typedoc configuration object.\n   */\n  public build() {\n    return cloneDeep(this.typedoc);\n  }\n}\n"],"names":["ZTypedocConfigBuilder","out","path","typedoc","entry","glob","entryPoints","concat","entryPointStrategy","strategy","excludeNotDocumented","categorizeByGroup","name","favicon","exclude","excludes","resolve","dist","packages","cloneDeep","bind","OutputDist","index","EntryPointIndex"],"mappings":";;;;;;;;;;;;;;;AAGA;;AAEC,IACM,MAAMA,qBAAAA,CAAAA;AAMX;;;;;;;MAQOC,GAAIC,CAAAA,IAAY,EAAE;AACvB,QAAA,IAAI,CAACC,OAAO,CAACF,GAAG,GAAGC,IAAAA;AACnB,QAAA,OAAO,IAAI;AACb;AAUA;;;;;;;;MASOE,KAAMC,CAAAA,IAAqB,EAAE;AAClC,QAAA,MAAMD,QAAQ,IAAI,CAACD,OAAO,CAACG,WAAW,IAAI,EAAE;AAC5C,QAAA,IAAI,CAACH,OAAO,CAACG,WAAW,GAAGF,KAAAA,CAAMG,MAAM,CAACF,IAAAA,CAAAA;AACxC,QAAA,OAAO,IAAI;AACb;AAUA;;;;;;;;;;;MAYOG,kBAAmBC,CAAAA,QAA4B,EAAE;AACtD,QAAA,IAAI,CAACN,OAAO,CAACK,kBAAkB,GAAGC,QAAAA;AAClC,QAAA,OAAO,IAAI;AACb;AAkBA;;;;;AAKC,MACD,oBAA8B,GAAA;AAC5B,QAAA,IAAI,CAACN,OAAO,CAACO,oBAAoB,GAAG,IAAA;AACpC,QAAA,OAAO,IAAI;AACb;AAEA;;;;;AAKC,MACD,iBAA2B,GAAA;AACzB,QAAA,IAAI,CAACP,OAAO,CAACQ,iBAAiB,GAAG,IAAA;AACjC,QAAA,OAAO,IAAI;AACb;AAEA;;;;;;;;MASOC,IAAKA,CAAAA,IAAY,EAAE;AACxB,QAAA,IAAI,CAACT,OAAO,CAACS,IAAI,GAAGA,IAAAA;AACpB,QAAA,OAAO,IAAI;AACb;AAEA;;;;;;;;MASOC,OAAQX,CAAAA,IAAY,EAAE;AAC3B,QAAA,IAAI,CAACC,OAAO,CAACU,OAAO,GAAGX,IAAAA;AACvB,QAAA,OAAO,IAAI;AACb;AAEA;;;;;;;;MASOY,OAAQT,CAAAA,IAAuB,EAAE;AACtC,QAAA,MAAMU,WAAW,IAAI,CAACZ,OAAO,CAACW,OAAO,IAAI,EAAE;AAC3C,QAAA,IAAI,CAACX,OAAO,CAACW,OAAO,GAAGC,QAAAA,CAASR,MAAM,CAACF,IAAAA,CAAAA;AACvC,QAAA,OAAO,IAAI;AACb;AAEA;;;;;;;;AAQC,MACD,OAAiB,GAAA;AACf,QAAA,OAAO,IAAI,CAACW,OAAO,EAAA,CAAGC,IAAI,EAAA;AAC5B;AAEA;;;;;;;;;;AAUC,MACD,GAAa,GAAA;QACX,OAAO,IAAI,CAACC,QAAQ,EACjBR,CAAAA,oBAAoB,EACpBC,CAAAA,iBAAiB,EACjBM,CAAAA,IAAI,EACJH,CAAAA,OAAO,CAAC,IAAA,CAAA;AACb;AAEA;;;;;AAKC,MACD,KAAe,GAAA;QACb,OAAOK,SAAAA,CAAU,IAAI,CAAChB,OAAO,CAAA;AAC/B;;AAxLA,QAAA,gBAAA,CAAA,IAAA,EAAQA,WAA0B,EAAC,CAAA;AAenC;;;;;MAMA,gBAAA,CAAA,IAAA,EAAOc,MAAO,EAAA,IAAI,CAAChB,GAAG,CAACmB,IAAI,CAAC,IAAI,EAAEpB,qBAAAA,CAAsBqB,UAAU,CAAA,CAAA;AAiBlE;;;;;MAMA,gBAAA,CAAA,IAAA,EAAOC,OAAQ,EAAA,IAAI,CAAClB,KAAK,CAACgB,IAAI,CAAC,IAAI,EAAEpB,qBAAAA,CAAsBuB,eAAe,CAAA,CAAA;AAmB1E;;;;;MAMA,gBAAA,CAAA,IAAA,EAAOP,WAAU,IAAI,CAACR,kBAAkB,CAACY,IAAI,CAAC,IAAI,EAAE,SAAA,CAAA,CAAA;AAEpD;;;;;MAMA,gBAAA,CAAA,IAAA,EAAOF,YAAW,IAAI,CAACV,kBAAkB,CAACY,IAAI,CAAC,IAAI,EAAE,UAAA,CAAA,CAAA;;AA4GvD;AA5LE,gBAAA,CADWpB,uBACYqB,YAAa,EAAA,QAAA,CAAA;AACpC,gBAAA,CAFWrB,uBAEYuB,iBAAkB,EAAA,gBAAA,CAAA;;;;"}

package/dist/vite/index.d.ts

@@ -0,0 +1,3 @@
+export * from './vite-config-builder.mjs';
+export * from './vite-library-builder.mjs';
+export * from './vite-test-builder.mjs';

package/dist/vite/vite-config-builder.d.mts

@@ -0,0 +1,92 @@
+import { LibraryOptions, UserConfig } from 'vite';
+import { InlineConfig as TestConfig } from 'vitest/node.js';
+/**
+ * A config builder for the vite build system.
+ *
+ * This is helpful when building different types
+ * of projects and keeping a standard.
+ *
+ * @example vite.config.ts
+ *
+ * ```ts
+ * // Before Config Builder
+ * export default defineConfig({
+ *  build: {
+ *     lib: {
+ *       entry: {
+ *         index: "./src/index.ts",
+ *       },
+ *       formats: ["cjs", "es"],
+ *     },
+ *   },
+ *   minify: false,
+ *   sourceMap: true,
+ *   plugins: [
+ *     swc.vite(),
+ *     tsConfigPaths(),
+ *     externalizeDeps(),
+ *     dtsPlugin({
+ *       compilerOptions: {
+ *         paths: {},
+ *       },
+ *     }),
+ *   ],
+ * });
+ * ```
+ *
+ * ```ts
+ * // After config builder
+ * const config = new ZViteConfigBuilder().library().build();
+ * export default defineConfig(config);
+ * ```
+ */
+export declare class ZViteConfigBuilder {
+    private _dirname;
+    private config;
+    /**
+     * Initializes a new instance of this object.
+     *
+     * @param _dirname -
+     *        The directory that is housing the vite.config
+     *        file.  Pass __dirname to this.
+     */
+    constructor(_dirname: string);
+    /**
+     * Sets vite into library mode.
+     *
+     * @param options -
+     *        The options for the library.  You can set this to
+     *        nothing to use the default library which looks for
+     *        an entry point at the source directory called index.ts
+     *
+     * @see {@link ZViteLibraryBuilder} for more information.
+     *
+     * @returns
+     *        This object.
+     */
+    library(options?: LibraryOptions): this;
+    /**
+     * Constructs the config to act as if it's compiling a node application.
+     *
+     * This is just an alias to {@link ZViteConfigBuilder.library} with two
+     * entry points.
+     *
+     * 1. The file src/cli.ts is the main entry point of the application.
+     * 1. The file, src/index.ts, is the api for importing
+     *
+     * @returns
+     *        This object.
+     */
+    cli(): this;
+    /**
+     * Constructs the config to be for testing.
+     */
+    test(options?: TestConfig): this;
+    /**
+     * Returns the currently built config.
+     *
+     * @returns
+     *        The currently built config.
+     */
+    build(): UserConfig;
+}

package/dist/vite/vite-config-builder.spec.d.ts

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