@tapjs/config - npm Package Compare versions

Comparing version 2.0.0-11 to 2.0.0-12

dist/cjs/index.d.ts

@@ -16,3 +16,3 @@ /**
  *
- * Typically, {@link TapConfig.load} is the way to get one of
+ * Typically, {@link @tapjs/config!index.TapConfig.load} is the way to get one of
  * these.
@@ -67,2 +67,6 @@ */
     loadPluginConfigFields(): TapConfig<C & import("jackspeak").ConfigSetFromMetaSet<"boolean", false, {
+        /**
+         * Add fields to the config set. Used when loading plugins that export
+         * a `config` object.
+         */
         only: {
@@ -80,3 +84,6 @@ type: string;
         } & {
-            multiple?: false | undefined;
+            multiple?: false | undefined; /**
+             * load the file, and write the fields in data. If the file is not present,
+             * create it.
+             */
             delim?: undefined;
@@ -173,3 +180,5 @@ };
             type: "boolean";
-            short?: string | undefined;
+            short?: string | undefined; /**
+             * Read the configuration from the `"tap"` object in a package.json file
+             */
             default?: boolean | undefined;
@@ -256,3 +265,3 @@ description?: string | undefined;
      * Load the configuration and return a Promise to a
-     * {@link TapConfig} object
+     * {@link @tapjs/config!index.TapConfig} object
      */
@@ -262,5 +271,6 @@ static load(): Promise<LoadedConfig>;
 /**
- * A fully loaded {@link TapConfig} object
+ * A fully loaded {@link @tapjs/config!index.TapConfig} object
  */
-export type LoadedConfig = ReturnType<ReturnType<Awaited<ReturnType<Awaited<ReturnType<ReturnType<TapConfig['loadPluginConfigFields']>['loadConfigFile']>>['loadColor']>>['loadReporter']>['parse']>;
+export interface LoadedConfig extends ReturnType<ReturnType<Awaited<ReturnType<Awaited<ReturnType<ReturnType<TapConfig['loadPluginConfigFields']>['loadConfigFile']>>['loadColor']>>['loadReporter']>['parse']> {
+}
 //# sourceMappingURL=index.d.ts.map

dist/cjs/index.js

@@ -26,3 +26,3 @@ "use strict";
  *
- * Typically, {@link TapConfig.load} is the way to get one of
+ * Typically, {@link @tapjs/config!index.TapConfig.load} is the way to get one of
  * these.
@@ -372,3 +372,3 @@ */
      * Load the configuration and return a Promise to a
-     * {@link TapConfig} object
+     * {@link @tapjs/config!index.TapConfig} object
      */
@@ -375,0 +375,0 @@ static async load() {

dist/mjs/index.d.ts

@@ -16,3 +16,3 @@ /**
  *
- * Typically, {@link TapConfig.load} is the way to get one of
+ * Typically, {@link @tapjs/config!index.TapConfig.load} is the way to get one of
  * these.
@@ -67,2 +67,6 @@ */
     loadPluginConfigFields(): TapConfig<C & import("jackspeak").ConfigSetFromMetaSet<"boolean", false, {
+        /**
+         * Add fields to the config set. Used when loading plugins that export
+         * a `config` object.
+         */
         only: {
@@ -80,3 +84,6 @@ type: string;
         } & {
-            multiple?: false | undefined;
+            multiple?: false | undefined; /**
+             * load the file, and write the fields in data. If the file is not present,
+             * create it.
+             */
             delim?: undefined;
@@ -173,3 +180,5 @@ };
             type: "boolean";
-            short?: string | undefined;
+            short?: string | undefined; /**
+             * Read the configuration from the `"tap"` object in a package.json file
+             */
             default?: boolean | undefined;
@@ -256,3 +265,3 @@ description?: string | undefined;
      * Load the configuration and return a Promise to a
-     * {@link TapConfig} object
+     * {@link @tapjs/config!index.TapConfig} object
      */
@@ -262,5 +271,6 @@ static load(): Promise<LoadedConfig>;
 /**
- * A fully loaded {@link TapConfig} object
+ * A fully loaded {@link @tapjs/config!index.TapConfig} object
  */
-export type LoadedConfig = ReturnType<ReturnType<Awaited<ReturnType<Awaited<ReturnType<ReturnType<TapConfig['loadPluginConfigFields']>['loadConfigFile']>>['loadColor']>>['loadReporter']>['parse']>;
+export interface LoadedConfig extends ReturnType<ReturnType<Awaited<ReturnType<Awaited<ReturnType<ReturnType<TapConfig['loadPluginConfigFields']>['loadConfigFile']>>['loadColor']>>['loadReporter']>['parse']> {
+}
 //# sourceMappingURL=index.d.ts.map

dist/mjs/index.js

@@ -20,3 +20,3 @@ /**
  *
- * Typically, {@link TapConfig.load} is the way to get one of
+ * Typically, {@link @tapjs/config!index.TapConfig.load} is the way to get one of
  * these.
@@ -366,3 +366,3 @@ */
      * Load the configuration and return a Promise to a
-     * {@link TapConfig} object
+     * {@link @tapjs/config!index.TapConfig} object
      */
@@ -369,0 +369,0 @@ static async load() {

package.json

 {
   "name": "@tapjs/config",
-  "version": "2.0.0-11",
+  "version": "2.0.0-12",
   "description": "Utility loading and managing tap configuration",
@@ -37,4 +37,4 @@ "author": "Isaac Z. Schlueter <[e-mail]> (https://blog.izs.me)",
   "peerDependencies": {
-    "@tapjs/core": "0.0.0-11",
-    "@tapjs/test": "0.0.0-11"
+    "@tapjs/core": "0.0.0-12",
+    "@tapjs/test": "0.0.0-12"
   },
@@ -41,0 +41,0 @@ "dependencies": {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

214676

increased by0.59%

Lines of code

2749

increased by0.73%

No dependency changes