submodule-version 2.3.2 → 3.0.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "submodule-version",
   "description": "Git <S>ubmodule <V>ersioning tool",
-  "version": "2.3.2",
+  "version": "3.0.0",
   "repository": "github:guljeny/submodule-version",
   "main": "dist/src/index.js",
   "bin": {
@@ -11,7 +11,7 @@
   "scripts": {
     "prepare": "npm run build",
     "test": "npx jest",
-    "build": "rm -rf ./dist && npx tsc",
+    "build": "rm -rf ./dist && npx tsc && chmod +x dist/runner/index.js",
     "lint": "npx eslint ./src"
   },
   "author": "Yauheni Hul",
@@ -25,6 +25,7 @@
   "license": "ISC",
   "devDependencies": {
     "@types/jest": "^29.5.13",
+    "@types/semver": "^7.5.8",
     "eslint": "9.9.1",
     "eslint-config-soft": "^1.0.5",
     "ts-jest": "^29.2.5",
@@ -33,6 +34,7 @@
   "dependencies": {
     "chalk": "^4.1.2",
     "jest": "^29.7.0",
+    "semver": "^7.6.3",
     "typescript": "^5.6.2",
     "yargs": "^17.7.2"
   }

package/runner/handleErrors/handleErrors.ts

@@ -1,13 +1,6 @@
-import { handleBuildGraphError } from './handleBuildGraphError';
-import { handleInstallError } from './handleInstallError';
-import { handleGitError } from './handleGitError';
+import { printError } from '../../src';
 import { log } from '../log';
 
-export const handleErrors = async (error: Error, gitUrl: string) => {
-  await Promise.all([
-    handleBuildGraphError(error),
-    handleInstallError(error, gitUrl),
-    handleGitError(error),
-  ]);
-  log.error('unhandled error', error.message);
+export const handleErrors = async (error: Error) => {
+  log.error(printError(error));
 };

package/runner/runner.ts

@@ -1,37 +1,106 @@
 import chalk from 'chalk';
 import yargs from 'yargs';
-import { SV } from '../src';
+import { SV, SVError } from '../src';
 import { log } from './log';
 import { handleErrors } from './handleErrors';
 
-const BASE_DIR = 'modules';
+/* 'A.B.C' → { name: 'C', parent: 'B' } (parent — непосредственный родитель) */
+const splitPath = (modulePath: string): { name: string, parent?: string } => {
+  const parts = modulePath.split('.');
+  const name = parts.pop() as string;
 
-const makeEvent = (event: (sv: SV, arg: any) => Promise<void>) => {
-  const sv = new SV(process.cwd(), BASE_DIR);
+  return { name, parent: parts.pop() };
+};
 
-  return async (arg: any) => {
-    const { url: gitUrl } = arg as {url: string};
+const makeEvent = (
+  event: (sv: SV, arg: any) => Promise<void>,
+  { skipInit = false } = {},
+) => async (arg: any) => {
+  const sv = new SV(process.cwd(), arg.modulesDir);
 
-    try {
-      await event(sv, arg);
-    } catch (e) {
-      handleErrors(e as Error, gitUrl);
+  try {
+    /* publish умеет работать с ещё не git/npm-инициализированным проектом */
+    if (!skipInit) {
+      await sv.init();
     }
-  };
+
+    await event(sv, arg);
+  } catch (e) {
+    handleErrors(e as Error);
+  }
 };
 
-const install = makeEvent(async (sv, arg) => {
-  const { url: gitUrl, target } = arg as {url: string, target?: string};
-  await sv.install(gitUrl, target);
+const put = makeEvent(async (sv, arg) => {
+  const { url: gitUrl, target, ver } = arg as {
+    url: string,
+    target?: string,
+    ver?: string,
+  };
+
+  await sv.put(gitUrl, ver || target, ver ? target : undefined);
 });
 
-const update = makeEvent(async sv => {
-  await sv.update();
+const update = makeEvent(async (sv, arg) => {
+  const { path: modulePath } = arg as { path?: string };
+
+  if (!modulePath) {
+    /* init внутри makeEvent уже пересобрал модули на максимально разрешённые */
+    log.message(chalk.green.bold('Modules are up to date!'));
+
+    return;
+  }
+
+  const { name, parent } = splitPath(modulePath);
+  const entry = sv.getResolution()[name];
+
+  if (!entry) throw new SVError('ADDON_NOT_FOUND', { name });
+
+  await sv.put(entry.url, '*', parent);
 });
 
-const remove = makeEvent(async (sv, arg) => {
-  const { name } = arg as {name: string};
-  await sv.remove(name);
+const del = makeEvent(async (sv, arg) => {
+  const { path: modulePath } = arg as {path: string};
+  const { name, parent } = splitPath(modulePath);
+
+  await sv.delete(name, parent);
+});
+
+const listVersions = makeEvent(async (sv, arg) => {
+  const { name, installed } = arg as { name?: string, installed?: boolean };
+
+  if (installed) {
+    const resolution = sv.getResolution();
+
+    if (name && !resolution[name]) {
+      throw new SVError('ADDON_NOT_FOUND', { name });
+    }
+
+    const names = name ? [name] : Object.keys(resolution);
+
+    await Promise.all(names.map(async moduleName => {
+      const version = await sv.currentVersion(moduleName);
+
+      log.message(
+        chalk.bold(moduleName),
+        version || chalk.red('no version tag'),
+      );
+    }));
+
+    return;
+  }
+
+  const versions = sv.listVersions(name);
+
+  if (name) {
+    log.message(chalk.bold(name), (versions as string[]).join(', '));
+
+    return;
+  }
+
+  Object.entries(versions as Record<string, string[]>)
+    .forEach(([moduleName, moduleVersions]) => {
+      log.message(chalk.bold(moduleName), moduleVersions.join(', '));
+    });
 });
 
 const publish = makeEvent(async (sv, arg) => {
@@ -50,59 +119,72 @@ const publish = makeEvent(async (sv, arg) => {
     chalk.green.bold('version'),
     chalk.bgGreen.black(` ${version} `),
   );
-});
+}, { skipInit: true });
 
 const validate = makeEvent(async sv => {
-  const result = await sv.buildGraph();
-
-  Object.entries(result).forEach(([name, entry]) => {
-    if (!entry.used.includes(entry.version) && entry.versions.length === 0) {
-      log.message(
-        chalk.yellow('⚠️  WARN: Module'),
-        chalk.bgYellow.black(` ${name} `),
-        chalk.yellow('does not contain any version tag!'),
-      );
-    }
-  });
+  sv.getResolution();
 
   log.message(chalk.green.bold('Everything is up to date!🔥'));
 });
 
-// eslint-disable-next-line @typescript-eslint/no-unused-expressions
 export const s = yargs.scriptName('sv')
-  .usage('$0 <cmd> [args]')
+  .usage('$0 [cmd] [args]')
+  .option('modules-dir', {
+    type: 'string',
+    describe: 'Directory where submodules live'
+      + ' (stored in package.json as sv-dir)',
+  })
   .command(
-    ['validate', '$0', 'v'],
+    ['$0'],
     'Validate and install modules',
     () => {},
     validate,
   )
   .command(
-    ['update', 'u'],
-    'Update git modules to actual versions',
-    () => {},
+    ['update [path]', 'u'],
+    'Update modules to the latest allowed versions',
+    y => y.positional('path', {
+      type: 'string',
+      describe: 'Module path (A.B.C), all modules when omitted',
+    }),
     update,
   )
   .command(
-    ['install <url> [target]', 'i'],
-    'Install new submodule',
+    ['put <url> [target]', 'install', 'i'],
+    'Install a submodule or change its version',
     y => y.positional('url', {
       type: 'string',
-      describe: 'Git submodule url',
+      describe: 'Git submodule url or installed module name',
     }).positional('target', {
       type: 'string',
-      describe: 'Target module name',
+      describe: 'Parent module name',
+    }).option('ver', {
+      type: 'string',
+      alias: 'v',
+      describe: 'Version to install',
+    }),
+    put,
+  )
+  .command(
+    ['delete <path>', 'remove', 'r'],
+    'Delete submodule by path',
+    y => y.positional('path', {
+      type: 'string',
+      describe: 'Submodule path (A.B.C)',
     }),
-    install,
+    del,
   )
   .command(
-    ['remove <name>', 'r'],
-    'Remove submodule by name',
+    ['list-versions [name]', 'ls'],
+    'List available versions of all modules or one',
     y => y.positional('name', {
       type: 'string',
-      describe: 'Submodule name',
+      describe: 'Module name',
+    }).option('installed', {
+      type: 'boolean',
+      describe: 'Show installed versions instead of available',
     }),
-    remove,
+    listVersions,
   )
   .command(
     ['publish [module]', 'p'],