create-vimp-game 0.2.1 → 0.3.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-vimp-game",
-  "version": "0.2.1",
+  "version": "0.3.1",
   "description": "Scaffolder for VIMP game plugins",
   "keywords": [
     "vimp",

package/src/cli.js

@@ -26,6 +26,8 @@ export const USAGE = `Usage: create-vimp-game <directory> [options]
   --title <title>    human-readable title
   --package <name>   npm package name (default: @vimp-games/<id>)
   --author <name>
+  --repository <url> project repository (URL or user/repo) — the engine links
+                     to it from the game's entry form
   --yes, -y          accept all defaults, no prompts
   --force            allow a non-empty target directory
   --no-git           skip \`git init\`
@@ -39,6 +41,7 @@ const VALUE_OPTIONS = new Map([
   ['--title', 'title'],
   ['--package', 'packageName'],
   ['--author', 'author'],
+  ['--repository', 'repository'],
   ['--engine-path', 'enginePath'],
   ['--core-path', 'corePath'],
 ]);
@@ -114,6 +117,9 @@ export function buildDefaults(args) {
     title: args.title ?? defaultTitle(id),
     packageName: args.packageName ?? defaultPackageName(id),
     author: args.author ?? '',
+    // репозиторий не выводится из author: тот — имя человека, а не логин на
+    // хостинге, и угаданный URL уехал бы битой ссылкой в футер к игрокам
+    repository: args.repository ?? '',
   };
 }
 
@@ -200,6 +206,7 @@ export async function main(argv) {
     force: args.force === true,
     enginePath: args.enginePath,
     corePath: args.corePath,
+    repository: answers.repository,
   });
 
   if (args.git) {

package/src/generator.js

@@ -144,6 +144,53 @@ async function applyEnginePath(targetDir, enginePath) {
   await writeFile(file, `${JSON.stringify(manifest, null, 2)}\n`, 'utf8');
 }
 
+// Приводит введённое человеком к голому https-адресу проекта, из которого
+// собираются оба поля. Разбираются все формы, которые реально вводят руками:
+// шорткат `user/repo`, строка из кнопки "Code → HTTPS" (хвост `.git`),
+// scp-форма `git@host:a/b`, `git+`/`ssh://`/`git://`, `#readme` и слэш.
+//
+// Движковый resolveProjectUrl сюда не импортируется: у пакета нулевые
+// рантайм-зависимости (см. prompts.js), а vimp-engine ему даже не
+// зависимость. Формы держать согласованными с packages/engine/src/lib/
+// packageLink.js — их читает та же ссылка в футере.
+function normalizeRepositoryUrl(raw) {
+  let url = raw.trim().replace(/^git\+/, '');
+
+  if (/^[\w.-]+\/[\w.-]+$/.test(url)) {
+    return `https://github.com/${url}`;
+  }
+
+  // scp-форма git@host:user/repo — двоеточие здесь разделитель, не порт
+  const scp = /^git@([^:/]+):(.+)$/.exec(url);
+
+  if (scp) {
+    url = `https://${scp[1]}/${scp[2]}`;
+  }
+
+  return url
+    .replace(/^ssh:\/\/(git@)?/, 'https://')
+    .replace(/^git:\/\//, 'https://')
+    .replace(/#readme$/, '')
+    .replace(/\.git(?=$|[#?])/, '')
+    .replace(/\/+$/, '');
+}
+
+// Адрес проекта в package.json: движок берёт из него ссылку в футере формы
+// входа (docs/en/client.md), а правило контракта A7 предупреждает, когда поля
+// нет. Пишется только по явно заданному значению — угаданный URL уехал бы
+// битой ссылкой к игрокам.
+async function applyRepository(targetDir, repository) {
+  const url = normalizeRepositoryUrl(repository);
+
+  const file = path.join(targetDir, 'package.json');
+  const manifest = JSON.parse(await readFile(file, 'utf8'));
+
+  manifest.repository = { type: 'git', url: `git+${url}.git` };
+  manifest.homepage = `${url}#readme`;
+
+  await writeFile(file, `${JSON.stringify(manifest, null, 2)}\n`, 'utf8');
+}
+
 async function applyCorePath(targetDir, corePath) {
   const file = path.join(targetDir, 'Cargo.toml');
   const patch =
@@ -171,6 +218,7 @@ export async function generate({
   force = false,
   enginePath,
   corePath,
+  repository = '',
 }) {
   await ensureTargetDir(targetDir, { force });
 
@@ -185,6 +233,13 @@ export async function generate({
     await applyEnginePath(targetDir, enginePath);
   }
 
+  if (
+    (repository ?? '').trim() !== '' &&
+    (await exists(path.join(targetDir, 'package.json')))
+  ) {
+    await applyRepository(targetDir, repository);
+  }
+
   if (
     corePath !== undefined &&
     (await exists(path.join(targetDir, 'Cargo.toml')))

package/src/prompts.js

@@ -29,7 +29,7 @@ export async function ask(question, fallback = '') {
 }
 
 // переспрос на месте: без него невалидный id всплывал бы TokenError-ом уже
-// после всех пяти вопросов, и вводить пришлось бы заново
+// после всех шести вопросов, и вводить пришлось бы заново
 export async function askValid(question, fallback, isValid, hint) {
   for (;;) {
     const answer = await ask(question, fallback);
@@ -72,6 +72,9 @@ export async function askAnswers(defaults, { interactive = true, derive } = {})
         'expected an npm package name, e.g. @vimp-games/space-arena',
       ),
       author: await ask('Author', defaults.author),
+      // пустой ответ допустим: поля repository тогда не будет вовсе, о чём
+      // скажет правило контракта A7
+      repository: await ask('Repository (URL or user/repo)', defaults.repository),
     };
   } finally {
     closePrompts();

package/src/versions.generated.json

@@ -1,4 +1,4 @@
 {
-  "engine": "0.17.0",
+  "engine": "0.18.1",
   "core": "0.8.4"
 }