Merge pull request #13 from frytg/dev/storage-s3

feat: prepare `storage-s3` module

.github/workflows/test.yml

@@ -17,8 +17,9 @@ permissions:
   contents: read
 
 env:
+  NODE_ENV: production
   JSR_DEPENDENCIES: "@cross/test @std/assert @std/fmt @frytg/logger"
-  NPM_DEPENDENCIES: "luxon sinon"
+  NPM_DEPENDENCIES: "luxon minio sinon"
 
 jobs:
   test-on-deno-and-lint:

biome.json

@@ -2,7 +2,7 @@
 	"$schema": "https://biomejs.dev/schemas/1.9.3/schema.json",
 	"files": {
 		"maxSize": 2097152,
-		"ignore": ["*.vue", "vendor"]
+		"ignore": ["*.vue", "coverage", "node_modules", "vendor"]
 	},
 	"formatter": {
 		"indentStyle": "tab",

check-required-env/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Check Required Env Changelog
+
+## 2024-12-17 - 0.1.0
+
+- feat: add `getRequiredEnv`
+
+## 2024-11-27 - 0.0.1
+
+- feat: add test for required env
+
+## 2024-11-22 - 0.0.1
+
+- feat: add check required env

check-required-env/check-required-env.ts

@@ -5,8 +5,8 @@ import logger from '@frytg/logger'
 /**
  * Check if an environment variable is required and log an alert and exit if it is not set.
  *
- * @param name - The name of the environment variable.
- * @returns void
+ * @param {string} name - The name of the environment variable.
+ * @returns {void}
  *
  * @example
  * ```ts

check-required-env/deno.jsonc

@@ -1,8 +1,11 @@
 {
 	"$schema": "https://jsr.io/schema/config-file.v1.json",
 	"name": "@frytg/check-required-env",
-	"version": "0.0.1",
-	"exports": "./check-required-env.ts",
+	"version": "0.1.0",
+	"exports": {
+		".": "./check-required-env.ts",
+		"./get": "./get-required-env.ts"
+	},
 	"imports": {
 		"@frytg/logger": "jsr:@frytg/[email protected]"
 	}

check-required-env/get-required-env.ts

@@ -0,0 +1,34 @@
+// load packages
+import process from 'node:process'
+import logger from '@frytg/logger'
+
+/**
+ * Access an environment variable and log an alert and exit if it is not set.
+ *
+ * @param {string} name - The name of the environment variable.
+ * @param {boolean} preferThrowError - Whether to throw an error if the environment variable is not set.
+ * @returns {string} The value of the environment variable.
+ *
+ * @example
+ * ```ts
+ * import { getRequiredEnv } from '@frytg/check-required-env/get'
+ *
+ * getRequiredEnv('MY_IMPORTANT_ENV_VAR', false)
+ * ```
+ */
+export const getRequiredEnv = (name: string, preferThrowError = true): string => {
+	const value = process.env[name]
+
+	// return if the env variable is set
+	if (value !== undefined) return value
+
+	// log and exit if not set
+	logger.log({
+		level: 'alert',
+		message: `env ${name} is required`,
+		source: 'getRequiredEnv',
+		data: { name },
+	})
+	if (preferThrowError) throw new Error(`env ${name} is required`)
+	process.exit(1)
+}

deno.jsonc

@@ -16,6 +16,7 @@
 	},
 	"tasks": {
 		"check": "deno fmt --check && deno lint && biome lint",
+		"dry-run": "deno publish --dry-run",
 		"test": "deno test --allow-sys --allow-env --clean --coverage"
 	},
 	"lint": {
@@ -30,7 +31,7 @@
 		},
 		"exclude": ["**/*.md", "**/*.yml", "**/*.yaml"]
 	},
-	"workspace": ["./check-required-env", "./crypto", "./dates", "./logger"],
+	"workspace": ["./check-required-env", "./crypto", "./dates", "./logger", "./storage-s3"],
 	"imports": {
 		"@biomejs/biome": "npm:@biomejs/biome@^1.9.4",
 		"@types/node": "npm:@types/node@^22.10.2",