@neurodevs/meta-node 0.19.16 → 0.19.17

package/src/__tests__/AbstractAutomoduleTest.ts

@@ -79,7 +79,8 @@ export default class AbstractAutomoduleTest extends AbstractPackageTest {
     `
 
     protected static setFakeExec() {
-        AbstractAutomodule.exec = fakeExec as unknown as typeof AbstractAutomodule.exec
+        AbstractAutomodule.exec =
+            fakeExec as unknown as typeof AbstractAutomodule.exec
         resetCallsToExec()
     }
 

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

@@ -116,7 +116,9 @@ export default class NpmAutopackageTest extends AbstractPackageTest {
     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'
 
@@ -130,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'
 
@@ -152,7 +157,7 @@ export default esConfigNdx
 export default prettierConfigNdx
 `
 
-private static readonly settingsJsonFile = `{
+    private static readonly settingsJsonFile = `{
   "debug.node.autoAttach": "on",
   "git.ignoreLimitWarning": true,
   "javascript.validate.enable": false,
@@ -400,7 +405,6 @@ private static readonly settingsJsonFile = `{
                 'dependencies',
                 'devDependencies',
                 'jest',
-                'skill',
             ]
         )
 
@@ -548,13 +552,28 @@ private static readonly settingsJsonFile = `{
         )
     }
 
+    @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 },
@@ -624,7 +643,7 @@ private static readonly settingsJsonFile = `{
     }
 
     @test()
-    protected static async thenDeletesOldEslintConfigMjs() {
+    protected static async thenRemovesOldEslintConfigMjs() {
         setPathShouldExist(
             path.join(this.packageDir, 'eslint.config.mjs'),
             true
@@ -634,12 +653,12 @@ private static readonly settingsJsonFile = `{
         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!'
         )
     }
 
@@ -741,12 +760,36 @@ private static readonly settingsJsonFile = `{
         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)
@@ -759,7 +802,7 @@ private static readonly settingsJsonFile = `{
 
         assert.isEqual(
             calls.length,
-            1, 
+            1,
             'Should install eslint.config.js if it does not exist!'
         )
     }
@@ -776,7 +819,7 @@ private static readonly settingsJsonFile = `{
 
         assert.isEqual(
             calls.length,
-            1, 
+            1,
             'Should install prettier.config.js if it does not exist!'
         )
     }
@@ -1041,7 +1084,10 @@ private static readonly settingsJsonFile = `{
     protected static async doesNotThrowIfGenerateIdNotInPackageJson() {
         setFakeReadFileResult(
             this.packageJsonPath,
-            this.originalPackageJson.replace('@neurodevs/generate-id', '')
+            JSON.stringify(this.originalPackageJson).replace(
+                '@neurodevs/generate-id',
+                ''
+            )
         )
 
         await this.runTwice()
@@ -1179,6 +1225,12 @@ private static readonly settingsJsonFile = `{
         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',
@@ -1263,7 +1315,10 @@ private static readonly settingsJsonFile = `{
         NpmAutopackage.readFile = fakeReadFile as unknown as typeof readFile
         resetCallsToReadFile()
 
-        setFakeReadFileResult(this.packageJsonPath, this.originalPackageJson)
+        setFakeReadFileResult(
+            this.packageJsonPath,
+            JSON.stringify(this.originalPackageJsonWithDummies)
+        )
 
         setFakeReadFileResult(
             this.tasksJsonPath,
@@ -1308,9 +1363,12 @@ private static readonly settingsJsonFile = `{
     }
 
     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',
@@ -1318,12 +1376,36 @@ private static readonly settingsJsonFile = `{
                 '@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',
@@ -1339,7 +1421,38 @@ private static readonly settingsJsonFile = `{
             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,
+            },
         })
     }
 
@@ -1350,7 +1463,7 @@ private static readonly settingsJsonFile = `{
                 types: [this.customType],
             },
             include: [this.customInclude],
-            customOption: this.customOption,
+            customOption: this.customTsconfigOption,
         }
     }
 

package/src/impl/NpmAutopackage.ts

@@ -365,6 +365,8 @@ export default prettierConfigNdx
     }
 
     private async updatePackageJsonFile() {
+        this.removeOldKeysFromPackageJson()
+
         const ordered = this.orderJsonKeys(this.updatedPackageJson, [
             'name',
             'version',
@@ -382,7 +384,6 @@ export default prettierConfigNdx
             'dependencies',
             'devDependencies',
             'jest',
-            'skill',
         ])
 
         await this.writeFile(
@@ -392,6 +393,42 @@ export default prettierConfigNdx
         )
     }
 
+    private removeOldKeysFromPackageJson() {
+        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',
+        ]
+
+        for (const key of keysToRemove) {
+            this.deleteByPath(this.originalPackageJson, key)
+        }
+    }
+
+    private deleteByPath(obj: any, path: string): void {
+        const dot = path.indexOf('.')
+
+        if (dot === -1) {
+            delete obj[path]
+            return
+        }
+
+        const parentKey = path.slice(0, dot)
+        const childKey = path.slice(dot + 1)
+
+        const parent = obj[parentKey]
+
+        if (parent) {
+            delete parent[childKey]
+        }
+    }
+
     private get updatedPackageJson() {
         return {
             ...this.originalPackageJson,
@@ -410,7 +447,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.originalPackageJson.dependencies ?? {},
+            jest: {
+                ...(this.originalPackageJson.jest ?? {}),
+                testEnvironment: 'node',
+                testRunner: 'jest-circus/runner',
+                testMatch: ['<rootDir>/build/__tests__/**/*.test.js?(x)'],
+                testTimeout: 5000,
+                maxWorkers: 4,
+            },
         }
     }
 
@@ -681,6 +749,8 @@ export default prettierConfigNdx
     }
 
     private async installDefaultDevDependencies() {
+        await this.removeDefaultDevDependencies()
+
         const generateIdVersion = await this.getLatestVersion(
             '@neurodevs/generate-id'
         )
@@ -713,6 +783,15 @@ export default prettierConfigNdx
         }
     }
 
+    private async removeDefaultDevDependencies() {
+        console.log('Removing default devDependencies...')
+
+        await this.exec(
+            'yarn remove eslint eslint-config-spruce prettier chokidar-cli ts-node @types/node',
+            { cwd: this.packageDir }
+        )
+    }
+
     private async getLatestVersion(scopedPackageName: string) {
         const { stdout } = await this.exec(
             `yarn info ${scopedPackageName} version --silent`,
@@ -831,7 +910,7 @@ export default prettierConfigNdx
             return ''
         }
     }
-    
+
     private get eslintConfigIsUpToDate() {
         return this.originalEslintConfig.trim() === this.eslintConfigFile.trim()
     }
@@ -848,9 +927,13 @@ export default prettierConfigNdx
         if (!this.prettierConfigIsUpToDate) {
             console.log('Installing prettier.config.js...')
 
-            await this.writeFile(this.prettierConfigPath, this.prettierConfigFile, {
-                encoding: 'utf-8',
-            })
+            await this.writeFile(
+                this.prettierConfigPath,
+                this.prettierConfigFile,
+                {
+                    encoding: 'utf-8',
+                }
+            )
 
             await this.commitInstallPrettierConfigFile()
         }
@@ -867,7 +950,10 @@ export default prettierConfigNdx
     }
 
     private get prettierConfigIsUpToDate() {
-        return this.originalPrettierConfig.trim() === this.prettierConfigFile.trim()
+        return (
+            this.originalPrettierConfig.trim() ===
+            this.prettierConfigFile.trim()
+        )
     }
 
     private async commitInstallPrettierConfigFile() {
@@ -882,14 +968,10 @@ export default prettierConfigNdx
         if (!this.settingsJsonIsUpToDate) {
             console.log('Installing .vscode/settings.json...')
 
-            await this.writeFile(
-                this.settingsJsonPath,
-                this.settingsJsonFile,
-                {
-                    encoding: 'utf-8',
-                }
-            )
-            
+            await this.writeFile(this.settingsJsonPath, this.settingsJsonFile, {
+                encoding: 'utf-8',
+            })
+
             await this.commitInstallSettingsJsonFile()
         }
     }

package/tsconfig.json

@@ -1,28 +1,25 @@
 {
-	"compilerOptions": {
-		"module": "nodenext",
-		"moduleResolution": "nodenext",
-		"target": "ES2022",
-		"lib": ["ES2022"],
-		"types": ["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": [
-		"./src/*.ts",
-		"./src/**/*.ts"
-	]
-}
+  "compilerOptions": {
+    "module": "nodenext",
+    "moduleResolution": "nodenext",
+    "target": "ES2022",
+    "lib": ["ES2022"],
+    "types": ["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": ["./src/*.ts", "./src/**/*.ts"]
+}