@neurodevs/meta-node 0.19.11 → 0.19.13

package/src/impl/NpmAutopackage.ts

@@ -1,7 +1,6 @@
 import { exec as execSync } from 'child_process'
 import { mkdir, readFile, writeFile } from 'fs/promises'
 import path from 'path'
-import { chdir } from 'process'
 import { promisify } from 'util'
 import { pathExists } from 'fs-extra'
 import { parse } from 'jsonc-parser'
@@ -10,7 +9,6 @@ import GitAutocommit from './GitAutocommit.js'
 
 export default class NpmAutopackage implements Autopackage {
     public static Class?: AutopackageConstructor
-    public static chdir = chdir
     public static exec = promisify(execSync)
     public static fetch = fetch
     public static mkdir = mkdir
@@ -18,8 +16,6 @@ export default class NpmAutopackage implements Autopackage {
     public static readFile = readFile
     public static writeFile = writeFile
 
-    private installDir: string
-    private packageName: string
     private description: string
     private gitNamespace: string
     private npmNamespace?: string
@@ -28,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!: {
@@ -39,6 +37,35 @@ export default class NpmAutopackage implements Autopackage {
 
     private shouldOpenVscode = false
 
+    private readonly installDir: string
+    private readonly packageName: string
+    private readonly packageDir: string
+    private readonly packageJsonPath: string
+    private readonly gitignorePath: string
+    private readonly tsconfigPath: string
+    private readonly tasksJsonPath: string
+    private readonly testDirPath: string
+    private readonly abstractTestPath: string
+
+    private readonly abstractPackageTestFile = `import AbstractModuleTest from '@neurodevs/node-tdd'
+
+export default abstract class AbstractPackageTest extends AbstractModuleTest {
+    protected static async beforeEach() {
+        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) {
         const {
             installDir,
@@ -59,6 +86,18 @@ export default class NpmAutopackage implements Autopackage {
         this.keywords = keywords
         this.license = license
         this.author = author
+
+        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.testDirPath = path.join(this.packageDir, 'src', '__tests__')
+
+        this.abstractTestPath = path.join(
+            this.testDirPath,
+            'AbstractPackageTest.ts'
+        )
     }
 
     public static Create(options: AutopackageOptions) {
@@ -69,20 +108,19 @@ export default class NpmAutopackage implements Autopackage {
         this.throwIfGithubTokenNotInEnv()
 
         await this.createRepoInGithubOrg()
-
-        this.chdirToInstallDir()
         await this.cloneGitRepo()
-
-        this.chdirToPackageDir()
         await this.resetMainToOrigin()
         await this.setCurrentMetaNodeVersion()
         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.installEslintConfigFile()
+        await this.installPrettierConfigFile()
         await this.openVscode()
     }
 
@@ -141,16 +179,15 @@ export default class NpmAutopackage implements Autopackage {
         )
     }
 
-    private chdirToInstallDir() {
-        this.chdir(this.installDir)
-    }
-
     private async cloneGitRepo() {
         const packageDirExists = await this.checkIfPackageDirExists()
 
         if (!packageDirExists) {
             console.log('Cloning git repository...')
-            await this.exec(`git clone ${this.gitUrl}`)
+
+            await this.exec(`git clone ${this.gitUrl}`, {
+                cwd: this.installDir,
+            })
             this.shouldOpenVscode = true
         }
     }
@@ -159,21 +196,16 @@ export default class NpmAutopackage implements Autopackage {
         return this.pathExists(this.packageDir)
     }
 
-    private get packageDir() {
-        return this.packageName
-    }
-
     private get gitUrl() {
         return `https://github.com/${this.gitNamespace}/${this.packageName}.git`
     }
 
     private async resetMainToOrigin() {
-        await this.exec('git fetch origin')
-        await this.exec('git reset --hard origin/main')
-    }
+        await this.exec('git fetch origin', { cwd: this.packageDir })
 
-    private chdirToPackageDir() {
-        this.chdir(this.packageDir)
+        await this.exec('git reset --hard origin/main', {
+            cwd: this.packageDir,
+        })
     }
 
     private async setCurrentMetaNodeVersion() {
@@ -198,6 +230,7 @@ export default class NpmAutopackage implements Autopackage {
 
         if (!packageJsonExists) {
             console.log('Running spruce create.module...')
+
             await this.execSpruceCreateModule()
             await this.commitCreatePackage()
         }
@@ -207,11 +240,10 @@ export default class NpmAutopackage implements Autopackage {
         return this.pathExists(this.packageJsonPath)
     }
 
-    private readonly packageJsonPath = 'package.json'
-
     private async execSpruceCreateModule() {
         await this.exec(
-            `spruce create.module --name "${this.packageName}" --destination "." --description "${this.description}"`
+            `spruce create.module --name "${this.packageName}" --destination "." --description "${this.description}"`,
+            { cwd: this.packageDir }
         )
     }
 
@@ -222,16 +254,17 @@ export default class NpmAutopackage implements Autopackage {
     }
 
     private async updatePackageJson() {
-        this.originalPackageJson = await this.loadPackageJsonFile()
+        this.originalPackageJson = await this.loadPackageJson()
 
         if (!this.isPackageUpToDate) {
             console.log('Updating package.json...')
+
             await this.updatePackageJsonFile()
             await this.commitUpdatePackageJson()
         }
     }
 
-    private async loadPackageJsonFile() {
+    private async loadPackageJson() {
         const raw = await this.readFile(this.packageJsonPath, {
             encoding: 'utf-8',
         })
@@ -278,6 +311,7 @@ export default class NpmAutopackage implements Autopackage {
             ...this.originalPackageJson,
             name: this.scopedPackageName,
             description: this.description,
+            type: 'module',
             keywords: this.keywords ?? [],
             license: this.license,
             author: this.author,
@@ -327,7 +361,7 @@ export default class NpmAutopackage implements Autopackage {
     }
 
     private async updateGitignore() {
-        this.originalGitignoreFile = await this.loadGitignoreFile()
+        this.originalGitignore = await this.loadGitignore()
 
         if (!this.isGitignoreUpdated) {
             console.log('Updating .gitignore...')
@@ -337,16 +371,14 @@ export default class NpmAutopackage implements Autopackage {
         }
     }
 
-    private async loadGitignoreFile() {
+    private async loadGitignore() {
         return await this.readFile(this.gitignorePath, {
             encoding: 'utf-8',
         })
     }
 
-    private readonly gitignorePath = '.gitignore'
-
     private get isGitignoreUpdated() {
-        const lines = this.originalGitignoreFile
+        const lines = this.originalGitignore
             .split(/\r?\n/)
             .map((line) => line.trim())
 
@@ -366,22 +398,112 @@ export default class NpmAutopackage implements Autopackage {
         )
     }
 
+    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()
             await this.commitSetupVscode()
         }
     }
 
-    private async checkIfVscodeSettingsExist() {
-        return this.pathExists(`.vscode/settings.json`)
+    private async checkIfVscodeTasksExist() {
+        return this.pathExists(this.tasksJsonPath)
     }
 
     private async spruceSetupVscode() {
-        await this.exec('spruce setup.vscode --all true')
+        await this.exec('spruce setup.vscode --all true', {
+            cwd: this.packageDir,
+        })
     }
 
     private async commitSetupVscode() {
@@ -430,8 +552,6 @@ export default class NpmAutopackage implements Autopackage {
         return parse(raw)
     }
 
-    private readonly tasksJsonPath = '.vscode/tasks.json'
-
     private get updatedTasksJsonFile() {
         return JSON.stringify(
             {
@@ -483,14 +603,25 @@ export default class NpmAutopackage implements Autopackage {
             '@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()
         }
@@ -498,7 +629,8 @@ export default class NpmAutopackage implements Autopackage {
 
     private async getLatestVersion(scopedPackageName: string) {
         const { stdout } = await this.exec(
-            `yarn info ${scopedPackageName} version --silent`
+            `yarn info ${scopedPackageName} version --silent`,
+            { cwd: this.packageDir }
         )
         return stdout.trim()
     }
@@ -519,6 +651,22 @@ export default class NpmAutopackage implements Autopackage {
         ).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})`
@@ -531,12 +679,14 @@ export default class NpmAutopackage implements Autopackage {
         if (!fileExists) {
             console.log(`Installing ${this.abstractTestPath}...`)
 
-            await this.mkdir('src/__tests__', { recursive: true })
+            await this.mkdir(this.testDirPath, { recursive: true })
 
             await this.writeFile(
                 this.abstractTestPath,
                 this.abstractPackageTestFile,
-                { encoding: 'utf-8' }
+                {
+                    encoding: 'utf-8',
+                }
             )
 
             await this.commitInstallAbstractPackageTest()
@@ -550,31 +700,62 @@ export default class NpmAutopackage implements Autopackage {
         return doesTsExist || doesTsxExist
     }
 
-    private readonly abstractTestPath = `src/__tests__/AbstractPackageTest.ts`
+    private async commitInstallAbstractPackageTest() {
+        await this.GitAutocommit(
+            `patch: install AbstractPackageTest (@neurodevs/meta-node: ${this.metaNodeVersion})`
+        )
+    }
 
-    private readonly abstractPackageTestFile = `import AbstractModuleTest from '@neurodevs/node-tdd'
+    private async installEslintConfigFile() {
+        const eslintConfigPath = path.join(this.packageDir, 'eslint.config.js')
+        const fileExists = await this.pathExists(eslintConfigPath)
 
-export default abstract class AbstractPackageTest extends AbstractModuleTest {
-    protected static async beforeEach() {
-        await super.beforeEach()
+        if (!fileExists) {
+            console.log('Installing eslint.config.js...')
+
+            await this.writeFile(eslintConfigPath, this.eslintConfigFile, {
+                encoding: 'utf-8',
+            })
+
+            await this.commitInstallEslintConfigFile()
+        }
     }
-}
-`
 
-    private async commitInstallAbstractPackageTest() {
+    private async commitInstallEslintConfigFile() {
         await this.GitAutocommit(
-            `patch: install AbstractPackageTest (@neurodevs/meta-node: ${this.metaNodeVersion})`
+            `patch: install eslint.config.js (@neurodevs/meta-node: ${this.metaNodeVersion})`
         )
     }
 
-    private async openVscode() {
-        if (this.shouldOpenVscode) {
-            await this.exec('code .')
+    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 get chdir() {
-        return NpmAutopackage.chdir
+    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 })
+        }
     }
 
     private get exec() {
@@ -602,7 +783,7 @@ export default abstract class AbstractPackageTest extends AbstractModuleTest {
     }
 
     private GitAutocommit(commitMessage: string) {
-        return GitAutocommit.Create(commitMessage)
+        return GitAutocommit.Create(commitMessage, this.packageDir)
     }
 }
 
@@ -624,3 +805,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
+}