@neurodevs/meta-node 0.19.12 → 0.19.13

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

@@ -32,6 +32,7 @@ import GitAutocommit from '../../impl/GitAutocommit.js'
 import NpmAutopackage, {
     Autopackage,
     AutopackageOptions,
+    TsConfig,
 } from '../../impl/NpmAutopackage.js'
 import FakeAutocommit from '../../testDoubles/Autocommit/FakeAutocommit.js'
 import AbstractPackageTest from '../AbstractPackageTest.js'
@@ -65,7 +66,15 @@ export default class NpmAutopackageTest extends AbstractPackageTest {
         this.packageDir,
         '.gitignore'
     )
-    private static readonly buildDirGitignorePattern = '\nbuild/\n'
+
+    private static readonly originalGitignore = this.generateId()
+
+    private static readonly updatedGitignore = `${this.originalGitignore}\nbuild/`
+
+    private static readonly tsconfigPath = path.join(
+        this.packageDir,
+        'tsconfig.json'
+    )
 
     private static readonly tasksJsonPath = path.join(
         this.packageDir,
@@ -84,10 +93,27 @@ export default class NpmAutopackageTest extends AbstractPackageTest {
         'AbstractPackageTest.ts'
     )
 
+    private static readonly eslintConfigPath = path.join(
+        this.packageDir,
+        'eslint.config.js'
+    )
+
+    private static readonly prettierConfigPath = path.join(
+        this.packageDir,
+        'prettier.config.js'
+    )
+
+    private static readonly customLib = this.generateId()
+    private static readonly customType = this.generateId()
+    private static readonly customInclude = this.generateId()
+    private static readonly customOption = this.generateId()
+
     private static readonly setupVscodeCmd = 'spruce setup.vscode --all true'
 
     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 checkEslintConfigNdxVersionCmd = `yarn info @neurodevs/eslint-config-ndx version --silent`
+    private static readonly checkPrettierConfigNdxVersionCmd = `yarn info @neurodevs/prettier-config-ndx version --silent`
 
     private static readonly dependencies = {
         [this.generateId()]: this.generateId(),
@@ -95,7 +121,7 @@ export default class NpmAutopackageTest extends AbstractPackageTest {
     }
 
     private static readonly yarnInstallDevDepsCommand =
-        'yarn add -D @neurodevs/generate-id@latest @neurodevs/node-tdd@latest'
+        'yarn add -D @neurodevs/generate-id @neurodevs/node-tdd @neurodevs/eslint-config-ndx @neurodevs/prettier-config-ndx'
 
     private static readonly abstractTestFile = `import AbstractModuleTest from '@neurodevs/node-tdd'
 
@@ -104,6 +130,16 @@ export default abstract class AbstractPackageTest extends AbstractModuleTest {
         await super.beforeEach()
     }
 }
+`
+
+    private static readonly eslintConfigFile = `import esConfigNdx from './src/eslint.config.js'
+
+export default esConfigNdx
+`
+
+    private static readonly prettierConfigFile = `import prettierConfigNdx from '@neurodevs/prettier-config-ndx'
+
+export default prettierConfigNdx
 `
 
     private static readonly defaultOptions = {
@@ -334,7 +370,7 @@ export default abstract class AbstractPackageTest extends AbstractModuleTest {
             callsToWriteFile[1],
             {
                 file: this.gitignorePath,
-                data: this.buildDirGitignorePattern,
+                data: '\nbuild/\n',
                 options: { encoding: 'utf-8', flag: 'a' },
             },
             'Did not update .gitignore as expected!'
@@ -355,6 +391,35 @@ export default abstract class AbstractPackageTest extends AbstractModuleTest {
         )
     }
 
+    @test()
+    protected static async thenUpdatesTsconfig() {
+        await this.run()
+
+        assert.isEqualDeep(
+            callsToWriteFile[2],
+            {
+                file: this.tsconfigPath,
+                data: JSON.stringify(this.updatedTsconfig, null, 4) + '\n',
+                options: { encoding: 'utf-8', flag: 'a' },
+            },
+            'Did not update tsconfig as expected!'
+        )
+    }
+
+    @test()
+    protected static async thenCommitsUpdateTsconfig() {
+        await this.run()
+
+        assert.isEqualDeep(
+            FakeAutocommit.callsToConstructor[3],
+            {
+                commitMessage: `patch: update tsconfig (@neurodevs/meta-node: ${this.metaNodeVersion})`,
+                cwd: this.packageDir,
+            },
+            'Did not commit tsconfig changes!'
+        )
+    }
+
     @test()
     protected static async thenSpruceSetupVscode() {
         await this.run()
@@ -374,7 +439,7 @@ export default abstract class AbstractPackageTest extends AbstractModuleTest {
         await this.run()
 
         assert.isEqualDeep(
-            FakeAutocommit.callsToConstructor[3],
+            FakeAutocommit.callsToConstructor[4],
             {
                 commitMessage: `patch: setup vscode (@neurodevs/meta-node: ${this.metaNodeVersion})`,
                 cwd: this.packageDir,
@@ -387,7 +452,7 @@ export default abstract class AbstractPackageTest extends AbstractModuleTest {
     protected static async thenUpdatesVscodeTasksJson() {
         await this.run()
 
-        assert.isEqualDeep(callsToWriteFile[2], {
+        assert.isEqualDeep(callsToWriteFile[3], {
             file: this.tasksJsonPath,
             data: this.updatedTasksJson,
             options: { encoding: 'utf-8' },
@@ -399,7 +464,7 @@ export default abstract class AbstractPackageTest extends AbstractModuleTest {
         await this.run()
 
         assert.isEqualDeep(
-            FakeAutocommit.callsToConstructor[4],
+            FakeAutocommit.callsToConstructor[5],
             {
                 commitMessage: `patch: update vscode tasks.json (@neurodevs/meta-node: ${this.metaNodeVersion})`,
                 cwd: this.packageDir,
@@ -410,10 +475,11 @@ export default abstract class AbstractPackageTest extends AbstractModuleTest {
 
     @test()
     protected static async thenInstallsDefaultDevDependencies() {
+        this.setShouldInstallDevDeps()
         await this.run()
 
         assert.isEqualDeep(
-            callsToExec[8],
+            callsToExec[10],
             {
                 command: this.yarnInstallDevDepsCommand,
                 options: { cwd: this.packageDir },
@@ -424,10 +490,11 @@ export default abstract class AbstractPackageTest extends AbstractModuleTest {
 
     @test()
     protected static async thenCommitsInstallDefaultDevDependencies() {
+        this.setShouldInstallDevDeps()
         await this.run()
 
         assert.isEqualDeep(
-            FakeAutocommit.callsToConstructor[5],
+            FakeAutocommit.callsToConstructor[6],
             {
                 commitMessage: `patch: install default devDependencies (@neurodevs/meta-node: ${this.metaNodeVersion})`,
                 cwd: this.packageDir,
@@ -452,10 +519,11 @@ export default abstract class AbstractPackageTest extends AbstractModuleTest {
 
     @test()
     protected static async thenInstallsAbstractPackageTest() {
+        this.setShouldInstallDevDeps()
         await this.run()
 
         assert.isEqualDeep(
-            callsToWriteFile[3],
+            callsToWriteFile[4],
             {
                 file: this.abstractTestPath,
                 data: this.abstractTestFile,
@@ -467,10 +535,11 @@ export default abstract class AbstractPackageTest extends AbstractModuleTest {
 
     @test()
     protected static async thenCommitsInstallAbstractPackageTest() {
+        this.setShouldInstallDevDeps()
         await this.run()
 
         assert.isEqualDeep(
-            FakeAutocommit.callsToConstructor[6],
+            FakeAutocommit.callsToConstructor[7],
             {
                 commitMessage: `patch: install AbstractPackageTest (@neurodevs/meta-node: ${this.metaNodeVersion})`,
                 cwd: this.packageDir,
@@ -479,12 +548,74 @@ export default abstract class AbstractPackageTest extends AbstractModuleTest {
         )
     }
 
+    @test()
+    protected static async thenInstallsEslintConfigFile() {
+        this.setShouldInstallDevDeps()
+        await this.run()
+
+        assert.isEqualDeep(
+            callsToWriteFile[5],
+            {
+                file: this.eslintConfigPath,
+                data: this.eslintConfigFile,
+                options: { encoding: 'utf-8' },
+            },
+            'Did not install eslint.config.js!'
+        )
+    }
+
+    @test()
+    protected static async thenCommitsInstallEslintConfigFile() {
+        this.setShouldInstallDevDeps()
+        await this.run()
+
+        assert.isEqualDeep(
+            FakeAutocommit.callsToConstructor[8],
+            {
+                commitMessage: `patch: install eslint.config.js (@neurodevs/meta-node: ${this.metaNodeVersion})`,
+                cwd: this.packageDir,
+            },
+            'Did not commit install eslint.config.js changes!'
+        )
+    }
+
+    @test()
+    protected static async thenInstallsPrettierConfigFile() {
+        this.setShouldInstallDevDeps()
+        await this.run()
+
+        assert.isEqualDeep(
+            callsToWriteFile[6],
+            {
+                file: this.prettierConfigPath,
+                data: this.prettierConfigFile,
+                options: { encoding: 'utf-8' },
+            },
+            'Did not install prettier.config.js!'
+        )
+    }
+
+    @test()
+    protected static async thenCommitsInstallPrettierConfigFile() {
+        this.setShouldInstallDevDeps()
+        await this.run()
+
+        assert.isEqualDeep(
+            FakeAutocommit.callsToConstructor[9],
+            {
+                commitMessage: `patch: install prettier.config.js (@neurodevs/meta-node: ${this.metaNodeVersion})`,
+                cwd: this.packageDir,
+            },
+            'Did not commit install prettier.config.js changes!'
+        )
+    }
+
     @test()
     protected static async lastlyOpensVscodeAtEnd() {
         await this.run()
 
         assert.isEqualDeep(
-            callsToExec[9],
+            callsToExec[10],
             { command: 'code .', options: { cwd: this.packageDir } },
             'Did not open vscode at end!'
         )
@@ -496,7 +627,7 @@ export default abstract class AbstractPackageTest extends AbstractModuleTest {
             stdout: '0.0.1',
         } as unknown as ChildProcess)
 
-        await this.createAndRunAutopackage()
+        await this.runTwice()
 
         const calls = callsToExec.filter(
             (call) => call?.command === this.yarnInstallDevDepsCommand
@@ -514,15 +645,46 @@ export default abstract class AbstractPackageTest extends AbstractModuleTest {
 
     @test()
     protected static async installsDevDependenciesIfNodeTddNotLatest() {
-        setFakeExecResult(this.checkGenerateIdVersionCmd, {
-            stdout: '1.0.0',
-        } as unknown as ChildProcess)
+        this.setShouldInstallDevDeps()
+        await this.runTwice()
 
-        setFakeExecResult(this.checkNodeTddVersionCmd, {
-            stdout: '0.0.1',
-        } as unknown as ChildProcess)
+        const calls = callsToExec.filter(
+            (call) => call?.command === this.yarnInstallDevDepsCommand
+        )
+
+        assert.isEqualDeep(
+            calls[0],
+            {
+                command: this.yarnInstallDevDepsCommand,
+                options: { cwd: this.packageDir },
+            },
+            'Should install default devDependencies if not already installed!'
+        )
+    }
 
-        await this.createAndRunAutopackage()
+    @test()
+    protected static async installsDevDependenciesIfEslintConfigNdxNotLatest() {
+        this.setShouldInstallDevDeps()
+        await this.runTwice()
+
+        const calls = callsToExec.filter(
+            (call) => call?.command === this.yarnInstallDevDepsCommand
+        )
+
+        assert.isEqualDeep(
+            calls[0],
+            {
+                command: this.yarnInstallDevDepsCommand,
+                options: { cwd: this.packageDir },
+            },
+            'Should install default devDependencies if not already installed!'
+        )
+    }
+
+    @test()
+    protected static async installsDevDependenciesIfPrettierConfigNdxNotLatest() {
+        this.setShouldInstallDevDeps()
+        await this.runTwice()
 
         const calls = callsToExec.filter(
             (call) => call?.command === this.yarnInstallDevDepsCommand
@@ -557,25 +719,18 @@ export default abstract class AbstractPackageTest extends AbstractModuleTest {
 
     @test()
     protected static async doesNotCreateRepoInGithubOrgIfDone() {
-        const fakeResponse = new Response(null, {
-            status: 200,
-            statusText: 'OK',
-        })
-
-        setFakeFetchResponse(this.reposUrl, fakeResponse)
-
-        await this.createAndRunAutopackage()
+        await this.runTwice()
 
         const numCalls = callsToFetch.filter(
             (call) => call.input === this.orgsUrl
         ).length
 
-        assert.isEqual(numCalls, 0, 'Should not have created repo!')
+        assert.isEqual(numCalls, 1, 'Should have created repo once!')
     }
 
     @test()
     protected static async doesNotCloneRepoIfDone() {
-        await this.createAndRunAutopackage()
+        await this.runTwice()
 
         assert.isEqual(
             callsToExec.filter(
@@ -590,7 +745,7 @@ export default abstract class AbstractPackageTest extends AbstractModuleTest {
 
     @test()
     protected static async doesNotSpruceCreateModuleIfDone() {
-        await this.createAndRunAutopackage()
+        await this.runTwice()
 
         assert.isEqual(
             callsToExec.filter((call) => call?.command === this.createModuleCmd)
@@ -602,7 +757,7 @@ export default abstract class AbstractPackageTest extends AbstractModuleTest {
 
     @test()
     protected static async doesNotRunSetupVscodeIfDone() {
-        await this.createAndRunAutopackage()
+        await this.runTwice()
 
         assert.isEqual(
             callsToExec.filter((call) => call?.command === this.setupVscodeCmd)
@@ -614,7 +769,7 @@ export default abstract class AbstractPackageTest extends AbstractModuleTest {
 
     @test()
     protected static async doesNotCommitCreatePackageIfDone() {
-        await this.createAndRunAutopackage()
+        await this.runTwice()
 
         assert.isEqual(
             FakeAutocommit.callsToConstructor.filter(
@@ -629,7 +784,7 @@ export default abstract class AbstractPackageTest extends AbstractModuleTest {
 
     @test()
     protected static async doesNotCommitUpdatePackageIfDone() {
-        await this.createAndRunAutopackage()
+        await this.runTwice()
 
         assert.isEqual(
             FakeAutocommit.callsToConstructor.filter(
@@ -644,7 +799,7 @@ export default abstract class AbstractPackageTest extends AbstractModuleTest {
 
     @test()
     protected static async doesNotCommitUpdateGitignoreIfDone() {
-        await this.createAndRunAutopackage()
+        await this.runTwice()
 
         assert.isEqual(
             FakeAutocommit.callsToConstructor.filter(
@@ -657,9 +812,24 @@ export default abstract class AbstractPackageTest extends AbstractModuleTest {
         )
     }
 
+    @test()
+    protected static async doesNotCommitUpdateTsconfigIfDone() {
+        await this.runTwice()
+
+        assert.isEqual(
+            FakeAutocommit.callsToConstructor.filter(
+                (call) =>
+                    call?.commitMessage ===
+                    `patch: update tsconfig (@neurodevs/meta-node: ${this.metaNodeVersion})`
+            ).length,
+            1,
+            'Did not commit tsconfig changes once!'
+        )
+    }
+
     @test()
     protected static async doesNotCommitSetupVscodeIfDone() {
-        await this.createAndRunAutopackage()
+        await this.runTwice()
 
         assert.isEqual(
             FakeAutocommit.callsToConstructor.filter(
@@ -674,7 +844,7 @@ export default abstract class AbstractPackageTest extends AbstractModuleTest {
 
     @test()
     protected static async doesNotOverrideOriginalDependencies() {
-        await this.createAndRunAutopackage()
+        await this.runTwice()
 
         assert.isEqualDeep(
             JSON.parse(callsToWriteFile[0]?.data).dependencies,
@@ -685,14 +855,12 @@ export default abstract class AbstractPackageTest extends AbstractModuleTest {
 
     @test()
     protected static async doesNotUpdateTasksJsonIfAlreadyDone() {
-        setFakeReadFileResult(this.tasksJsonPath, this.updatedTasksJson)
-
-        await this.createAndRunAutopackage()
+        await this.runTwice()
 
         assert.isEqualDeep(
             callsToWriteFile.filter((call) => call.file === this.tasksJsonPath)
                 .length,
-            0,
+            1,
             'Did not update tasks.json once!'
         )
     }
@@ -701,7 +869,7 @@ export default abstract class AbstractPackageTest extends AbstractModuleTest {
     protected static async doesNotOpenVscodeIfNotCloned() {
         setPathShouldExist(this.packageDir, true)
 
-        await this.createAndRunAutopackage()
+        await this.run()
 
         assert.isFalse(
             callsToExec.some((call) => call?.command === 'code .'),
@@ -716,14 +884,14 @@ export default abstract class AbstractPackageTest extends AbstractModuleTest {
             this.originalPackageJson.replace('@neurodevs/generate-id', '')
         )
 
-        await this.createAndRunAutopackage()
+        await this.runTwice()
     }
 
     @test()
     protected static async doesNotInstallAbstractPackageTestIfTsExists() {
         setPathShouldExist(this.abstractTestPath, true)
 
-        await this.createAndRunAutopackage()
+        await this.run()
 
         const calls = callsToWriteFile.filter(
             (call) => call.file === this.abstractTestPath
@@ -740,7 +908,7 @@ export default abstract class AbstractPackageTest extends AbstractModuleTest {
     protected static async doesNotInstallAbstractPackageTestIfTsxExists() {
         setPathShouldExist(`${this.abstractTestPath}x`, true)
 
-        await this.createAndRunAutopackage()
+        await this.run()
 
         const calls = callsToWriteFile.filter(
             (call) => call.file === this.abstractTestPath
@@ -753,13 +921,75 @@ export default abstract class AbstractPackageTest extends AbstractModuleTest {
         )
     }
 
+    @test()
+    protected static async doesNotInstallEslintConfigFileIfExists() {
+        setPathShouldExist(this.eslintConfigPath, true)
+
+        await this.run()
+
+        const calls = callsToWriteFile.filter(
+            (call) => call.file === this.eslintConfigPath
+        )
+
+        assert.isEqual(
+            calls.length,
+            0,
+            'Should not install eslint.config.js if already exists!'
+        )
+    }
+
+    @test()
+    protected static async doesNotInstallPrettierConfigFileIfExists() {
+        setPathShouldExist(this.prettierConfigPath, true)
+
+        await this.run()
+
+        const calls = callsToWriteFile.filter(
+            (call) => call.file === this.prettierConfigPath
+        )
+
+        assert.isEqual(
+            calls.length,
+            0,
+            'Should not install prettier.config.js if already exists!'
+        )
+    }
+
     private static async run() {
         await this.instance.run()
     }
 
-    private static async createAndRunAutopackage() {
-        const instance = this.NpmAutopackage()
-        await instance.run()
+    private static async runTwice() {
+        await this.run()
+
+        setPathShouldExist(this.packageDir, true)
+        setPathShouldExist(this.packageJsonPath, true)
+        setPathShouldExist(this.abstractTestPath, true)
+        setPathShouldExist(this.tasksJsonPath, true)
+
+        setFakeReadFileResult(this.packageJsonPath, this.updatedPackageJson)
+        setFakeReadFileResult(this.gitignorePath, this.updatedGitignore)
+        setFakeReadFileResult(this.tasksJsonPath, this.updatedTasksJson)
+
+        setFakeReadFileResult(
+            this.tsconfigPath,
+            JSON.stringify(this.updatedTsconfig)
+        )
+
+        const fakeResponse = new Response(null, {
+            status: 200,
+            statusText: 'OK',
+        })
+
+        setFakeFetchResponse(this.reposUrl, fakeResponse)
+
+        await this.run()
+    }
+
+    private static setShouldInstallDevDeps() {
+        setFakeExecResult(this.checkGenerateIdVersionCmd, {
+            stdout: '0.0.1',
+        } as unknown as ChildProcess)
     }
 
     private static get scopedPackageName() {
@@ -798,6 +1028,22 @@ export default abstract class AbstractPackageTest extends AbstractModuleTest {
         resetCallsToExec()
 
         this.setFakeMetaNodeVersion()
+
+        setFakeExecResult(this.checkGenerateIdVersionCmd, {
+            stdout: '1.0.0',
+        } as unknown as ChildProcess)
+
+        setFakeExecResult(this.checkNodeTddVersionCmd, {
+            stdout: '1.0.0',
+        } as unknown as ChildProcess)
+
+        setFakeExecResult(this.checkEslintConfigNdxVersionCmd, {
+            stdout: '1.0.0',
+        } as unknown as ChildProcess)
+
+        setFakeExecResult(this.checkPrettierConfigNdxVersionCmd, {
+            stdout: '1.0.0',
+        } as unknown as ChildProcess)
     }
 
     private static fakeFetch() {
@@ -814,6 +1060,9 @@ export default abstract class AbstractPackageTest extends AbstractModuleTest {
         NpmAutopackage.pathExists = fakePathExists
         resetCallsToPathExists()
 
+        setPathShouldExist(this.packageDir, false)
+        setPathShouldExist(this.packageJsonPath, false)
+        setPathShouldExist(this.tasksJsonPath, false)
         setPathShouldExist(this.abstractTestPath, false)
     }
 
@@ -827,6 +1076,13 @@ export default abstract class AbstractPackageTest extends AbstractModuleTest {
             this.tasksJsonPath,
             JSON.stringify(this.originalTasksJson)
         )
+
+        setFakeReadFileResult(
+            this.tsconfigPath,
+            JSON.stringify(this.originalTsconfig)
+        )
+
+        setFakeReadFileResult(this.gitignorePath, this.originalGitignore)
     }
 
     private static fakeWriteFile() {
@@ -864,6 +1120,8 @@ export default abstract class AbstractPackageTest extends AbstractModuleTest {
             devDependencies: {
                 '@neurodevs/generate-id': '^1.0.0',
                 '@neurodevs/node-tdd': '^1.0.0',
+                '@neurodevs/eslint-config-ndx': '^1.0.0',
+                '@neurodevs/prettier-config-ndx': '^1.0.0',
             },
         })
     }
@@ -873,6 +1131,7 @@ export default abstract class AbstractPackageTest extends AbstractModuleTest {
             ...JSON.parse(this.originalPackageJson),
             name: this.scopedPackageName,
             description: this.description,
+            type: 'module',
             keywords: this.keywords,
             license: this.license,
             author: this.author,
@@ -889,6 +1148,46 @@ export default abstract class AbstractPackageTest extends AbstractModuleTest {
         })
     }
 
+    private static get originalTsconfig(): TsConfig {
+        return {
+            compilerOptions: {
+                lib: [this.customLib],
+                types: [this.customType],
+            },
+            include: [this.customInclude],
+            customOption: this.customOption,
+        }
+    }
+
+    private static get updatedTsconfig() {
+        return {
+            ...this.originalTsconfig,
+            compilerOptions: {
+                module: 'nodenext',
+                moduleResolution: 'nodenext',
+                target: 'ES2022',
+                lib: [this.customLib, 'ES2022'],
+                types: [this.customType, 'node'],
+                baseUrl: 'src',
+                outDir: 'build',
+                sourceMap: false,
+                strict: true,
+                noImplicitAny: true,
+                noImplicitReturns: true,
+                noUnusedLocals: true,
+                forceConsistentCasingInFileNames: true,
+                declaration: true,
+                skipLibCheck: true,
+                esModuleInterop: true,
+                moduleDetection: 'force',
+                allowJs: true,
+                resolveJsonModule: true,
+                experimentalDecorators: true,
+            },
+            include: [this.customInclude, './src/*.ts', './src/**/*.ts'],
+        }
+    }
+
     private static originalTasksJson = {
         [this.randomId]: this.randomId,
         tasks: [