From ed04f054c8b04733c123995c5a5263c98a1ac21a Mon Sep 17 00:00:00 2001 From: "Mark S. Miller" Date: Fri, 12 Jan 2024 18:31:56 -0800 Subject: [PATCH] fix: review suggestions --- packages/{utils => common}/LICENSE | 0 packages/{utils => common}/NEWS.md | 0 packages/{utils => common}/README.md | 0 packages/{utils => common}/SECURITY.md | 0 packages/common/index.js | 1 + packages/{utils => common}/package.json | 2 +- packages/{utils/src/utils.js => common/src/common.js} | 4 ++-- packages/{utils => common}/test/prepare-test-env-ava.js | 0 packages/common/test/test-index.js | 5 +++++ packages/{utils => common}/tsconfig.build.json | 0 packages/{utils => common}/tsconfig.json | 0 packages/exo/package.json | 2 +- packages/exo/src/exo-makers.js | 2 +- packages/exo/src/exo-tools.js | 2 +- packages/patterns/index.js | 6 +++--- packages/patterns/package.json | 2 +- packages/patterns/src/keys/checkKey.js | 2 +- packages/patterns/src/keys/keycollection-operators.js | 2 +- packages/patterns/src/patterns/patternMatchers.js | 2 +- packages/utils/index.js | 1 - packages/utils/test/test-index.js | 5 ----- 21 files changed, 19 insertions(+), 19 deletions(-) rename packages/{utils => common}/LICENSE (100%) rename packages/{utils => common}/NEWS.md (100%) rename packages/{utils => common}/README.md (100%) rename packages/{utils => common}/SECURITY.md (100%) create mode 100644 packages/common/index.js rename packages/{utils => common}/package.json (98%) rename packages/{utils/src/utils.js => common/src/common.js} (99%) rename packages/{utils => common}/test/prepare-test-env-ava.js (100%) create mode 100644 packages/common/test/test-index.js rename packages/{utils => common}/tsconfig.build.json (100%) rename packages/{utils => common}/tsconfig.json (100%) delete mode 100644 packages/utils/index.js delete mode 100644 packages/utils/test/test-index.js diff --git a/packages/utils/LICENSE b/packages/common/LICENSE similarity index 100% rename from packages/utils/LICENSE rename to packages/common/LICENSE diff --git a/packages/utils/NEWS.md b/packages/common/NEWS.md similarity index 100% rename from packages/utils/NEWS.md rename to packages/common/NEWS.md diff --git a/packages/utils/README.md b/packages/common/README.md similarity index 100% rename from packages/utils/README.md rename to packages/common/README.md diff --git a/packages/utils/SECURITY.md b/packages/common/SECURITY.md similarity index 100% rename from packages/utils/SECURITY.md rename to packages/common/SECURITY.md diff --git a/packages/common/index.js b/packages/common/index.js new file mode 100644 index 0000000000..07112a93f4 --- /dev/null +++ b/packages/common/index.js @@ -0,0 +1 @@ +export * from './src/common.js'; diff --git a/packages/utils/package.json b/packages/common/package.json similarity index 98% rename from packages/utils/package.json rename to packages/common/package.json index 101fd4dd7a..d3b6eec79e 100644 --- a/packages/utils/package.json +++ b/packages/common/package.json @@ -1,5 +1,5 @@ { - "name": "@endo/utils", + "name": "@endo/common", "version": "1.0.1", "private": true, "description": null, diff --git a/packages/utils/src/utils.js b/packages/common/src/common.js similarity index 99% rename from packages/utils/src/utils.js rename to packages/common/src/common.js index 16f4f3cdc6..67fba81ec7 100644 --- a/packages/utils/src/utils.js +++ b/packages/common/src/common.js @@ -13,9 +13,9 @@ const { ownKeys } = Reflect; const { details: X, quote: q, Fail } = assert; -// TODO Complete migration of Checker type from @endo/pass-style to @endo/utils +// TODO Complete migration of Checker type from @endo/pass-style to @endo/common // by having @endo/pass-style, and everyone else who needs it, import it from -// @endo/utils. +// @endo/common. /** * @callback Checker * Internal to a useful pattern for writing checking logic diff --git a/packages/utils/test/prepare-test-env-ava.js b/packages/common/test/prepare-test-env-ava.js similarity index 100% rename from packages/utils/test/prepare-test-env-ava.js rename to packages/common/test/prepare-test-env-ava.js diff --git a/packages/common/test/test-index.js b/packages/common/test/test-index.js new file mode 100644 index 0000000000..f09f5a7be6 --- /dev/null +++ b/packages/common/test/test-index.js @@ -0,0 +1,5 @@ +import { test } from './prepare-test-env-ava.js'; + +test('placeholder', async t => { + t.fail('TODO: add tests'); +}); diff --git a/packages/utils/tsconfig.build.json b/packages/common/tsconfig.build.json similarity index 100% rename from packages/utils/tsconfig.build.json rename to packages/common/tsconfig.build.json diff --git a/packages/utils/tsconfig.json b/packages/common/tsconfig.json similarity index 100% rename from packages/utils/tsconfig.json rename to packages/common/tsconfig.json diff --git a/packages/exo/package.json b/packages/exo/package.json index 64a1ea610d..8fa7e84599 100644 --- a/packages/exo/package.json +++ b/packages/exo/package.json @@ -37,7 +37,7 @@ "@endo/far": "^1.0.1", "@endo/pass-style": "^1.0.1", "@endo/patterns": "^1.0.1", - "@endo/utils": "^1.0.1" + "@endo/common": "^1.0.1" }, "devDependencies": { "@endo/init": "^1.0.1", diff --git a/packages/exo/src/exo-makers.js b/packages/exo/src/exo-makers.js index aeea9451a8..eb1dd4441f 100644 --- a/packages/exo/src/exo-makers.js +++ b/packages/exo/src/exo-makers.js @@ -1,6 +1,6 @@ /// import { environmentOptionsListHas } from '@endo/env-options'; -import { objectMap } from '@endo/utils'; +import { objectMap } from '@endo/common'; import { defendPrototype, defendPrototypeKit } from './exo-tools.js'; diff --git a/packages/exo/src/exo-tools.js b/packages/exo/src/exo-tools.js index 08b6f4ba5c..1dfc7fbb0f 100644 --- a/packages/exo/src/exo-tools.js +++ b/packages/exo/src/exo-tools.js @@ -11,7 +11,7 @@ import { getInterfaceGuardPayload, getCopyMapEntries, } from '@endo/patterns'; -import { listDifference, objectMap } from '@endo/utils'; +import { listDifference, objectMap } from '@endo/common'; import { GET_INTERFACE_GUARD } from './get-interface.js'; /** @typedef {import('@endo/patterns').Method} Method */ diff --git a/packages/patterns/index.js b/packages/patterns/index.js index 0541af89c0..cbc64805db 100644 --- a/packages/patterns/index.js +++ b/packages/patterns/index.js @@ -79,13 +79,13 @@ export * from './src/types.js'; export { /** * @deprecated - * Import directly from `@endo/utils` instead. + * Import directly from `@endo/common` instead. */ listDifference, /** * @deprecated - * Import directly from `@endo/utils` instead. + * Import directly from `@endo/common` instead. */ objectMap, -} from '@endo/utils'; +} from '@endo/common'; diff --git a/packages/patterns/package.json b/packages/patterns/package.json index 5034bd83c1..682754f43b 100644 --- a/packages/patterns/package.json +++ b/packages/patterns/package.json @@ -34,7 +34,7 @@ "@endo/eventual-send": "^1.0.1", "@endo/marshal": "^1.0.1", "@endo/promise-kit": "^1.0.1", - "@endo/utils": "^1.0.1" + "@endo/common": "^1.0.1" }, "devDependencies": { "@endo/init": "^1.0.1", diff --git a/packages/patterns/src/keys/checkKey.js b/packages/patterns/src/keys/checkKey.js index 46eba6afeb..c1c7a01a7a 100644 --- a/packages/patterns/src/keys/checkKey.js +++ b/packages/patterns/src/keys/checkKey.js @@ -12,7 +12,7 @@ import { makeFullOrderComparatorKit, sortByRank, } from '@endo/marshal'; -import { identChecker } from '@endo/utils'; +import { identChecker } from '@endo/common'; import { checkElements, makeSetOfElements } from './copySet.js'; import { checkBagEntries, makeBagOfEntries } from './copyBag.js'; diff --git a/packages/patterns/src/keys/keycollection-operators.js b/packages/patterns/src/keys/keycollection-operators.js index ad4bede2d8..0aec3b8364 100644 --- a/packages/patterns/src/keys/keycollection-operators.js +++ b/packages/patterns/src/keys/keycollection-operators.js @@ -5,7 +5,7 @@ import { makeFullOrderComparatorKit, sortByRank, } from '@endo/marshal'; -import { makeIterator, makeArrayIterator } from '@endo/utils'; +import { makeIterator, makeArrayIterator } from '@endo/common'; /** @typedef {import('@endo/marshal').RankCompare} RankCompare */ /** @typedef {import('../types').KeyComparison} KeyComparison */ diff --git a/packages/patterns/src/patterns/patternMatchers.js b/packages/patterns/src/patterns/patternMatchers.js index 3c40955b5d..cbef8d9f21 100644 --- a/packages/patterns/src/patterns/patternMatchers.js +++ b/packages/patterns/src/patterns/patternMatchers.js @@ -18,7 +18,7 @@ import { applyLabelingError, fromUniqueEntries, listDifference, -} from '@endo/utils'; +} from '@endo/common'; import { keyEQ, keyGT, keyGTE, keyLT, keyLTE } from '../keys/compareKeys.js'; import { diff --git a/packages/utils/index.js b/packages/utils/index.js deleted file mode 100644 index 6fe5c17341..0000000000 --- a/packages/utils/index.js +++ /dev/null @@ -1 +0,0 @@ -export * from './src/utils.js'; diff --git a/packages/utils/test/test-index.js b/packages/utils/test/test-index.js deleted file mode 100644 index 9da523a4be..0000000000 --- a/packages/utils/test/test-index.js +++ /dev/null @@ -1,5 +0,0 @@ -import { test } from './prepare-test-env-ava.js'; - -test('place holder', async t => { - t.pass(); -});