rvlib-shipkit 0.22.2 → 0.24.0

package/src/ts/rename.ts

@@ -0,0 +1,238 @@
+// Rename / move a file or folder AND update every exact occurrence of its
+// repo-relative path across all tracked + untracked source files.
+//
+// Assumes non-relative import paths with explicit extensions, e.g.
+//   import { X } from 'src/foo/bar.ts'
+// so the exact path string is a reliable search key.
+//
+// Modes:
+//   file -> file path            renames the file
+//   file -> existing folder      moves the file into that folder (keeps name)
+//   file -> path ending with /   same, creates folder if missing
+//   folder -> folder path        renames the folder (recursive replacement)
+import { existsSync, mkdirSync, readFileSync, renameSync, statSync, writeFileSync } from 'fs'
+import { basename, dirname, extname, join, relative, resolve } from 'path'
+import { canonicalSpecifier, isSkipped, loadConfig, toPosix, type RvtConfig } from 'rvlib-shipkit/src/ts/config.ts'
+
+const BINARY_EXTS = new Set([
+   '.png', '.jpg', '.jpeg', '.gif', '.webp', '.ico', '.bmp', '.tiff',
+   '.mp3', '.mp4', '.wav', '.webm', '.ogg', '.mov', '.avi',
+   '.pdf', '.zip', '.gz', '.tar', '.7z', '.rar',
+   '.woff', '.woff2', '.ttf', '.otf', '.eot',
+   '.wasm', '.node', '.keystore', '.jks', '.p12', '.pem',
+   '.psd', '.sketch', '.lockb',
+])
+
+/** the nearest ancestor package.json of a repo-relative path, whatever the
+ *  configured roots say. Its `name` plus the path below it IS the specifier a
+ *  sibling module imports. */
+function enclosingPackage(repoRoot: string, relPath: string): { name: string; dir: string } | null {
+   const segs = toPosix(relPath).split('/')
+   for (let i = segs.length - 1; i > 0; i--) {
+      const dir = segs.slice(0, i).join('/')
+      const manifest = join(repoRoot, dir, 'package.json')
+      if (!existsSync(manifest)) continue
+      try {
+         const name = (JSON.parse(readFileSync(manifest, 'utf8')) as { name?: string }).name
+         if (name != null && name !== '') return { name, dir }
+      } catch {
+         // an unparseable manifest is not a package boundary
+      }
+   }
+   return null
+}
+
+export type RenameResult = {
+   srcRel: string
+   dstRel: string
+   isFolder: boolean
+   hits: { file: string; count: number }[]
+   totalRefs: number
+   suspicious: string[]
+   applied: boolean
+}
+
+export function runRename(srcArg: string, dstArg: string, opts: { apply?: boolean; cfg?: RvtConfig } = {}): RenameResult {
+   const cfg = opts.cfg ?? loadConfig()
+   const repoRoot = cfg.root
+
+   const srcAbs = resolve(repoRoot, srcArg)
+   if (!existsSync(srcAbs)) throw new Error(`source does not exist: ${srcAbs}`)
+   const srcIsFolder = statSync(srcAbs).isDirectory()
+
+   let dstAbs = resolve(repoRoot, dstArg)
+   const dstEndsWithSep = /[/\\]$/.test(dstArg)
+   const dstIsExistingFolder = existsSync(dstAbs) && statSync(dstAbs).isDirectory()
+   // file -> folder: move into folder, keep basename
+   if (!srcIsFolder && (dstIsExistingFolder || dstEndsWithSep)) dstAbs = join(dstAbs, basename(srcAbs))
+   if (existsSync(dstAbs)) throw new Error(`destination already exists: ${dstAbs}`)
+
+   const srcRel = toPosix(relative(repoRoot, srcAbs))
+   const dstRel = toPosix(relative(repoRoot, dstAbs))
+   if (srcRel === dstRel) throw new Error('src == dst, nothing to do')
+   if (srcRel.startsWith('..')) throw new Error(`source outside repo: ${srcRel}`)
+   if (dstRel.startsWith('..')) throw new Error(`destination outside repo: ${dstRel}`)
+
+   // both spellings of the path are search keys: the repo-relative form and,
+   // when inside a sub-package, the package-name form imports actually use.
+   // The package is found by walking UP from the file, never by the configured
+   // roots: the content scan is repo-wide, so the specifier derivation must be
+   // too. A repo whose packages live outside `roots` (a docs tree that ships
+   // libs) otherwise renamed the file and rewrote NOTHING, silently.
+   const pairs: { from: string; to: string }[] = [{ from: srcRel, to: dstRel }]
+   const srcCanon = canonicalSpecifier(srcRel, cfg)
+   if (srcCanon !== srcRel) pairs.push({ from: srcCanon, to: canonicalSpecifier(dstRel, cfg) })
+   else {
+      const owner = enclosingPackage(repoRoot, srcRel)
+      if (owner != null && dstRel.startsWith(`${owner.dir}/`))
+         pairs.push({
+            from: `${owner.name}${srcRel.slice(owner.dir.length)}`,
+            to: `${owner.name}${dstRel.slice(owner.dir.length)}`,
+         })
+   }
+
+   const pkgDirs = cfg.packages.map((p) => p.dir)
+   // scan all tracked + untracked (non-ignored) files
+   const ls = Bun.spawnSync(['git', 'ls-files', '-co', '--exclude-standard', '-z'], { cwd: repoRoot })
+   const allFiles = ls.stdout.toString().split('\u0000').filter(Boolean)
+
+   const hits: { file: string; count: number }[] = []
+   let totalRefs = 0
+   for (const file of allFiles) {
+      if (isSkipped(file, cfg, pkgDirs)) continue
+      if (BINARY_EXTS.has(extname(file).toLowerCase())) continue
+      let content: string
+      try {
+         content = readFileSync(join(repoRoot, file), 'utf8')
+      } catch {
+         continue
+      }
+      const nul = content.indexOf('\u0000')
+      if (nul !== -1 && nul < 4096) continue // cheap binary sniff
+      const count = scanPairs(content, pairs).count
+      if (count > 0) {
+         hits.push({ file, count })
+         totalRefs += count
+      }
+   }
+
+   const suspicious = pairs.flatMap((p) => findSuspiciousContexts(repoRoot, p.from, hits))
+   // a file naming the BASENAME without matching any full path form is a
+   // near-miss the rewrite cannot make: a regex-escaped path in a test, a doc
+   // line, a specifier built from parts. Reported, never rewritten, because
+   // guessing at those is how a rename corrupts a repo
+   // the STEM, not the filename: a regex-escaped path writes `foo\.ts`, so the
+   // extension never matches literally
+   const srcBase = basename(srcRel).replace(/\.[^.]+$/, '')
+   if (!srcIsFolder && srcBase.length > 3) {
+      const hitFiles = new Set(hits.map((h) => h.file))
+      const baseRe = new RegExp(`(?<![\\w-])${srcBase.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')}(?![\\w-])`)
+      for (const file of allFiles) {
+         if (hitFiles.has(file) || file === srcRel || isSkipped(file, cfg, pkgDirs)) continue
+         if (BINARY_EXTS.has(extname(file).toLowerCase())) continue
+         let content: string
+         try { content = readFileSync(join(repoRoot, file), 'utf8') } catch { continue }
+         if (baseRe.test(content)) suspicious.push(`${file}: names '${srcBase}' without a rewritable path — check it by hand`)
+      }
+   }
+
+   if (opts.apply === true) {
+      for (const h of hits) {
+         const full = join(repoRoot, h.file)
+         const before = readFileSync(full, 'utf8')
+         const after = scanPairs(before, pairs).text
+         if (after !== before) writeFileSync(full, after)
+      }
+      const dstDir = dirname(dstAbs)
+      if (!existsSync(dstDir)) mkdirSync(dstDir, { recursive: true })
+      const mv = Bun.spawnSync(['git', 'mv', srcAbs, dstAbs], { cwd: repoRoot, stdout: 'pipe', stderr: 'pipe' })
+      if (mv.exitCode !== 0) renameSync(srcAbs, dstAbs) // untracked file: plain fs move
+   }
+
+   return { srcRel, dstRel, isFolder: srcIsFolder, hits, totalRefs, suspicious, applied: opts.apply === true }
+}
+
+export function renameCli(argv: string[]): number {
+   const apply = argv.includes('-x') || argv.includes('--apply')
+   const paths = argv.filter((a) => !a.startsWith('-'))
+   if (paths.length !== 2) {
+      console.log('usage: rvt rename <src> <dst> [-x|--apply]   (dry-run by default)')
+      return 2
+   }
+   let r: RenameResult
+   try {
+      r = runRename(paths[0]!, paths[1]!, { apply })
+   } catch (e) {
+      console.error(String(e instanceof Error ? e.message : e))
+      return 1
+   }
+   console.log(`rename: ${r.srcRel} -> ${r.dstRel}`)
+   console.log(`type:   ${r.isFolder ? 'folder (recursive)' : 'file'}`)
+   console.log(`refs:   ${r.totalRefs} across ${r.hits.length} file(s)`)
+   for (const h of r.hits) console.log(`  ${h.count.toString().padStart(4)}  ${h.file}`)
+   if (r.suspicious.length > 0) {
+      console.log('\nwarning: possible substring overreach (inspect before applying):')
+      for (const s of r.suspicious) console.log(`  ${s}`)
+   }
+   if (!r.applied) console.log('\ndry-run. pass -x or --apply to commit.')
+   else console.log(`\napplied: ${r.srcRel} -> ${r.dstRel} (${r.totalRefs} refs rewritten)`)
+   return 0
+}
+
+// simultaneous multi-needle replace: earliest match wins (longest needle on a
+// tie) and the scan continues PAST the replacement — sequential split/join
+// would let one pair's output feed the next (the package form is a substring
+// of the repo form, so that corrupts content)
+function scanPairs(text: string, pairs: { from: string; to: string }[]): { text: string; count: number } {
+   let out = ''
+   let i = 0
+   let count = 0
+   while (true) {
+      let at = -1
+      let hit: { from: string; to: string } | null = null
+      for (const p of pairs) {
+         if (p.from.length === 0) continue
+         const idx = text.indexOf(p.from, i)
+         if (idx === -1) continue
+         if (at === -1 || idx < at || (idx === at && p.from.length > (hit?.from.length ?? 0))) {
+            at = idx
+            hit = p
+         }
+      }
+      if (hit == null) {
+         out += text.slice(i)
+         return { text: out, count }
+      }
+      out += text.slice(i, at) + hit.to
+      i = at + hit.from.length
+      count++
+   }
+}
+
+// matches where the char right after the needle continues the path
+// (letter, digit, _, -) — likely substring overreach into a sibling name
+function findSuspiciousContexts(repoRoot: string, needle: string, hitList: { file: string }[]): string[] {
+   const bad = /[A-Za-z0-9_-]/
+   const out: string[] = []
+   for (const h of hitList) {
+      let content: string
+      try {
+         content = readFileSync(join(repoRoot, h.file), 'utf8')
+      } catch {
+         continue
+      }
+      let i = 0
+      while (true) {
+         const idx = content.indexOf(needle, i)
+         if (idx === -1) break
+         const after = content[idx + needle.length]
+         if (after != null && bad.test(after)) {
+            const lineStart = content.lastIndexOf('\n', idx) + 1
+            const lineEnd = content.indexOf('\n', idx)
+            out.push(`${h.file}: ${content.slice(lineStart, lineEnd === -1 ? content.length : lineEnd).trim()}`)
+         }
+         i = idx + needle.length
+      }
+   }
+   return out
+}

package/src/ts/source-graph-cli.ts

@@ -0,0 +1,19 @@
+#!/usr/bin/env bun
+// the source-graph verbs, as one small binary the gate spawns: imports,
+// cycles, rename. They live in shipkit rather than in a dependency, because a
+// tool the gate REQUIRES must never be a published version behind the repo it
+// gates (field: `shipkit mv` renamed a file and rewrote zero references,
+// because the copy it resolved predated the fix).
+import { cyclesCli } from 'rvlib-shipkit/src/ts/cycles.ts'
+import { importsCli } from 'rvlib-shipkit/src/ts/imports.ts'
+import { renameCli } from 'rvlib-shipkit/src/ts/rename.ts'
+
+const [verb, ...rest] = process.argv.slice(2)
+const run = (): number => {
+    if (verb === 'imports') return importsCli(rest)
+    if (verb === 'cycles') return cyclesCli(rest)
+    if (verb === 'rename' || verb === 'mv') return renameCli(rest)
+    console.log('usage: imports [--fix] | cycles | rename <src> <dst> [--apply]')
+    return 2
+}
+process.exit(run())

package/src/ts/source-mask.ts

@@ -0,0 +1,26 @@
+// which lines sit inside a multiline template literal — shared by the import
+// rewriter and the cycle scanner so one concern has one handler.
+//
+// the walk is a per-line backtick parity toggle over SANITIZED lines (quoted
+// strings and line comments blanked first). regex literals can still carry a
+// stray backtick and desync the walk, so the result is only trusted when the
+// file ENDS outside a template: valid source cannot end inside one, an
+// in-template EOF means the walk desynced and callers scan unmasked (a loud
+// false positive beats a silent unscanned tail).
+
+/** true per line = the line STARTS inside a multiline template literal.
+ *  null = the parity walk desynced (EOF inside a template), do not mask. */
+export function templateLineMask(lines: string[]): boolean[] | null {
+   let inTemplate = false
+   const mask = lines.map((line) => {
+      const startedIn = inTemplate
+      const sanitized = line
+         .replace(/'(?:\\.|[^'\\])*'/g, "''")
+         .replace(/"(?:\\.|[^"\\])*"/g, '""')
+         .replace(/(^|\s)\/\/.*$/, '$1')
+      const backticks = (sanitized.match(/(?<!\\)`/g) ?? []).length
+      if (backticks % 2 === 1) inTemplate = !inTemplate
+      return startedIn
+   })
+   return inTemplate ? null : mask
+}