@neurodevs/meta-node 0.19.12 → 0.19.14

package/src/impl/NpmAutopackage.ts

@@ -24,7 +24,9 @@ export default class NpmAutopackage implements Autopackage {
     private author?: string
 
     private originalPackageJson!: Record<string, unknown>
-    private originalGitignoreFile!: string
+    private originalGitignore!: string
+
+    private originalTsconfig!: TsConfig
     private metaNodeVersion!: string
 
     private originalTasksJson!: {
@@ -40,8 +42,8 @@ export default class NpmAutopackage implements Autopackage {
     private readonly packageDir: string
     private readonly packageJsonPath: string
     private readonly gitignorePath: string
+    private readonly tsconfigPath: string
     private readonly tasksJsonPath: string
-    private readonly settingsJsonPath: string
     private readonly testDirPath: string
     private readonly abstractTestPath: string
 
@@ -52,6 +54,16 @@ export default abstract class AbstractPackageTest extends AbstractModuleTest {
         await super.beforeEach()
     }
 }
+`
+
+    private readonly eslintConfigFile = `import esConfigNdx from './src/eslint.config.js'
+
+export default esConfigNdx
+`
+
+    private readonly prettierConfigFile = `import prettierConfigNdx from '@neurodevs/prettier-config-ndx'
+
+export default prettierConfigNdx
 `
 
     protected constructor(options: AutopackageOptions) {
@@ -78,13 +90,8 @@ export default abstract class AbstractPackageTest extends AbstractModuleTest {
         this.packageDir = path.join(this.installDir, this.packageName)
         this.packageJsonPath = path.join(this.packageDir, 'package.json')
         this.gitignorePath = path.join(this.packageDir, '.gitignore')
+        this.tsconfigPath = path.join(this.packageDir, 'tsconfig.json')
         this.tasksJsonPath = path.join(this.packageDir, '.vscode/tasks.json')
-
-        this.settingsJsonPath = path.join(
-            this.packageDir,
-            '.vscode/settings.json'
-        )
-
         this.testDirPath = path.join(this.packageDir, 'src', '__tests__')
 
         this.abstractTestPath = path.join(
@@ -107,10 +114,14 @@ export default abstract class AbstractPackageTest extends AbstractModuleTest {
         await this.spruceCreateModule()
         await this.updatePackageJson()
         await this.updateGitignore()
+        await this.updateTsconfig()
         await this.setupVscode()
         await this.updateVscodeTasks()
         await this.installDefaultDevDependencies()
         await this.installAbstractPackageTest()
+        await this.removeOldEslintConfigMjs()
+        await this.installNewEslintConfigJs()
+        await this.installPrettierConfigFile()
         await this.openVscode()
     }
 
@@ -244,7 +255,7 @@ export default abstract class AbstractPackageTest extends AbstractModuleTest {
     }
 
     private async updatePackageJson() {
-        this.originalPackageJson = await this.loadPackageJsonFile()
+        this.originalPackageJson = await this.loadPackageJson()
 
         if (!this.isPackageUpToDate) {
             console.log('Updating package.json...')
@@ -254,7 +265,7 @@ export default abstract class AbstractPackageTest extends AbstractModuleTest {
         }
     }
 
-    private async loadPackageJsonFile() {
+    private async loadPackageJson() {
         const raw = await this.readFile(this.packageJsonPath, {
             encoding: 'utf-8',
         })
@@ -301,6 +312,7 @@ export default abstract class AbstractPackageTest extends AbstractModuleTest {
             ...this.originalPackageJson,
             name: this.scopedPackageName,
             description: this.description,
+            type: 'module',
             keywords: this.keywords ?? [],
             license: this.license,
             author: this.author,
@@ -350,7 +362,7 @@ export default abstract class AbstractPackageTest extends AbstractModuleTest {
     }
 
     private async updateGitignore() {
-        this.originalGitignoreFile = await this.loadGitignoreFile()
+        this.originalGitignore = await this.loadGitignore()
 
         if (!this.isGitignoreUpdated) {
             console.log('Updating .gitignore...')
@@ -360,14 +372,14 @@ export default abstract class AbstractPackageTest extends AbstractModuleTest {
         }
     }
 
-    private async loadGitignoreFile() {
+    private async loadGitignore() {
         return await this.readFile(this.gitignorePath, {
             encoding: 'utf-8',
         })
     }
 
     private get isGitignoreUpdated() {
-        const lines = this.originalGitignoreFile
+        const lines = this.originalGitignore
             .split(/\r?\n/)
             .map((line) => line.trim())
 
@@ -387,10 +399,97 @@ export default abstract class AbstractPackageTest extends AbstractModuleTest {
         )
     }
 
+    private async updateTsconfig() {
+        this.originalTsconfig = await this.loadTsconfig()
+
+        if (!this.isTsconfigUpdated) {
+            console.log('Updating tsconfig...')
+            await this.updateTsconfigFile()
+            await this.commitUpdateTsconfig()
+        }
+    }
+
+    private async loadTsconfig() {
+        const raw = await this.readFile(this.tsconfigPath, {
+            encoding: 'utf-8',
+        })
+        return JSON.parse(raw)
+    }
+
+    private get isTsconfigUpdated() {
+        return (
+            JSON.stringify(this.originalTsconfig) ==
+            JSON.stringify(this.updatedTsconfig)
+        )
+    }
+
+    private async updateTsconfigFile() {
+        await this.writeFile(
+            this.tsconfigPath,
+            JSON.stringify(this.updatedTsconfig, null, 4) + '\n',
+            {
+                encoding: 'utf-8',
+                flag: 'a',
+            }
+        )
+    }
+
+    private get updatedTsconfig() {
+        return {
+            ...this.originalTsconfig,
+            compilerOptions: {
+                module: 'nodenext',
+                moduleResolution: 'nodenext',
+                target: 'ES2022',
+                lib: Array.from(
+                    new Set([
+                        ...(this.originalTsconfig?.compilerOptions?.lib ?? []),
+                        'ES2022',
+                    ])
+                ),
+                types: Array.from(
+                    new Set([
+                        ...(this.originalTsconfig?.compilerOptions?.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: Array.from(
+                new Set([
+                    ...(this.originalTsconfig?.include ?? []),
+                    './src/*.ts',
+                    './src/**/*.ts',
+                ])
+            ),
+        }
+    }
+
+    private async commitUpdateTsconfig() {
+        await this.GitAutocommit(
+            `patch: update tsconfig (@neurodevs/meta-node: ${this.metaNodeVersion})`
+        )
+    }
+
     private async setupVscode() {
-        const vscodeSettingsExist = await this.checkIfVscodeSettingsExist()
+        const vscodeTasksExist = await this.checkIfVscodeTasksExist()
 
-        if (!vscodeSettingsExist) {
+        if (!vscodeTasksExist) {
             console.log('Setting up VSCode...')
 
             await this.spruceSetupVscode()
@@ -398,8 +497,8 @@ export default abstract class AbstractPackageTest extends AbstractModuleTest {
         }
     }
 
-    private async checkIfVscodeSettingsExist() {
-        return this.pathExists(this.settingsJsonPath)
+    private async checkIfVscodeTasksExist() {
+        return this.pathExists(this.tasksJsonPath)
     }
 
     private async spruceSetupVscode() {
@@ -505,14 +604,24 @@ export default abstract class AbstractPackageTest extends AbstractModuleTest {
             '@neurodevs/node-tdd'
         )
 
+        const eslintConfigNdxVersion = await this.getLatestVersion(
+            '@neurodevs/eslint-config-ndx'
+        )
+
+        const prettierConfigNdxVersion = await this.getLatestVersion(
+            '@neurodevs/prettier-config-ndx'
+        )
+
         if (
             this.currentGenerateIdVersion != generateIdVersion ||
-            this.currentNodeTddVersion != nodeTddVersion
+            this.currentNodeTddVersion != nodeTddVersion ||
+            this.currentEslintConfigNdxVersion != eslintConfigNdxVersion ||
+            this.currentPrettierConfigNdxVersion != prettierConfigNdxVersion
         ) {
             console.log('Installing default devDependencies...')
 
             await this.exec(
-                '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',
                 { cwd: this.packageDir }
             )
             await this.commitInstallDevDependencies()
@@ -543,6 +652,22 @@ export default abstract class AbstractPackageTest extends AbstractModuleTest {
         ).replace('^', '')
     }
 
+    private get currentEslintConfigNdxVersion() {
+        return (
+            (this.originalPackageJson.devDependencies as any)[
+                '@neurodevs/eslint-config-ndx'
+            ] || ''
+        ).replace('^', '')
+    }
+
+    private get currentPrettierConfigNdxVersion() {
+        return (
+            (this.originalPackageJson.devDependencies as any)[
+                '@neurodevs/prettier-config-ndx'
+            ] || ''
+        ).replace('^', '')
+    }
+
     private async commitInstallDevDependencies() {
         await this.GitAutocommit(
             `patch: install default devDependencies (@neurodevs/meta-node: ${this.metaNodeVersion})`
@@ -582,6 +707,66 @@ export default abstract class AbstractPackageTest extends AbstractModuleTest {
         )
     }
 
+    private async removeOldEslintConfigMjs() {
+        const fileExists = await this.pathExists(
+            path.join(this.packageDir, 'eslint.config.mjs')
+        )
+
+        if (fileExists) {
+            console.log('Removing old eslint.config.mjs...')
+
+            await this.exec(`git rm eslint.config.mjs`, {
+                cwd: this.packageDir,
+            })
+        }
+    }
+
+    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, {
+                encoding: 'utf-8',
+            })
+
+            await this.commitInstallEslintConfigFile()
+        }
+    }
+
+    private async commitInstallEslintConfigFile() {
+        await this.GitAutocommit(
+            `patch: install eslint.config.js (@neurodevs/meta-node: ${this.metaNodeVersion})`
+        )
+    }
+
+    private async installPrettierConfigFile() {
+        const prettierConfigPath = path.join(
+            this.packageDir,
+            'prettier.config.js'
+        )
+
+        const fileExists = await this.pathExists(prettierConfigPath)
+
+        if (!fileExists) {
+            console.log('Installing prettier.config.js...')
+
+            await this.writeFile(prettierConfigPath, this.prettierConfigFile, {
+                encoding: 'utf-8',
+            })
+
+            await this.commitInstallPrettierConfigFile()
+        }
+    }
+
+    private async commitInstallPrettierConfigFile() {
+        await this.GitAutocommit(
+            `patch: install prettier.config.js (@neurodevs/meta-node: ${this.metaNodeVersion})`
+        )
+    }
+
     private async openVscode() {
         if (this.shouldOpenVscode) {
             await this.exec('code .', { cwd: this.packageDir })
@@ -635,3 +820,13 @@ export interface AutopackageOptions {
 export type AutopackageConstructor = new (
     options: AutopackageOptions
 ) => Autopackage
+
+export interface TsConfig {
+    compilerOptions?: {
+        lib?: string[]
+        types?: string[]
+        [key: string]: unknown
+    }
+    include?: string[]
+    [key: string]: unknown
+}