@rnx-kit/config - npm Package Compare versions

Comparing version 0.2.9 to 0.3.0

CHANGELOG.json

@@ -5,6 +5,141 @@ {
     {
-      "date": "Fri, 04 Jun 2021 12:36:23 GMT",
+      "date": "Mon, 12 Jul 2021 07:51:21 GMT",
+      "tag": "@rnx-kit/config_v0.3.0",
+      "version": "0.3.0",
+      "comments": {
+        "minor": [
+          {
+            "comment": "Bump @rnx-kit/config to v0.3.0",
+            "author": "[e-mail]",
+            "commit": "021cfdb3fe726b76a377b2a6cccbe16a6999bf7a",
+            "package": "@rnx-kit/config"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Sat, 10 Jul 2021 07:28:45 GMT",
       "tag": "@rnx-kit/config_v0.2.9",
       "version": "0.2.9",
       "comments": {
+        "none": [
+          {
+            "comment": "Added `format` script",
+            "author": "[e-mail]",
+            "commit": "eaedb2cae443a479e131cfd71fab5c1039daca9d",
+            "package": "@rnx-kit/config"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Sat, 10 Jul 2021 07:28:25 GMT",
+      "tag": "@rnx-kit/config_v0.2.9",
+      "version": "0.2.9",
+      "comments": {
+        "none": [
+          {
+            "comment": "Added `format` script",
+            "author": "[e-mail]",
+            "commit": "12196abcec79794493615829c3783d35f5bfc364",
+            "package": "@rnx-kit/config"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Fri, 09 Jul 2021 12:23:47 GMT",
+      "tag": "@rnx-kit/config_v0.2.9",
+      "version": "0.2.9",
+      "comments": {
+        "none": [
+          {
+            "comment": "Add badges for build status and version",
+            "author": "[e-mail]",
+            "commit": "2dc9fe456410eed10abbfa464ae7aa7e5cef7aef",
+            "package": "@rnx-kit/config"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Fri, 09 Jul 2021 12:23:07 GMT",
+      "tag": "@rnx-kit/config_v0.2.9",
+      "version": "0.2.9",
+      "comments": {
+        "none": [
+          {
+            "comment": "Add badges for build status and version",
+            "author": "[e-mail]",
+            "commit": "f3ff6e5f5c20cf9e8c81ca25a4fae3f483925c59",
+            "package": "@rnx-kit/config"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Tue, 29 Jun 2021 06:01:48 GMT",
+      "tag": "@rnx-kit/config_v0.2.9",
+      "version": "0.2.9",
+      "comments": {
+        "none": [
+          {
+            "comment": "Update type definitions",
+            "author": "[e-mail]",
+            "commit": "0608b0120730c5cf0a78dd8bed80c18083851011",
+            "package": "@rnx-kit/config"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Wed, 23 Jun 2021 17:39:16 GMT",
+      "tag": "@rnx-kit/config_v0.2.9",
+      "version": "0.2.9",
+      "comments": {
+        "none": [
+          {
+            "comment": "Bumped @types/node to 14.17.4",
+            "author": "[e-mail]",
+            "commit": "41bc87cda7c7c74084abf9f3f8039b0b670ab6ba",
+            "package": "@rnx-kit/config"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Wed, 23 Jun 2021 17:38:46 GMT",
+      "tag": "@rnx-kit/config_v0.2.9",
+      "version": "0.2.9",
+      "comments": {
+        "none": [
+          {
+            "comment": "Bumped @types/node to 14.17.4",
+            "author": "[e-mail]",
+            "commit": "c630c871d6747cb6631070f6f8ccba8d8933b353",
+            "package": "@rnx-kit/config"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Wed, 23 Jun 2021 09:28:25 GMT",
+      "tag": "@rnx-kit/config_v0.2.9",
+      "version": "0.2.9",
+      "comments": {
+        "none": [
+          {
+            "comment": "Added ESLint config",
+            "author": "[e-mail]",
+            "commit": "4701f7a40c050f8d376fbcfc84ce6e50f5fcf501",
+            "package": "@rnx-kit/config"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Fri, 04 Jun 2021 12:36:37 GMT",
+      "tag": "@rnx-kit/config_v0.2.9",
+      "version": "0.2.9",
+      "comments": {
         "patch": [
@@ -11,0 +146,0 @@ {

CHANGELOG.md

 # Change Log - @rnx-kit/config
 
-This log was last generated on Fri, 04 Jun 2021 12:36:23 GMT and should not be manually modified.
+This log was last generated on Mon, 12 Jul 2021 07:51:21 GMT and should not be manually modified.
 
 <!-- Start content -->
 
+## 0.3.0
+
+Mon, 12 Jul 2021 07:51:21 GMT
+
+### Minor changes
+
+- Bump @rnx-kit/config to v0.3.0 ([e-mail])
+
 ## 0.2.9
 
-Fri, 04 Jun 2021 12:36:23 GMT
+Fri, 04 Jun 2021 12:36:37 GMT
 
@@ -11,0 +19,0 @@ ### Patches

lib/bundleConfig.d.ts

@@ -0,1 +1,4 @@
+import type { OutputOptions } from "metro";
+import type { PluginOptions as CyclicDetectorOptions } from "@rnx-kit/metro-plugin-cyclic-dependencies-detector";
+import type { Options as DuplicateDetectorOptions } from "@rnx-kit/metro-plugin-duplicates-checker";
 /**
@@ -37,10 +40,38 @@ * List of supported kit platforms.
     bundlePrefix: string;
+    /**
+     * Choose whether to detect cycles in the dependency graph. If true, then a default set
+     * of options will be used. Otherwise the object allows for fine-grained control over
+     * the detection process.
+     *
+     * @default true
+     */
+    detectCyclicDependencies: boolean | CyclicDetectorOptions;
+    /**
+     * Choose whether to detect duplicate packages in the dependency graph.
+     *
+     * A duplicate error happens when a package is imported from two or more unique paths,
+     * even if the versions are all the same. Duplicate packages increase bundle size and
+     * can lead to unexpected errors.
+     *
+     * If true, then a default set of options will be used. Otherwise the object allows for
+     * fine-grained control over the detection process.
+     *
+     * @default true
+     */
+    detectDuplicateDependencies: boolean | DuplicateDetectorOptions;
+    /**
+     * Choose whether to type-check source files using TypeScript.
+     *
+     * @default true
+     */
+    typescriptValidation: boolean;
 };
 export declare type BundleParameters = Partial<BundleRequiredParameters> & {
     /**
-     * Encoding scheme to use when writing the bundle file.
+     * Encoding scheme to use when writing the bundle file. Currently limited
+     * to UTF-8, UTF-16 (little endian), and 7-bit ASCII.
      *
      * @see "https://nodejs.org/api/buffer.html#buffer_buffers_and_character_encodings"
      */
-    bundleEncoding?: string;
+    bundleEncoding?: OutputOptions["bundleEncoding"];
     /**
@@ -47,0 +78,0 @@ * Path to use when creating the bundle source map file.

lib/getBundleDefinition.d.ts

 import type { AllPlatforms, BundleConfig, BundleDefinition, BundleRequiredParameters } from "./bundleConfig";
-declare type BundleDefinitionWithRequiredParameters = BundleDefinition & BundleRequiredParameters;
+export declare type BundleDefinitionWithRequiredParameters = BundleDefinition & BundleRequiredParameters;
 /**
@@ -22,3 +22,2 @@ * Get a bundle definition from the kit config.
 export declare function getBundlePlatformDefinition(bundle: BundleDefinitionWithRequiredParameters, platform: AllPlatforms): BundleDefinitionWithRequiredParameters;
-export {};
 //# sourceMappingURL=getBundleDefinition.d.ts.map

lib/getBundleDefinition.js

@@ -23,2 +23,5 @@ "use strict";
         bundlePrefix: "index",
+        detectCyclicDependencies: true,
+        detectDuplicateDependencies: true,
+        typescriptValidation: true,
     };
@@ -25,0 +28,0 @@ if (typeof config === "boolean") {

package.json

 {
   "name": "@rnx-kit/config",
-  "version": "0.2.9",
+  "version": "0.3.0",
   "description": "Package for defining and querying information about rnx kits",
+  "license": "MIT",
   "main": "./lib/index.js",
@@ -10,2 +11,3 @@ "types": "./lib/index.d.ts",
     "depcheck": "rnx-kit-scripts depcheck",
+    "format": "rnx-kit-scripts format",
     "lint": "rnx-kit-scripts lint",
@@ -19,9 +21,17 @@ "test": "rnx-kit-scripts test"
   "devDependencies": {
-    "@types/jest": "^26.0.0",
-    "@types/node": "^14.14.20",
+    "@rnx-kit/metro-plugin-cyclic-dependencies-detector": "*",
+    "@rnx-kit/metro-plugin-duplicates-checker": "*",
+    "@types/metro": "*",
+    "@types/node": "^14.15.0",
     "@types/semver": "^7.0.0",
     "rnx-kit-scripts": "0.1.1"
   },
-  "author": "",
-  "license": "MIT",
+  "depcheck": {
+    "ignoreMatches": [
+      "metro"
+    ]
+  },
+  "eslintConfig": {
+    "extends": "@rnx-kit/eslint-config"
+  },
   "jest": {
@@ -28,0 +38,0 @@ "preset": "ts-jest",

README.md

 # @rnx-kit/config
 
+[![Build](https://github.com/microsoft/rnx-kit/actions/workflows/build.yml/badge.svg)](https://github.com/microsoft/rnx-kit/actions/workflows/build.yml)
+[![npm version](https://img.shields.io/npm/v/@rnx-kit/config)](https://www.npmjs.com/package/@rnx-kit/config)
+
 A package for configuring and extracting configuration information about
@@ -4,0 +7,0 @@ rnx-kits.

src/bundleConfig.ts

@@ -0,1 +1,5 @@
+import type { OutputOptions } from "metro";
+import type { PluginOptions as CyclicDetectorOptions } from "@rnx-kit/metro-plugin-cyclic-dependencies-detector";
+import type { Options as DuplicateDetectorOptions } from "@rnx-kit/metro-plugin-duplicates-checker";
+
 /**
@@ -41,2 +45,32 @@ * List of supported kit platforms.
   bundlePrefix: string;
+
+  /**
+   * Choose whether to detect cycles in the dependency graph. If true, then a default set
+   * of options will be used. Otherwise the object allows for fine-grained control over
+   * the detection process.
+   *
+   * @default true
+   */
+  detectCyclicDependencies: boolean | CyclicDetectorOptions;
+
+  /**
+   * Choose whether to detect duplicate packages in the dependency graph.
+   *
+   * A duplicate error happens when a package is imported from two or more unique paths,
+   * even if the versions are all the same. Duplicate packages increase bundle size and
+   * can lead to unexpected errors.
+   *
+   * If true, then a default set of options will be used. Otherwise the object allows for
+   * fine-grained control over the detection process.
+   *
+   * @default true
+   */
+  detectDuplicateDependencies: boolean | DuplicateDetectorOptions;
+
+  /**
+   * Choose whether to type-check source files using TypeScript.
+   *
+   * @default true
+   */
+  typescriptValidation: boolean;
 };
@@ -46,7 +80,8 @@
   /**
-   * Encoding scheme to use when writing the bundle file.
+   * Encoding scheme to use when writing the bundle file. Currently limited
+   * to UTF-8, UTF-16 (little endian), and 7-bit ASCII.
    *
    * @see "https://nodejs.org/api/buffer.html#buffer_buffers_and_character_encodings"
    */
-  bundleEncoding?: string;
+  bundleEncoding?: OutputOptions["bundleEncoding"];
 
@@ -53,0 +88,0 @@ /**

src/getBundleDefinition.ts

@@ -8,3 +8,3 @@ import type {
 
-type BundleDefinitionWithRequiredParameters = BundleDefinition &
+export type BundleDefinitionWithRequiredParameters = BundleDefinition &
   BundleRequiredParameters;
@@ -35,2 +35,5 @@
     bundlePrefix: "index",
+    detectCyclicDependencies: true,
+    detectDuplicateDependencies: true,
+    typescriptValidation: true,
   };
@@ -37,0 +40,0 @@ if (typeof config === "boolean") {

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

No contributors or author data

Maintenance

Package does not specify a list of contributors or an author in package.json.

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

72489

increased by12.18%

Lines of code

1471

increased by15.92%

Number of lines in readme file

44

increased by7.32%

Worsened metrics

Dev dependency count

6

increased by50%

No dependency changes