@preventive/upstream 1.0.0-alpha.6 → 1.0.0-alpha.7

package/npm.d.ts

@@ -50,7 +50,8 @@ export interface PackageRepo {
 export function resolvePackageRepos(packageNames: Iterable<string>, options?: { cachedOnly?: boolean }): Promise<Map<string, PackageRepo>>
 
 // The disk cache resolvePackageRepos reads and writes, a month per entry.
-// A read answers null for anything but a usable entry; a write answers
+// A read answers null for anything but a usable entry, one written by a
+// release that resolved repos by other rules included; a write answers
 // false where it could not write, and never throws.
 export function readPackageRepoCache(name: string): Promise<PackageRepo | null>
 export function writePackageRepoCache(name: string, github: string, directory?: string): Promise<boolean>

package/package.d.ts

@@ -11,7 +11,7 @@ export interface PackageRepoLink {
   url?: string
 }
 
-// Read off `bugs`, `repository` and `homepage`, in that order, from a
+// Read off `repository`, `bugs` and `homepage`, in that order, from a
 // package.json or the registry's document for a version of one. Both
 // fields absent where nothing in it names a GitHub repo; a throw only
 // for something that is not an object at all.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@preventive/upstream",
-  "version": "1.0.0-alpha.6",
+  "version": "1.0.0-alpha.7",
   "description": "Minimal npm, crates.io and Soldeer registry clients, a GitHub client, and a git checkout reader: the calls we use, nothing more",
   "type": "module",
   "exports": {

package/src/npm/repos.js

@@ -9,6 +9,9 @@ import { getDocument } from './registry.js'
 
 const DIR = 'npm/repos'
 const CONCURRENCY = 8
+// Stamped on each entry, and raised when getRepo would answer differently:
+// 2 is `repository` taking precedence over `bugs`.
+const VERSION = 2
 
 // `latest`, not the full packument, which is megabytes of version history.
 const fetchRepo = async (method, name) => getRepo(await getDocument(method, name, 'latest'))
@@ -20,12 +23,13 @@ export async function getGitHub(name) {
   return link
 }
 
-// An entry without `directory` predates the field: a miss, not a package
-// at the repo root.
+// An entry under another VERSION was resolved by other rules, and may
+// name the repo a stale tracker does: a miss, as is one without
+// `directory`, which would read as a package at the repo root.
 export async function readPackageRepoCache(name) {
   assertPackageName('readPackageRepoCache', 'name', name)
   const entry = await readRecord(DIR, name)
-  if (!isRepo(entry?.github) || !isRepoDirectory(entry.directory)) return null
+  if (entry?.v !== VERSION || !isRepo(entry.github) || !isRepoDirectory(entry.directory)) return null
   return { github: entry.github, ...(entry.directory && { directory: entry.directory }) }
 }
 
@@ -35,7 +39,7 @@ export async function writePackageRepoCache(name, github, directory = '') {
   assertPackageName('writePackageRepoCache', 'name', name)
   assertRepo('writePackageRepoCache', 'github', github)
   assertRepoDirectory('writePackageRepoCache', 'directory', directory)
-  return await writeRecord(DIR, name, { github, directory })
+  return await writeRecord(DIR, name, { v: VERSION, github, directory })
 }
 
 export async function resolvePackageRepos(packageNames, options = {}) {

package/src/package.js

@@ -41,7 +41,9 @@ export function getRepo(pkg) {
   const { bugs, repository } = pkg
   const declared = repositoryRepo(urlOf(repository))
   const homepage = homepageRegex.exec(homepageUrl(pkg.homepage))?.groups
-  const github = [repoIn(bugsRegex, urlOf(bugs)), declared, homepage?.repo].find(isRepo)
+  // `repository` first: it is the field a publisher maintains, where a
+  // `bugs` tracker can be left pointing at a former owner or misspelt.
+  const github = [declared, repoIn(bugsRegex, urlOf(bugs)), homepage?.repo].find(isRepo)
   if (github === undefined) return {}
   const directory = (sameName(declared, github) && repoSubdirectory(repository?.directory))
     || (sameName(homepage?.repo, github) && repoSubdirectory(decodePath(homepage.directory)))