@tapestry-mud/cli 0.3.10 → 0.4.0

package/bin/tapestry.js

@@ -255,7 +255,7 @@ program
 
 program
   .command('validate')
-  .description('Validate tapestry.yaml in the current directory')
+  .description('Validate pack.yaml in the current directory')
   .action(() => {
     try {
       validate();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tapestry-mud/cli",
-  "version": "0.3.10",
+  "version": "0.4.0",
   "description": "CLI for the Tapestry MUD engine",
   "bin": {
     "tapestry": "./bin/tapestry.js"

package/src/commands/create-pack.js

@@ -3,6 +3,7 @@
 const fs = require('fs');
 const path = require('path');
 const { generatePackFiles } = require('../scaffold/templates');
+const { PACK_MANIFEST } = require('../lib/manifest');
 
 function parseName(name) {
   const scopedMatch = name.match(/^@([a-z0-9-]+)\/([a-z0-9-]+)$/);
@@ -59,7 +60,7 @@ function createPack(name, cwd) {
         console.log(`  ${file.path}`);
       }
     }
-    console.log('\nEdit tapestry.yaml, then run: tapestry validate');
+    console.log(`\nEdit ${PACK_MANIFEST}, then run: tapestry validate`);
   }
 }
 

package/src/commands/init.js

@@ -28,7 +28,7 @@ function buildManifest(name, deps, engineVersion, engineChannel) {
   ].join('\n');
 }
 
-function buildServerYaml({ serverName, adminHandle, adminPassword, telemetry }) {
+function buildServerYaml({ serverName, adminHandle, adminEmail, adminPassword, telemetry }) {
   const telemetryBlock = telemetry
     ? [
         `telemetry:`,
@@ -59,6 +59,7 @@ function buildServerYaml({ serverName, adminHandle, adminPassword, telemetry })
     ``,
     `admin:`,
     `  handle: ${adminHandle}`,
+    `  email: ${adminEmail}`,
     `  password: ${adminPassword}`,
     ``,
     `# --- Telemetry (OpenTelemetry) ---`,
@@ -105,6 +106,15 @@ function buildServerYaml({ serverName, adminHandle, adminPassword, telemetry })
     `# pre_auth:`,
     `#   enabled: false`,
     `#   token_expiry_seconds: 60`,
+    ``,
+    `# --- Accounts ---`,
+    `# accounts:`,
+    `#   max_concurrent_characters: 1`,
+    ``,
+    `# --- Link-Dead (player disconnect grace period) ---`,
+    `# link_dead:`,
+    `#   enabled: true`,
+    `#   timeout_seconds: 120`,
   ].join('\n');
 }
 
@@ -157,6 +167,7 @@ async function init(cwd, { registryUrl = DEFAULT_REGISTRY, yes = false, prompter
     answers = {
       gameName: dirName,
       adminHandle: 'admin',
+      adminEmail: 'admin@localhost',
       adminPassword: 'changeme',
       telemetry: false,
     };
@@ -177,6 +188,17 @@ async function init(cwd, { registryUrl = DEFAULT_REGISTRY, yes = false, prompter
         message: 'Admin handle:',
         validate: (v) => (v.trim().length > 0 && !/\s/.test(v)) || 'Required, no spaces',
       },
+      {
+        type: 'input',
+        name: 'adminEmail',
+        message: 'Admin email:',
+        validate: (v) => {
+          v = v.trim();
+          if (!v) { return 'Required'; }
+          if (!v.includes('@') || !v.includes('.')) { return 'Must be a valid email'; }
+          return true;
+        },
+      },
       {
         type: 'password',
         name: 'adminPassword',
@@ -208,6 +230,7 @@ async function init(cwd, { registryUrl = DEFAULT_REGISTRY, yes = false, prompter
     buildServerYaml({
       serverName: answers.gameName,
       adminHandle: answers.adminHandle,
+      adminEmail: answers.adminEmail,
       adminPassword: answers.adminPassword,
       telemetry: answers.telemetry,
     })

package/src/commands/install.js

@@ -5,11 +5,12 @@ const os = require('os');
 const path = require('path');
 const { readYaml, writeYaml } = require('../util/yaml');
 const { resolve } = require('../lib/semver-resolver');
-const { readLock, writeLock } = require('../lib/lock-file');
+const { readLock, writeLock, hashDeps } = require('../lib/lock-file');
 const { fetchTarball, DEFAULT_REGISTRY } = require('../lib/registry-client');
 const { verifyIntegrity, saveTarball, extractTarball } = require('../lib/tarball');
 const { addPackageToBoot } = require('../lib/boot');
 const { loadToken } = require('../lib/auth');
+const { PACK_MANIFEST } = require('../lib/manifest');
 
 function packInstallPath(cwd, packageName) {
   const parts = packageName.split('/');
@@ -25,6 +26,9 @@ function parsePackageArg(arg) {
 }
 
 function isLockCurrent(manifestDeps, lock) {
+  if (!lock.deps_hash || lock.deps_hash !== hashDeps(manifestDeps)) {
+    return false;
+  }
   const lockResolved = lock.resolved || {};
   return Object.keys(manifestDeps).every((name) => lockResolved[name]);
 }
@@ -34,8 +38,18 @@ async function installResolved(cwd, resolved, token) {
     const destDir = packInstallPath(cwd, packageName);
 
     if (fs.existsSync(destDir)) {
-      console.log(`  already installed ${packageName}@${info.version}`);
-      continue;
+      const installedManifestPath = path.join(destDir, PACK_MANIFEST);
+      if (fs.existsSync(installedManifestPath)) {
+        const installed = readYaml(installedManifestPath);
+        if (installed.version === info.version) {
+          console.log(`  already installed ${packageName}@${info.version}`);
+          continue;
+        }
+        console.log(`  upgrading ${packageName} ${installed.version} -> ${info.version}`);
+      } else {
+        console.log(`  reinstalling ${packageName}@${info.version} (missing manifest)`);
+      }
+      fs.rmSync(destDir, { recursive: true });
     }
 
     console.log(`  installing ${packageName}@${info.version}`);
@@ -54,7 +68,7 @@ async function installResolved(cwd, resolved, token) {
       }
     }
 
-    const packManifest = readYaml(path.join(destDir, 'tapestry.yaml'));
+    const packManifest = readYaml(path.join(destDir, PACK_MANIFEST));
     addPackageToBoot(cwd, packageName, packManifest);
   }
 }
@@ -95,7 +109,8 @@ async function install(packageArg, { cwd = process.cwd(), registryUrl = DEFAULT_
   }
 
   await installResolved(cwd, resolved, token);
-  writeLock(cwd, { lockfile_version: 1, resolved });
+  const deps = manifest.dependencies || {};
+  writeLock(cwd, { lockfile_version: 1, deps_hash: hashDeps(deps), resolved });
   console.log('Done.');
 }
 

package/src/commands/list.js

@@ -5,6 +5,7 @@ const path = require('path');
 const { readLock } = require('../lib/lock-file');
 const { readBoot } = require('../lib/boot');
 const { readYaml } = require('../util/yaml');
+const { PACK_MANIFEST } = require('../lib/manifest');
 
 function packInstallPath(cwd, packageName) {
   const parts = packageName.split('/');
@@ -32,7 +33,7 @@ async function list({ cwd = process.cwd() } = {}) {
     const enabled = boot.packs[pkgName]?.enabled !== false ? 'enabled' : 'disabled';
 
     let type = '';
-    const packManifestPath = path.join(packInstallPath(cwd, pkgName), 'tapestry.yaml');
+    const packManifestPath = path.join(packInstallPath(cwd, pkgName), PACK_MANIFEST);
     if (fs.existsSync(packManifestPath)) {
       try {
         type = readYaml(packManifestPath).type || '';

package/src/commands/pack.js

@@ -3,12 +3,13 @@
 const path = require('path');
 const { readYaml } = require('../util/yaml');
 const { buildTarball, computeIntegrity } = require('../lib/tarball-builder');
+const { PACK_MANIFEST } = require('../lib/manifest');
 const { validate } = require('./validate');
 
 async function pack({ cwd = process.cwd() } = {}) {
   validate({ cwd });
 
-  const manifest = readYaml(path.join(cwd, 'tapestry.yaml'));
+  const manifest = readYaml(path.join(cwd, PACK_MANIFEST));
   const shortName = manifest.name.split('/')[1];
   const outputPath = path.join(cwd, `${shortName}-${manifest.version}.tgz`);
 

package/src/commands/publish.js

@@ -8,13 +8,14 @@ const FormData = require('form-data');
 const { readYaml } = require('../util/yaml');
 const { validate } = require('./validate');
 const { buildTarball, computeIntegrity } = require('../lib/tarball-builder');
+const { PACK_MANIFEST } = require('../lib/manifest');
 const { requireToken } = require('../lib/auth');
 const { DEFAULT_REGISTRY, throwIfError } = require('../lib/registry-client');
 
 async function publish({ cwd = process.cwd(), registryUrl = DEFAULT_REGISTRY } = {}) {
   validate({ cwd });
 
-  const manifest = readYaml(path.join(cwd, 'tapestry.yaml'));
+  const manifest = readYaml(path.join(cwd, PACK_MANIFEST));
   const token = requireToken();
 
   const shortName = manifest.name.split('/')[1];

package/src/commands/update.js

@@ -9,6 +9,7 @@ const { readLock, writeLock } = require('../lib/lock-file');
 const { fetchTarball, DEFAULT_REGISTRY } = require('../lib/registry-client');
 const { verifyIntegrity, saveTarball, extractTarball } = require('../lib/tarball');
 const { addPackageToBoot } = require('../lib/boot');
+const { PACK_MANIFEST } = require('../lib/manifest');
 
 function packInstallPath(cwd, packageName) {
   const parts = packageName.split('/');
@@ -69,7 +70,7 @@ async function update(packageArg, { cwd = process.cwd(), registryUrl = DEFAULT_R
       }
     }
 
-    const packManifest = readYaml(path.join(destDir, 'tapestry.yaml'));
+    const packManifest = readYaml(path.join(destDir, PACK_MANIFEST));
     addPackageToBoot(cwd, packageName, packManifest);
   }
 

package/src/commands/validate.js

@@ -4,11 +4,20 @@ const fs = require('fs');
 const path = require('path');
 const { readYaml } = require('../util/yaml');
 const { validatePackageManifest } = require('../schema/manifest');
+const { PACK_MANIFEST } = require('../lib/manifest');
 
 function validate({ cwd = process.cwd() } = {}) {
-  const manifestPath = path.join(cwd, 'tapestry.yaml');
+  const manifestPath = path.join(cwd, PACK_MANIFEST);
   if (!fs.existsSync(manifestPath)) {
-    throw new Error('No tapestry.yaml found in current directory');
+    const serverPath = path.join(cwd, 'tapestry.yaml');
+    if (fs.existsSync(serverPath)) {
+      throw new Error(
+        `No ${PACK_MANIFEST} found in current directory. ` +
+        `The tapestry.yaml here is a server manifest. ` +
+        `Pack validation requires ${PACK_MANIFEST}.`
+      );
+    }
+    throw new Error(`No ${PACK_MANIFEST} found in current directory`);
   }
 
   const data = readYaml(manifestPath);
@@ -18,7 +27,11 @@ function validate({ cwd = process.cwd() } = {}) {
   if (!result.success) {
     for (const issue of result.error.issues) {
       const fieldPath = issue.path.join('.') || 'root';
-      console.log(`  error: ${fieldPath} - ${issue.message}`);
+      let message = issue.message;
+      if (fieldPath === 'engine' && data.engine && typeof data.engine === 'object') {
+        message += `. engine must be a version constraint string in pack manifests (e.g. '>=0.0.1'). Object format is for server manifests (tapestry.yaml).`;
+      }
+      console.log(`  error: ${fieldPath} - ${message}`);
     }
     throw new Error(`${result.error.issues.length} validation error(s)`);
   }

package/src/lib/lock-file.js

@@ -1,11 +1,17 @@
 'use strict';
 
+const crypto = require('crypto');
 const fs = require('fs');
 const path = require('path');
 const { readYaml, writeYaml } = require('../util/yaml');
 
 const LOCK_FILE = 'tapestry-lock.yaml';
 
+function hashDeps(deps) {
+  const sorted = Object.keys(deps).sort().map((k) => `${k}@${deps[k]}`).join('\n');
+  return crypto.createHash('sha256').update(sorted).digest('hex');
+}
+
 function readLock(cwd) {
   const lockPath = path.join(cwd, LOCK_FILE);
   if (!fs.existsSync(lockPath)) {
@@ -18,4 +24,4 @@ function writeLock(cwd, lock) {
   writeYaml(path.join(cwd, LOCK_FILE), lock);
 }
 
-module.exports = { readLock, writeLock };
+module.exports = { readLock, writeLock, hashDeps };

package/src/lib/manifest.js

@@ -0,0 +1,5 @@
+'use strict';
+
+const PACK_MANIFEST = 'pack.yaml';
+
+module.exports = { PACK_MANIFEST };

package/src/scaffold/templates.js

@@ -404,7 +404,7 @@ see_also: [help, commands]
 
 function generatePackFiles({ scopedName, shortName }) {
   return [
-    { path: 'tapestry.yaml', content: manifestTemplate(scopedName) },
+    { path: 'pack.yaml', content: manifestTemplate(scopedName) },
     { path: 'tags.yml', content: tagsTemplate() },
     { path: 'areas/example-area/area.yaml', content: areaTemplate() },
     { path: 'areas/example-area/rooms/town-square.yaml', content: roomTemplate(shortName) },