refactor(runtime): ♻️ Organize & remove more occurencies of RuntimeError (#93)

xeho91 · web-flow · commit d86ad4abf89d · 2023-05-06T23:29:01.000+08:00
diff --git a/.changeset/shaggy-bugs-unite.md b/.changeset/shaggy-bugs-unite.md
@@ -0,0 +1,5 @@
+---
+"@terminal-nerds/snippets-runtime": patch
+---
+
+♻️ Remove more occurences of `RuntimeError` to fix CJS issues
diff --git a/packages/runtime/package.json b/packages/runtime/package.json
@@ -41,7 +41,6 @@
 		"dist/"
 	],
 	"dependencies": {
-		"@terminal-nerds/snippets-error": "workspace:*",
 		"local-pkg": "0.4.3",
 		"zod": "3.21.4"
 	},
diff --git a/packages/runtime/source/environment/environment.ts b/packages/runtime/source/environment/environment.ts
@@ -1,5 +1,6 @@
 /* import { RuntimeError } from "@terminal-nerds/snippets-error/custom"; */
 import { z } from "zod";
+
 /* prettier-ignore */
 export const RUNTIME_ENVIRONMENTS = [
 	"browser",
diff --git a/packages/runtime/source/scope/name.test.ts b/packages/runtime/source/scope/name.test.ts
@@ -2,15 +2,11 @@ import { returns } from "@terminal-nerds/snippets-test/unit";
 import { describe, expect, it } from "vitest";
 
 import { deleteEnvironmentVariable, getEnvironmentVariable, setEnvironmentVariable } from "../variable/variable.ts";
-import {
-	CI_CD_ENVIRONMENT_VARIABLES,
-	inDevelopment,
-	inProduction,
-	isIn,
-	type ScopeName,
-	STORYBOOK_ENVIRONMENT_VARIABLES,
-	TEST_ENVIRONMENT_VARIABLES,
-} from "./scope.ts";
+import { isIn, type ScopeName } from "./name.ts";
+import { CI_CD_ENVIRONMENT_VARIABLES } from "./scopes/continuous-integration.ts";
+import { inDevelopment, inProduction } from "./scopes/node.ts";
+import { STORYBOOK_ENVIRONMENT_VARIABLES } from "./scopes/storybook.ts";
+import { TEST_ENVIRONMENT_VARIABLES } from "./scopes/test.ts";
 
 describe(`isIn("continuousIntegration", options?)`, () => {
 	const scopeName: ScopeName = "continuousIntegration";
diff --git a/packages/runtime/source/scope/name.ts b/packages/runtime/source/scope/name.ts
@@ -0,0 +1,35 @@
+/* import { RuntimeError } from "@terminal-nerds/snippets-error/custom"; */
+
+import { IN_BROWSER } from "../environment/environment.ts";
+import { getEnvironmentVariable } from "../variable/variable.ts";
+import { CI_CD_ENVIRONMENT_VARIABLES } from "./scopes/continuous-integration.ts";
+import { STORYBOOK_ENVIRONMENT_VARIABLES } from "./scopes/storybook.ts";
+import { TEST_ENVIRONMENT_VARIABLES } from "./scopes/test.ts";
+import type { ScopeOptions } from "./shared.ts";
+
+export const SCOPE_NAMES = ["continuousIntegration", "storybook", "test"] as const;
+export type ScopeName = (typeof SCOPE_NAMES)[number];
+export const SCOPE_VARIABLES = {
+	continuousIntegration: CI_CD_ENVIRONMENT_VARIABLES,
+	storybook: STORYBOOK_ENVIRONMENT_VARIABLES,
+	test: TEST_ENVIRONMENT_VARIABLES,
+} as const;
+
+export function isIn(scopeName: ScopeName, options: ScopeOptions = {}): boolean {
+	const { strict = false } = options;
+
+	return IN_BROWSER ? handleBrowserRuntime(strict) : isAnyVariableDefined(SCOPE_VARIABLES[scopeName]);
+}
+
+function handleBrowserRuntime(strict: boolean): boolean {
+	if (strict) throw new Error(`You cannot use this snippet in the browser.`);
+	else return false;
+}
+
+function isAnyVariableDefined(names: readonly string[]): boolean {
+	for (const variable of names) {
+		if (getEnvironmentVariable(variable)) return true;
+	}
+
+	return false;
+}
diff --git a/packages/runtime/source/scope/scope.ts b/packages/runtime/source/scope/scope.ts
@@ -1,40 +1,5 @@
-import { RuntimeError } from "@terminal-nerds/snippets-error/custom";
-
-import { IN_BROWSER } from "../environment/environment.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";
-import { TEST_ENVIRONMENT_VARIABLES } from "./groups/test.ts";
-import type { ScopeOptions } from "./shared.ts";
-
-export * from "./groups/continuous-integration.ts";
-export * from "./groups/node.ts";
-export * from "./groups/storybook.ts";
-export * from "./groups/test.ts";
-
-export const SCOPE_NAMES = ["continuousIntegration", "storybook", "test"] as const;
-export type ScopeName = (typeof SCOPE_NAMES)[number];
-export const SCOPE_VARIABLES = {
-	continuousIntegration: CI_CD_ENVIRONMENT_VARIABLES,
-	storybook: STORYBOOK_ENVIRONMENT_VARIABLES,
-	test: TEST_ENVIRONMENT_VARIABLES,
-} as const;
-
-export function isIn(scopeName: ScopeName, options: ScopeOptions = {}): boolean {
-	const { strict = false } = options;
-
-	return IN_BROWSER ? handleBrowserRuntime(strict) : isAnyVariableDefined(SCOPE_VARIABLES[scopeName]);
-}
-
-function handleBrowserRuntime(strict: boolean): boolean {
-	if (strict) throw new RuntimeError(`You cannot use this snippet in the browser.`);
-	else return false;
-}
-
-function isAnyVariableDefined(names: readonly string[]): boolean {
-	for (const variable of names) {
-		if (getEnvironmentVariable(variable)) return true;
-	}
-
-	return false;
-}
+export * from "./name.ts";
+export * from "./scopes/continuous-integration.ts";
+export * from "./scopes/node.ts";
+export * from "./scopes/storybook.ts";
+export * from "./scopes/test.ts";
diff --git a/packages/runtime/source/scope/scopes/continuous-integration.ts b/packages/runtime/source/scope/scopes/continuous-integration.ts
diff --git a/packages/runtime/source/scope/scopes/node.ts b/packages/runtime/source/scope/scopes/node.ts
@@ -1,4 +1,4 @@
-import { RuntimeError } from "@terminal-nerds/snippets-error/custom";
+/* import { RuntimeError } from "@terminal-nerds/snippets-error/custom"; */
 
 import { IN_NODE } from "../../environment/environment.ts";
 import { getEnvironmentVariable } from "../../variable/variable.ts";
@@ -24,6 +24,6 @@ export function isNodeEnvironment(value: NodeEnvironment, options: ScopeOptions
 }
 
 function handleNonNodeRuntime(strict: boolean) {
-	if (strict) throw new RuntimeError(`Currently you can check only inside the Node.js runtime environment.`);
+	if (strict) throw new Error(`Currently you can check only inside the Node.js runtime environment.`);
 	else return false;
 }
diff --git a/packages/runtime/source/scope/scopes/storybook.ts b/packages/runtime/source/scope/scopes/storybook.ts
diff --git a/packages/runtime/source/scope/scopes/test.ts b/packages/runtime/source/scope/scopes/test.ts
diff --git a/packages/runtime/source/variable/variable.test.ts b/packages/runtime/source/variable/variable.test.ts
@@ -1,4 +1,4 @@
-import { RuntimeError } from "@terminal-nerds/snippets-error/custom";
+/* import { RuntimeError } from "@terminal-nerds/snippets-error/custom"; */
 import { returns, throws } from "@terminal-nerds/snippets-test/unit";
 import { afterEach, describe, expect, it } from "vitest";
 
@@ -45,8 +45,8 @@ describe(`hasEnvironmentVariable(name)`, () => {
 describe(`getEnvironmentVariable(name, options?)`, () => {
 	const strictOptions = { strict: true } as const;
 
-	it(throws(RuntimeError).on(`non-existing variable`).sample(NEW_VARIABLE).with(strictOptions), () => {
-		expect(() => getEnvironmentVariable(NEW_VARIABLE, strictOptions)).toThrow(RuntimeError);
+	it(throws(Error).on(`non-existing variable`).sample(NEW_VARIABLE).with(strictOptions), () => {
+		expect(() => getEnvironmentVariable(NEW_VARIABLE, strictOptions)).toThrow(Error);
 	});
 
 	const nonStrictOptions = { strict: false } as const;
@@ -96,14 +96,14 @@ describe(`setEnvironmentVariable(name, value)`, () => {
 describe(`deleteEnvironmentVariable(name, options?)`, () => {
 	const strictOptions = { strict: true };
 
-	it(throws(RuntimeError).on(`deleting non-existing variable`).sample(NEW_VARIABLE).with(strictOptions), () => {
-		expect(() => deleteEnvironmentVariable(NEW_VARIABLE, strictOptions)).toThrow(RuntimeError);
+	it(throws(Error).on(`deleting non-existing variable`).sample(NEW_VARIABLE).with(strictOptions), () => {
+		expect(() => deleteEnvironmentVariable(NEW_VARIABLE, strictOptions)).toThrow(Error);
 	});
 
 	const nonStrictOptions = { strict: false };
 
 	it(returns().on(`deleting non-existing variable`).sample(NEW_VARIABLE).with(nonStrictOptions), () => {
-		expect(() => deleteEnvironmentVariable(NEW_VARIABLE, nonStrictOptions)).not.toThrow(RuntimeError);
+		expect(() => deleteEnvironmentVariable(NEW_VARIABLE, nonStrictOptions)).not.toThrow(Error);
 		expect(deleteEnvironmentVariable(NEW_VARIABLE, nonStrictOptions)).toBeUndefined();
 	});
 
diff --git a/packages/runtime/source/variable/variable.ts b/packages/runtime/source/variable/variable.ts
@@ -1,4 +1,4 @@
-import { RuntimeError } from "@terminal-nerds/snippets-error/custom";
+/* import { RuntimeError } from "@terminal-nerds/snippets-error/custom"; */
 
 import { getRuntimeEnvironmentName, type RuntimeEnvironment } from "../environment/environment.ts";
 
@@ -15,7 +15,7 @@ function getSupportedRuntime(): SupportedRuntime {
 	if (isSupportedRuntime(runtimeName)) {
 		return runtimeName;
 	} else {
-		throw new RuntimeError(`This snippet cannot be run in a runtime: ${runtimeName}!`);
+		throw new Error(`This snippet cannot be run in a runtime: ${runtimeName}!`);
 	}
 }
 
@@ -41,7 +41,9 @@ export interface EnvironmentVariableOptions {
 	strict?: boolean;
 }
 
-/** Possible value types of the environment variable. */
+/**
+ * Possible value types of the environment variable.
+ */
 export type EnvironmentVariableValue = boolean | number | string;
 
 export function hasEnvironmentVariable(variable: string): boolean {
@@ -67,7 +69,7 @@ export function getEnvironmentVariable<ValueType extends EnvironmentVariableValu
 	if (value) {
 		return parseEnvironmentVariableValue(value) as ValueType;
 	} else if (strict) {
-		throw new RuntimeError(`The environment variable - "${variable}" - is not set. Getter aborted.`);
+		throw new Error(`The environment variable - "${variable}" - is not set. Getter aborted.`);
 	}
 }
 
@@ -125,6 +127,6 @@ export function deleteEnvironmentVariable(name: string, options: EnvironmentVari
 			}
 		}
 	} else if (strict) {
-		throw new RuntimeError(`The environment variable name: "${name}" does not exist. Deletion aborted.`);
+		throw new Error(`The environment variable name: "${name}" does not exist. Deletion aborted.`);
 	}
 }
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"@terminal-nerds/snippets-runtime": patch
 +---
++
 +♻️ Remove more occurences of `RuntimeError` to fix CJS issues
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { RuntimeError } from "@terminal-nerds/snippets-error/custom";`
	`1`	`+/* import { RuntimeError } from "@terminal-nerds/snippets-error/custom"; */`
`2`	`2`
`3`	`3`	`import { IN_NODE } from "../../environment/environment.ts";`
`4`	`4`	`import { getEnvironmentVariable } from "../../variable/variable.ts";`
`@@ -24,6 +24,6 @@ export function isNodeEnvironment(value: NodeEnvironment, options: ScopeOptions`
`24`	`24`	`}`
`25`	`25`
`26`	`26`	`function handleNonNodeRuntime(strict: boolean) {`
`27`		- if (strict) throw new RuntimeError(`Currently you can check only inside the Node.js runtime environment.`);
	`27`	+ if (strict) throw new Error(`Currently you can check only inside the Node.js runtime environment.`);
`28`	`28`	`else return false;`
`29`	`29`	`}`