@fluidframework/core-utils - npm Package Compare versions

Comparing version 2.0.0-internal.6.2.0 to 2.0.0-internal.6.3.0

.eslintrc.js

@@ -22,3 +22,3 @@ /*!
 				// Test files are run in node only so additional node libraries can be used.
-				"import/no-nodejs-modules": ["error", { allow: ["assert", "events"] }],
+				"import/no-nodejs-modules": ["error", { allow: ["assert", "events", "process"] }],
 			},
@@ -25,0 +25,0 @@ },

CHANGELOG.md

 # @fluidframework/core-utils
 
+## 2.0.0-internal.6.3.0
+
+Dependency updates only.
+
 ## 2.0.0-internal.6.2.0
@@ -4,0 +8,0 @@

dist/index.d.ts

@@ -5,5 +5,11 @@ /*!
  */
+export { assert } from "./assert";
 export { compareArrays } from "./compare";
+export { delay } from "./delay";
+export { Heap, IComparer, IHeapNode, NumberComparer } from "./heap";
 export { Lazy, LazyPromise } from "./lazy";
 export { PromiseCache, PromiseCacheExpiry, PromiseCacheOptions } from "./promiseCache";
+export { Deferred } from "./promises";
+export { IPromiseTimer, IPromiseTimerResult, ITimer, PromiseTimer, setLongTimeout, Timer, } from "./timer";
+export { unreachableCase } from "./unreachable";
 //# sourceMappingURL=index.d.ts.map

dist/index.js

@@ -7,5 +7,12 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PromiseCache = exports.LazyPromise = exports.Lazy = exports.compareArrays = void 0;
+exports.unreachableCase = exports.Timer = exports.setLongTimeout = exports.PromiseTimer = exports.Deferred = exports.PromiseCache = exports.LazyPromise = exports.Lazy = exports.NumberComparer = exports.Heap = exports.delay = exports.compareArrays = exports.assert = void 0;
+var assert_1 = require("./assert");
+Object.defineProperty(exports, "assert", { enumerable: true, get: function () { return assert_1.assert; } });
 var compare_1 = require("./compare");
 Object.defineProperty(exports, "compareArrays", { enumerable: true, get: function () { return compare_1.compareArrays; } });
+var delay_1 = require("./delay");
+Object.defineProperty(exports, "delay", { enumerable: true, get: function () { return delay_1.delay; } });
+var heap_1 = require("./heap");
+Object.defineProperty(exports, "Heap", { enumerable: true, get: function () { return heap_1.Heap; } });
+Object.defineProperty(exports, "NumberComparer", { enumerable: true, get: function () { return heap_1.NumberComparer; } });
 var lazy_1 = require("./lazy");
@@ -16,2 +23,10 @@ Object.defineProperty(exports, "Lazy", { enumerable: true, get: function () { return lazy_1.Lazy; } });
 Object.defineProperty(exports, "PromiseCache", { enumerable: true, get: function () { return promiseCache_1.PromiseCache; } });
+var promises_1 = require("./promises");
+Object.defineProperty(exports, "Deferred", { enumerable: true, get: function () { return promises_1.Deferred; } });
+var timer_1 = require("./timer");
+Object.defineProperty(exports, "PromiseTimer", { enumerable: true, get: function () { return timer_1.PromiseTimer; } });
+Object.defineProperty(exports, "setLongTimeout", { enumerable: true, get: function () { return timer_1.setLongTimeout; } });
+Object.defineProperty(exports, "Timer", { enumerable: true, get: function () { return timer_1.Timer; } });
+var unreachable_1 = require("./unreachable");
+Object.defineProperty(exports, "unreachableCase", { enumerable: true, get: function () { return unreachable_1.unreachableCase; } });
 //# sourceMappingURL=index.js.map

lib/index.d.ts

@@ -5,5 +5,11 @@ /*!
  */
+export { assert } from "./assert";
 export { compareArrays } from "./compare";
+export { delay } from "./delay";
+export { Heap, IComparer, IHeapNode, NumberComparer } from "./heap";
 export { Lazy, LazyPromise } from "./lazy";
 export { PromiseCache, PromiseCacheExpiry, PromiseCacheOptions } from "./promiseCache";
+export { Deferred } from "./promises";
+export { IPromiseTimer, IPromiseTimerResult, ITimer, PromiseTimer, setLongTimeout, Timer, } from "./timer";
+export { unreachableCase } from "./unreachable";
 //# sourceMappingURL=index.d.ts.map

lib/index.js

@@ -5,5 +5,11 @@ /*!
  */
+export { assert } from "./assert";
 export { compareArrays } from "./compare";
+export { delay } from "./delay";
+export { Heap, NumberComparer } from "./heap";
 export { Lazy, LazyPromise } from "./lazy";
 export { PromiseCache } from "./promiseCache";
+export { Deferred } from "./promises";
+export { PromiseTimer, setLongTimeout, Timer, } from "./timer";
+export { unreachableCase } from "./unreachable";
 //# sourceMappingURL=index.js.map

package.json

 {
   "name": "@fluidframework/core-utils",
-  "version": "2.0.0-internal.6.2.0",
+  "version": "2.0.0-internal.6.3.0",
   "description": "Not intended for use outside the Fluid client repo.",
@@ -17,3 +17,3 @@ "homepage": "https://fluidframework.com",
   "types": "dist/index.d.ts",
-  "nyc": {
+  "c8": {
     "all": true,
@@ -40,7 +40,7 @@ "cache-dir": "nyc/.cache",
     "@fluid-tools/benchmark": "^0.47.0",
-    "@fluid-tools/build-cli": "^0.23.0",
+    "@fluid-tools/build-cli": "^0.22.0",
     "@fluidframework/build-common": "^2.0.0",
-    "@fluidframework/build-tools": "^0.23.0",
+    "@fluidframework/build-tools": "^0.22.0",
     "@fluidframework/eslint-config-fluid": "^2.1.0",
-    "@fluidframework/mocha-test-setup": ">=2.0.0-internal.6.2.0 <2.0.0-internal.6.3.0",
+    "@fluidframework/mocha-test-setup": ">=2.0.0-internal.6.3.0 <2.0.0-internal.6.4.0",
     "@microsoft/api-extractor": "^7.34.4",
@@ -50,3 +50,3 @@ "@types/mocha": "^9.1.1",
     "@types/sinon": "^7.0.13",
-    "concurrently": "^7.6.0",
+    "c8": "^7.7.1",
     "copyfiles": "^2.4.1",
@@ -60,3 +60,2 @@ "cross-env": "^7.0.3",
     "moment": "^2.21.0",
-    "nyc": "^15.1.0",
     "prettier": "~2.6.2",
@@ -82,3 +81,3 @@ "rimraf": "^4.4.0",
     "ci:build:docs": "api-extractor run --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/* ../../../_api-extractor-temp/",
-    "clean": "rimraf --glob \"dist\" \"lib\" \"*.tsbuildinfo\" \"*.build.log\"",
+    "clean": "rimraf --glob 'dist' 'lib' '*.tsbuildinfo' '*.build.log' '_api-extractor-temp' 'nyc'",
     "eslint": "eslint --format stylish src",
@@ -93,5 +92,4 @@ "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
     "test:benchmark:report": "mocha --node-option unhandled-rejections=strict,expose-gc --exit --perfMode --fgrep @Benchmark --reporter @fluid-tools/benchmark/dist/MochaReporter.js --timeout 60000",
-    "test:coverage": "nyc npm test -- --reporter xunit --reporter-option output=nyc/junit-report.xml",
+    "test:coverage": "c8 npm test",
     "test:mocha": "mocha",
-    "test:mocha:multireport": "npm run test:mocha",
     "test:mocha:verbose": "cross-env FLUID_TEST_VERBOSE=1 npm run test:mocha",
@@ -98,0 +96,0 @@ "tsc": "tsc",

README.md

 # @fluidframework/core-utils
 
-Intended for internally sharing/promoting best-practice implementations of Fluid agnostic utility functions across packages in the client repo.
+This package is intended for sharing and promoting best-practice implementations of Fluid-agnostic utility functions
+across packages in the Fluid Framework repo.
 
-Use outside of the Fluid Framework client repo is not supported or recommended.
+Use outside of the Fluid Framework repo is not supported or recommended.
 
-All exports must be designated @internal. This package must not depend on other packages.
+## Adding code to this package
 
+As a utility package, this package does not have a strong identity. This means that it's easy to become a "dumping
+ground" for code that we think we should share but doesn't have an obvious home. We try to avoid dumping things into
+utility packages, and this one is no exception.
+
+New code should only be added to this package in rare circumstances. In most cases, the code would be better placed in a
+package with a clear identity (e.g. an "events" package for shared event infrastructure) or not shared at all.
+
+## Requirements
+
+This package has important requirements for the code within it.
+
+1. **Code in this package must have zero dependencies.** That is, it must not depend on other packages, even within the
+   Fluid Framework repo. `devDependencies` are OK.
+1. **All exports must be designated `@internal`.** This code is intended for use within the Fluid Framework only.
+1. This package should **only contain 'implementation' code, not type definitions.** This is the most flexible rule, and
+   there are some exceptions. If the type is _only_ necessary when using this package, then it is probably OK. However,
+   usually such types would be better placed in core-interfaces or in a package that corresponds to the purpose.
+
+If you want to add code that does not meet these requirements, these other packages may be a better choice:
+
+-   **Types and interfaces** that are intended to be broadly shared across the client release group should be put in the
+    **core-interfaces** package.
+-   **Shared implementation code with dependencies** should be put in the **client-utils** package.
+
 <!-- AUTO-GENERATED-CONTENT:START (README_DEPENDENCY_GUIDELINES_SECTION:includeHeading=TRUE) -->
@@ -10,0 +35,0 @@

src/index.ts

@@ -6,4 +6,17 @@ /*!
 
+export { assert } from "./assert";
 export { compareArrays } from "./compare";
+export { delay } from "./delay";
+export { Heap, IComparer, IHeapNode, NumberComparer } from "./heap";
 export { Lazy, LazyPromise } from "./lazy";
 export { PromiseCache, PromiseCacheExpiry, PromiseCacheOptions } from "./promiseCache";
+export { Deferred } from "./promises";
+export {
+	IPromiseTimer,
+	IPromiseTimerResult,
+	ITimer,
+	PromiseTimer,
+	setLongTimeout,
+	Timer,
+} from "./timer";
+export { unreachableCase } from "./unreachable";

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

216822

increased by138.44%

Dev dependency count

24

decreased by-4%

Number of package files

101

increased by114.89%

Lines of code

3099

increased by168.08%

Number of lines in readme file

72

increased by53.19%

No dependency changes