fix(packages): 🐛 Resolve issue with duplicated exports (#69)

xeho91 · web-flow · commit 7591f402ea0d · 2023-03-27T16:54:06.000+08:00
diff --git a/.changeset/yellow-socks-wash.md b/.changeset/yellow-socks-wash.md
@@ -0,0 +1,7 @@
+---
+"@terminal-nerds/snippets-config": minor
+"@terminal-nerds/snippets-error": minor
+"@terminal-nerds/snippets-runtime": minor
+---
+
+🐛 Resolve issue with duplicated re-export - `RuntimeError`
diff --git a/packages/config/package.json b/packages/config/package.json
@@ -41,6 +41,7 @@
 		"dist/"
 	],
 	"dependencies": {
+		"@terminal-nerds/snippets-error": "workspace:*",
 		"@terminal-nerds/snippets-runtime": "workspace:*",
 		"deepmerge-ts": "4.3.0",
 		"pkg-dir": "7.0.0",
diff --git a/packages/config/source/read/read.ts b/packages/config/source/read/read.ts
@@ -1,8 +1,8 @@
 import { existsSync } from "node:fs";
 import { join } from "node:path";
 
+import { RuntimeError } from "@terminal-nerds/snippets-error/custom/runtime";
 import { getRuntimeEnvironmentName, IN_BROWSER } from "@terminal-nerds/snippets-runtime/environment";
-import { RuntimeError } from "@terminal-nerds/snippets-runtime/error";
 import { packageDirectorySync } from "pkg-dir";
 import type { Join } from "type-fest";
 
diff --git a/packages/error/package.json b/packages/error/package.json
@@ -35,6 +35,11 @@
 			"types": "./dist/*/*.d.ts",
 			"import": "./dist/*/*.js",
 			"require": "./dist/*/*.cjs"
+		},
+		"./custom/*": {
+			"types": "./dist/custom/*/*.d.ts",
+			"import": "./dist/custom/*/*.js",
+			"require": "./dist/custom/*/*.cjs"
 		}
 	},
 	"files": [
diff --git a/packages/error/source/custom/custom.ts b/packages/error/source/custom/custom.ts
@@ -1,33 +1,2 @@
-/**
- * FIXME: There's a bug with pnpm and TypeScript, this a workaround.
- *
- * @see {@link https://github.com/microsoft/TypeScript/issues/42873}
- */
-import type {} from "modern-errors";
-import ModernError from "modern-errors";
-import { z, ZodError } from "zod";
-
-/** Error related to the currently used JavaScript runtime environment. */
-export const RuntimeError: typeof ModernError = ModernError.subclass("RuntimeError", {
-	props: {
-		bun: typeof globalThis.Bun,
-		deno: typeof globalThis.Deno,
-		process: typeof globalThis.process,
-		window: typeof globalThis.window,
-	},
-});
-/** @see {@link RuntimeError} */
-export const RUNTIME_ERROR_SCHEMA: ReturnType<typeof z.instanceof<typeof RuntimeError>> = z.instanceof(RuntimeError);
-/** @see {@link RuntimeError} */
-export function isRuntimeError(error: unknown): error is typeof RuntimeError {
-	return RUNTIME_ERROR_SCHEMA.safeParse(error).success;
-}
-
-/** Error related to the type validation. */
-export const ValidationError = ZodError;
-/** @see {@link ValidationError} */
-export const VALIDATION_ERROR_SCHEMA = z.instanceof(ValidationError);
-/** @see {@link ValidationError} */
-export function isValidationError(error: unknown): error is typeof ValidationError {
-	return VALIDATION_ERROR_SCHEMA.safeParse(error).success;
-}
+export * from "./runtime/runtime.ts";
+export * from "./validation/validation.ts";
diff --git a/packages/error/source/custom/runtime/runtime.test.ts b/packages/error/source/custom/runtime/runtime.test.ts
@@ -0,0 +1,18 @@
+import { returns } from "@terminal-nerds/snippets-test/unit";
+import { describe, expect, it } from "vitest";
+
+import { isRuntimeError, RuntimeError } from "./runtime.ts";
+
+describe("isRuntimeError(error)", () => {
+	it(returns(false).on(`Error`), () => {
+		expect(isRuntimeError(Error)).toBe(false);
+	});
+
+	it(returns(false).on(`random value`).sample(""), () => {
+		expect(isRuntimeError("")).toBe(false);
+	});
+
+	it(returns(true).on(`RuntimeError`), () => {
+		expect(isRuntimeError(new RuntimeError("message"))).toBe(true);
+	});
+});
diff --git a/packages/error/source/custom/runtime/runtime.ts b/packages/error/source/custom/runtime/runtime.ts
@@ -0,0 +1,24 @@
+/**
+ * FIXME: There's a bug with pnpm and TypeScript, this a workaround.
+ *
+ * @see {@link https://github.com/microsoft/TypeScript/issues/42873}
+ */
+import type {} from "modern-errors";
+import ModernError from "modern-errors";
+import { z } from "zod";
+
+/** Error related to the currently used JavaScript runtime environment. */
+export const RuntimeError: typeof ModernError = ModernError.subclass("RuntimeError", {
+	props: {
+		bun: typeof globalThis.Bun,
+		deno: typeof globalThis.Deno,
+		process: typeof globalThis.process,
+		window: typeof globalThis.window,
+	},
+});
+/** @see {@link RuntimeError} */
+export const RUNTIME_ERROR_SCHEMA: ReturnType<typeof z.instanceof<typeof RuntimeError>> = z.instanceof(RuntimeError);
+/** @see {@link RuntimeError} */
+export function isRuntimeError(error: unknown): error is typeof RuntimeError {
+	return RUNTIME_ERROR_SCHEMA.safeParse(error).success;
+}
diff --git a/packages/error/source/custom/validation/validation.test.ts b/packages/error/source/custom/validation/validation.test.ts
@@ -1,21 +1,7 @@
 import { returns } from "@terminal-nerds/snippets-test/unit";
 import { describe, expect, it } from "vitest";
 
-import { isRuntimeError, isValidationError, RuntimeError, ValidationError } from "./custom.ts";
-
-describe("isRuntimeError(error)", () => {
-	it(returns(false).on(`Error`), () => {
-		expect(isRuntimeError(Error)).toBe(false);
-	});
-
-	it(returns(false).on(`random value`).sample(""), () => {
-		expect(isRuntimeError("")).toBe(false);
-	});
-
-	it(returns(true).on(`RuntimeError`), () => {
-		expect(isRuntimeError(new RuntimeError("message"))).toBe(true);
-	});
-});
+import { isValidationError, ValidationError } from "./validation.ts";
 
 describe("isValidationError(error)", () => {
 	it(returns(false).on(`Error`), () => {
diff --git a/packages/error/source/custom/validation/validation.ts b/packages/error/source/custom/validation/validation.ts
@@ -0,0 +1,10 @@
+import { z, ZodError } from "zod";
+
+/** Error related to the type validation. */
+export const ValidationError = ZodError;
+/** @see {@link ValidationError} */
+export const VALIDATION_ERROR_SCHEMA = z.instanceof(ValidationError);
+/** @see {@link ValidationError} */
+export function isValidationError(error: unknown): error is typeof ValidationError {
+	return VALIDATION_ERROR_SCHEMA.safeParse(error).success;
+}
diff --git a/packages/runtime/source/environment/environment.ts b/packages/runtime/source/environment/environment.ts
@@ -1,7 +1,5 @@
+import { RuntimeError } from "@terminal-nerds/snippets-error/custom";
 import { z } from "zod";
-
-import { RuntimeError } from "../error/error.ts";
-
 /* prettier-ignore */
 export const RUNTIME_ENVIRONMENTS = [
 	"browser",
diff --git a/packages/runtime/source/error/error.ts b/packages/runtime/source/error/error.ts
diff --git a/packages/runtime/source/main.ts b/packages/runtime/source/main.ts
@@ -1,6 +1,5 @@
 /* MODULES */
 export * from "./environment/environment.ts";
-export * from "./error/error.ts";
 export * from "./module/module.ts";
 export * from "./scope/scope.ts";
 export * from "./variable/variable.ts";
diff --git a/packages/runtime/source/module/module.ts b/packages/runtime/source/module/module.ts
@@ -1,9 +1,9 @@
+import { RuntimeError } from "@terminal-nerds/snippets-error/custom";
 import { resolveModule } from "local-pkg";
 import { type NormalizedPackageJson, readPackageUpSync } from "read-pkg-up";
 import type { KebabCase } from "type-fest/source/kebab-case.ts";
 
 import { IN_BROWSER } from "../environment/environment.ts";
-import { RuntimeError } from "../error/error.ts";
 
 /** @see {@link https://nodejs.org/api/modules.html#modules-commonjs-modules} CommonJS Module */
 export const IN_CJS = typeof globalThis.require === "function";
@@ -60,7 +60,11 @@ export function getPackagesNames(): Set<PackageName> {
 	return new Set(Object.keys(getDepedencies()));
 }
 
-/** TODO: Add targetting, for better debugging (required, dev, optional or peer) */
+/**
+ * TODO: Add targetting, for better debugging (required, dev, optional or peer)
+ *
+ * @param name
+ */
 export function hasPackage(name: string): boolean {
 	return getPackagesNames().has(name);
 }
diff --git a/packages/runtime/source/scope/groups/node.ts b/packages/runtime/source/scope/groups/node.ts
@@ -1,5 +1,6 @@
+import { RuntimeError } from "@terminal-nerds/snippets-error/custom";
+
 import { IN_NODE } from "../../environment/environment.ts";
-import { RuntimeError } from "../../error/error.ts";
 import { getEnvironmentVariable } from "../../variable/variable.ts";
 import type { ScopeOptions } from "../shared.ts";
 
diff --git a/packages/runtime/source/scope/scope.ts b/packages/runtime/source/scope/scope.ts
@@ -1,5 +1,6 @@
+import { RuntimeError } from "@terminal-nerds/snippets-error/custom";
+
 import { IN_BROWSER } from "../environment/environment.ts";
-import { RuntimeError } from "../error/error.ts";
 import { getEnvironmentVariable } from "../variable/variable.ts";
 import { CI_CD_ENVIRONMENT_VARIABLES } from "./groups/continuous-integration.ts";
 import { STORYBOOK_ENVIRONMENT_VARIABLES } from "./groups/storybook.ts";
diff --git a/packages/runtime/source/variable/variable.ts b/packages/runtime/source/variable/variable.ts
@@ -1,5 +1,6 @@
+import { RuntimeError } from "@terminal-nerds/snippets-error/custom";
+
 import { getRuntimeEnvironmentName, type RuntimeEnvironment } from "../environment/environment.ts";
-import { RuntimeError } from "../error/error.ts";
 
 const SUPPORTED_RUNTIMES = ["bun", "deno", "node"] as const;
 type SupportedRuntime = Extract<RuntimeEnvironment, (typeof SUPPORTED_RUNTIMES)[number]>;
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
