@neurodevs/meta-node 0.19.15 → 0.19.17

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

@@ -1,8 +1,7 @@
-import { ChildProcess, exec as execSync } from 'child_process'
+import { ChildProcess } from 'child_process'
 import { readFile, writeFile } from 'fs/promises'
 import { mkdir } from 'fs/promises'
 import path from 'path'
-import { promisify } from 'util'
 import {
     callsToExec,
     callsToFetch,
@@ -21,9 +20,11 @@ import {
     resetCallsToPathExists,
     resetCallsToReadFile,
     resetCallsToWriteFile,
+    resetFakeReadFileThrowsFor,
     setFakeExecResult,
     setFakeFetchResponse,
     setFakeReadFileResult,
+    setFakeReadFileThrowsFor,
     setPathShouldExist,
 } from '@neurodevs/fake-node-core'
 import { test, assert } from '@neurodevs/node-tdd'
@@ -37,8 +38,6 @@ import NpmAutopackage, {
 import FakeAutocommit from '../../testDoubles/Autocommit/FakeAutocommit.js'
 import AbstractPackageTest from '../AbstractPackageTest.js'
 
-const exec = promisify(execSync)
-
 export default class NpmAutopackageTest extends AbstractPackageTest {
     private static instance: Autopackage
 
@@ -108,10 +107,18 @@ export default class NpmAutopackageTest extends AbstractPackageTest {
         'prettier.config.js'
     )
 
+    private static readonly settingsJsonPath = path.join(
+        this.packageDir,
+        '.vscode',
+        'settings.json'
+    )
+
     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 customTsconfigOption = this.generateId()
+    private static readonly customJestOption = this.generateId()
+    private static readonly customScript = this.generateId()
 
     private static readonly setupVscodeCmd = 'spruce setup.vscode --all true'
 
@@ -125,6 +132,9 @@ export default class NpmAutopackageTest extends AbstractPackageTest {
         [this.generateId()]: this.generateId(),
     }
 
+    private static readonly yarnRemoveDevDepsCommand =
+        'yarn remove eslint eslint-config-spruce prettier chokidar-cli ts-node @types/node'
+
     private static readonly yarnInstallDevDepsCommand =
         'yarn add -D @neurodevs/generate-id @neurodevs/node-tdd @neurodevs/eslint-config-ndx @neurodevs/prettier-config-ndx'
 
@@ -145,6 +155,71 @@ export default esConfigNdx
     private static readonly prettierConfigFile = `import prettierConfigNdx from '@neurodevs/prettier-config-ndx'
 
 export default prettierConfigNdx
+`
+
+    private static readonly settingsJsonFile = `{
+  "debug.node.autoAttach": "on",
+  "git.ignoreLimitWarning": true,
+  "javascript.validate.enable": false,
+  "files.watcherExclude": {
+    "**/.git/objects/**": true,
+    "**/.git/subtree-cache/**": true,
+    "**/build/**": true,
+    "**/node_modules/**": true
+  },
+  "search.exclude": {
+    "**/build/**": true,
+    "**/node_modules/**": true,
+    "**/.next/**": true
+  },
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": "always"
+  },
+  "editor.formatOnSave": true,
+  "editor.formatOnSaveMode": "file",
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "editor.maxTokenizationLineLength": 20000000,
+  "[javascript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true
+  },
+  "[javascriptreact]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true
+  },
+  "[typescript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true
+  },
+  "[typescriptreact]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true
+  },
+  "eslint.enable": true,
+  "eslint.useFlatConfig": true,
+  "eslint.validate": [
+    "javascript",
+    "javascriptreact",
+    "typescript",
+    "typescriptreact"
+  ],
+  "eslint.workingDirectories": ["./"],
+  "debug.javascript.unmapMissingSources": true,
+  "javascript.preferences.importModuleSpecifier": "relative",
+  "typescript.preferences.importModuleSpecifier": "relative",
+  "typescript.tsdk": "node_modules/typescript/lib",
+  "typescript.validate.enable": true,
+  "cSpell.ignorePaths": [
+    "**/package-lock.json",
+    "**/node_modules/**",
+    "**/build/**",
+    "**/vscode-extension/**",
+    "**/.git/objects/**",
+    ".vscode",
+    ".spruce"
+  ],
+  "cSpell.words": ["arkit", "autogenerated", "scrollable", "serializable"]
+}
 `
 
     private static readonly defaultOptions = {
@@ -330,7 +405,6 @@ export default prettierConfigNdx
                 'dependencies',
                 'devDependencies',
                 'jest',
-                'skill',
             ]
         )
 
@@ -478,13 +552,28 @@ export default prettierConfigNdx
         )
     }
 
+    @test()
+    protected static async thenRemovesOldDevDependencies() {
+        this.setShouldInstallDevDeps()
+        await this.run()
+
+        assert.isEqualDeep(
+            callsToExec[6],
+            {
+                command: this.yarnRemoveDevDepsCommand,
+                options: { cwd: this.packageDir },
+            },
+            'Did not remove old devDependencies!'
+        )
+    }
+
     @test()
     protected static async thenInstallsDefaultDevDependencies() {
         this.setShouldInstallDevDeps()
         await this.run()
 
         assert.isEqualDeep(
-            callsToExec[10],
+            callsToExec[11],
             {
                 command: this.yarnInstallDevDepsCommand,
                 options: { cwd: this.packageDir },
@@ -554,7 +643,7 @@ export default prettierConfigNdx
     }
 
     @test()
-    protected static async thenDeletesOldEslintConfigMjs() {
+    protected static async thenRemovesOldEslintConfigMjs() {
         setPathShouldExist(
             path.join(this.packageDir, 'eslint.config.mjs'),
             true
@@ -564,12 +653,12 @@ export default prettierConfigNdx
         await this.run()
 
         assert.isEqualDeep(
-            callsToExec[11],
+            callsToExec[12],
             {
                 command: `git rm eslint.config.mjs`,
                 options: { cwd: this.packageDir },
             },
-            'Did not delete old eslint.config.mjs!'
+            'Did not remove old eslint.config.mjs!'
         )
     }
 
@@ -635,17 +724,106 @@ export default prettierConfigNdx
         )
     }
 
+    @test()
+    protected static async thenInstallsSettingsJsonFile() {
+        this.setShouldInstallDevDeps()
+        await this.run()
+
+        assert.isEqualDeep(
+            callsToWriteFile[7],
+            {
+                file: this.settingsJsonPath,
+                data: this.settingsJsonFile,
+                options: { encoding: 'utf-8' },
+            },
+            'Did not install settings.json!'
+        )
+    }
+
+    @test()
+    protected static async thenCommitsInstallSettingsJsonFile() {
+        this.setShouldInstallDevDeps()
+        await this.run()
+
+        assert.isEqualDeep(
+            FakeAutocommit.callsToConstructor[10],
+            {
+                commitMessage: `patch: install settings.json (@neurodevs/meta-node: ${this.metaNodeVersion})`,
+                cwd: this.packageDir,
+            },
+            'Did not commit install settings.json changes!'
+        )
+    }
+
     @test()
     protected static async lastlyOpensVscodeAtEnd() {
         await this.run()
 
         assert.isEqualDeep(
-            callsToExec[11],
+            callsToExec[12],
             { command: 'code .', options: { cwd: this.packageDir } },
             'Did not open vscode at end!'
         )
     }
 
+    @test()
+    protected static async removesCertainKeysFromPackageJson() {
+        const keysToRemove = [
+            'skill',
+            'jest.testPathIgnorePatterns',
+            'jest.moduleNameMapper',
+            'scripts.build.resolve-paths',
+            'scripts.lint.tsc',
+            'scripts.post.watch.build',
+            'scripts.resolve-paths.lint',
+            'scripts.watch.rebuild',
+            'scripts.watch.tsc',
+        ]
+
+        const pkg = JSON.parse(this.updatedPackageJson)
+
+        for (const key of keysToRemove) {
+            assert.isUndefined(
+                this.getByPath(pkg, key),
+                `Did not remove ${key} from package.json!`
+            )
+        }
+    }
+
+    @test()
+    protected static async installsEslintConfigIfNotExists() {
+        setFakeReadFileThrowsFor(this.eslintConfigJsPath)
+
+        await this.run()
+
+        const calls = callsToWriteFile.filter(
+            (call) => call.file === this.eslintConfigJsPath
+        )
+
+        assert.isEqual(
+            calls.length,
+            1,
+            'Should install eslint.config.js if it does not exist!'
+        )
+    }
+
+    @test()
+    protected static async installsPrettierConfigIfNotExists() {
+        setFakeReadFileThrowsFor(this.prettierConfigPath)
+
+        await this.run()
+
+        const calls = callsToWriteFile.filter(
+            (call) => call.file === this.prettierConfigPath
+        )
+
+        assert.isEqual(
+            calls.length,
+            1,
+            'Should install prettier.config.js if it does not exist!'
+        )
+    }
+
     @test()
     protected static async installsDevDependenciesIfGenerateIdNotLatest() {
         setFakeExecResult(this.checkGenerateIdVersionCmd, {
@@ -906,7 +1084,10 @@ export default prettierConfigNdx
     protected static async doesNotThrowIfGenerateIdNotInPackageJson() {
         setFakeReadFileResult(
             this.packageJsonPath,
-            this.originalPackageJson.replace('@neurodevs/generate-id', '')
+            JSON.stringify(this.originalPackageJson).replace(
+                '@neurodevs/generate-id',
+                ''
+            )
         )
 
         await this.runTwice()
@@ -963,8 +1144,8 @@ export default prettierConfigNdx
     }
 
     @test()
-    protected static async doesNotInstallEslintConfigFileIfExists() {
-        setPathShouldExist(this.eslintConfigJsPath, true)
+    protected static async doesNotInstallEslintConfigFileIfContentsEqual() {
+        setFakeReadFileResult(this.eslintConfigJsPath, this.eslintConfigFile)
 
         await this.run()
 
@@ -975,13 +1156,13 @@ export default prettierConfigNdx
         assert.isEqual(
             calls.length,
             0,
-            'Should not install eslint.config.js if already exists!'
+            'Should not install eslint.config.js if contents are equal!'
         )
     }
 
     @test()
-    protected static async doesNotInstallPrettierConfigFileIfExists() {
-        setPathShouldExist(this.prettierConfigPath, true)
+    protected static async doesNotInstallPrettierConfigFileIfContentsEqual() {
+        setFakeReadFileResult(this.prettierConfigPath, this.prettierConfigFile)
 
         await this.run()
 
@@ -992,7 +1173,24 @@ export default prettierConfigNdx
         assert.isEqual(
             calls.length,
             0,
-            'Should not install prettier.config.js if already exists!'
+            'Should not install prettier.config.js if contents are equal!'
+        )
+    }
+
+    @test()
+    protected static async doesNotInstallSettingsJsonFileIfContentsEqual() {
+        setFakeReadFileResult(this.settingsJsonPath, this.settingsJsonFile)
+
+        await this.run()
+
+        const calls = callsToWriteFile.filter(
+            (call) => call.file === this.settingsJsonPath
+        )
+
+        assert.isEqual(
+            calls.length,
+            0,
+            'Should not install settings.json if contents are equal!'
         )
     }
 
@@ -1027,6 +1225,12 @@ export default prettierConfigNdx
         await this.run()
     }
 
+    private static getByPath(obj: any, path: string) {
+        return path
+            .split('.')
+            .reduce((acc, key) => (acc == null ? undefined : acc[key]), obj)
+    }
+
     private static setShouldInstallDevDeps() {
         setFakeExecResult(this.checkGenerateIdVersionCmd, {
             stdout: '0.0.1',
@@ -1065,7 +1269,7 @@ export default prettierConfigNdx
     }
 
     private static fakeExec() {
-        NpmAutopackage.exec = fakeExec as unknown as typeof exec
+        NpmAutopackage.exec = fakeExec as any
         resetCallsToExec()
 
         this.setFakeMetaNodeVersion()
@@ -1111,7 +1315,10 @@ export default prettierConfigNdx
         NpmAutopackage.readFile = fakeReadFile as unknown as typeof readFile
         resetCallsToReadFile()
 
-        setFakeReadFileResult(this.packageJsonPath, this.originalPackageJson)
+        setFakeReadFileResult(
+            this.packageJsonPath,
+            JSON.stringify(this.originalPackageJsonWithDummies)
+        )
 
         setFakeReadFileResult(
             this.tasksJsonPath,
@@ -1124,6 +1331,8 @@ export default prettierConfigNdx
         )
 
         setFakeReadFileResult(this.gitignorePath, this.originalGitignore)
+
+        resetFakeReadFileThrowsFor()
     }
 
     private static fakeWriteFile() {
@@ -1154,9 +1363,12 @@ export default prettierConfigNdx
     }
 
     private static get originalPackageJson() {
-        return JSON.stringify({
+        return {
             name: this.packageName,
             description: 'Old description',
+            scripts: {
+                customScript: this.customScript,
+            },
             dependencies: this.dependencies,
             devDependencies: {
                 '@neurodevs/generate-id': '^1.0.0',
@@ -1164,12 +1376,36 @@ export default prettierConfigNdx
                 '@neurodevs/eslint-config-ndx': '^1.0.0',
                 '@neurodevs/prettier-config-ndx': '^1.0.0',
             },
-        })
+            jest: {
+                ['customOption']: this.customJestOption,
+            },
+        }
+    }
+
+    private static get originalPackageJsonWithDummies() {
+        return {
+            ...this.originalPackageJson,
+            scripts: {
+                ...this.originalPackageJson.scripts,
+                'build.resolve-paths': 'dummy',
+                'lint.tsc': 'dummy',
+                'post.watch.build': 'dummy',
+                'resolve-paths.lint': 'dummy',
+                'watch.rebuild': 'dummy',
+                'watch.tsc': 'dummy',
+            },
+            jest: {
+                ...this.originalPackageJson.jest,
+                testPathIgnorePatterns: 'dummy',
+                moduleNameMapper: 'dummy',
+            },
+            skill: 'dummy',
+        }
     }
 
     private static get updatedPackageJson() {
         return JSON.stringify({
-            ...JSON.parse(this.originalPackageJson),
+            ...this.originalPackageJson,
             name: this.scopedPackageName,
             description: this.description,
             type: 'module',
@@ -1185,7 +1421,38 @@ export default prettierConfigNdx
             bugs: {
                 url: `https://github.com/${this.gitNamespace}/${this.packageName}/issues`,
             },
+            scripts: {
+                ...this.originalPackageJson.scripts,
+                'build.ci': 'yarn run build.tsc && yarn run lint',
+                'build.dev':
+                    'yarn run build.tsc --sourceMap ; yarn run lint ; prettier --write .',
+                'build.copy-files':
+                    "mkdir -p build && rsync -avzq --exclude='*.ts' ./src/ ./build/",
+                'build.tsc': 'yarn run build.copy-files && tsc',
+                clean: 'yarn run clean.build',
+                'clean.all':
+                    'yarn run clean.dependencies && yarn run clean.build',
+                'clean.build': 'rm -rf build/',
+                'clean.dependencies':
+                    'rm -rf node_modules/ package-lock.json yarn.lock',
+                'fix.lint': "eslint --fix --cache '**/*.ts'",
+                lint: "eslint --cache '**/*.ts'",
+                rebuild:
+                    'yarn run clean.all && yarn install && yarn run build.dev',
+                'update.dependencies': 'yarn run clean.dependencies && yarn',
+                test: 'NODE_OPTIONS=--experimental-vm-modules jest',
+                'watch.build.dev':
+                    "tsc-watch --sourceMap --onCompilationComplete 'yarn run build.copy-files'",
+            },
             dependencies: this.dependencies,
+            jest: {
+                ...this.originalPackageJson.jest,
+                testEnvironment: 'node',
+                testRunner: 'jest-circus/runner',
+                testMatch: ['<rootDir>/build/__tests__/**/*.test.js?(x)'],
+                testTimeout: 5000,
+                maxWorkers: 4,
+            },
         })
     }
 
@@ -1196,7 +1463,7 @@ export default prettierConfigNdx
                 types: [this.customType],
             },
             include: [this.customInclude],
-            customOption: this.customOption,
+            customOption: this.customTsconfigOption,
         }
     }
 

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

@@ -1,7 +1,6 @@
-import { ChildProcess, exec as execSync } from 'node:child_process'
+import { ChildProcess } from 'node:child_process'
 import { readFile } from 'node:fs/promises'
 import { Readable } from 'node:stream'
-import { promisify } from 'node:util'
 import {
     callsToExec,
     fakeExec,
@@ -23,8 +22,6 @@ import NpmReleasePropagator, {
 import { FakeAutocommit } from '../../index.js'
 import AbstractPackageTest from '../AbstractPackageTest.js'
 
-const exec = promisify(execSync)
-
 export default class NpmReleasePropagatorTest extends AbstractPackageTest {
     private static instance: ReleasePropagator
 
@@ -119,7 +116,7 @@ export default class NpmReleasePropagatorTest extends AbstractPackageTest {
 
         try {
             await this.run()
-        } catch (error) {
+        } catch (_error) {
             // Expected to throw
         }
 
@@ -199,7 +196,7 @@ Please commit or stash these changes before running propagation!
     }
 
     private static setFakeExec() {
-        NpmReleasePropagator.exec = fakeExec as unknown as typeof exec
+        NpmReleasePropagator.exec = fakeExec as unknown as typeof this.exec
         resetCallsToExec()
         resetExecThrowsFor()
 

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

@@ -1,6 +1,4 @@
-import { exec as execSync } from 'node:child_process'
 import { readdir } from 'node:fs/promises'
-import { promisify } from 'node:util'
 
 import {
     callsToExec,
@@ -16,8 +14,6 @@ import {
 } from '@neurodevs/fake-node-core'
 import { test, assert } from '@neurodevs/node-tdd'
 
-const exec = promisify(execSync)
-
 import NpmWorkspaceTypeChecker, {
     WorkspaceTypeChecker,
 } from '../../impl/NpmWorkspaceTypeChecker.js'
@@ -128,7 +124,7 @@ export default class NpmWorkspaceTypeCheckerTest extends AbstractPackageTest {
     }
 
     private static setFakeExec() {
-        NpmWorkspaceTypeChecker.exec = fakeExec as unknown as typeof exec
+        NpmWorkspaceTypeChecker.exec = fakeExec as unknown as typeof this.exec
         resetCallsToExec()
     }