@neurodevs/meta-node 0.19.15 → 0.19.17

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()
     }
 
@@ -280,6 +365,8 @@ export default prettierConfigNdx
     }
 
     private async updatePackageJsonFile() {
+        this.removeOldKeysFromPackageJson()
+
         const ordered = this.orderJsonKeys(this.updatedPackageJson, [
             'name',
             'version',
@@ -297,7 +384,6 @@ export default prettierConfigNdx
             'dependencies',
             'devDependencies',
             'jest',
-            'skill',
         ])
 
         await this.writeFile(
@@ -307,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,
@@ -325,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,
+            },
         }
     }
 
@@ -596,6 +749,8 @@ export default prettierConfigNdx
     }
 
     private async installDefaultDevDependencies() {
+        await this.removeDefaultDevDependencies()
+
         const generateIdVersion = await this.getLatestVersion(
             '@neurodevs/generate-id'
         )
@@ -628,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`,
@@ -707,6 +871,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,21 +901,20 @@ 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(
             `patch: install eslint.config.js (@neurodevs/meta-node: ${this.metaNodeVersion})`
@@ -743,30 +922,76 @@ 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, {
-                encoding: 'utf-8',
-            })
+            await this.writeFile(
+                this.prettierConfigPath,
+                this.prettierConfigFile,
+                {
+                    encoding: 'utf-8',
+                }
+            )
 
             await this.commitInstallPrettierConfigFile()
         }
     }
 
+    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/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"]
+}

package/eslint.config.mjs

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