submodule-version 2.2.0 → 2.3.0

package/src/sv.ts

@@ -1,8 +1,9 @@
+import path from 'path';
 import { pkgJSONManager } from "./pkgJSONManager";
 import { buildGraph } from "./buildGraph";
 import { RunOptions } from "./runOptions";
 import { versionUtil } from "./versionUtil";
-import { git } from "./git";
+import { git, GitError } from "./git";
 
 export class SV {
   constructor (
@@ -24,11 +25,10 @@ export class SV {
     }
 
     const targetPkg = await pkgJSONManager.read(parentModule);
-    let installedPkg = await pkgJSONManager.read(name);
+    const installedPkg = await pkgJSONManager.read(name);
 
     if (!installedPkg) {
       await git.addSumbmodule(url);
-      installedPkg = pkgJSONManager.read(name);
     }
 
     const versions = await git.listVersions(name);
@@ -61,6 +61,76 @@ export class SV {
     }));
   };
 
+  /*
+   * Устанавливает конкретную версию аддона: checkout на тег + запись constraint'а
+   * в package.json проекта (иначе buildGraph вернёт latest(used)).
+   * constraint по умолчанию — точный пин выбранной версии; при обновлении до
+   * последней имеет смысл передать `^<version>`, чтобы новые версии продолжали приходить.
+   */
+  // eslint-disable-next-line class-methods-use-this
+  public setVersion = async (name: string, version: string, constraint?: string) => {
+    const versions = await git.listVersions(name);
+
+    if (!versions.includes(version)) {
+      throw new Error('REQUESTED_VERSION_NOT_EXISTS');
+    }
+
+    const dir = path.join(RunOptions.modulesDir, name);
+    const dirty = await git.hasChanges(dir);
+
+    /*
+     * checkout с локальными изменениями транзакционен: git переносит их на
+     * новую версию, а если перенести нельзя — отказывается, НЕ трогая дерево.
+     * Значит при ошибке мы гарантированно остаёмся на исходной версии с теми
+     * же изменениями — сообщаем, что перенос нужно сделать вручную.
+     */
+    try {
+      await git.checkout(name, version);
+    } catch (e) {
+      if (dirty) {
+        throw new GitError('GIT_DIRTY_SWITCH_CONFLICT');
+      }
+
+      throw e;
+    }
+
+    const json = await pkgJSONManager.read();
+    if (!json?.sv) return;
+
+    const key = Object.keys(json.sv).find(k => k.endsWith(`${name}.git`));
+    const nextConstraint = constraint || version;
+    if (key && json.sv[key] !== nextConstraint) {
+      json.sv[key] = nextConstraint;
+      await pkgJSONManager.write(json);
+    }
+  };
+
+  /*
+   * Constraint корневого проекта на аддон (ключ в sv ищем по имени, как в remove).
+   */
+  // eslint-disable-next-line class-methods-use-this
+  public getConstraint = async (name: string): Promise<string | null> => {
+    const json = await pkgJSONManager.read();
+    if (!json?.sv) return null;
+
+    const key = Object.keys(json.sv).find(k => k.endsWith(`${name}.git`));
+
+    return key ? json.sv[key] : null;
+  };
+
+  // eslint-disable-next-line class-methods-use-this
+  public setConstraint = async (name: string, constraint: string): Promise<void> => {
+    const json = await pkgJSONManager.read();
+    if (!json?.sv) return;
+
+    const key = Object.keys(json.sv).find(k => k.endsWith(`${name}.git`));
+
+    if (key && json.sv[key] !== constraint) {
+      json.sv[key] = constraint;
+      await pkgJSONManager.write(json);
+    }
+  };
+
   // eslint-disable-next-line class-methods-use-this
   public remove = async (submoduleName: string, parentModule?: string) => {
     await git.rm(submoduleName);
@@ -79,4 +149,138 @@ export class SV {
     await pkgJSONManager.write(json, parentModule);
     await buildGraph();
   };
+
+  // eslint-disable-next-line class-methods-use-this
+  public hasChanges = async (module?: string): Promise<boolean> => {
+    const dir = module
+      ? path.join(RunOptions.modulesDir, module)
+      : RunOptions.cwd;
+
+    /* Сначала дешёвая проверка рабочей копии; если чисто — смотрим,
+     * нет ли незапушенных коммитов (идёт fetch в remote) */
+    if (await git.hasChanges(dir)) return true;
+
+    return git.hasUnpushedCommits(dir);
+  };
+
+  // eslint-disable-next-line class-methods-use-this
+  public hasUncommittedChanges = async (module?: string): Promise<boolean> => {
+    const dir = module
+      ? path.join(RunOptions.modulesDir, module)
+      : RunOptions.cwd;
+
+    return git.hasChanges(dir);
+  };
+
+  // eslint-disable-next-line class-methods-use-this
+  public currentVersion = async (module?: string): Promise<string | null> => {
+    const dir = module
+      ? path.join(RunOptions.modulesDir, module)
+      : RunOptions.cwd;
+
+    const tags = await git.tagsAtHead(dir);
+
+    return versionUtil.latest(tags) || null;
+  };
+
+  // eslint-disable-next-line class-methods-use-this
+  public latestVersion = async (module?: string): Promise<string> => {
+    const dir = module
+      ? path.join(RunOptions.modulesDir, module)
+      : RunOptions.cwd;
+
+    const versions = await git.listTags(dir);
+
+    return versionUtil.latest(versions) || '0.0.0';
+  };
+
+  // eslint-disable-next-line class-methods-use-this
+  public getRemote = async (module?: string): Promise<string | null> => {
+    const dir = module
+      ? path.join(RunOptions.modulesDir, module)
+      : RunOptions.cwd;
+
+    return git.getRemote(dir);
+  };
+
+  public isPublished = async (module?: string): Promise<boolean> => {
+    const dir = module
+      ? path.join(RunOptions.modulesDir, module)
+      : RunOptions.cwd;
+
+    if (!await git.isGitRepo(dir)) return false;
+
+    return !!(await this.getRemote(module));
+  };
+
+  public publish = async (opts: {
+    module?: string,
+    repoUrl?: string,
+    message?: string,
+    bump: 'release' | 'minor' | 'major',
+  }): Promise<string> => {
+    const { module, repoUrl, message, bump } = opts;
+    const dir = module
+      ? path.join(RunOptions.modulesDir, module)
+      : RunOptions.cwd;
+
+    if (!await this.isPublished(module)) {
+      if (!repoUrl) {
+        throw new GitError('GIT_REPO_URL_REQUIRED');
+      }
+
+      if (!await git.isGitRepo(dir)) {
+        await git.init(dir);
+      }
+
+      await git.addRemote(dir, repoUrl);
+    }
+
+    /* Публикация не последней версии запрещена: HEAD на теге, отличном
+     * от последнего, — обновлять такую базу можно только вручную */
+    const currentTag = await this.currentVersion(module);
+    const latestKnown = await this.latestVersion(module);
+
+    if (currentTag && latestKnown && currentTag !== latestKnown) {
+      throw new GitError('GIT_NOT_LATEST_VERSION');
+    }
+
+    /* Аддоны checkout'нуты на тег: поднимаем ветку до sync/commit,
+     * иначе коммиты и push уйдут в detached HEAD */
+    await git.ensureBranch(dir);
+
+    if (await git.isRemoteAhead(dir)) {
+      await git.pullRebaseAutostash(dir);
+    }
+
+    const dirty = await git.hasChanges(dir);
+    const headTag = await this.currentVersion(module);
+
+    /* Дерево чистое и HEAD уже отмечен версионным тегом:
+     * коммитить и бампить нечего — просто доставляем ветку и тег на remote */
+    if (!dirty && headTag) {
+      await git.push(dir, headTag);
+
+      return headTag;
+    }
+
+    const next = versionUtil.bump(await this.latestVersion(module), bump);
+
+    /* Фиксируем версию и в package.json, чтобы она не расходилась с git-тегом */
+    const pkg = await pkgJSONManager.read(module);
+    if (pkg) {
+      pkg.version = next;
+      await pkgJSONManager.write(pkg, module);
+    }
+
+    /* Перечитываем: запись версии в package.json сама по себе даёт изменения */
+    if (await git.hasChanges(dir)) {
+      await git.commitAll(dir, message || 'Update');
+    }
+
+    await git.addTag(dir, next);
+    await git.push(dir, next);
+
+    return next;
+  };
 }

package/src/versionUtil.ts

@@ -74,9 +74,22 @@ const latest = (versions: string[]) => (
   })[0] || '')
 );
 
+const bump = (
+  version: string,
+  kind: 'release' | 'minor' | 'major',
+): string => {
+  const [major, minor, patch] = toArray(version);
+
+  if (kind === 'major') return `${major + 1}.0.0`;
+  if (kind === 'minor') return `${major}.${minor + 1}.0`;
+
+  return `${major}.${minor}.${patch + 1}`;
+};
+
 export const versionUtil = {
   compare,
   pick,
   validate,
   latest,
+  bump,
 };