@neurodevs/meta-node 0.19.10 → 0.19.12

package/src/__tests__/impl/NpmReleasePropagator.test.ts

@@ -49,6 +49,10 @@ export default class NpmReleasePropagatorTest extends AbstractPackageTest {
     protected static async runInstallsReleaseForEachRepoPath() {
         await this.run()
 
+        const actualCalls = callsToExec.filter((call) =>
+            call.command.includes(`yarn add`)
+        )
+
         const expectedCalls = [
             {
                 command: `yarn add ${this.packageName}@${this.packageVersion}`,
@@ -61,7 +65,7 @@ export default class NpmReleasePropagatorTest extends AbstractPackageTest {
         ]
 
         assert.isEqualDeep(
-            [callsToExec[2], callsToExec[5]],
+            actualCalls,
             expectedCalls,
             'Did not install release in each repo path!'
         )

package/src/impl/NpmAutopackage.ts

@@ -1,7 +1,6 @@
 import { exec as execSync } from 'child_process'
 import { mkdir, readFile, writeFile } from 'fs/promises'
 import path from 'path'
-import { chdir } from 'process'
 import { promisify } from 'util'
 import { pathExists } from 'fs-extra'
 import { parse } from 'jsonc-parser'
@@ -10,7 +9,6 @@ import GitAutocommit from './GitAutocommit.js'
 
 export default class NpmAutopackage implements Autopackage {
     public static Class?: AutopackageConstructor
-    public static chdir = chdir
     public static exec = promisify(execSync)
     public static fetch = fetch
     public static mkdir = mkdir
@@ -18,8 +16,6 @@ export default class NpmAutopackage implements Autopackage {
     public static readFile = readFile
     public static writeFile = writeFile
 
-    private installDir: string
-    private packageName: string
     private description: string
     private gitNamespace: string
     private npmNamespace?: string
@@ -39,6 +35,25 @@ export default class NpmAutopackage implements Autopackage {
 
     private shouldOpenVscode = false
 
+    private readonly installDir: string
+    private readonly packageName: string
+    private readonly packageDir: string
+    private readonly packageJsonPath: string
+    private readonly gitignorePath: string
+    private readonly tasksJsonPath: string
+    private readonly settingsJsonPath: string
+    private readonly testDirPath: string
+    private readonly abstractTestPath: string
+
+    private readonly abstractPackageTestFile = `import AbstractModuleTest from '@neurodevs/node-tdd'
+
+export default abstract class AbstractPackageTest extends AbstractModuleTest {
+    protected static async beforeEach() {
+        await super.beforeEach()
+    }
+}
+`
+
     protected constructor(options: AutopackageOptions) {
         const {
             installDir,
@@ -59,6 +74,23 @@ export default class NpmAutopackage implements Autopackage {
         this.keywords = keywords
         this.license = license
         this.author = author
+
+        this.packageDir = path.join(this.installDir, this.packageName)
+        this.packageJsonPath = path.join(this.packageDir, 'package.json')
+        this.gitignorePath = path.join(this.packageDir, '.gitignore')
+        this.tasksJsonPath = path.join(this.packageDir, '.vscode/tasks.json')
+
+        this.settingsJsonPath = path.join(
+            this.packageDir,
+            '.vscode/settings.json'
+        )
+
+        this.testDirPath = path.join(this.packageDir, 'src', '__tests__')
+
+        this.abstractTestPath = path.join(
+            this.testDirPath,
+            'AbstractPackageTest.ts'
+        )
     }
 
     public static Create(options: AutopackageOptions) {
@@ -69,11 +101,7 @@ export default class NpmAutopackage implements Autopackage {
         this.throwIfGithubTokenNotInEnv()
 
         await this.createRepoInGithubOrg()
-
-        this.chdirToInstallDir()
         await this.cloneGitRepo()
-
-        this.chdirToPackageDir()
         await this.resetMainToOrigin()
         await this.setCurrentMetaNodeVersion()
         await this.spruceCreateModule()
@@ -141,16 +169,15 @@ export default class NpmAutopackage implements Autopackage {
         )
     }
 
-    private chdirToInstallDir() {
-        this.chdir(this.installDir)
-    }
-
     private async cloneGitRepo() {
         const packageDirExists = await this.checkIfPackageDirExists()
 
         if (!packageDirExists) {
             console.log('Cloning git repository...')
-            await this.exec(`git clone ${this.gitUrl}`)
+
+            await this.exec(`git clone ${this.gitUrl}`, {
+                cwd: this.installDir,
+            })
             this.shouldOpenVscode = true
         }
     }
@@ -159,21 +186,16 @@ export default class NpmAutopackage implements Autopackage {
         return this.pathExists(this.packageDir)
     }
 
-    private get packageDir() {
-        return this.packageName
-    }
-
     private get gitUrl() {
         return `https://github.com/${this.gitNamespace}/${this.packageName}.git`
     }
 
     private async resetMainToOrigin() {
-        await this.exec('git fetch origin')
-        await this.exec('git reset --hard origin/main')
-    }
+        await this.exec('git fetch origin', { cwd: this.packageDir })
 
-    private chdirToPackageDir() {
-        this.chdir(this.packageDir)
+        await this.exec('git reset --hard origin/main', {
+            cwd: this.packageDir,
+        })
     }
 
     private async setCurrentMetaNodeVersion() {
@@ -198,6 +220,7 @@ export default class NpmAutopackage implements Autopackage {
 
         if (!packageJsonExists) {
             console.log('Running spruce create.module...')
+
             await this.execSpruceCreateModule()
             await this.commitCreatePackage()
         }
@@ -207,11 +230,10 @@ export default class NpmAutopackage implements Autopackage {
         return this.pathExists(this.packageJsonPath)
     }
 
-    private readonly packageJsonPath = 'package.json'
-
     private async execSpruceCreateModule() {
         await this.exec(
-            `spruce create.module --name "${this.packageName}" --destination "." --description "${this.description}"`
+            `spruce create.module --name "${this.packageName}" --destination "." --description "${this.description}"`,
+            { cwd: this.packageDir }
         )
     }
 
@@ -226,6 +248,7 @@ export default class NpmAutopackage implements Autopackage {
 
         if (!this.isPackageUpToDate) {
             console.log('Updating package.json...')
+
             await this.updatePackageJsonFile()
             await this.commitUpdatePackageJson()
         }
@@ -343,8 +366,6 @@ export default class NpmAutopackage implements Autopackage {
         })
     }
 
-    private readonly gitignorePath = '.gitignore'
-
     private get isGitignoreUpdated() {
         const lines = this.originalGitignoreFile
             .split(/\r?\n/)
@@ -371,17 +392,20 @@ export default class NpmAutopackage implements Autopackage {
 
         if (!vscodeSettingsExist) {
             console.log('Setting up VSCode...')
+
             await this.spruceSetupVscode()
             await this.commitSetupVscode()
         }
     }
 
     private async checkIfVscodeSettingsExist() {
-        return this.pathExists(`.vscode/settings.json`)
+        return this.pathExists(this.settingsJsonPath)
     }
 
     private async spruceSetupVscode() {
-        await this.exec('spruce setup.vscode --all true')
+        await this.exec('spruce setup.vscode --all true', {
+            cwd: this.packageDir,
+        })
     }
 
     private async commitSetupVscode() {
@@ -430,8 +454,6 @@ export default class NpmAutopackage implements Autopackage {
         return parse(raw)
     }
 
-    private readonly tasksJsonPath = '.vscode/tasks.json'
-
     private get updatedTasksJsonFile() {
         return JSON.stringify(
             {
@@ -490,7 +512,8 @@ export default class NpmAutopackage implements Autopackage {
             console.log('Installing default devDependencies...')
 
             await this.exec(
-                'yarn add -D @neurodevs/generate-id@latest @neurodevs/node-tdd@latest'
+                'yarn add -D @neurodevs/generate-id@latest @neurodevs/node-tdd@latest',
+                { cwd: this.packageDir }
             )
             await this.commitInstallDevDependencies()
         }
@@ -498,7 +521,8 @@ export default class NpmAutopackage implements Autopackage {
 
     private async getLatestVersion(scopedPackageName: string) {
         const { stdout } = await this.exec(
-            `yarn info ${scopedPackageName} version --silent`
+            `yarn info ${scopedPackageName} version --silent`,
+            { cwd: this.packageDir }
         )
         return stdout.trim()
     }
@@ -531,12 +555,14 @@ export default class NpmAutopackage implements Autopackage {
         if (!fileExists) {
             console.log(`Installing ${this.abstractTestPath}...`)
 
-            await this.mkdir('src/__tests__', { recursive: true })
+            await this.mkdir(this.testDirPath, { recursive: true })
 
             await this.writeFile(
                 this.abstractTestPath,
                 this.abstractPackageTestFile,
-                { encoding: 'utf-8' }
+                {
+                    encoding: 'utf-8',
+                }
             )
 
             await this.commitInstallAbstractPackageTest()
@@ -550,17 +576,6 @@ export default class NpmAutopackage implements Autopackage {
         return doesTsExist || doesTsxExist
     }
 
-    private readonly abstractTestPath = `src/__tests__/AbstractPackageTest.ts`
-
-    private readonly abstractPackageTestFile = `import AbstractModuleTest from '@neurodevs/node-tdd'
-
-export default abstract class AbstractPackageTest extends AbstractModuleTest {
-    protected static async beforeEach() {
-        await super.beforeEach()
-    }
-}
-`
-
     private async commitInstallAbstractPackageTest() {
         await this.GitAutocommit(
             `patch: install AbstractPackageTest (@neurodevs/meta-node: ${this.metaNodeVersion})`
@@ -569,14 +584,10 @@ export default abstract class AbstractPackageTest extends AbstractModuleTest {
 
     private async openVscode() {
         if (this.shouldOpenVscode) {
-            await this.exec('code .')
+            await this.exec('code .', { cwd: this.packageDir })
         }
     }
 
-    private get chdir() {
-        return NpmAutopackage.chdir
-    }
-
     private get exec() {
         return NpmAutopackage.exec
     }
@@ -602,7 +613,7 @@ export default abstract class AbstractPackageTest extends AbstractModuleTest {
     }
 
     private GitAutocommit(commitMessage: string) {
-        return GitAutocommit.Create(commitMessage)
+        return GitAutocommit.Create(commitMessage, this.packageDir)
     }
 }
 

package/src/impl/NpmPropagationCoordinator.ts

@@ -49,7 +49,7 @@ export default class NpmPropagationCoordinator
 
         const repoPaths = await this.determineWhereToPropagate()
 
-        const propagator = this.NpmReleaseCoordinator({
+        const propagator = this.NpmReleasePropagator({
             packageName: this.packageName,
             packageVersion: this.packageVersion,
             repoPaths,
@@ -121,7 +121,7 @@ export default class NpmPropagationCoordinator
         return NpmPropagationCoordinator.readFile
     }
 
-    private NpmReleaseCoordinator(options: ReleasePropagatorOptions) {
+    private NpmReleasePropagator(options: ReleasePropagatorOptions) {
         return NpmReleasePropagator.Create(options)
     }
 }

package/src/impl/NpmReleasePropagator.ts

@@ -3,7 +3,7 @@ import { readFile } from 'node:fs/promises'
 import path from 'node:path'
 import { promisify } from 'node:util'
 
-import { parse, minVersion, gte } from 'semver'
+import semver from 'semver'
 
 import GitAutocommit from './GitAutocommit.js'
 
@@ -17,8 +17,6 @@ export default class NpmReleasePropagator implements ReleasePropagator {
     private repoPaths: string[]
     private shouldGitCommit: boolean
 
-    private currentRepoPath!: string
-    private currentPackageJson!: PackageJson
     private metaNodeVersion!: string
 
     protected constructor(options: ReleasePropagatorOptions) {
@@ -41,38 +39,13 @@ export default class NpmReleasePropagator implements ReleasePropagator {
 
     public async run() {
         await this.throwIfUncommittedGitChanges()
+        await this.setCurrentMetaNodeVersion()
 
         console.info('Starting propagation...\n')
 
-        for (const repoPath of this.repoPaths) {
-            this.currentRepoPath = repoPath
-
-            await this.loadCurrentPackageJson()
-
-            this.throwIfPreviousReleaseNotFound()
-
-            if (this.isUpToDate) {
-                console.info(`Already up to date, skipping ${repoPath}...`)
-                continue
-            }
-
-            console.info(`Propagating to ${repoPath}...`)
-            await this.installReleaseForCurrentRepo()
-
-            const hasTypeErrors = await this.checkForTypeErrors()
-
-            if (hasTypeErrors) {
-                console.warn(
-                    `TypeScript compilation errors detected! Rolling back for ${repoPath}...`
-                )
-                await this.rollbackInstallation()
-                continue
-            }
-
-            if (this.shouldGitCommit) {
-                await this.gitCommitChanges()
-            }
-        }
+        await Promise.all(
+            this.repoPaths.map((repoPath) => this.runFor(repoPath))
+        )
 
         console.info('\nPropagation complete!\n')
     }
@@ -105,62 +78,98 @@ Please commit or stash these changes before running propagation!
         `
     }
 
-    private async loadCurrentPackageJson() {
-        const raw = await this.readFile(this.currentPackageJsonPath, 'utf-8')
-        this.currentPackageJson = JSON.parse(raw)
+    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 currentPackageJsonPath() {
-        return `${this.currentRepoPath}/package.json`
+    private async runFor(repoPath: string) {
+        const pkg = await this.loadPackageJsonFor(repoPath)
+        this.throwIfNoPreviousReleaseFor(pkg)
+
+        const isUpToDate = this.isUpToDateFor(pkg)
+
+        if (isUpToDate) {
+            console.info(`Already up to date, skipping ${repoPath}...`)
+            return
+        }
+
+        console.info(`Propagating to ${repoPath}...`)
+        await this.installReleaseFor(repoPath, pkg)
+
+        const hasTypeErrors = await this.checkTypeErrorsFor(repoPath)
+
+        if (hasTypeErrors) {
+            console.warn(`Type errors detected! Rolling back ${repoPath}...`)
+            await this.rollbackInstallationFor(repoPath)
+            return
+        }
+
+        if (this.shouldGitCommit) {
+            await this.gitCommitChangesFor(repoPath)
+        }
     }
 
-    private throwIfPreviousReleaseNotFound() {
-        if (!(this.dependencyRange || this.devDependencyRange)) {
+    private async loadPackageJsonFor(repoPath: string) {
+        const raw = await this.readFile(`${repoPath}/package.json`, 'utf-8')
+        return JSON.parse(raw)
+    }
+
+    private throwIfNoPreviousReleaseFor(pkg: PackageJson) {
+        const isDependency = Boolean(pkg.dependencies?.[this.packageName])
+        const isDevDependency = Boolean(pkg.devDependencies?.[this.packageName])
+
+        if (!(isDependency || 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 get dependencyRange() {
-        return this.currentPackageJson?.dependencies?.[this.packageName] ?? ''
-    }
+    private isUpToDateFor(pkg: PackageJson) {
+        const target = semver.parse(this.packageVersion)!
 
-    private get devDependencyRange() {
-        return (
-            this.currentPackageJson?.devDependencies?.[this.packageName] ?? ''
+        const dependencyMin = semver.minVersion(
+            pkg.dependencies?.[this.packageName] ?? ''
         )
-    }
-
-    private get isUpToDate() {
-        const target = parse(this.packageVersion)
 
-        if (!target) {
-            return false
-        }
-
-        const depMin = minVersion(this.dependencyRange ?? '')
-        const devDepMin = minVersion(this.devDependencyRange ?? '')
+        const devDependencyMin = semver.minVersion(
+            pkg.devDependencies?.[this.packageName] ?? ''
+        )
 
         return (
-            (depMin && gte(depMin, target)) ||
-            (devDepMin && gte(devDepMin, target))
+            (dependencyMin && semver.gte(dependencyMin, target)) ||
+            (devDependencyMin && semver.gte(devDependencyMin, target))
         )
     }
 
-    private async installReleaseForCurrentRepo() {
+    private async installReleaseFor(repoPath: string, pkg: PackageJson) {
+        const isDevDependency = Boolean(pkg.devDependencies?.[this.packageName])
+
         await this.exec(
-            `yarn add ${this.devDependencyRange ? '-D ' : ''}${this.packageName}@${this.packageVersion}`,
+            `yarn add ${isDevDependency ? '-D ' : ''}${this.packageName}@${this.packageVersion}`,
             {
-                cwd: this.currentRepoPath,
+                cwd: repoPath,
             }
         )
     }
 
-    private async checkForTypeErrors() {
+    private async checkTypeErrorsFor(repoPath: string) {
         try {
             await this.exec(`npx tsc --noEmit`, {
-                cwd: this.currentRepoPath,
+                cwd: repoPath,
             })
             return false
         } catch {
@@ -168,37 +177,19 @@ Please commit or stash these changes before running propagation!
         }
     }
 
-    private async rollbackInstallation() {
+    private async rollbackInstallationFor(repoPath: string) {
         await this.exec(`git reset --hard && git clean -fd`, {
-            cwd: this.currentRepoPath,
+            cwd: repoPath,
         })
     }
 
-    private async gitCommitChanges() {
-        await this.setCurrentMetaNodeVersion()
-
+    private async gitCommitChangesFor(repoPath: string) {
         await this.GitAutocommit(
-            `patch: propagate ${this.packageName}@${this.packageVersion} (@neurodevs/meta-node: ${this.metaNodeVersion})`
+            `patch: propagate ${this.packageName}@${this.packageVersion} (@neurodevs/meta-node: ${this.metaNodeVersion})`,
+            repoPath
         )
     }
 
-    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
     }
@@ -207,8 +198,8 @@ Please commit or stash these changes before running propagation!
         return NpmReleasePropagator.readFile
     }
 
-    private GitAutocommit(commitMessage: string) {
-        return GitAutocommit.Create(commitMessage, this.currentRepoPath)
+    private GitAutocommit(commitMessage: string, repoPath: string) {
+        return GitAutocommit.Create(commitMessage, repoPath)
     }
 }