feat: migrate command

Author: gearonixx

src/commands/index.ts

@@ -1,4 +1,5 @@
-import { RunCommand } from './run/run.command'
-import { ShowCommand } from './show/show.command'
+import { MigrateCommand } from '@/commands/migrate/migrate.command'
+import { RunCommand } from '@/commands/run/run.command'
+import { ShowCommand } from '@/commands/show/show.command'
 
-export const Commands = [RunCommand, ShowCommand]
+export const Commands = [MigrateCommand, RunCommand, ShowCommand]

src/commands/migrate/migrate.command.ts

@@ -0,0 +1,111 @@
+import { assertDir, ensureFile } from '@neodx/fs'
+import { mapValues } from '@neodx/std'
+import { Inject } from '@nestjs/common'
+import {
+  CliUtilityService,
+  Command,
+  CommandRunner,
+  Option
+} from 'nest-commander'
+import { resolve } from 'node:path'
+import { ConfigService } from '@/config'
+import { LoggerService } from '@/logger'
+import type { AbstractPackageManager } from '@/pkg-manager'
+import { InjectPackageManager } from '@/pkg-manager'
+import { ROOT_PROJECT } from '@/pkg-manager/pkg-manager.consts'
+import type { WorkspaceProject } from '@/pkg-manager/pkg-manager.types'
+import type { TargetOptions } from '@/resolver/targets/targets-resolver.schema'
+import type { PackageJson, PackageScripts } from '@/shared/json'
+import { writeJson } from '@/shared/json'
+import { invariant } from '@/shared/misc'
+
+export interface MigrateCommandOptions {
+  all?: boolean
+}
+
+@Command({
+  name: 'migrate',
+  // TODO: add descriptions
+  description: ''
+})
+export class MigrateCommand extends CommandRunner {
+  constructor(
+    @InjectPackageManager() private readonly manager: AbstractPackageManager,
+    @Inject(LoggerService) private readonly logger: LoggerService,
+    @Inject(ConfigService) private readonly cfg: ConfigService,
+    private readonly utilityService: CliUtilityService
+  ) {
+    super()
+  }
+
+  public async run(params: string[], options: MigrateCommandOptions) {
+    await this.manager.computeWorkspaceProjects()
+
+    const { projects: workspaceProjects } = this.manager
+
+    if (options.all) {
+      await Promise.all(
+        workspaceProjects.map(async (projectMeta) =>
+          this.migrateProjectCommands(projectMeta, options)
+        )
+      )
+      return
+    }
+
+    const [projectName = ROOT_PROJECT] = params
+
+    const projectMeta = workspaceProjects.find(
+      ({ name }) => name === projectName
+    )
+
+    invariant(projectMeta, `Project '${projectName}' not found.`)
+
+    await this.migrateProjectCommands(projectMeta)
+  }
+
+  private async migrateProjectCommands(
+    projectMeta: WorkspaceProject,
+    options?: MigrateCommandOptions
+  ): Promise<void> {
+    const { location: projectCwd, type: targetType } = projectMeta
+
+    await assertDir(projectMeta.location)
+
+    if (targetType === 'package-scripts') {
+      const commandsFilePath = resolve(
+        projectMeta.location,
+        this.cfg.commandsFile
+      )
+      const pkgScripts = projectMeta.targets as NonNullable<
+        PackageJson['scripts']
+      >
+
+      await ensureFile(commandsFilePath)
+
+      const serializedTargets = mapValues<PackageScripts, TargetOptions>(
+        pkgScripts,
+        (command) => ({ command })
+      )
+
+      await writeJson(commandsFilePath, serializedTargets)
+
+      this.logger.info(`Generated ${this.cfg.commandsFile} in ${projectCwd}`)
+      return
+    }
+
+    if (!options?.all) {
+      this.logger.error(
+        `The specified target type '${targetType}' is not allowed.
+        It seems you may already have a '${this.cfg.commandsFile}' file in your project.`
+      )
+    }
+  }
+
+  @Option({
+    flags: '--all [boolean]',
+    name: 'all'
+  })
+  public parseAll(all: string) {
+    return this.utilityService.parseBoolean(all)
+  }
+}

src/commands/run/run.command.ts

@@ -10,13 +10,13 @@ import {
 } from 'nest-commander'
 import { dirname } from 'node:path'
 import { buildTargetInfoPrompt } from '@/commands/run/run.prompts'
-import { createIndependentTargetCommand } from '@/commands/run/utils/independent-target-command'
 import { LoggerService } from '@/logger'
 import type { AbstractPackageManager } from '@/pkg-manager'
 import { InjectPackageManager } from '@/pkg-manager'
 import { PackageManager, ROOT_PROJECT } from '@/pkg-manager/pkg-manager.consts'
 import { ResolverService } from '@/resolver/resolver.service'
 import { invariant } from '@/shared/misc'
+import { createIndependentTargetCommand } from './utils/independent-target-command'
 
 export interface RunCommandOptions {
   args?: string

src/pkg-manager/managers/abstract.pkg-manager.ts

@@ -38,12 +38,13 @@ export abstract class AbstractPackageManager {
     workspaces: WorkspaceProject[] = []
   ): Promise<void> {
     const cwd = process.cwd()
-    const { targets } = await this.resolver.resolveProjectTargets(cwd)
+    const { targets, type } = await this.resolver.resolveProjectTargets(cwd)
 
     const root = {
       name: ROOT_PROJECT,
       location: cwd,
-      targets
+      targets,
+      type
     } satisfies WorkspaceProject
 
     this.projects = [root, ...workspaces]

src/pkg-manager/managers/bun.pkg-manager.ts

@@ -36,10 +36,10 @@ export class BunPackageManager extends AbstractPackageManager {
 
         const workspaceName = scopedPkgJson.name ?? null
         const workspaceDir = dirname(pattern)
-        const { targets } =
+        const { targets, type } =
           await this.resolver.resolveProjectTargets(workspaceDir)
 
-        return { name: workspaceName, location: workspaceDir, targets }
+        return { name: workspaceName, location: workspaceDir, targets, type }
       })
     )
 

src/pkg-manager/managers/npm.pkg-manager.ts

@@ -50,10 +50,10 @@ export class NpmPackageManager extends AbstractPackageManager {
         const normalizedPath = dependency.resolved.replace(/^file:..\//, '')
         const absolutePath = resolve(cwd, normalizedPath)
 
-        const { targets } =
+        const { targets, type } =
           await this.resolver.resolveProjectTargets(absolutePath)
 
-        return { name, location: absolutePath, targets }
+        return { name, location: absolutePath, targets, type }
       })
     )
 

src/pkg-manager/managers/pnpm.pkg-manager.ts

@@ -31,9 +31,10 @@ export class PnpmPackageManager extends AbstractPackageManager {
         const isRoot = pathEqual(path, process.cwd())
         if (isRoot) return null
 
-        const { targets } = await this.resolver.resolveProjectTargets(path)
+        const { targets, type } =
+          await this.resolver.resolveProjectTargets(path)
 
-        return { name, location: path, targets }
+        return { name, location: path, targets, type }
       })
     )
 

src/pkg-manager/managers/yarn-berry.pkg-manager.ts

@@ -20,11 +20,11 @@ export class YarnBerryPackageManager extends AbstractPackageManager {
     const workspaces = await Promise.all(
       serializedLines.map(async (serializedMeta) => {
         const project = parseJson<WorkspaceProject>(serializedMeta)
-        const { targets } = await this.resolver.resolveProjectTargets(
+        const { targets, type } = await this.resolver.resolveProjectTargets(
           project.location
         )
 
-        return { ...project, targets }
+        return { ...project, targets, type }
       })
     )
 

src/pkg-manager/managers/yarn.pkg-manager.ts

@@ -37,9 +37,10 @@ export class YarnPackageManager extends AbstractPackageManager {
     const yarnWorkspaces = await Promise.all(
       workspacesEntries.map(async ([name, metadata]) => {
         const location = toAbsolutePath(metadata.location)
-        const { targets } = await this.resolver.resolveProjectTargets(location)
+        const { targets, type } =
+          await this.resolver.resolveProjectTargets(location)
 
-        return { name, location, targets }
+        return { name, location, targets, type }
       })
     )
 

src/pkg-manager/pkg-manager.types.ts

@@ -1,9 +1,11 @@
+import type { TargetType } from '@/resolver/resolver.types'
 import type { TargetOptions } from '@/resolver/targets/targets-resolver.schema'
 
 export interface WorkspaceProject {
   name: string | null
   location: string
   targets: TargetOptions
+  type: TargetType
 }
 
 export interface RunCommandOptions {