@texisoft/create-nexus-plugin 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,78 @@
+TEXISOFT PROPRIETARY LICENSE
+
+Copyright (c) 2026 texisoft. All rights reserved.
+
+This software, including its source code, documentation and associated
+materials (the "Software"), is proprietary to texisoft ("Licensor"). It is made
+available on public package registries for distribution convenience only.
+Publication does NOT grant an open-source license and does NOT transfer or
+waive any right of the Licensor.
+
+1. Limited permission
+   Subject to this license, you may install and run the Software solely to
+   develop, test, build and publish plugins for the Nexus Discord bot platform
+   operated by the Licensor ("Nexus"), and only for as long as you comply with
+   this license. This permission is personal, non-exclusive, non-transferable,
+   non-sublicensable and revocable at any time.
+
+2. Restrictions
+   Except where applicable law expressly forbids the restriction, you may not:
+   a) copy, modify, adapt, translate or create derivative works of the Software;
+   b) redistribute, publish, sell, rent, lease, sublicense or otherwise make
+      the Software or any part of it available to third parties, whether
+      modified or not, including re-publishing it to any package registry or
+      repository;
+   c) decompile, reverse engineer or attempt to derive source code, algorithms
+      or the sandbox, permission or protocol design, except for the source
+      that is delivered in readable form with the package, which remains
+      subject to this license;
+   d) use the Software, or knowledge gained from it, to build, operate or
+      support a platform, service or product that competes with or replaces
+      Nexus, or that is compatible with Nexus plugins;
+   e) circumvent, disable or probe the security, sandbox, permission, rate
+      limit, review or consent mechanisms of Nexus, or use the Software to
+      attack, overload or gain unauthorized access to Nexus or any third
+      party;
+   f) remove or alter copyright, license or attribution notices;
+   g) use the Software to train, fine-tune or evaluate machine-learning models,
+      or to build datasets for that purpose.
+
+3. Your plugins
+   Plugins you write remain yours. Submitting a plugin to Nexus is governed by
+   the Nexus developer terms, not by this license. Bundled portions of the
+   Software that the build tooling inserts into your plugin may be distributed
+   only as part of that plugin and only to Nexus.
+
+4. Ownership
+   The Software is licensed, not sold. The Licensor retains all right, title
+   and interest, including all intellectual property rights.
+
+5. Termination
+   This license ends automatically and without notice if you breach it. On
+   termination you must stop using the Software and delete all copies. The
+   Licensor may also withdraw this license at any time by publishing a notice
+   or removing the Software.
+
+6. No warranty
+   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+   IMPLIED, INCLUDING MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE,
+   NON-INFRINGEMENT, AVAILABILITY OR COMPATIBILITY WITH ANY FUTURE VERSION. THE
+   SOFTWARE IS A PRE-1.0 RELEASE AND ITS INTERFACES MAY CHANGE WITHOUT NOTICE.
+
+7. Limitation of liability
+   TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE LICENSOR IS NOT LIABLE FOR ANY
+   INDIRECT, INCIDENTAL, SPECIAL, CONSEQUENTIAL OR PUNITIVE DAMAGES, LOSS OF
+   DATA, PROFITS OR GOODWILL, ARISING FROM OR RELATED TO THE SOFTWARE. THE
+   LICENSOR'S TOTAL LIABILITY IS LIMITED TO EUR 100, EXCEPT FOR LIABILITY THAT
+   CANNOT BE EXCLUDED UNDER APPLICABLE LAW (INTENT, GROSS NEGLIGENCE, INJURY
+   TO LIFE, BODY OR HEALTH, AND LIABILITY UNDER THE PRODUCT LIABILITY ACT).
+
+8. Governing law
+   This license is governed by the laws of the Federal Republic of Germany,
+   excluding its conflict-of-laws rules and the UN Convention on Contracts for
+   the International Sale of Goods. If you are a merchant or a legal entity,
+   the courts at the Licensor's registered seat have exclusive jurisdiction.
+
+9. Severability
+   If a provision is invalid, the remaining provisions stay in force and the
+   invalid provision is replaced by the closest valid one.

package/README.md

@@ -1,3 +1,26 @@
-# Temporary Holding Version
+# @texisoft/create-nexus-plugin
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Legt ein neues Nexus-Plugin an.
+
+```bash
+npm create @texisoft/nexus-plugin mein-plugin
+cd mein-plugin
+npm install
+npm test
+```
+
+Du bekommst ein lauffähiges Projekt mit einem Beispiel-Command, Übersetzungen und einem Test:
+
+```
+manifest.json    id, Version, Berechtigungen, Commands, Sprachen
+index.js         export default definePlugin({ setup(ctx) { ... } })
+locales/         Übersetzungen für ctx.t
+test/            Tests mit dem Testkit
+package.json     SDK, CLI und Testkit als Abhängigkeiten
+```
+
+Weiter geht es mit `npx nexus-plugin validate`, `npx nexus-plugin dev --guild <TEST_GUILD_ID>` und `npx nexus-plugin publish`. Was diese Befehle tun, steht in der README von `@texisoft/nexus-plugin-cli`.
+
+## Lizenz
+
+Node.js 22 oder neuer. Das Paket ist proprietär, alle Rechte bleiben bei texisoft. Du darfst es nur nutzen, um Plugins für Nexus zu entwickeln, Genaueres steht in der `LICENSE`. Die Version ist noch 0.x, Schnittstellen können sich ändern.

package/bin/create-nexus-plugin.js

@@ -0,0 +1,18 @@
+#!/usr/bin/env node
+import { resolve } from 'node:path'
+import { scaffoldPlugin } from '../src/scaffold.js'
+
+const [id, ...rest] = process.argv.slice(2)
+
+if (!id || id.startsWith('-')) {
+  process.stderr.write('Aufruf: npm create @texisoft/nexus-plugin <plugin-id> [Anzeigename]\n')
+  process.exit(2)
+}
+
+try {
+  const files = await scaffoldPlugin({ dir: resolve(process.cwd(), id), id, name: rest.join(' ') || undefined })
+  process.stdout.write(`Plugin "${id}" angelegt (${files.length} Dateien).\n\n  cd ${id}\n  npm install\n  npm test\n  npx nexus-plugin validate\n`)
+} catch (error) {
+  process.stderr.write(`Fehler: ${error.message}\n`)
+  process.exit(1)
+}

package/package.json

@@ -1,6 +1,46 @@
 {
   "name": "@texisoft/create-nexus-plugin",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "Gerüst für neue Nexus-Plugins (npm create @texisoft/nexus-plugin <id>).",
+  "keywords": [
+    "nexus",
+    "discord",
+    "discord-bot",
+    "plugin",
+    "texisoft"
+  ],
+  "license": "SEE LICENSE IN LICENSE",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/texisoft/discord-nexus-bot.git",
+    "directory": "packages/create-nexus-plugin"
+  },
+  "homepage": "https://github.com/texisoft/discord-nexus-bot/tree/master/packages/create-nexus-plugin",
+  "bugs": {
+    "url": "https://github.com/texisoft/discord-nexus-bot/issues"
+  },
+  "type": "module",
+  "bin": {
+    "create-nexus-plugin": "./bin/create-nexus-plugin.js"
+  },
+  "main": "./src/scaffold.js",
+  "exports": {
+    ".": "./src/scaffold.js"
+  },
+  "files": [
+    "bin",
+    "src",
+    "template",
+    "README.md",
+    "LICENSE"
+  ],
+  "engines": {
+    "node": ">=22"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@texisoft/nexus-plugin-sdk": "^0.1.0"
+  }
+}

package/src/scaffold.js

@@ -0,0 +1,58 @@
+import { mkdir, readFile, readdir, stat, writeFile } from 'node:fs/promises'
+import { dirname, join, relative } from 'node:path'
+import { fileURLToPath } from 'node:url'
+import { PLUGIN_ID_REGEX } from '@texisoft/nexus-plugin-sdk'
+
+export const TEMPLATE_DIR = fileURLToPath(new URL('../template', import.meta.url))
+
+const RENAMES = { _gitignore: '.gitignore' }
+
+function targetName(name) {
+  if (RENAMES[name]) return RENAMES[name]
+  return name.endsWith('.tpl') ? name.slice(0, -4) : name
+}
+
+function titleFromId(id) {
+  return id.split('-').map((part) => part.charAt(0).toUpperCase() + part.slice(1)).join(' ')
+}
+
+async function walk(dir) {
+  const out = []
+  for (const entry of await readdir(dir, { withFileTypes: true })) {
+    const full = join(dir, entry.name)
+    if (entry.isDirectory()) out.push(...await walk(full))
+    else out.push(full)
+  }
+  return out
+}
+
+async function assertEmpty(dir) {
+  try {
+    const info = await stat(dir)
+    if (!info.isDirectory()) throw new Error(`${dir} existiert und ist kein Verzeichnis`)
+    if ((await readdir(dir)).length > 0) throw new Error(`Zielverzeichnis ${dir} ist nicht leer`)
+  } catch (error) {
+    if (error.code !== 'ENOENT') throw error
+  }
+}
+
+export async function scaffoldPlugin({ dir, id, name, templateDir = TEMPLATE_DIR }) {
+  if (!PLUGIN_ID_REGEX.test(id)) {
+    throw new Error(`Ungültige Plugin-ID "${id}": erlaubt sind ^[a-z][a-z0-9-]{2,31}$`)
+  }
+  await assertEmpty(dir)
+  const values = { __ID__: id, __NAME__: name ?? titleFromId(id) }
+  const created = []
+  for (const file of await walk(templateDir)) {
+    const rel = relative(templateDir, file)
+    const parts = rel.split(/[\\/]/)
+    parts[parts.length - 1] = targetName(parts[parts.length - 1])
+    const target = join(dir, ...parts)
+    let content = await readFile(file, 'utf8')
+    for (const [token, value] of Object.entries(values)) content = content.replaceAll(token, value)
+    await mkdir(dirname(target), { recursive: true })
+    await writeFile(target, content)
+    created.push(parts.join('/'))
+  }
+  return created.sort()
+}

package/template/README.md

@@ -0,0 +1,14 @@
+# __NAME__
+
+Nexus-Plugin (`__ID__`).
+
+```
+npm install
+npm test                    Tests mit dem Test-Kit
+npx nexus-plugin validate   Manifest, Permissions und Muster prüfen
+npx nexus-plugin login      Schlüssel einmalig speichern (nie im Projekt)
+npx nexus-plugin dev        Plugin lokal entwickeln, verbunden mit einer Test-Guild
+npx nexus-plugin publish    Bauen, hochladen und zur Prüfung einreichen
+```
+
+Die vollständige Anleitung steht in `docs/PLUGINS-DEV.md` des Nexus-Repositories.

package/template/_gitignore

@@ -0,0 +1,5 @@
+node_modules
+dist
+.nexus-plugin
+.env
+.env.*

package/template/index.js

@@ -0,0 +1,10 @@
+import { definePlugin } from '@texisoft/nexus-plugin-sdk'
+
+export default definePlugin({
+  setup(ctx) {
+    ctx.commands.on('hello', async (interaction, api) => {
+      const n = await ctx.storage.kv.incr('hello:count')
+      await api.reply({ content: ctx.t('hello.reply', { name: interaction.user.username, n }), ephemeral: true })
+    })
+  }
+})

package/template/locales/de.json

@@ -0,0 +1,3 @@
+{
+  "hello.reply": "Hallo {name}! Das war Aufruf Nummer {n}."
+}

package/template/locales/en.json

@@ -0,0 +1,3 @@
+{
+  "hello.reply": "Hello {name}! That was call number {n}."
+}

package/template/manifest.json

@@ -0,0 +1,16 @@
+{
+  "id": "__ID__",
+  "name": "__NAME__",
+  "version": "0.1.0",
+  "sdkVersion": "^0.1.0",
+  "description": "Beschreibe hier, was dein Plugin tut.",
+  "permissions": {
+    "commandsMax": 1,
+    "storageQuotaKb": 16
+  },
+  "commands": [
+    { "name": "hello", "description": "Sagt Hallo und zählt mit", "options": [] }
+  ],
+  "locales": { "default": "de", "supported": ["de", "en"] },
+  "main": "index.js"
+}

package/template/package.json.tpl

@@ -0,0 +1,20 @@
+{
+  "name": "__ID__",
+  "version": "0.1.0",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "test": "node --test",
+    "validate": "nexus-plugin validate",
+    "build": "nexus-plugin build",
+    "dev": "nexus-plugin dev",
+    "publish:plugin": "nexus-plugin publish"
+  },
+  "dependencies": {
+    "@texisoft/nexus-plugin-sdk": "^0.1.0"
+  },
+  "devDependencies": {
+    "@texisoft/nexus-plugin-cli": "^0.1.0",
+    "@texisoft/nexus-plugin-testkit": "^0.1.0"
+  }
+}

package/template/test/plugin.test.js.tpl

@@ -0,0 +1,16 @@
+import { test } from 'node:test'
+import assert from 'node:assert/strict'
+import { fileURLToPath } from 'node:url'
+import { createProjectHarness } from '@texisoft/nexus-plugin-testkit'
+
+const dir = fileURLToPath(new URL('..', import.meta.url))
+
+test('/hello antwortet und zählt hoch', async () => {
+  const harness = await createProjectHarness(dir)
+  const first = await harness.runCommand('hello')
+  assert.equal(first.ok, true)
+  assert.match(first.reply.content, /Nummer 1\./)
+  const second = await harness.runCommand('hello')
+  assert.match(second.reply.content, /Nummer 2\./)
+  assert.equal(harness.storage.get('hello:count'), 2)
+})