@neurodevs/meta-node 0.14.29 → 0.16.0

package/src/impl/GitAutocommit.ts

@@ -0,0 +1,40 @@
+import { exec as execSync } from 'node:child_process'
+import { promisify } from 'node:util'
+
+export default class GitAutocommit implements Autocommit {
+    public static Class?: AutocommitConstructor
+    public static exec = promisify(execSync)
+
+    private commitMessage: string
+    private cwd?: string
+
+    protected constructor(commitMessage: string, cwd?: string) {
+        this.commitMessage = commitMessage
+        this.cwd = cwd
+    }
+
+    public static async Create(commitMessage: string, cwd?: string) {
+        const instance = new (this.Class ?? this)(commitMessage, cwd)
+        await instance.run()
+
+        return instance
+    }
+
+    public async run() {
+        const execOptions = { cwd: this.cwd ?? process.cwd() }
+
+        await this.exec('git add .', execOptions)
+        await this.exec(`git commit -m "${this.commitMessage}"`, execOptions)
+        await this.exec('git push', execOptions)
+    }
+
+    private get exec() {
+        return GitAutocommit.exec
+    }
+}
+
+export interface Autocommit {
+    run(): Promise<void>
+}
+
+export type AutocommitConstructor = new (commitMessage: string) => Autocommit

package/src/impl/NpmAutopackage.ts

@@ -6,6 +6,8 @@ import { promisify } from 'util'
 import { pathExists } from 'fs-extra'
 import { parse } from 'jsonc-parser'
 
+import GitAutocommit from './GitAutocommit.js'
+
 export default class NpmAutopackage implements Autopackage {
     public static Class?: AutopackageConstructor
     public static chdir = chdir
@@ -214,25 +216,11 @@ export default class NpmAutopackage implements Autopackage {
     }
 
     private async commitCreatePackage() {
-        await this.gitAddAll()
-        await this.gitCommitCreatePackage()
-        await this.gitPush()
-    }
-
-    private async gitAddAll() {
-        await this.exec('git add .')
-    }
-
-    private async gitCommitCreatePackage() {
-        await this.exec(
-            `git commit -m "patch: create package (@neurodevs/meta-node: ${this.metaNodeVersion})"`
+        await this.GitAutocommit(
+            `patch: create package (@neurodevs/meta-node: ${this.metaNodeVersion})`
         )
     }
 
-    private async gitPush() {
-        await this.exec('git push')
-    }
-
     private async updatePackageJson() {
         this.originalPackageJson = await this.loadPackageJsonFile()
 
@@ -333,14 +321,8 @@ export default class NpmAutopackage implements Autopackage {
     }
 
     private async commitUpdatePackageJson() {
-        await this.gitAddAll()
-        await this.gitCommitUpdatePackage()
-        await this.gitPush()
-    }
-
-    private async gitCommitUpdatePackage() {
-        await this.exec(
-            `git commit -m "patch: update package.json (@neurodevs/meta-node: ${this.metaNodeVersion})"`
+        await this.GitAutocommit(
+            `patch: update package.json (@neurodevs/meta-node: ${this.metaNodeVersion})`
         )
     }
 
@@ -379,14 +361,8 @@ export default class NpmAutopackage implements Autopackage {
     }
 
     private async commitUpdateGitignore() {
-        await this.gitAddAll()
-        await this.gitCommitUpdateGitignore()
-        await this.gitPush()
-    }
-
-    private async gitCommitUpdateGitignore() {
-        await this.exec(
-            `git commit -m "patch: add build dir to gitignore (@neurodevs/meta-node: ${this.metaNodeVersion})"`
+        await this.GitAutocommit(
+            `patch: add build dir to gitignore (@neurodevs/meta-node: ${this.metaNodeVersion})`
         )
     }
 
@@ -409,14 +385,8 @@ export default class NpmAutopackage implements Autopackage {
     }
 
     private async commitSetupVscode() {
-        await this.gitAddAll()
-        await this.gitCommitSetupVscode()
-        await this.gitPush()
-    }
-
-    private async gitCommitSetupVscode() {
-        await this.exec(
-            `git commit -m "patch: setup vscode (@neurodevs/meta-node: ${this.metaNodeVersion})"`
+        await this.GitAutocommit(
+            `patch: setup vscode (@neurodevs/meta-node: ${this.metaNodeVersion})`
         )
     }
 
@@ -499,14 +469,8 @@ export default class NpmAutopackage implements Autopackage {
     }
 
     private async commitUpdateVscodeTasks() {
-        await this.gitAddAll()
-        await this.gitCommitUpdateVscodeTasks()
-        await this.gitPush()
-    }
-
-    private async gitCommitUpdateVscodeTasks() {
-        await this.exec(
-            `git commit -m "patch: update vscode tasks.json (@neurodevs/meta-node: ${this.metaNodeVersion})"`
+        await this.GitAutocommit(
+            `patch: update vscode tasks.json (@neurodevs/meta-node: ${this.metaNodeVersion})`
         )
     }
 
@@ -556,14 +520,8 @@ export default class NpmAutopackage implements Autopackage {
     }
 
     private async commitInstallDevDependencies() {
-        await this.gitAddAll()
-        await this.gitCommitInstallDevDependencies()
-        await this.gitPush()
-    }
-
-    private async gitCommitInstallDevDependencies() {
-        await this.exec(
-            `git commit -m "patch: install default devDependencies (@neurodevs/meta-node: ${this.metaNodeVersion})"`
+        await this.GitAutocommit(
+            `patch: install default devDependencies (@neurodevs/meta-node: ${this.metaNodeVersion})`
         )
     }
 
@@ -604,14 +562,8 @@ export default abstract class AbstractPackageTest extends AbstractModuleTest {
 `
 
     private async commitInstallAbstractPackageTest() {
-        await this.gitAddAll()
-        await this.gitCommitInstallAbstractPackageTest()
-        await this.gitPush()
-    }
-
-    private async gitCommitInstallAbstractPackageTest() {
-        await this.exec(
-            `git commit -m "patch: install AbstractPackageTest (@neurodevs/meta-node: ${this.metaNodeVersion})"`
+        await this.GitAutocommit(
+            `patch: install AbstractPackageTest (@neurodevs/meta-node: ${this.metaNodeVersion})`
         )
     }
 
@@ -648,6 +600,10 @@ export default abstract class AbstractPackageTest extends AbstractModuleTest {
     private get writeFile() {
         return NpmAutopackage.writeFile
     }
+
+    private GitAutocommit(commitMessage: string) {
+        return GitAutocommit.Create(commitMessage)
+    }
 }
 
 export interface Autopackage {

package/src/impl/NpmPropagationCoordinator.ts

@@ -0,0 +1,94 @@
+import { readFile } from 'node:fs/promises'
+
+import NpmReleasePropagator, {
+    PackageJson,
+    ReleasePropagatorOptions,
+} from './NpmReleasePropagator.js'
+
+export default class NpmPropagationCoordinator implements PropagationCoordinator {
+    public static Class?: PropagationCoordinatorConstructor
+    public static readFile = readFile
+
+    private repoPath: string
+    private repoPaths: string[]
+
+    private currentRepoPath!: string
+    private currentPkgJson!: PackageJson
+
+    protected constructor(repoPath: string, repoPaths: string[]) {
+        this.repoPath = repoPath
+        this.repoPaths = repoPaths
+    }
+
+    public static Create(repoPath: string, repoPaths: string[]) {
+        return new (this.Class ?? this)(repoPath, repoPaths)
+    }
+
+    public async run() {
+        const pkg = await this.loadPackageJson()
+        const repoPaths = await this.determineWhereToPropagate()
+
+        const propagator = this.NpmReleaseCoordinator({
+            packageName: pkg.name,
+            packageVersion: pkg.version,
+            repoPaths,
+        })
+
+        await propagator.run()
+    }
+
+    private async loadPackageJson() {
+        const pkgJson = await this.readFile(
+            `${this.repoPath}/package.json`,
+            'utf-8'
+        )
+        return JSON.parse(pkgJson)
+    }
+
+    private async determineWhereToPropagate() {
+        const repoPaths: string[] = []
+
+        for (const repoPath of this.repoPaths) {
+            this.currentRepoPath = repoPath
+            this.currentPkgJson = await this.loadCurrentPkgJson()
+
+            if (this.isDependency ?? this.isDevDependency) {
+                repoPaths.push(repoPath)
+            }
+        }
+        return repoPaths
+    }
+
+    private get isDependency() {
+        return this.currentPkgJson?.dependencies?.[this.repoPath]
+    }
+
+    private get isDevDependency() {
+        return this.currentPkgJson?.devDependencies?.[this.repoPath]
+    }
+
+    private async loadCurrentPkgJson() {
+        const pkgJson = await this.readFile(
+            `${this.currentRepoPath}/package.json`,
+            'utf-8'
+        )
+        return JSON.parse(pkgJson)
+    }
+
+    private get readFile() {
+        return NpmPropagationCoordinator.readFile
+    }
+
+    private NpmReleaseCoordinator(options: ReleasePropagatorOptions) {
+        return NpmReleasePropagator.Create(options)
+    }
+}
+
+export interface PropagationCoordinator {
+    run(): Promise<void>
+}
+
+export type PropagationCoordinatorConstructor = new (
+    repoPath: string,
+    repoPaths: string[]
+) => PropagationCoordinator

package/src/impl/NpmReleasePropagator.ts

@@ -0,0 +1,135 @@
+import { exec as execSync } from 'node:child_process'
+import { readFile } from 'node:fs/promises'
+import path from 'node:path'
+import { promisify } from 'node:util'
+
+import GitAutocommit from './GitAutocommit.js'
+
+export default class NpmReleasePropagator implements ReleasePropagator {
+    public static Class?: ReleasePropagatorConstructor
+    public static exec = promisify(execSync)
+    public static readFile = readFile
+
+    private packageName: string
+    private packageVersion: string
+    private repoPaths: string[]
+
+    private currentRepoPath!: string
+    private currentPackageJson!: PackageJson
+    private metaNodeVersion!: string
+
+    protected constructor(options: ReleasePropagatorOptions) {
+        const { packageName, packageVersion, repoPaths } = options
+
+        this.packageName = packageName
+        this.packageVersion = packageVersion
+        this.repoPaths = repoPaths
+    }
+
+    public static Create(options: ReleasePropagatorOptions) {
+        return new (this.Class ?? this)(options)
+    }
+
+    public async run() {
+        for (const repoPath of this.repoPaths) {
+            this.currentRepoPath = repoPath
+
+            await this.throwIfPreviousReleaseNotFound()
+            await this.installReleaseForCurrentRepo()
+            await this.gitCommitChanges()
+        }
+    }
+
+    private async throwIfPreviousReleaseNotFound() {
+        await this.loadCurrentPackageJson()
+
+        if (!(this.isDependency || this.isDevDependency)) {
+            throw new Error(
+                `Cannot propagate release for ${this.packageName} because it is not listed in either dependencies or devDependencies! Please install it in the target repository before running propagation.`
+            )
+        }
+    }
+
+    private async loadCurrentPackageJson() {
+        const raw = await this.readFile(this.currentPackageJsonPath, 'utf-8')
+        this.currentPackageJson = JSON.parse(raw)
+    }
+
+    private get currentPackageJsonPath() {
+        return `${this.currentRepoPath}/package.json`
+    }
+
+    private get isDependency() {
+        return this.currentPackageJson?.dependencies?.[this.packageName]
+    }
+
+    private get isDevDependency() {
+        return this.currentPackageJson?.devDependencies?.[this.packageName]
+    }
+
+    private async installReleaseForCurrentRepo() {
+        await this.exec(
+            `yarn add ${this.isDevDependency ? '-D ' : ''}${this.packageName}@${this.packageVersion}`,
+            {
+                cwd: this.currentRepoPath,
+            }
+        )
+    }
+
+    private async gitCommitChanges() {
+        await this.setCurrentMetaNodeVersion()
+
+        await this.GitAutocommit(
+            `patch: propagate ${this.packageName}@${this.packageVersion} (@neurodevs/meta-node: ${this.metaNodeVersion})`
+        )
+    }
+
+    private async setCurrentMetaNodeVersion() {
+        const globalRoot = await this.exec('yarn global dir')
+
+        const pkgPath = path.join(
+            globalRoot.stdout.trim(),
+            'node_modules',
+            '@neurodevs',
+            'meta-node',
+            'package.json'
+        )
+
+        const raw = await this.readFile(pkgPath, { encoding: 'utf-8' })
+        const pkg = JSON.parse(raw)
+
+        this.metaNodeVersion = pkg.version
+    }
+
+    private get exec() {
+        return NpmReleasePropagator.exec
+    }
+
+    private get readFile() {
+        return NpmReleasePropagator.readFile
+    }
+
+    private GitAutocommit(commitMessage: string) {
+        return GitAutocommit.Create(commitMessage, this.currentRepoPath)
+    }
+}
+
+export interface ReleasePropagator {
+    run(): Promise<void>
+}
+
+export type ReleasePropagatorConstructor = new (
+    options: ReleasePropagatorOptions
+) => ReleasePropagator
+
+export interface ReleasePropagatorOptions {
+    packageName: string
+    packageVersion: string
+    repoPaths: string[]
+}
+
+export interface PackageJson {
+    version?: string
+    dependencies?: Record<string, string>
+    devDependencies?: Record<string, string>
+}

package/src/index.ts

@@ -6,6 +6,14 @@ export * from './impl/GitAutocloner.js'
 export { default as FakeAutocloner } from './testDoubles/Autocloner/FakeAutocloner.js'
 export * from './testDoubles/Autocloner/FakeAutocloner.js'
 
+// Autocommit
+
+export { default as GitAutocommit } from './impl/GitAutocommit.js'
+export * from './impl/GitAutocommit.js'
+
+export { default as FakeAutocommit } from './testDoubles/Autocommit/FakeAutocommit.js'
+export * from './testDoubles/Autocommit/FakeAutocommit.js'
+
 // Autodocumenter
 
 export { default as PackageAutodocumenter } from './impl/PackageAutodocumenter.js'
@@ -36,6 +44,22 @@ export * from './impl/NpmAutopackage.js'
 export { default as FakeAutopackage } from './testDoubles/Autopackage/FakeAutopackage.js'
 export * from './testDoubles/Autopackage/FakeAutopackage.js'
 
+// PropagationCoordinator
+
+export { default as NpmPropagationCoordinator } from './impl/NpmPropagationCoordinator.js'
+export * from './impl/NpmPropagationCoordinator.js'
+
+export { default as FakePropagationCoordinator } from './testDoubles/PropagationCoordinator/FakePropagationCoordinator.js'
+export * from './testDoubles/PropagationCoordinator/FakePropagationCoordinator.js'
+
+// ReleasePropagator
+
+export { default as NpmReleasePropagator } from './impl/NpmReleasePropagator.js'
+export * from './impl/NpmReleasePropagator.js'
+
+export { default as FakeReleasePropagator } from './testDoubles/ReleasePropagator/FakeReleasePropagator.js'
+export * from './testDoubles/ReleasePropagator/FakeReleasePropagator.js'
+
 // SnippetKeybinder
 
 export { default as VscodeSnippetKeybinder } from './impl/VscodeSnippetKeybinder.js'

package/src/scripts/runNpmReleasePropagator.ts

@@ -0,0 +1,9 @@
+import NpmReleasePropagator from '../impl/NpmReleasePropagator.js'
+
+const propagator = NpmReleasePropagator.Create({
+    packageName: '@neurodevs/node-tdd',
+    packageVersion: '0.2.3',
+    repoPaths: ['/Users/ericthecurious/dev/node-ble'],
+})
+
+await propagator.run()

package/src/testDoubles/Autocommit/FakeAutocommit.ts

@@ -0,0 +1,26 @@
+import { Autocommit } from '../../impl/GitAutocommit.js'
+
+export default class FakeAutocommit implements Autocommit {
+    public static callsToConstructor: {
+        commitMessage?: string
+        cwd?: string
+    }[] = []
+
+    public static numCallsToRun = 0
+
+    public constructor(commitMessage?: string, cwd?: string) {
+        FakeAutocommit.callsToConstructor.push({
+            commitMessage,
+            cwd,
+        })
+    }
+
+    public async run() {
+        FakeAutocommit.numCallsToRun++
+    }
+
+    public static resetTestDouble() {
+        FakeAutocommit.callsToConstructor = []
+        FakeAutocommit.numCallsToRun = 0
+    }
+}

package/src/testDoubles/PropagationCoordinator/FakePropagationCoordinator.ts

@@ -0,0 +1,26 @@
+import { PropagationCoordinator } from '../../impl/NpmPropagationCoordinator.js'
+
+export default class FakePropagationCoordinator implements PropagationCoordinator {
+    public static callsToConstructor: {
+        repoPath?: string
+        repoPaths?: string[]
+    }[] = []
+
+    public static numCallsToRun = 0
+
+    public constructor(repoPath?: string, repoPaths?: string[]) {
+        FakePropagationCoordinator.callsToConstructor.push({
+            repoPath,
+            repoPaths,
+        })
+    }
+
+    public async run() {
+        FakePropagationCoordinator.numCallsToRun += 1
+    }
+
+    public static resetTestDouble() {
+        FakePropagationCoordinator.callsToConstructor = []
+        FakePropagationCoordinator.numCallsToRun = 0
+    }
+}

package/src/testDoubles/ReleasePropagator/FakeReleasePropagator.ts

@@ -0,0 +1,23 @@
+import {
+    ReleasePropagator,
+    ReleasePropagatorOptions,
+} from '../../impl/NpmReleasePropagator.js'
+
+export default class FakeReleasePropagator implements ReleasePropagator {
+    public static callsToConstructor: (ReleasePropagatorOptions | undefined)[] =
+        []
+    public static numCallsToRun = 0
+
+    public constructor(options?: ReleasePropagatorOptions) {
+        FakeReleasePropagator.callsToConstructor.push(options)
+    }
+
+    public async run() {
+        FakeReleasePropagator.numCallsToRun++
+    }
+
+    public static resetTestDouble() {
+        FakeReleasePropagator.callsToConstructor = []
+        FakeReleasePropagator.numCallsToRun = 0
+    }
+}