@pnpm/releasing.exportable-manifest 1100.3.4 → 1100.3.5

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @pnpm/exportable-manifest
 
+## 1100.3.5
+
+### Patch Changes
+
+- `pnpm publish` now includes bare `README` files and README files with Markdown extensions such as `readme.markdown` in registry metadata [#12704](https://github.com/pnpm/pnpm/issues/12704).
+
 ## 1100.3.4
 
 ### Patch Changes

package/lib/index.d.ts

@@ -3,6 +3,29 @@ import type { Hooks } from '@pnpm/hooks.pnpmfile';
 import type { ProjectManifest } from '@pnpm/types';
 import { type ExportedManifest } from './transform/index.js';
 export { type ExportedManifest };
+declare const README_RANK: {
+    readonly bare: 1;
+    readonly markdown: 2;
+    readonly readmeMd: 3;
+};
+export interface ReadmeCandidate {
+    fileName: string;
+    rank: ReadmeRank;
+}
+/** How npm ranks a package-root file as the package's README. A higher rank wins. */
+export type ReadmeRank = typeof README_RANK[keyof typeof README_RANK];
+/**
+ * Rank a filename as a README candidate, or return `undefined` if npm would not use it as the
+ * package's README. npm matches the bare `README` case-sensitively and accepts `README.*` whose
+ * extension matches `/.m?a?r?k?d?o?w?n?$/i`.
+ */
+export declare function getReadmeRank(fileName: string): ReadmeRank | undefined;
+/**
+ * Whether README `candidate` should replace the `current` selection. A higher rank wins. Equal
+ * ranks keep the lower filename, so the choice does not depend on directory or archive order, and
+ * an equal filename replaces, so the last duplicate archive entry wins as it would on extraction.
+ */
+export declare function isPreferredReadme(candidate: ReadmeCandidate, current: ReadmeCandidate | undefined): boolean;
 export type WorkspacePackageLookup = Array<{
     manifest: ProjectManifest;
     rootDir?: string;

package/lib/index.js

@@ -9,6 +9,35 @@ import { clone, omit } from 'ramda';
 import { overridePublishConfig } from './overridePublishConfig.js';
 import { transform } from './transform/index.js';
 export {};
+const README_RANK = {
+    bare: 1,
+    markdown: 2,
+    readmeMd: 3,
+};
+/**
+ * Rank a filename as a README candidate, or return `undefined` if npm would not use it as the
+ * package's README. npm matches the bare `README` case-sensitively and accepts `README.*` whose
+ * extension matches `/.m?a?r?k?d?o?w?n?$/i`.
+ */
+export function getReadmeRank(fileName) {
+    if (/^readme\.md$/i.test(fileName))
+        return README_RANK.readmeMd;
+    if (fileName === 'README')
+        return README_RANK.bare;
+    if (/^readme\./i.test(fileName) && /\.m?a?r?k?d?o?w?n?$/i.test(fileName))
+        return README_RANK.markdown;
+    return undefined;
+}
+/**
+ * Whether README `candidate` should replace the `current` selection. A higher rank wins. Equal
+ * ranks keep the lower filename, so the choice does not depend on directory or archive order, and
+ * an equal filename replaces, so the last duplicate archive entry wins as it would on extraction.
+ */
+export function isPreferredReadme(candidate, current) {
+    if (current == null || candidate.rank > current.rank)
+        return true;
+    return candidate.rank === current.rank && candidate.fileName <= current.fileName;
+}
 const PREPUBLISH_SCRIPTS = [
     'prepublishOnly',
     'prepack',
@@ -59,26 +88,33 @@ export async function createExportableManifest(dir, originalManifest, opts) {
         }
     }
     for (const hook of opts?.hooks?.beforePacking ?? []) {
-        // eslint-disable-next-line no-await-in-loop
+        // eslint-disable-next-line no-await-in-loop -- each hook receives the manifest returned by the previous one
         publishManifest = await hook(publishManifest, dir) ?? publishManifest;
     }
     return transform(publishManifest);
 }
 // `O_NOFOLLOW` makes the open itself refuse a symlink at the final path component, closing the
-// TOCTOU window between the `readdir` type check and the read: a symlink swapped in for README.md
-// after the check can't redirect the read outside the project and leak its target into the
-// published manifest. Windows lacks the flag (and requires privileges to create symlinks), so it
-// falls back to a plain read.
+// TOCTOU window between the `readdir` type check and the read: a symlink swapped in for the
+// selected README after the check can't redirect the read outside the project and leak its target
+// into the published manifest. Windows lacks the flag (and requires privileges to create symlinks),
+// so it falls back to a plain read.
 const README_READ_FLAGS = fs.constants.O_RDONLY | (process.platform === 'win32' ? 0 : fs.constants.O_NOFOLLOW);
 export async function readReadmeFile(projectDir) {
     const entries = await fs.promises.readdir(projectDir, { withFileTypes: true });
-    // Only embed a regular README.md file — a symlink is skipped (see README_READ_FLAGS).
-    const readmeEntry = entries.find((entry) => entry.isFile() && /^readme\.md$/i.test(entry.name));
-    if (readmeEntry == null)
+    let readme;
+    for (const entry of entries) {
+        const rank = getReadmeRank(entry.name);
+        if (rank == null || !entry.isFile())
+            continue;
+        const candidate = { fileName: entry.name, rank };
+        if (isPreferredReadme(candidate, readme))
+            readme = candidate;
+    }
+    if (readme == null)
         return undefined;
     let handle;
     try {
-        handle = await fs.promises.open(path.join(projectDir, readmeEntry.name), README_READ_FLAGS);
+        handle = await fs.promises.open(path.join(projectDir, readme.fileName), README_READ_FLAGS);
         return await handle.readFile('utf8');
     }
     catch (err) {
@@ -95,7 +131,7 @@ function combineConverters(...converters) {
     return async (depName, depSpec, context) => {
         let bareSpecifier = depSpec;
         for (const converter of converters) {
-            // eslint-disable-next-line no-await-in-loop
+            // eslint-disable-next-line no-await-in-loop -- each converter receives the specifier returned by the previous one
             bareSpecifier = await converter(depName, bareSpecifier, context);
         }
         return bareSpecifier;

package/lib/overridePublishConfig.js

@@ -33,11 +33,11 @@ export function overridePublishConfig(publishManifest) {
     if (!publishManifest.publishConfig)
         return;
     const publishConfig = { ...publishManifest.publishConfig };
+    const manifestFields = publishManifest;
     for (const key in publishConfig) {
         if (!PUBLISH_CONFIG_WHITELIST.has(key))
             continue;
-        const value = publishConfig[key];
-        publishManifest[key] = value; // eslint-disable-line @typescript-eslint/no-explicit-any
+        manifestFields[key] = publishConfig[key];
         delete publishConfig[key];
     }
     if (isEmpty(publishConfig)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pnpm/releasing.exportable-manifest",
-  "version": "1100.3.4",
+  "version": "1100.3.5",
   "description": "Creates an exportable manifest",
   "keywords": [
     "pnpm",
@@ -42,8 +42,8 @@
     "@pnpm/catalogs.config": "1100.0.9",
     "@pnpm/catalogs.types": "1100.0.1",
     "@pnpm/hooks.pnpmfile": "1100.0.34",
-    "@pnpm/prepare": "1100.0.33",
-    "@pnpm/releasing.exportable-manifest": "1100.3.4",
+    "@pnpm/prepare": "1100.0.34",
+    "@pnpm/releasing.exportable-manifest": "1100.3.5",
     "@types/cross-spawn": "^6.0.6",
     "@types/ramda": "0.32.0",
     "cross-spawn": "^7.0.6",