refactor(runtime): 🏗 Rename to environment & major reorganization (#…

…114)

.changeset/orange-elephants-march.md

@@ -0,0 +1,5 @@
+---
+"@terminal-nerds/snippets-environment": minor
+---
+
+🏗️ Rename to `environment` & major reorganization

README.md

@@ -159,8 +159,8 @@ Reusable pieces of code, which can be **reused** across the projects.
 
 [runtime]: ./packages/runtime/README.md
 [runtime badge]: https://img.shields.io/static/v1?label=%40terminal-nerds&message=snippets-runtime&style=flat-square&color=informational
-[runtime version badge]: https://img.shields.io/npm/v/@terminal-nerds/snippets-runtime/latest?style=flat-square&logo=npm
-[runtime npm page]: https://www.npmjs.com/package/@terminal-nerds/snippets-runtime
+[runtime version badge]: https://img.shields.io/npm/v/@terminal-nerds/snippets-environment/latest?style=flat-square&logo=npm
+[runtime npm page]: https://www.npmjs.com/package/@terminal-nerds/snippets-environment
 
 [string]: ./packages/string/README.md
 [string badge]: https://img.shields.io/static/v1?label=%40terminal-nerds&message=snippets-string&style=flat-square&color=informational

packages/config/CHANGELOG.md

@@ -5,14 +5,14 @@
 ### Patch Changes
 
 -   Updated dependencies [[`d86ad4a`](https://github.com/terminal-nerds/snippets/commit/d86ad4abf89db7ed01dfce729594d07b74d189a7)]:
-    -   @terminal-nerds/snippets-runtime@0.6.2
+    -   @terminal-nerds/snippets-environment@0.6.2
 
 ## 0.4.3
 
 ### Patch Changes
 
 -   Updated dependencies [[`05015d5`](https://github.com/terminal-nerds/snippets/commit/05015d567ddfc7beff51b9c09aac59c06f3380b9)]:
-    -   @terminal-nerds/snippets-runtime@0.6.1
+    -   @terminal-nerds/snippets-environment@0.6.1
 
 ## 0.4.2
 
@@ -23,7 +23,7 @@
 -   Updated dependencies [[`3d519ff`](https://github.com/terminal-nerds/snippets/commit/3d519ffcc696e8c102fcb8856c9067ad6e51c35d), [`b2341ed`](https://github.com/terminal-nerds/snippets/commit/b2341ed3378773a64fe9df1283e4a3225da0b90e)]:
     -   @terminal-nerds/snippets-error@0.4.1
     -   @terminal-nerds/snippets-object@0.4.1
-    -   @terminal-nerds/snippets-runtime@0.6.0
+    -   @terminal-nerds/snippets-environment@0.6.0
 
 ## 0.4.1
 
@@ -47,7 +47,7 @@
 -   Updated dependencies [[`2630f51`](https://github.com/terminal-nerds/snippets/commit/2630f5138db3f2f1bc0b766cd94c1c415bba2656), [`ebabfc7`](https://github.com/terminal-nerds/snippets/commit/ebabfc72f7831ea12055d0214e47c4be8aa051fd), [`c07740f`](https://github.com/terminal-nerds/snippets/commit/c07740fb2f91e869d75c01b23724a3dad634a0c5)]:
     -   @terminal-nerds/snippets-error@0.4.0
     -   @terminal-nerds/snippets-object@0.3.0
-    -   @terminal-nerds/snippets-runtime@0.5.0
+    -   @terminal-nerds/snippets-environment@0.5.0
 
 ## 0.3.1
 
@@ -66,14 +66,14 @@
 
 -   Updated dependencies [[`7591f40`](https://github.com/terminal-nerds/snippets/commit/7591f402ea0d6287ccc30c93aab16e725ebd252d)]:
     -   @terminal-nerds/snippets-error@0.3.0
-    -   @terminal-nerds/snippets-runtime@0.4.0
+    -   @terminal-nerds/snippets-environment@0.4.0
 
 ## 0.2.1
 
 ### Patch Changes
 
 -   Updated dependencies [[`2a474e0`](https://github.com/terminal-nerds/snippets/commit/2a474e0f693bcc245108ccba1ad1606a747c3591), [`2a474e0`](https://github.com/terminal-nerds/snippets/commit/2a474e0f693bcc245108ccba1ad1606a747c3591), [`2a474e0`](https://github.com/terminal-nerds/snippets/commit/2a474e0f693bcc245108ccba1ad1606a747c3591)]:
-    -   @terminal-nerds/snippets-runtime@0.3.0
+    -   @terminal-nerds/snippets-environment@0.3.0
 
 ## 0.2.0
 
@@ -84,7 +84,7 @@
 ### Patch Changes
 
 -   Updated dependencies [[`7ba7377`](https://github.com/terminal-nerds/snippets/commit/7ba73779bb732b0f1bfe7a9d1c702514fb99a193)]:
-    -   @terminal-nerds/snippets-runtime@0.2.0
+    -   @terminal-nerds/snippets-environment@0.2.0
 
 ## 0.1.0
 
@@ -97,4 +97,4 @@
 ### Patch Changes
 
 -   Updated dependencies [[`82e822d`](https://github.com/terminal-nerds/snippets/commit/82e822d32580c8f31a51416b05cca0f6a4222c20), [`40625dc`](https://github.com/terminal-nerds/snippets/commit/40625dcc60a3d3484e1b9bed3b840f215e3c4803), [`82e822d`](https://github.com/terminal-nerds/snippets/commit/82e822d32580c8f31a51416b05cca0f6a4222c20), [`1837e4f`](https://github.com/terminal-nerds/snippets/commit/1837e4f5ee3883b2187c5b81f6cf8ceb2ed7619a), [`82e822d`](https://github.com/terminal-nerds/snippets/commit/82e822d32580c8f31a51416b05cca0f6a4222c20)]:
-    -   @terminal-nerds/snippets-runtime@0.1.0
+    -   @terminal-nerds/snippets-environment@0.1.0

packages/config/package.json

@@ -43,7 +43,7 @@
 	"dependencies": {
 		"@terminal-nerds/snippets-error": "workspace:*",
 		"@terminal-nerds/snippets-object": "workspace:*",
-		"@terminal-nerds/snippets-runtime": "workspace:*",
+		"@terminal-nerds/snippets-environment": "workspace:*",
 		"pkg-dir": "7.0.0",
 		"type-fest": "3.11.0"
 	},

packages/config/source/read/read.ts

@@ -2,7 +2,7 @@ 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 { getRuntimeEnvironmentName, IN_BROWSER } from "@terminal-nerds/snippets-environment/environment";
 import { packageDirectorySync } from "pkg-dir";
 import type { Join } from "type-fest";
 

packages/runtime/CHANGELOG.md → packages/environment/CHANGELOG.md

@@ -1,4 +1,4 @@
-# @terminal-nerds/snippets-runtime<!-- markdownlint-disable line-length list-marker-space no-duplicate-header ul-style ul-indent no-bare-urls -->
+# @terminal-nerds/snippets-environment<!-- markdownlint-disable line-length list-marker-space no-duplicate-header ul-style ul-indent no-bare-urls -->
 
 ## 0.6.2
 

packages/runtime/README.md → packages/environment/README.md

@@ -1,55 +1,45 @@
-# @terminal-nerds/snippets-runtime
+# @terminal-nerds/snippets-environment
 
 ![package version badge]
 [![dependencies badge]][dependencies url]\
 [![install size badge]][install size url]
 
-➡️ **This package wraps all available modules with snippets related to JavasScript runtimes**
+➡️ **This package wraps all available modules with snippets related to JavasScript environment**
 — part of the [terminal-nerds/snippets] project.
 
 [terminal-nerds/snippets]: https://github.com/terminal-nerds/snippets
-[package version badge]: https://img.shields.io/npm/v/@terminal-nerds/snippets-runtime/latest?style=for-the-badge&logo=npm
-[dependencies badge]: https://img.shields.io/librariesio/release/npm/@terminal-nerds/snippets-runtime?style=for-the-badge
-[dependencies url]: https://libraries.io/npm/@terminal-nerds%2snippets-runtime
-[install size badge]: https://packagephobia.com/badge?p=@terminal-nerds/snippets-runtime
-[install size url]: https://packagephobia.com/result?p=@terminal-nerds/snippets-runtime
+[package version badge]: https://img.shields.io/npm/v/@terminal-nerds/snippets-environment/latest?style=for-the-badge&logo=npm
+[dependencies badge]: https://img.shields.io/librariesio/release/npm/@terminal-nerds/snippets-environment?style=for-the-badge
+[dependencies url]: https://libraries.io/npm/@terminal-nerds%2snippets-environment
+[install size badge]: https://packagephobia.com/badge?p=@terminal-nerds/snippets-environment
+[install size url]: https://packagephobia.com/result?p=@terminal-nerds/snippets-environment
 
 ## Modules included
 
 [![documentation badge]][documentation url]
 
 [documentation badge]: https://img.shields.io/static/v1?color=informational&style=for-the-badge&label=documentation&message=jsdocs.io
-[documentation url]: https://jsdocs.io/package/@terminal-nerds/snippets-runtime
+[documentation url]: https://jsdocs.io/package/@terminal-nerds/snippets-environment
 
-| Name                                             | Size                                                            |
-| ------------------------------------------------ | --------------------------------------------------------------- |
-| [`@terminal-nerds/snippets-runtime/environment`] | ![environment size gzip badge] ![environment size brotli badge] |
-| [`@terminal-nerds/snippets-runtime/runtime`]     | ![environment size gzip badge] ![environment size brotli badge] |
-| [`@terminal-nerds/snippets-runtime/module`]      | ![module size gzip badge] ![module size brotli badge]           |
-| [`@terminal-nerds/snippets-runtime/scope`]       | ![scope size gzip badge] ![scope size brotli badge]             |
-| [`@terminal-nerds/snippets-runtime/variable`]    | ![variable size gzip badge] ![variable size brotli badge]       |
+| Name                                              | Size                                                      |
+| ------------------------------------------------- | --------------------------------------------------------- |
+| [`@terminal-nerds/snippets-environment/runtime`]  | ![runtime size gzip badge] ![runtime size brotli badge]   |
+| [`@terminal-nerds/snippets-environment/scope`]    | ![scope size gzip badge] ![scope size brotli badge]       |
+| [`@terminal-nerds/snippets-environment/variable`] | ![variable size gzip badge] ![variable size brotli badge] |
 
 <!-- prettier-ignore-start -->
 <!-- MODULES LINKS -->
-[`@terminal-nerds/snippets-runtime/runtime`]: https://github.com/terminal-nerds/snippets/blob/main/packages/runtime/source/environment/environment.ts
-[runtime size gzip badge]: https://badgen.net/badgesize/gzip/file-url/unpkg.com/@terminal-nerds/snippets-runtime/dist/environment/environment.js?label=gzip
-[runtime size brotli badge]: https://badgen.net/badgesize/brotli/file-url/unpkg.com/@terminal-nerds/snippets-runtime/dist/environment/environment.js?label=brotli
+[`@terminal-nerds/snippets-environment/runtime`]: https://github.com/terminal-nerds/snippets/blob/main/packages/environment/source/runtime/runtime.ts
+[runtime size gzip badge]: https://badgen.net/badgesize/gzip/file-url/unpkg.com/@terminal-nerds/snippets-environment/dist/runtime/runtime.js?label=gzip
+[runtime size brotli badge]: https://badgen.net/badgesize/brotli/file-url/unpkg.com/@terminal-nerds/snippets-environment/dist/runtime/runtime.js?label=brotli
 
-[`@terminal-nerds/snippets-runtime/environment`]: https://github.com/terminal-nerds/snippets/blob/main/packages/runtime/source/environment/environment.ts
-[environment size gzip badge]: https://badgen.net/badgesize/gzip/file-url/unpkg.com/@terminal-nerds/snippets-runtime/dist/environment/environment.js?label=gzip
-[environment size brotli badge]: https://badgen.net/badgesize/brotli/file-url/unpkg.com/@terminal-nerds/snippets-runtime/dist/environment/environment.js?label=brotli
+[`@terminal-nerds/snippets-environment/scope`]: https://github.com/terminal-nerds/snippets/blob/main/packages/environment/source/scope/scope.ts
+[scope size gzip badge]: https://badgen.net/badgesize/gzip/file-url/unpkg.com/@terminal-nerds/snippets-environment/dist/scope/scope.js?label=gzip
+[scope size brotli badge]: https://badgen.net/badgesize/brotli/file-url/unpkg.com/@terminal-nerds/snippets-environment/dist/scope/scope.js?label=brotli
 
-[`@terminal-nerds/snippets-runtime/module`]: https://github.com/terminal-nerds/snippets/blob/main/packages/runtime/source/module/module.ts
-[module size gzip badge]: https://badgen.net/badgesize/gzip/file-url/unpkg.com/@terminal-nerds/snippets-runtime/dist/module/module.js?label=gzip
-[module size brotli badge]: https://badgen.net/badgesize/brotli/file-url/unpkg.com/@terminal-nerds/snippets-runtime/dist/module/module.js?label=brotli
-
-[`@terminal-nerds/snippets-runtime/scope`]: https://github.com/terminal-nerds/snippets/blob/main/packages/runtime/source/scope/scope.ts
-[scope size gzip badge]: https://badgen.net/badgesize/gzip/file-url/unpkg.com/@terminal-nerds/snippets-runtime/dist/scope/scope.js?label=gzip
-[scope size brotli badge]: https://badgen.net/badgesize/brotli/file-url/unpkg.com/@terminal-nerds/snippets-runtime/dist/scope/scope.js?label=brotli
-
-[`@terminal-nerds/snippets-runtime/variable`]: https://github.com/terminal-nerds/snippets/blob/main/packages/runtime/source/variable/variable.ts
-[variable size gzip badge]: https://badgen.net/badgesize/gzip/file-url/unpkg.com/@terminal-nerds/snippets-runtime/dist/variable/variable.js?label=gzip
-[variable size brotli badge]: https://badgen.net/badgesize/brotli/file-url/unpkg.com/@terminal-nerds/snippets-runtime/dist/variable/variable.js?label=brotli
+[`@terminal-nerds/snippets-environment/variable`]: https://github.com/terminal-nerds/snippets/blob/main/packages/environment/source/variable/variable.ts
+[variable size gzip badge]: https://badgen.net/badgesize/gzip/file-url/unpkg.com/@terminal-nerds/snippets-environment/dist/variable/variable.js?label=gzip
+[variable size brotli badge]: https://badgen.net/badgesize/brotli/file-url/unpkg.com/@terminal-nerds/snippets-environment/dist/variable/variable.js?label=brotli
 <!-- prettier-ignore-end -->
 
 ---
@@ -71,8 +61,8 @@ the latest version, which supports new features _(such as `satisfies`)_, is supp
 
 ### Runtime environments
 
-This package can be used in several runtime environments.
-We aim for cross-runtime compatibility and ensure proper error messages
+This package can be used in several environment environments.
+We aim for cross-environment compatibility and ensure proper error messages
 if a particular snippet cannot be run in the currently running environment.
 
 #### Browsers

packages/runtime/package.json → packages/environment/package.json

@@ -1,13 +1,13 @@
 {
 	"$schema": "https://json.schemastore.org/package",
 	"type": "module",
-	"name": "@terminal-nerds/snippets-runtime",
+	"name": "@terminal-nerds/snippets-environment",
 	"version": "0.6.2",
-	"description": "@terminal-nerds reusable snippets for runtime.",
+	"description": "@terminal-nerds reusable snippets for environment.",
 	"keywords": [
 		"snippets",
 		"typescript",
-		"runtime"
+		"environment"
 	],
 	"author": {
 		"name": "Mateusz Kadlubowski",
@@ -19,7 +19,7 @@
 	"repository": {
 		"type": "git",
 		"url": "https://github.com/terminal-nerds/snippets.git",
-		"directory": "packages/runtime"
+		"directory": "packages/environment"
 	},
 	"bugs": "https://github.com/terminal-nerds/snippets/issues",
 	"engines": {
@@ -32,16 +32,25 @@
 			"require": "./dist/main.cjs"
 		},
 		"./*": {
-			"types": "./dist/*/*.d.ts",
-			"import": "./dist/*/*.js",
-			"require": "./dist/*/*.cjs"
+			"types": [
+				"./dist/*.d.ts",
+				"./dist/*/index.d.ts"
+			],
+			"import": [
+				"./dist/*.js",
+				"./dist/*/index.js"
+			],
+			"require": [
+				"./dist/*.cjs",
+				"./dist/*/index.cjs"
+			]
 		}
 	},
 	"files": [
 		"dist/"
 	],
 	"dependencies": {
-		"local-pkg": "0.4.3",
+		"@terminal-nerds/snippets-array": "workspace:^",
 		"zod": "3.21.4"
 	},
 	"peerDependencies": {
@@ -67,7 +76,7 @@
 		"dev:pkg": "tsup --watch",
 		"dev:test": "vitest watch --ui",
 		"fix": "concurrently \"pnpm:fix:*\" --group --timings",
-		"fix:format": "pretty-quick --branch main --pattern \"packages/runtime/**/*\" --verbose",
+		"fix:format": "pretty-quick --branch main --pattern \"packages/environment/**/*\" --verbose",
 		"fix:js": "pnpm lint:js --fix",
 		"fix:md": "pnpm lint:md --fix",
 		"fix:pkg": "syncpack format ; syncpack fix-mismatches",

packages/environment/source/main.ts

@@ -0,0 +1,4 @@
+/* MODULES */
+export * from "./runtime/index.ts";
+export * from "./scope/index.ts";
+export * from "./variables/index.ts";

packages/environment/source/runtime/index.ts

@@ -0,0 +1,2 @@
+export * from "./sub/check.ts";
+export * from "./sub/name.ts";

packages/runtime/source/environment/environment.edge.test.ts → packages/environment/source/runtime/sub/check.edge.test.ts

@@ -6,52 +6,33 @@
 /* import { returns } from "@terminal-nerds/snippets-test/unit"; */
 import { describe } from "vitest";
 
-/* import { */
-/* 	getRuntimeEnvironmentName, */
-/* 	IN_BROWSER, */
-/* 	IN_BUN, */
-/* 	IN_DENO, */
-/* 	IN_DOM, */
-/* 	IN_EDGE, */
-/* 	IN_HAPPY_DOM, */
-/* 	IN_JSDOM, */
-/* 	IN_NODE, */
-/* 	IN_WEB_WORKER, */
-/* } from "./environment.ts"; */
-
-describe.todo("getRuntimeEnvironmentName() - in Edge Runtime", () => {
-	/* it.fails(returns("edge"), () => { */
-		/* expect(getRuntimeEnvironmentName()).toBe("edge"); */
-	/* }); */
-});
-
 describe.todo("IN_BROWSER", () => {
 	/* it.fails(returns(false), () => { */
-		/* expect(IN_BROWSER).toBe(false); */
+	/* expect(IN_BROWSER).toBe(false); */
 	/* }); */
 });
 
 describe.todo("IN_BUN", () => {
 	/* it.fails(returns(false), () => { */
-		/* expect(IN_BUN).toBe(false); */
+	/* expect(IN_BUN).toBe(false); */
 	/* }); */
 });
 
 describe.todo("IN_DENO", () => {
 	/* it.fails(returns(false), () => { */
-		/* expect(IN_DENO).toBe(false); */
+	/* expect(IN_DENO).toBe(false); */
 	/* }); */
 });
 
 describe.todo("IN_DOM", () => {
 	/* it.fails(returns(false), () => { */
-		/* expect(IN_DOM).toBe(false); */
+	/* expect(IN_DOM).toBe(false); */
 	/* }); */
 });
 
 describe.todo("IN_EDGE_RUNTIME", () => {
 	/* it.fails(returns(true), () => { */
-		/* expect(IN_EDGE).toBe(true); */
+	/* expect(IN_EDGE).toBe(true); */
 	/* }); */
 });
 
@@ -63,19 +44,19 @@ describe.todo("IN_HAPPY_DOM", () => {
 
 describe.todo("IN_JSDOM", () => {
 	/* it.fails(returns(false), () => { */
-		/* expect(IN_JSDOM).toBe(false); */
+	/* expect(IN_JSDOM).toBe(false); */
 	/* }); */
 });
 
 describe.todo("IN_NODE", () => {
 	// NOTE: This test is being run in Node.js.
 	/* it.fails(returns(false), () => { */
-		/* expect(IN_NODE).toBe(false); */
+	/* expect(IN_NODE).toBe(false); */
 	/* }); */
 });
 
 describe.todo("IN_WEB_WORKER", () => {
 	/* it.fails(returns(false), () => { */
-		/* expect(IN_WEB_WORKER).toBe(false); */
+	/* expect(IN_WEB_WORKER).toBe(false); */
 	/* }); */
 });