@maratus-codemod/rewrite-internal-imports 0.1.0 → 0.1.2

package/package.json

@@ -1,7 +1,10 @@
 {
   "name": "@maratus-codemod/rewrite-internal-imports",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "private": false,
+  "files": [
+    "dist"
+  ],
   "type": "module",
   "exports": {
     ".": "./dist/index.mjs"

package/CHANGELOG.md

@@ -1,12 +0,0 @@
-# @maratus-codemod/rewrite-internal-imports
-
-## 0.1.0
-
-### Minor Changes
-
-- 479324d: Publish the initial public Maratus packages, including the CLI, platform binaries, codemod runner, codemods, runtime libraries, and the first registry components: separator, button, focus-modality.
-
-### Patch Changes
-
-- Updated dependencies [479324d]
-  - @maratus/codemod-runner@0.1.0

package/src/declarations.ts

@@ -1,96 +0,0 @@
-import type { InternalImportTarget } from './index'
-import type { ImportDeclaration } from 'ts-morph'
-
-export type InternalImportDeclaration = {
-  moduleSpecifier: string
-  defaultImport?: string
-  namespaceImport?: string
-  namedImports?: string[]
-}
-
-export function buildInternalImportDeclarations(
-  importDeclaration: ImportDeclaration,
-  target: InternalImportTarget,
-) {
-  const namedImports = importDeclaration.getNamedImports()
-  const namedImportsByPath = new Map<string, string[]>()
-
-  for (const namedImport of namedImports) {
-    const importName = namedImport.getName()
-    const modulePath = target.namedPaths?.[importName]
-
-    if (!modulePath) {
-      continue
-    }
-
-    const existing = namedImportsByPath.get(modulePath) ?? []
-    existing.push(namedImport.getText())
-    namedImportsByPath.set(modulePath, existing)
-  }
-
-  const nextDeclarations: InternalImportDeclaration[] = []
-
-  const defaultImport = importDeclaration.getDefaultImport()?.getText()
-  if (defaultImport && target.defaultPath) {
-    nextDeclarations.push({
-      moduleSpecifier: target.defaultPath,
-      defaultImport,
-    })
-  }
-
-  const namespaceImport = importDeclaration.getNamespaceImport()?.getText()
-  if (namespaceImport && target.namespacePath) {
-    nextDeclarations.push({
-      moduleSpecifier: target.namespacePath,
-      namespaceImport,
-    })
-  }
-
-  for (const [moduleSpecifier, groupedNamedImports] of namedImportsByPath) {
-    nextDeclarations.push({
-      moduleSpecifier,
-      namedImports: groupedNamedImports,
-    })
-  }
-
-  if (
-    importDeclaration.getImportClause() === undefined &&
-    target.sideEffectPath
-  ) {
-    nextDeclarations.push({
-      moduleSpecifier: target.sideEffectPath,
-    })
-  }
-
-  return nextDeclarations
-}
-
-export function renderInternalImportDeclarations(
-  declarations: InternalImportDeclaration[],
-) {
-  return declarations
-    .map((declaration) => {
-      if (
-        declaration.defaultImport &&
-        declaration.namedImports &&
-        declaration.namedImports.length > 0
-      ) {
-        return `import ${declaration.defaultImport}, { ${declaration.namedImports.join(', ')} } from '${declaration.moduleSpecifier}'`
-      }
-
-      if (declaration.namespaceImport) {
-        return `import * as ${declaration.namespaceImport} from '${declaration.moduleSpecifier}'`
-      }
-
-      if (declaration.defaultImport) {
-        return `import ${declaration.defaultImport} from '${declaration.moduleSpecifier}'`
-      }
-
-      if (declaration.namedImports && declaration.namedImports.length > 0) {
-        return `import { ${declaration.namedImports.join(', ')} } from '${declaration.moduleSpecifier}'`
-      }
-
-      return `import '${declaration.moduleSpecifier}'`
-    })
-    .join('\n')
-}

package/src/index.ts

@@ -1,14 +0,0 @@
-export {
-  type InternalImportTarget,
-  type RewriteInternalImportsOptions,
-  type RewriteInternalPackageImportsOptions,
-} from './options'
-
-export { rewriteInternalImports } from './rewrite-internal-imports'
-export { rewriteInternalPackageImports } from './rewrite-internal-package-imports'
-
-export {
-  type ResolvedInternalImportTargets,
-  type ResolveInternalImportTargetsOptions,
-  resolveInternalImportTargets,
-} from './resolve-targets'

package/src/options.ts

@@ -1,23 +0,0 @@
-export type FileNameKind = 'match-export' | 'kebab-case'
-
-export type InternalImportTarget = {
-  barrelPath?: string
-  sideEffectPath?: string
-  defaultPath?: string
-  namespacePath?: string
-  namedPaths?: Record<string, string>
-}
-
-export type RewriteInternalImportsOptions = {
-  targets: Record<string, InternalImportTarget>
-}
-
-export type RewriteInternalPackageImportsOptions = {
-  packages: Array<{
-    packageName: string
-    sourceDir: string
-    destinationDir: string
-    barrel: boolean
-    fileNameKind: FileNameKind
-  }>
-}

package/src/resolve-targets.ts

@@ -1,122 +0,0 @@
-import type { FileNameKind, InternalImportTarget } from './options'
-import { existsSync } from 'node:fs'
-import path from 'node:path'
-import { rewriteSourcePath } from '@maratus/codemod-runner'
-import { Project } from 'ts-morph'
-
-export type ResolveInternalImportTargetsOptions = {
-  sourceFilePath: string
-  packages: Array<{
-    packageName: string
-    sourceDir: string
-    destinationDir: string
-    barrel: boolean
-    fileNameKind: FileNameKind
-  }>
-}
-
-export type ResolvedInternalImportTargets = Record<string, InternalImportTarget>
-
-export function resolveInternalImportTargets(
-  options: ResolveInternalImportTargetsOptions,
-): ResolvedInternalImportTargets {
-  const targets: ResolvedInternalImportTargets = {}
-
-  for (const internalPackage of options.packages) {
-    const packageName = `@maratus/${internalPackage.packageName}`
-
-    if (internalPackage.barrel) {
-      targets[packageName] = {
-        barrelPath: relativeModuleSpecifier(
-          options.sourceFilePath,
-          internalPackage.destinationDir,
-        ),
-      }
-      continue
-    }
-
-    const indexSourceFilePath = resolvePackageIndexFile(
-      internalPackage.sourceDir,
-    )
-    if (!indexSourceFilePath) {
-      continue
-    }
-
-    const project = new Project({
-      useInMemoryFileSystem: false,
-    })
-    const indexSourceFile = project.addSourceFileAtPath(indexSourceFilePath)
-    const exportedDeclarations = indexSourceFile.getExportedDeclarations()
-    const namedPaths: Record<string, string> = {}
-
-    for (const [exportName, declarations] of exportedDeclarations) {
-      const declaration = declarations[0]
-      if (!declaration) {
-        continue
-      }
-
-      const declarationFile = declaration.getSourceFile().getFilePath()
-      const relativeSourcePath = path.relative(
-        internalPackage.sourceDir,
-        declarationFile,
-      )
-      const destinationFilePath = path.join(
-        internalPackage.destinationDir,
-        rewriteSourcePath(relativeSourcePath, internalPackage.fileNameKind),
-      )
-
-      namedPaths[exportName] = relativeModuleSpecifier(
-        options.sourceFilePath,
-        destinationFilePath,
-      )
-    }
-
-    targets[packageName] = {
-      namedPaths,
-    }
-  }
-
-  return targets
-}
-
-function resolvePackageIndexFile(sourceDir: string) {
-  for (const candidate of ['index.ts', 'index.tsx']) {
-    const sourceFilePath = path.join(sourceDir, candidate)
-    if (existsSync(sourceFilePath)) {
-      return sourceFilePath
-    }
-  }
-
-  return null
-}
-
-function relativeModuleSpecifier(fromFilePath: string, toPath: string) {
-  const normalizedToPath = path.normalize(toPath)
-  const relativePath = path.relative(
-    path.dirname(fromFilePath),
-    normalizedToPath,
-  )
-  const withoutExt = hasSourceExtension(normalizedToPath)
-    ? relativePath.replace(/\.(ts|tsx|js|jsx|mjs|cjs)$/, '')
-    : relativePath
-  let modulePath = withoutExt.split(path.sep).join('/')
-
-  if (modulePath.endsWith('/.')) {
-    modulePath = modulePath.slice(0, -2)
-  }
-  if (modulePath === '' || modulePath == '.') {
-    return './'
-  }
-
-  if (modulePath.startsWith('.')) {
-    return modulePath
-  }
-
-  return `./${modulePath}`
-}
-
-function hasSourceExtension(pathValue: string) {
-  return ['.ts', '.tsx', '.js', '.jsx', '.mjs', '.cjs'].includes(
-    path.extname(pathValue),
-  )
-}

package/src/rewrite-internal-imports.test.ts

@@ -1,84 +0,0 @@
-import { describe, expect, it } from 'bun:test'
-import { runCodemod } from '@maratus/codemod-runner'
-import { rewriteInternalImports } from './rewrite-internal-imports'
-
-describe(rewriteInternalImports, () => {
-  it('rewrites to the barrel path when one is provided', async () => {
-    const [result] = await runCodemod(
-      rewriteInternalImports,
-      [
-        {
-          path: '/consumer/components/component/component.tsx',
-          sourceText: "import { useTestHook } from '@maratus/lib-hook'\n",
-        },
-      ],
-      {
-        targets: {
-          '@maratus/lib-hook': {
-            barrelPath: '../../lib/lib-hook',
-          },
-        },
-      },
-    )
-
-    expect(result.sourceText).toContain(
-      "import { useTestHook } from '../../lib/lib-hook'",
-    )
-  })
-
-  it('splits named imports by file path when no barrel path is provided', async () => {
-    const [result] = await runCodemod(
-      rewriteInternalImports,
-      [
-        {
-          path: '/consumer/components/component/component.tsx',
-          sourceText:
-            "import { useLibHook, useTestHook } from '@maratus/lib-hook'\n",
-        },
-      ],
-      {
-        targets: {
-          '@maratus/lib-hook': {
-            namedPaths: {
-              useLibHook: '../../lib/lib-hook/useLibHook',
-              useTestHook: '../../lib/lib-hook/useTestHook',
-            },
-          },
-        },
-      },
-    )
-
-    expect(result.sourceText).toContain(
-      "import { useLibHook } from '../../lib/lib-hook/useLibHook'",
-    )
-    expect(result.sourceText).toContain(
-      "import { useTestHook } from '../../lib/lib-hook/useTestHook'",
-    )
-  })
-
-  it('groups named imports that resolve to the same file path', async () => {
-    const [result] = await runCodemod(
-      rewriteInternalImports,
-      [
-        {
-          path: '/consumer/components/example/example.ts',
-          sourceText: "import { A, B } from '@maratus/example-lib'\n",
-        },
-      ],
-      {
-        targets: {
-          '@maratus/example-lib': {
-            namedPaths: {
-              A: '../../lib/example-lib/a',
-              B: '../../lib/example-lib/a',
-            },
-          },
-        },
-      },
-    )
-
-    expect(result.sourceText).toContain(
-      "import { A, B } from '../../lib/example-lib/a'",
-    )
-  })
-})

package/src/rewrite-internal-imports.ts

@@ -1,46 +0,0 @@
-import type { RewriteInternalImportsOptions } from './options'
-import type { Codemod } from '@maratus/codemod-runner'
-import {
-  buildInternalImportDeclarations,
-  renderInternalImportDeclarations,
-} from './declarations'
-
-export const rewriteInternalImports: Codemod<RewriteInternalImportsOptions> = ({
-  files,
-  options,
-  project,
-}) => {
-  for (const file of files) {
-    const sourceFile = project.getSourceFile(file.path)
-    if (!sourceFile) continue
-
-    for (const importDeclaration of sourceFile.getImportDeclarations()) {
-      const packageName = importDeclaration.getModuleSpecifierValue()
-      const target = options.targets[packageName]
-      if (!target) continue
-
-      if (target.barrelPath) {
-        importDeclaration.setModuleSpecifier(target.barrelPath)
-        continue
-      }
-
-      const nextDeclarations = buildInternalImportDeclarations(
-        importDeclaration,
-        target,
-      )
-
-      if (nextDeclarations.length === 0) {
-        continue
-      }
-
-      importDeclaration.replaceWithText(
-        renderInternalImportDeclarations(nextDeclarations),
-      )
-    }
-  }
-
-  return files.map((file) => ({
-    path: file.path,
-    sourceText: project.getSourceFileOrThrow(file.path).getFullText(),
-  }))
-}

package/src/rewrite-internal-package-imports.test.ts

@@ -1,33 +0,0 @@
-import { describe, expect, it } from 'bun:test'
-import { runCodemod } from '@maratus/codemod-runner'
-import { rewriteInternalPackageImports } from './rewrite-internal-package-imports'
-
-describe(rewriteInternalPackageImports, () => {
-  it('rewrites barrel imports from a nested hook file to the lib directory path', async () => {
-    const [result] = await runCodemod(
-      rewriteInternalPackageImports,
-      [
-        {
-          path: '/consumer/src/components/component/use-component.ts',
-          sourceText:
-            "import { useDependencyFeature } from '@maratus/dependency-lib'\n",
-        },
-      ],
-      {
-        packages: [
-          {
-            packageName: 'dependency-lib',
-            sourceDir: '/consumer-repo/lib/dependency-lib/src',
-            destinationDir: '/consumer/src/lib/dependency-lib',
-            barrel: true,
-            fileNameKind: 'kebab-case',
-          },
-        ],
-      },
-    )
-
-    expect(result.sourceText).toContain(
-      "import { useDependencyFeature } from '../../lib/dependency-lib'",
-    )
-  })
-})

package/src/rewrite-internal-package-imports.ts

@@ -1,39 +0,0 @@
-import type { RewriteInternalPackageImportsOptions } from './options'
-import type { Codemod } from '@maratus/codemod-runner'
-import { Project } from 'ts-morph'
-import { resolveInternalImportTargets } from './resolve-targets'
-import { rewriteInternalImports } from './rewrite-internal-imports'
-
-export const rewriteInternalPackageImports: Codemod<
-  RewriteInternalPackageImportsOptions
-> = async ({ files, options }) => {
-  const results: Array<{
-    path: string
-    sourceText: string
-  }> = []
-
-  for (const file of files) {
-    const project = new Project({
-      useInMemoryFileSystem: true,
-    })
-
-    project.createSourceFile(file.path, file.sourceText, {
-      overwrite: true,
-    })
-
-    const rewrittenFiles = await rewriteInternalImports({
-      files: [file],
-      project,
-      options: {
-        targets: resolveInternalImportTargets({
-          sourceFilePath: file.path,
-          packages: options.packages,
-        }),
-      },
-    })
-
-    results.push(...rewrittenFiles)
-  }
-
-  return results
-}