@neurodevs/meta-node 0.19.15 → 0.19.16

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,6 +107,12 @@ 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()
@@ -145,6 +150,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 = {
@@ -635,6 +705,37 @@ 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()
@@ -646,6 +747,40 @@ export default prettierConfigNdx
         )
     }
 
+    @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, {
@@ -963,8 +1098,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 +1110,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 +1127,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!'
         )
     }
 
@@ -1065,7 +1217,7 @@ export default prettierConfigNdx
     }
 
     private static fakeExec() {
-        NpmAutopackage.exec = fakeExec as unknown as typeof exec
+        NpmAutopackage.exec = fakeExec as any
         resetCallsToExec()
 
         this.setFakeMetaNodeVersion()
@@ -1124,6 +1276,8 @@ export default prettierConfigNdx
         )
 
         setFakeReadFileResult(this.gitignorePath, this.originalGitignore)
+
+        resetFakeReadFileThrowsFor()
     }
 
     private static fakeWriteFile() {

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()
     }
 

package/src/impl/NpmAutopackage.ts

@@ -29,6 +29,10 @@ export default class NpmAutopackage implements Autopackage {
     private originalTsconfig!: TsConfig
     private metaNodeVersion!: string
 
+    private originalEslintConfig!: string
+    private originalPrettierConfig!: string
+    private originalSettingsJson!: string
+
     private originalTasksJson!: {
         tasks: unknown[]
         inputs: unknown[]
@@ -46,6 +50,9 @@ export default class NpmAutopackage implements Autopackage {
     private readonly tasksJsonPath: string
     private readonly testDirPath: string
     private readonly abstractTestPath: string
+    private readonly eslintConfigPath: string
+    private readonly prettierConfigPath: string
+    private readonly settingsJsonPath: string
 
     private readonly abstractPackageTestFile = `import AbstractModuleTest from '@neurodevs/node-tdd'
 
@@ -64,6 +71,71 @@ export default esConfigNdx
     private readonly prettierConfigFile = `import prettierConfigNdx from '@neurodevs/prettier-config-ndx'
 
 export default prettierConfigNdx
+`
+
+    private 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"]
+}
 `
 
     protected constructor(options: AutopackageOptions) {
@@ -98,6 +170,19 @@ export default prettierConfigNdx
             this.testDirPath,
             'AbstractPackageTest.ts'
         )
+
+        this.eslintConfigPath = path.join(this.packageDir, 'eslint.config.js')
+
+        this.prettierConfigPath = path.join(
+            this.packageDir,
+            'prettier.config.js'
+        )
+
+        this.settingsJsonPath = path.join(
+            this.packageDir,
+            '.vscode',
+            'settings.json'
+        )
     }
 
     public static Create(options: AutopackageOptions) {
@@ -119,9 +204,9 @@ export default prettierConfigNdx
         await this.updateVscodeTasks()
         await this.installDefaultDevDependencies()
         await this.installAbstractPackageTest()
-        await this.removeOldEslintConfigMjs()
-        await this.installNewEslintConfigJs()
+        await this.installEslintConfigFile()
         await this.installPrettierConfigFile()
+        await this.installSettingsJsonFile()
         await this.openVscode()
     }
 
@@ -707,6 +792,22 @@ export default prettierConfigNdx
         )
     }
 
+    private async installEslintConfigFile() {
+        await this.removeOldEslintConfigMjs()
+
+        this.originalEslintConfig = await this.loadEslintConfigFile()
+
+        if (!this.eslintConfigIsUpToDate) {
+            console.log('Installing eslint.config.js...')
+
+            await this.writeFile(this.eslintConfigPath, this.eslintConfigFile, {
+                encoding: 'utf-8',
+            })
+
+            await this.commitInstallEslintConfigFile()
+        }
+    }
+
     private async removeOldEslintConfigMjs() {
         const fileExists = await this.pathExists(
             path.join(this.packageDir, 'eslint.config.mjs')
@@ -721,20 +822,19 @@ export default prettierConfigNdx
         }
     }
 
-    private async installNewEslintConfigJs() {
-        const eslintConfigPath = path.join(this.packageDir, 'eslint.config.js')
-        const fileExists = await this.pathExists(eslintConfigPath)
-
-        if (!fileExists) {
-            console.log('Installing eslint.config.js...')
-
-            await this.writeFile(eslintConfigPath, this.eslintConfigFile, {
+    private async loadEslintConfigFile() {
+        try {
+            return await this.readFile(this.eslintConfigPath, {
                 encoding: 'utf-8',
             })
-
-            await this.commitInstallEslintConfigFile()
+        } catch {
+            return ''
         }
     }
+    
+    private get eslintConfigIsUpToDate() {
+        return this.originalEslintConfig.trim() === this.eslintConfigFile.trim()
+    }
 
     private async commitInstallEslintConfigFile() {
         await this.GitAutocommit(
@@ -743,17 +843,12 @@ export default prettierConfigNdx
     }
 
     private async installPrettierConfigFile() {
-        const prettierConfigPath = path.join(
-            this.packageDir,
-            'prettier.config.js'
-        )
-
-        const fileExists = await this.pathExists(prettierConfigPath)
+        this.originalPrettierConfig = await this.loadPrettierConfigFile()
 
-        if (!fileExists) {
+        if (!this.prettierConfigIsUpToDate) {
             console.log('Installing prettier.config.js...')
 
-            await this.writeFile(prettierConfigPath, this.prettierConfigFile, {
+            await this.writeFile(this.prettierConfigPath, this.prettierConfigFile, {
                 encoding: 'utf-8',
             })
 
@@ -761,12 +856,60 @@ export default prettierConfigNdx
         }
     }
 
+    private async loadPrettierConfigFile() {
+        try {
+            return await this.readFile(this.prettierConfigPath, {
+                encoding: 'utf-8',
+            })
+        } catch {
+            return ''
+        }
+    }
+
+    private get prettierConfigIsUpToDate() {
+        return this.originalPrettierConfig.trim() === this.prettierConfigFile.trim()
+    }
+
     private async commitInstallPrettierConfigFile() {
         await this.GitAutocommit(
             `patch: install prettier.config.js (@neurodevs/meta-node: ${this.metaNodeVersion})`
         )
     }
 
+    private async installSettingsJsonFile() {
+        this.originalSettingsJson = await this.loadSettingsJsonFile()
+
+        if (!this.settingsJsonIsUpToDate) {
+            console.log('Installing .vscode/settings.json...')
+
+            await this.writeFile(
+                this.settingsJsonPath,
+                this.settingsJsonFile,
+                {
+                    encoding: 'utf-8',
+                }
+            )
+            
+            await this.commitInstallSettingsJsonFile()
+        }
+    }
+
+    private async loadSettingsJsonFile() {
+        return await this.readFile(this.settingsJsonPath, {
+            encoding: 'utf-8',
+        })
+    }
+
+    private get settingsJsonIsUpToDate() {
+        return this.originalSettingsJson.trim() === this.settingsJsonFile.trim()
+    }
+
+    private async commitInstallSettingsJsonFile() {
+        await this.GitAutocommit(
+            `patch: install settings.json (@neurodevs/meta-node: ${this.metaNodeVersion})`
+        )
+    }
+
     private async openVscode() {
         if (this.shouldOpenVscode) {
             await this.exec('code .', { cwd: this.packageDir })

package/eslint.config.mjs

@@ -1,3 +0,0 @@
-import eslintConfigSpruce from 'eslint-config-spruce'
-
-export default eslintConfigSpruce