TELESTION-435: Release npm package

wuespace · Dec 15, 2023 · 4e74ed9 · 4e74ed9
1 parent 95a4cdd
commit 4e74ed9
Show file tree

Hide file tree

Showing 3 changed files with 76 additions and 14 deletions.
diff --git a/frontend-react/package.json b/frontend-react/package.json
@@ -1,6 +1,7 @@
 {
 	"name": "@wuespace/telestion",
 	"description": "Telestion is a framework for building ground station / mission control applications.",
+	"homepage": "https://telestion.wuespace.de/",
 	"keywords": [
 		"telestion",
 		"ground station",
@@ -10,9 +11,24 @@
 		"spacecrafts",
 		"spaceflight"
 	],
-	"author": "WüSpace e.V.",
+	"author": {
+		"name": "WüSpace e. V.",
+		"email": "[email protected]",
+		"url": "https://telestion.wuespace.de/"
+	},
+	"contributors": [
+		{
+			"name": "Zuri Klaschka",
+			"email": "[email protected]",
+			"url": "https://github.com/pklaschka"
+		},
+		{
+			"name": "Ludwig Richter",
+			"email": "[email protected]",
+			"url": "https://github.com/fussel178"
+		}
+	],
 	"license": "MIT",
-	"private": true,
 	"version": "1.0.0-alpha.0",
 	"type": "module",
 	"files": [
@@ -39,6 +55,11 @@
 		"ci:style": "prettier --list-different .",
 		"ci:test": "vitest"
 	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/wuespace/telestion.git",
+		"directory": "frontend-react"
+	},
 	"dependencies": {
 		"@popperjs/core": "^2.11.8",
 		"bootstrap": "^5.3.2",
@@ -51,8 +72,12 @@
 		"react-router-dom": "^6.19.0",
 		"zod": "^3.22.4"
 	},
+	"peerDependencies": {
+		"react": "18"
+	},
 	"devDependencies": {
 		"@cucumber/cucumber": "^10.0.1",
+		"@types/node": "^20.10.4",
 		"@types/react": "^18.2.37",
 		"@types/react-dom": "^18.2.15",
 		"@typescript-eslint/eslint-plugin": "^6.10.0",
@@ -73,6 +98,7 @@
 		"typedoc-plugin-zod": "^1.1.0",
 		"typescript": "^5.2.2",
 		"vite": "^5.0.5",
+		"vite-plugin-banner": "^0.7.1",
 		"vitest": "^1.0.4"
 	}
 }
diff --git a/frontend-react/pnpm-lock.yaml b/frontend-react/pnpm-lock.yaml
diff --git a/frontend-react/vite.config.ts b/frontend-react/vite.config.ts
@@ -1,10 +1,20 @@
 /// <reference types="vitest" />
-import { resolve } from 'path';
+import { resolve } from 'node:path';
 import { defineConfig } from 'vite';
 import react from '@vitejs/plugin-react-swc';
+import banner from 'vite-plugin-banner';
 
 import packageJson from './package.json' assert { type: 'json' };
 
+const bannerText = {
+	name: packageJson.name,
+	version: packageJson.version,
+	description: packageJson.description,
+	author: `${packageJson.author.name} <${packageJson.author.email}>`,
+	homepage: packageJson.homepage,
+	license: 'Copyright (c) 2023 WüSpace e. V.'
+};
+
 // https://vitejs.dev/config/
 export default defineConfig({
 	build: {
@@ -23,8 +33,12 @@ export default defineConfig({
 			}
 		}
 	},
-	plugins: [react()],
+	plugins: [react(), banner(transformBanner(bannerText))],
 	test: {
 		environment: 'happy-dom'
 	}
 });
+
+function transformBanner(banner: Record<string, string>) {
+	return '/**\n' + Object.entries(banner).map(([key, value]) => ` * ${key}: ${value}\n`).join('') + '**/';
+}