feat(packages): ✨ Add snippets related to project (#75)

Author: xeho91

.changeset/healthy-bobcats-burn.md

@@ -0,0 +1,5 @@
+---
+"@terminal-nerds/snippets-project": minor
+---
+
+✨ Added a new module `monorepo` for grouped snippets

README.md

@@ -100,6 +100,7 @@ Reusable pieces of code, which can be **reused** across the projects.
 | ------------------------------- | ------------------------------------------------ |
 | [![snippets badge]][snippets]   | [![snippets version badge]][snippets npm page]   |
 | <!-- PACKAGES -->               | <!-- PACKAGES -->                                |
+| [![project badge]][project]     | [![project version badge]][project npm page]     |
 | [![object badge]][object]       | [![object version badge]][object npm page]       |
 | [![url badge]][url]             | [![url version badge]][url npm page]             |
 | [![array badge]][array]         | [![array version badge]][array npm page]         |
@@ -120,6 +121,11 @@ Reusable pieces of code, which can be **reused** across the projects.
 
 <!-- prettier-ignore-start -->
 <!-- PACKAGES LINKS -->
+[project]: ./packages/project/README.md
+[project badge]: https://img.shields.io/static/v1?label=%40terminal-nerds&message=snippets-project&style=flat-square&color=informational
+[project version badge]: https://img.shields.io/npm/v/@terminal-nerds/snippets-project/latest?style=flat-square&logo=npm
+[project npm page]: https://www.npmjs.com/package/@terminal-nerds/snippets-project
+
 [object]: ./packages/object/README.md
 [object badge]: https://img.shields.io/static/v1?label=%40terminal-nerds&message=snippets-object&style=flat-square&color=informational
 [object version badge]: https://img.shields.io/npm/v/@terminal-nerds/snippets-object/latest?style=flat-square&logo=npm

packages/project/.depcheckrc.json

@@ -0,0 +1,3 @@
+{
+	"ignores": ["@terminal-nerds/*-config", "tsup", "vitest"]
+}

packages/project/CHANGELOG.md

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

packages/project/LICENSE.md

@@ -0,0 +1 @@
+/home/xeho91/Nextcloud/Projects/terminal-nerds/snippets/LICENSE.md

packages/project/README.md

@@ -0,0 +1,187 @@
+# @terminal-nerds/snippets-project
+
+![package version badge]
+[![dependencies badge]][dependencies url]\
+[![install size badge]][install size url]
+
+➡️ **This package wraps all available modules with snippets related to project**
+— 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-project/latest?style=for-the-badge&logo=npm
+[dependencies badge]: https://img.shields.io/librariesio/release/npm/@terminal-nerds/snippets-project?style=for-the-badge
+[dependencies url]: https://libraries.io/npm/@terminal-nerds%2snippets-project
+[install size badge]: https://packagephobia.com/badge?p=@terminal-nerds/snippets-project
+[install size url]: https://packagephobia.com/result?p=@terminal-nerds/snippets-project
+
+## 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-project
+
+<!-- prettier-sort-markdown-table -->
+
+| Name                                          | Size                                                      |
+| --------------------------------------------- | --------------------------------------------------------- |
+| [`@terminal-nerds/snippets-project/monorepo`] | ![monorepo size gzip badge] ![monorepo size brotli badge] |
+
+<!-- prettier-ignore-start -->
+<!-- MODULES LINKS -->
+[`@terminal-nerds/snippets-project/monorepo`]: https://github.com/terminal-nerds/snippets/blob/main/packages/project/source/localhost/localhost.ts
+[monorepo size gzip badge]: https://badgen.net/badgesize/gzip/file-project/unpkg.com/@terminal-nerds/snippets-project/dist/localhost/localhost.js?label=gzip
+[monorepo size brotli badge]: https://badgen.net/badgesize/brotli/file-project/unpkg.com/@terminal-nerds/snippets-project/dist/localhost/localhost.js?label=brotli
+<!-- prettier-ignore-end -->
+
+---
+
+## Prerequisites & usage
+
+### Optional
+
+[![supported typescript version badge]][typescript]
+
+[typescript]: https://typescriptlang.org/
+[typescript icon]: https://api.iconify.design/logos/typescript-icon.svg
+[supported typescript version badge]: https://img.shields.io/github/package-json/dependency-version/terminal-nerds/snippets/peer/typescript?filename=packages%2Ftypescript%2Fpackage.json&logo=typescript&style=for-the-badge&label=typescript
+
+If you are using ![typescript icon] [TypeScript],
+the latest version, which supports new features _(such as `satisfies`)_, is supported.
+
+### Runtime environments
+
+This package can be used in several runtime environments.
+We aim for cross-runtime compatibility and ensure proper error messages
+if a particular snippet cannot be run in the currently running environment.
+
+#### Browsers
+
+We use [browserslist] to define the minimum browsers versions supported.\
+Take a look at our [shared browserslist configuration] for more details.
+
+[browserslist]: https://github.com/browserslist/browserslist
+[shared browserslist configuration]: https://github.com/terminal-nerds/configs/blob/main/packages/browserslist/source/browsers.ts
+
+**Usage**:
+
+```html
+<script type="module">
+	import { snippet } from "https://cdn.jsdelivr.net/npm/@terminal-nerds/snippets-project";
+</script>
+```
+
+---
+
+#### Bun
+
+We aim to support the latest version of ![bun icon] [bun].
+
+**Usage**:
+
+Firstly, install it:
+
+```sh
+bun add @terminal-nerds/snippets-project
+```
+
+And then in a particular file:
+
+```js
+import { snippet } from "@terminal-nerds/snippets-project";
+```
+
+[bun]: https://bun.sh/
+[bun icon]: https://api.iconify.design/logos/bun.svg
+
+---
+
+#### Deno
+
+We aim to support the latest version of ![deno icon] [Deno].
+
+**Usage**:
+
+```ts
+import { snippet } from "npm:@terminal-nerds/snippets-project";
+```
+
+[deno]: https://deno.land/
+[deno icon]: https://api.iconify.design/logos/deno.svg
+
+---
+
+#### Node.js
+
+[![node.js version support badge]][node.js]
+
+The latest ![node.js icon] [Node.js] LTS _(Long-Term Support)_ version is the minimum one supported.
+
+> **Warning**\
+> **This package is written in [ES Module] _(ESM)_ type.**\
+> So, if you wish to use it in a project with CommonJS (CJS) type, you need to bundle this package or a particular module(s).
+
+**Usage**:
+
+Install it first with the Node.js package manager of your choice. In our example, we use [pnpm].
+
+```sh
+pnpm add @terminal-nerds/snippets-project
+```
+
+And then in a particular file:
+
+```js
+import { snippet } from "@terminal-nerds/snippets-project";
+```
+
+[ES Module]: https://www.freecodecamp.org/news/javascript-es-modules-and-module-bundlers
+[pnpm]: https://pnpm.io
+[node.js]: https://nodejs.org/en/
+[node.js icon]: https://api.iconify.design/logos/nodejs-icon.svg
+[node.js version support badge]: https://img.shields.io/node/v-lts/@terminal-nerds/snippets?style=for-the-badge&logo=nodedotjs
+
+---
+
+## Security
+
+[![workflow security badge]][security policy]
+
+🔐 For more information, please refer to the [Security section] at the root of
+the [terminal-nerds/snippets] monorepo.
+
+[workflow security badge]: https://img.shields.io/github/actions/workflow/status/terminal-nerds/snippets/maintenance.yml?label=Security&logo=github&style=for-the-badge&branch=main
+[security section]: https://github.com/terminal-nerds/snippets#security
+[security policy]: https://github.com/terminal-nerds/snippets/security/policy
+
+---
+
+## License
+
+[![license badge]][license]
+
+⚖️ For more information, please refer to the [License section] at the root of the [terminal-nerds/snippets] monorepo.
+
+[license]: https://github.com/terminal-nerds/snippets/blob/main/LICENSE.md
+[license badge]: https://img.shields.io/github/license/terminal-nerds/snippets?style=for-the-badge
+[license section]: https://github.com/terminal-nerds/snippets#License
+
+### Contributing
+
+[![contributors badge]][contributors url]
+
+🤝 **Contributions of any kind are welcome!**
+
+Please refer to the monorepo _([terminal-nerds/snippets])_ project's [CONTRIBUTING file] for more information
+if you wish to get involved.
+
+[contributing file]: https://github.com/terminal-nerds/snippets/blob/main/.github/CONTRIBUTING.md
+[contributors badge]: https://img.shields.io/github/contributors/terminal-nerds/snippets?style=for-the-badge
+[contributors url]: https://github.com/terminal-nerds/snippets#contributors
+
+### Author
+
+🎉 The idea of this project was initiated by [xeho91]. However, it's the [contributors] who matter the most.
+
+[contributors]: https://github.com/terminal-nerds/snippets/blob/main/README.md#project-contributors
+[xeho91]: https://github.com/xeho91

packages/project/package.json

@@ -0,0 +1,81 @@
+{
+	"$schema": "https://json.schemastore.org/package",
+	"type": "module",
+	"name": "@terminal-nerds/snippets-project",
+	"version": "0.0.0",
+	"description": "@terminal-nerds reusable snippets for projects.",
+	"keywords": [
+		"snippets",
+		"typescript",
+		"project"
+	],
+	"license": "MIT",
+	"author": {
+		"name": "Mateusz Kadlubowski",
+		"email": "[email protected]",
+		"url": "https://xeho91.com"
+	},
+	"homepage": "https://github.com/terminal-nerds/snippets",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/terminal-nerds/snippets.git",
+		"directory": "packages/project"
+	},
+	"bugs": "https://github.com/terminal-nerds/snippets/issues",
+	"engines": {
+		"node": ">=18"
+	},
+	"exports": {
+		".": {
+			"types": "./dist/main.d.ts",
+			"import": "./dist/main.js",
+			"require": "./dist/main.cjs"
+		},
+		"./*": {
+			"types": "./dist/*/*.d.ts",
+			"import": "./dist/*/*.js",
+			"require": "./dist/*/*.cjs"
+		}
+	},
+	"files": [
+		"dist/"
+	],
+	"scripts": {
+		"build": "tsup",
+		"clean": "concurrently \"pnpm:clean:*\" --group --timings",
+		"clean:build": "del \"./dist\"",
+		"clean:cache": "del \"./node_modules/.cache\"",
+		"clean:test": "del \"./coverage\"",
+		"dev:test": "vitest watch --ui",
+		"dev:pkg": "tsup --watch",
+		"fix": "concurrently \"pnpm:fix:*\" --group --timings",
+		"fix:format": "pretty-quick --branch main --pattern \"packages/project/**/*\" --verbose",
+		"fix:js": "pnpm lint:js --fix",
+		"fix:md": "pnpm lint:md --fix",
+		"fix:pkg": "syncpack format ; syncpack fix-mismatches",
+		"lint": "concurrently \"pnpm:lint:*\" --group --timings",
+		"lint:deps": "depcheck",
+		"lint:format": "pnpm fix:format --check",
+		"lint:js": "DEBUG=\"eslint:cli-engine\" eslint . --ext .cjs,.js,.ts,.json,.yml --cache --cache-location \"./node_modules/.cache/eslint\"",
+		"lint:md": "markdownlint . --config \"../../.markdownlint.json\" --dot --ignore \"./LICENSE.md\" --ignore-path \"../../.gitignore\"",
+		"lint:pkg": "syncpack list-mismatches",
+		"lint:types": "tsc --noEmit",
+		"test:unit": "vitest run --dir \"./source\""
+	},
+	"peerDependencies": {
+		"typescript": "5.0.2"
+	},
+	"devDependencies": {
+		"@terminal-nerds/snippets-test": "workspace:*"
+	},
+	"peerDependenciesMeta": {
+		"typescript": {
+			"optional": true
+		}
+	},
+	"dependencies": {
+		"@terminal-nerds/snippets-error": "workspace:*",
+		"@terminal-nerds/snippets-runtime": "workspace:*",
+		"monorepo-root": "2.3.0"
+	}
+}

packages/project/source/main.ts

@@ -0,0 +1,2 @@
+/* MODULES */
+export * from "./monorepo/monorepo.ts";

packages/project/source/monorepo/monorepo.test.ts

@@ -0,0 +1,28 @@
+import { join } from "node:path";
+
+import { RuntimeError } from "@terminal-nerds/snippets-error/custom";
+import { returns, throws } from "@terminal-nerds/snippets-test/unit";
+import { describe, it } from "vitest";
+
+import { getProjectMonorepoRootPath, isProjectMonorepo } from "./monorepo.ts";
+
+describe(`getProjectMonorepoRoothPath(cwd?)`, () => {
+	const sampleCwd = join(process.env["HOME"] as string);
+
+	it(throws(RuntimeError).on(`random cwd`).sample(sampleCwd), ({ expect }) => {
+		expect(() => getProjectMonorepoRootPath(sampleCwd)).toThrowError(RuntimeError);
+	});
+
+	it(returns({ what: "String", value: "<project monorepo path>" }).on(`monorepo project`), ({ expect }) => {
+		expect(getProjectMonorepoRootPath()).toBeTypeOf("string");
+	});
+});
+
+describe(`isProjectMonorepo()`, () => {
+	// TODO: Find a way to test this case.
+	describe.todo("returns false on random cwd - don't know how to test it yet.");
+
+	it(returns(true).on(`monorepo project`), ({ expect }) => {
+		expect(isProjectMonorepo()).toBe(true);
+	});
+});

packages/project/source/monorepo/monorepo.ts

@@ -0,0 +1,31 @@
+import { RuntimeError } from "@terminal-nerds/snippets-error/custom";
+import { IN_BROWSER } from "@terminal-nerds/snippets-runtime/environment";
+import { monorepoRootSync } from "monorepo-root";
+
+type Path = `/${string}`;
+
+export function getProjectMonorepoRootPath(cwd?: string): Path {
+	if (IN_BROWSER) {
+		throw new RuntimeError(`You cannot determine if the current process is monorepo inside the browser.`);
+	} else {
+		const monorepoPath = monorepoRootSync(cwd);
+
+		if (monorepoPath) {
+			return monorepoPath as Path;
+		} else {
+			throw new RuntimeError(
+				`The current project is either not a monorepo, or there was an issue determining it.`,
+			);
+		}
+	}
+}
+
+export function isProjectMonorepo(): boolean {
+	try {
+		getProjectMonorepoRootPath();
+
+		return true;
+	} catch {
+		return false;
+	}
+}