@neurodevs/meta-node 0.14.27 → 0.15.0

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

@@ -1,7 +1,6 @@
 import { ChildProcess, exec as execSync } from 'child_process'
 import { readFile, writeFile } from 'fs/promises'
 import { mkdir } from 'fs/promises'
-import path from 'path'
 import { promisify } from 'util'
 import {
     callsToChdir,
@@ -31,10 +30,12 @@ import {
 } from '@neurodevs/fake-node-core'
 import { test, assert } from '@neurodevs/node-tdd'
 
+import GitAutocommit from '../../impl/GitAutocommit.js'
 import NpmAutopackage, {
     Autopackage,
     AutopackageOptions,
 } from '../../impl/NpmAutopackage.js'
+import FakeAutocommit from '../../testDoubles/Autocommit/FakeAutocommit.js'
 import AbstractPackageTest from '../AbstractPackageTest.js'
 
 const exec = promisify(execSync)
@@ -53,6 +54,8 @@ export default class NpmAutopackageTest extends AbstractPackageTest {
         this.fakeReadFile()
         this.fakeWriteFile()
 
+        this.setFakeAutocommit()
+
         this.fakeFetchForRepoNotFound()
 
         process.env.GITHUB_TOKEN = this.githubToken
@@ -127,7 +130,7 @@ export default class NpmAutopackageTest extends AbstractPackageTest {
         await this.run()
 
         assert.isEqual(
-            callsToExec[0],
+            callsToExec[0]?.command,
             `git clone https://github.com/${this.gitNamespace}/${this.name}.git`,
             'Did not call git clone!'
         )
@@ -149,7 +152,7 @@ export default class NpmAutopackageTest extends AbstractPackageTest {
         await this.run()
 
         assert.isEqual(
-            callsToExec[1],
+            callsToExec[1]?.command,
             `git fetch origin`,
             'Did not call git fetch origin!'
         )
@@ -160,7 +163,7 @@ export default class NpmAutopackageTest extends AbstractPackageTest {
         await this.run()
 
         assert.isEqual(
-            callsToExec[2],
+            callsToExec[2]?.command,
             `git reset --hard origin/main`,
             'Did not call git reset hard!'
         )
@@ -171,7 +174,7 @@ export default class NpmAutopackageTest extends AbstractPackageTest {
         await this.run()
 
         assert.isEqual(
-            callsToExec[4],
+            callsToExec[4]?.command,
             this.createModuleCmd,
             'Did not call "spruce create.module"!'
         )
@@ -182,12 +185,8 @@ export default class NpmAutopackageTest extends AbstractPackageTest {
         await this.run()
 
         assert.isEqualDeep(
-            callsToExec.slice(5, 8),
-            [
-                'git add .',
-                `git commit -m "patch: create package (@neurodevs/meta-node: ${this.metaNodeVersion})"`,
-                'git push',
-            ],
+            FakeAutocommit.callsToConstructor[0]?.commitMessage,
+            `patch: create package (@neurodevs/meta-node: ${this.metaNodeVersion})`,
             'Did not commit create package changes!'
         )
     }
@@ -255,12 +254,8 @@ export default class NpmAutopackageTest extends AbstractPackageTest {
         await this.run()
 
         assert.isEqualDeep(
-            callsToExec.slice(8, 11),
-            [
-                'git add .',
-                `git commit -m "patch: update package.json (@neurodevs/meta-node: ${this.metaNodeVersion})"`,
-                'git push',
-            ],
+            FakeAutocommit.callsToConstructor[1]?.commitMessage,
+            `patch: update package.json (@neurodevs/meta-node: ${this.metaNodeVersion})`,
             'Did not commit update package changes!'
         )
     }
@@ -285,12 +280,8 @@ export default class NpmAutopackageTest extends AbstractPackageTest {
         await this.run()
 
         assert.isEqualDeep(
-            callsToExec.slice(11, 14),
-            [
-                'git add .',
-                `git commit -m "patch: add build dir to gitignore (@neurodevs/meta-node: ${this.metaNodeVersion})"`,
-                'git push',
-            ],
+            FakeAutocommit.callsToConstructor[2]?.commitMessage,
+            `patch: add build dir to gitignore (@neurodevs/meta-node: ${this.metaNodeVersion})`,
             'Did not commit .gitignore changes!'
         )
     }
@@ -300,7 +291,7 @@ export default class NpmAutopackageTest extends AbstractPackageTest {
         await this.run()
 
         assert.isEqual(
-            callsToExec[14],
+            callsToExec[5]?.command,
             this.setupVscodeCmd,
             'Did not call "spruce setup.vscode"!'
         )
@@ -311,12 +302,8 @@ export default class NpmAutopackageTest extends AbstractPackageTest {
         await this.run()
 
         assert.isEqualDeep(
-            callsToExec.slice(15, 18),
-            [
-                'git add .',
-                `git commit -m "patch: setup vscode (@neurodevs/meta-node: ${this.metaNodeVersion})"`,
-                'git push',
-            ],
+            FakeAutocommit.callsToConstructor[3]?.commitMessage,
+            `patch: setup vscode (@neurodevs/meta-node: ${this.metaNodeVersion})`,
             'Did not commit vscode changes!'
         )
     }
@@ -337,12 +324,8 @@ export default class NpmAutopackageTest extends AbstractPackageTest {
         await this.run()
 
         assert.isEqualDeep(
-            callsToExec.slice(18, 21),
-            [
-                'git add .',
-                `git commit -m "patch: update vscode tasks.json (@neurodevs/meta-node: ${this.metaNodeVersion})"`,
-                'git push',
-            ],
+            FakeAutocommit.callsToConstructor[4]?.commitMessage,
+            `patch: update vscode tasks.json (@neurodevs/meta-node: ${this.metaNodeVersion})`,
             'Did not commit updated vscode tasks.json changes!'
         )
     }
@@ -352,7 +335,7 @@ export default class NpmAutopackageTest extends AbstractPackageTest {
         await this.run()
 
         assert.isEqual(
-            callsToExec[23],
+            callsToExec[8]?.command,
             this.yarnInstallDevDepsCommand,
             'Did not install default devDependencies!'
         )
@@ -363,12 +346,8 @@ export default class NpmAutopackageTest extends AbstractPackageTest {
         await this.run()
 
         assert.isEqualDeep(
-            callsToExec.slice(24, 27),
-            [
-                'git add .',
-                `git commit -m "patch: install default devDependencies (@neurodevs/meta-node: ${this.metaNodeVersion})"`,
-                'git push',
-            ],
+            FakeAutocommit.callsToConstructor[5]?.commitMessage,
+            `patch: install default devDependencies (@neurodevs/meta-node: ${this.metaNodeVersion})`,
             'Did not commit install devDependencies changes!'
         )
     }
@@ -407,12 +386,8 @@ export default class NpmAutopackageTest extends AbstractPackageTest {
         await this.run()
 
         assert.isEqualDeep(
-            callsToExec.slice(27, 30),
-            [
-                'git add .',
-                `git commit -m "patch: install AbstractPackageTest (@neurodevs/meta-node: ${this.metaNodeVersion})"`,
-                'git push',
-            ],
+            FakeAutocommit.callsToConstructor[6]?.commitMessage,
+            `patch: install AbstractPackageTest (@neurodevs/meta-node: ${this.metaNodeVersion})`,
             'Did not commit install AbstractPackageTest changes!'
         )
     }
@@ -421,7 +396,11 @@ export default class NpmAutopackageTest extends AbstractPackageTest {
     protected static async lastlyOpensVscodeAtEnd() {
         await this.run()
 
-        assert.isEqual(callsToExec[30], 'code .', 'Did not open vscode at end!')
+        assert.isEqual(
+            callsToExec[9]?.command,
+            'code .',
+            'Did not open vscode at end!'
+        )
     }
 
     @test()
@@ -448,8 +427,8 @@ export default class NpmAutopackageTest extends AbstractPackageTest {
 
         assert.isEqual(
             callsToExec.filter(
-                (cmd) =>
-                    cmd ===
+                (call) =>
+                    call?.command ===
                     `git clone https://github.com/${this.gitNamespace}/${this.name}.git`
             ).length,
             1,
@@ -462,7 +441,8 @@ export default class NpmAutopackageTest extends AbstractPackageTest {
         await this.createAndRunAutopackage()
 
         assert.isEqual(
-            callsToExec.filter((cmd) => cmd === this.createModuleCmd).length,
+            callsToExec.filter((call) => call?.command === this.createModuleCmd)
+                .length,
             1,
             'Did not call spruce create.module once!'
         )
@@ -473,7 +453,8 @@ export default class NpmAutopackageTest extends AbstractPackageTest {
         await this.createAndRunAutopackage()
 
         assert.isEqual(
-            callsToExec.filter((cmd) => cmd === this.setupVscodeCmd).length,
+            callsToExec.filter((call) => call?.command === this.setupVscodeCmd)
+                .length,
             1,
             'Did not call spruce setup.vscode once!'
         )
@@ -484,10 +465,10 @@ export default class NpmAutopackageTest extends AbstractPackageTest {
         await this.createAndRunAutopackage()
 
         assert.isEqual(
-            callsToExec.filter(
-                (cmd) =>
-                    cmd ===
-                    `git commit -m "patch: create package (@neurodevs/meta-node: ${this.metaNodeVersion})"`
+            FakeAutocommit.callsToConstructor.filter(
+                (call) =>
+                    call?.commitMessage ===
+                    `patch: create package (@neurodevs/meta-node: ${this.metaNodeVersion})`
             ).length,
             1,
             'Did not commit create package changes once!'
@@ -499,10 +480,10 @@ export default class NpmAutopackageTest extends AbstractPackageTest {
         await this.createAndRunAutopackage()
 
         assert.isEqual(
-            callsToExec.filter(
-                (cmd) =>
-                    cmd ===
-                    `git commit -m "patch: update package.json (@neurodevs/meta-node: ${this.metaNodeVersion})"`
+            FakeAutocommit.callsToConstructor.filter(
+                (call) =>
+                    call?.commitMessage ===
+                    `patch: update package.json (@neurodevs/meta-node: ${this.metaNodeVersion})`
             ).length,
             1,
             'Did not commit update package changes once!'
@@ -514,10 +495,10 @@ export default class NpmAutopackageTest extends AbstractPackageTest {
         await this.createAndRunAutopackage()
 
         assert.isEqual(
-            callsToExec.filter(
-                (cmd) =>
-                    cmd ===
-                    `git commit -m "patch: add build dir to gitignore (@neurodevs/meta-node: ${this.metaNodeVersion})"`
+            FakeAutocommit.callsToConstructor.filter(
+                (call) =>
+                    call?.commitMessage ===
+                    `patch: add build dir to gitignore (@neurodevs/meta-node: ${this.metaNodeVersion})`
             ).length,
             1,
             'Did not commit gitignore changes once!'
@@ -529,10 +510,10 @@ export default class NpmAutopackageTest extends AbstractPackageTest {
         await this.createAndRunAutopackage()
 
         assert.isEqual(
-            callsToExec.filter(
-                (cmd) =>
-                    cmd ===
-                    `git commit -m "patch: setup vscode (@neurodevs/meta-node: ${this.metaNodeVersion})"`
+            FakeAutocommit.callsToConstructor.filter(
+                (call) =>
+                    call?.commitMessage ===
+                    `patch: setup vscode (@neurodevs/meta-node: ${this.metaNodeVersion})`
             ).length,
             1,
             'Did not commit vscode changes once!'
@@ -571,7 +552,7 @@ export default class NpmAutopackageTest extends AbstractPackageTest {
         await this.createAndRunAutopackage()
 
         assert.isFalse(
-            callsToExec.includes('code .'),
+            callsToExec.some((call) => call?.command === 'code .'),
             'Should not open vscode if not cloned!'
         )
     }
@@ -585,7 +566,7 @@ export default class NpmAutopackageTest extends AbstractPackageTest {
         await this.createAndRunAutopackage()
 
         const calls = callsToExec.filter(
-            (cmd) => cmd === this.yarnInstallDevDepsCommand
+            (call) => call?.command === this.yarnInstallDevDepsCommand
         )
 
         assert.isEqual(
@@ -608,7 +589,7 @@ export default class NpmAutopackageTest extends AbstractPackageTest {
         await this.createAndRunAutopackage()
 
         const calls = callsToExec.filter(
-            (cmd) => cmd === this.yarnInstallDevDepsCommand
+            (call) => call?.command === this.yarnInstallDevDepsCommand
         )
 
         assert.isEqual(
@@ -709,9 +690,6 @@ export default class NpmAutopackageTest extends AbstractPackageTest {
     private static readonly checkGenerateIdVersionCmd = `yarn info @neurodevs/generate-id version --silent`
     private static readonly checkNodeTddVersionCmd = `yarn info @neurodevs/node-tdd version --silent`
 
-    private static readonly yarnGlobalDirCmd = 'yarn global dir'
-    private static readonly fakeGlobalRoot = this.generateId()
-
     private static orderJsonKeys(
         json: Record<string, unknown>,
         keyOrder: string[]
@@ -744,20 +722,7 @@ export default class NpmAutopackageTest extends AbstractPackageTest {
         NpmAutopackage.exec = fakeExec as unknown as typeof exec
         resetCallsToExec()
 
-        setFakeExecResult(this.yarnGlobalDirCmd, {
-            stdout: this.fakeGlobalRoot,
-        } as unknown as ChildProcess)
-
-        setFakeReadFileResult(
-            path.join(
-                this.fakeGlobalRoot,
-                'node_modules',
-                '@neurodevs',
-                'meta-node',
-                'package.json'
-            ),
-            JSON.stringify({ version: this.metaNodeVersion })
-        )
+        this.setFakeMetaNodeVersion()
     }
 
     private static fakeFetch() {
@@ -794,6 +759,11 @@ export default class NpmAutopackageTest extends AbstractPackageTest {
         resetCallsToWriteFile()
     }
 
+    private static setFakeAutocommit() {
+        GitAutocommit.Class = FakeAutocommit
+        FakeAutocommit.resetTestDouble()
+    }
+
     private static fakeFetchForRepoNotFound() {
         const fakeResponse = new Response(null, {
             status: 404,
@@ -813,7 +783,6 @@ export default class NpmAutopackageTest extends AbstractPackageTest {
     private static readonly author = this.generateId()
 
     private static readonly githubToken = this.generateId()
-    private static readonly metaNodeVersion = this.generateId()
     private static readonly randomId = this.generateId()
 
     private static get reposUrl() {

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

@@ -0,0 +1,151 @@
+import { exec as execSync } from 'node:child_process'
+import { readFile } from 'node:fs/promises'
+import { promisify } from 'node:util'
+import {
+    callsToExec,
+    fakeExec,
+    fakeReadFile,
+    resetCallsToExec,
+    resetCallsToReadFile,
+    setFakeReadFileResult,
+} from '@neurodevs/fake-node-core'
+import { test, assert } from '@neurodevs/node-tdd'
+
+import GitAutocommit from '../../impl/GitAutocommit.js'
+import NpmReleasePropagator, {
+    ReleasePropagator,
+    ReleasePropagatorOptions,
+} from '../../impl/NpmReleasePropagator.js'
+import { FakeAutocommit } from '../../index.js'
+import AbstractPackageTest from '../AbstractPackageTest.js'
+
+const exec = promisify(execSync)
+
+export default class NpmReleasePropagatorTest extends AbstractPackageTest {
+    private static instance: ReleasePropagator
+
+    private static readonly packageName = this.generateId()
+    private static readonly packageVersion = this.generateId()
+    private static readonly repoPaths = [this.generateId(), this.generateId()]
+
+    protected static async beforeEach() {
+        await super.beforeEach()
+
+        this.setFakeExec()
+        this.setFakeReadFile()
+        this.setFakeAutocommit()
+
+        this.instance = this.NpmReleasePropagator()
+    }
+
+    @test()
+    protected static async createsInstance() {
+        assert.isTruthy(this.instance, 'Failed to create instance!')
+    }
+
+    @test()
+    protected static async runInstallsReleaseForEachRepoPath() {
+        await this.run()
+
+        const expectedCalls = [
+            {
+                command: `yarn add ${this.packageName}@${this.packageVersion}`,
+                options: { cwd: this.repoPaths[0] },
+            },
+            {
+                command: `yarn add -D ${this.packageName}@${this.packageVersion}`,
+                options: { cwd: this.repoPaths[1] },
+            },
+        ]
+
+        assert.isEqualDeep(
+            [callsToExec[0], callsToExec[2]],
+            expectedCalls,
+            'Did not install release in each repo path!'
+        )
+    }
+
+    @test()
+    protected static async runThrowsIfRepoDoesNotHavePreviousRelease() {
+        const missingPackageName = this.generateId()
+
+        this.instance = this.NpmReleasePropagator({
+            packageName: missingPackageName,
+        })
+
+        await assert.doesThrowAsync(async () => {
+            await this.run()
+        }, `Cannot propagate release for ${missingPackageName} because it is not listed in either dependencies or devDependencies! Please install it in the target repository before running propagation.`)
+    }
+
+    @test()
+    protected static async commitsChangesToGit() {
+        await this.run()
+
+        assert.isEqualDeep(
+            FakeAutocommit.callsToConstructor,
+            [
+                {
+                    commitMessage: `patch: propagate ${this.packageName}@${this.packageVersion} (@neurodevs/meta-node: ${this.metaNodeVersion})`,
+                    cwd: this.repoPaths[0],
+                },
+                {
+                    commitMessage: `patch: propagate ${this.packageName}@${this.packageVersion} (@neurodevs/meta-node: ${this.metaNodeVersion})`,
+                    cwd: this.repoPaths[1],
+                },
+            ],
+            'Did not commit changes to git for each repo path!'
+        )
+    }
+
+    private static async run() {
+        await this.instance.run()
+    }
+
+    private static setFakeExec() {
+        NpmReleasePropagator.exec = fakeExec as unknown as typeof exec
+        resetCallsToExec()
+
+        this.setFakeMetaNodeVersion()
+    }
+
+    private static setFakeReadFile() {
+        NpmReleasePropagator.readFile =
+            fakeReadFile as unknown as typeof readFile
+        resetCallsToReadFile()
+
+        setFakeReadFileResult(
+            `${this.repoPaths[0]}/package.json`,
+            JSON.stringify({
+                dependencies: {
+                    [this.packageName]: this.generateId(),
+                },
+            })
+        )
+
+        setFakeReadFileResult(
+            `${this.repoPaths[1]}/package.json`,
+            JSON.stringify({
+                devDependencies: {
+                    [this.packageName]: this.generateId(),
+                },
+            })
+        )
+    }
+
+    private static setFakeAutocommit() {
+        GitAutocommit.Class = FakeAutocommit
+        FakeAutocommit.resetTestDouble()
+    }
+
+    private static NpmReleasePropagator(
+        options?: Partial<ReleasePropagatorOptions>
+    ) {
+        return NpmReleasePropagator.Create({
+            packageName: this.packageName,
+            packageVersion: this.packageVersion,
+            repoPaths: this.repoPaths,
+            ...options,
+        })
+    }
+}

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

@@ -119,7 +119,7 @@ export default class UiAutomoduleTest extends AbstractAutomoduleTest {
         await this.run()
 
         assert.isEqualDeep(
-            callsToExec[0],
+            callsToExec[0]?.command,
             'yarn version --minor --no-git-tag-version',
             'Did not bump minor version!'
         )
@@ -234,18 +234,44 @@ export default class UiAutomoduleTest extends AbstractAutomoduleTest {
     }
 
     private static get sortedIndexFile() {
-        const blocks = `${this.originalIndexFile}${this.indexFilePattern}`
+        const blocks = this.originalIndexFile
             .split(/(?=\/\/)/)
             .map((s) => s.trim())
             .filter(Boolean)
 
-        blocks.sort((a, b) => {
-            const aKey = a.match(/^\/\/\s*([^\n]*)/)?.[1]?.trim() ?? ''
-            const bKey = b.match(/^\/\/\s*([^\n]*)/)?.[1]?.trim() ?? ''
-            return aKey.localeCompare(bKey)
-        })
+        const newBlock = this.indexFilePattern.trim()
+
+        const newKey =
+            newBlock
+                .match(/^\/\/\s*([^\n]*)/)?.[1]
+                ?.trim()
+                .toLowerCase() ?? ''
+
+        let inserted = false
+        const result: string[] = []
+
+        for (const block of blocks) {
+            if (!inserted) {
+                const blockKey =
+                    block
+                        .match(/^\/\/\s*([^\n]*)/)?.[1]
+                        ?.trim()
+                        .toLowerCase() ?? ''
+
+                if (newKey.localeCompare(blockKey) < 0) {
+                    result.push(newBlock)
+                    inserted = true
+                }
+            }
+
+            result.push(block)
+        }
+
+        if (!inserted) {
+            result.push(newBlock)
+        }
 
-        return blocks.join('\n\n')
+        return result.join('\n\n')
     }
 
     private static toKebabCase(str: string): string {

package/src/impl/AbstractAutomodule.ts

@@ -151,18 +151,44 @@ export default abstract class AbstractAutomodule implements Automodule {
     private readonly backupIndexFilePath = './src/exports.ts'
 
     private get sortedIndexFile() {
-        const blocks = `${this.originalIndexFile}${this.indexFileContent}`
+        const blocks = this.originalIndexFile
             .split(/(?=\/\/)/)
             .map((s) => s.trim())
             .filter(Boolean)
 
-        blocks.sort((a, b) => {
-            const aKey = a.match(/^\/\/\s*([^\n]*)/)?.[1]?.trim() ?? ''
-            const bKey = b.match(/^\/\/\s*([^\n]*)/)?.[1]?.trim() ?? ''
-            return aKey.localeCompare(bKey)
-        })
+        const newBlock = this.indexFileContent.trim()
 
-        return blocks.join('\n\n')
+        const newKey =
+            newBlock
+                .match(/^\/\/\s*([^\n]*)/)?.[1]
+                ?.trim()
+                .toLowerCase() ?? ''
+
+        let inserted = false
+        const result: string[] = []
+
+        for (const block of blocks) {
+            if (!inserted) {
+                const blockKey =
+                    block
+                        .match(/^\/\/\s*([^\n]*)/)?.[1]
+                        ?.trim()
+                        .toLowerCase() ?? ''
+
+                if (newKey.localeCompare(blockKey) < 0) {
+                    result.push(newBlock)
+                    inserted = true
+                }
+            }
+
+            result.push(block)
+        }
+
+        if (!inserted) {
+            result.push(newBlock)
+        }
+
+        return result.join('\n\n')
     }
 
     private async bumpMinorVersion() {

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