add readme to publishBody (#5374)

* add readme to publishBody

* clean test with example

* add fallback to project name

* cleaning

* fix getPublishAccess

* cleaning

* remove unused parameter

* Tweaks

* Tweaks tests

* Versions

* Update publish.test.ts

---------

Co-authored-by: Maël Nison <[email protected]>

Author: hindicator

.yarn/versions/d25ca604.yml

@@ -0,0 +1,24 @@
+releases:
+  "@yarnpkg/cli": patch
+  "@yarnpkg/plugin-npm": patch
+
+declined:
+  - "@yarnpkg/plugin-compat"
+  - "@yarnpkg/plugin-constraints"
+  - "@yarnpkg/plugin-dlx"
+  - "@yarnpkg/plugin-essentials"
+  - "@yarnpkg/plugin-init"
+  - "@yarnpkg/plugin-interactive-tools"
+  - "@yarnpkg/plugin-nm"
+  - "@yarnpkg/plugin-npm-cli"
+  - "@yarnpkg/plugin-pack"
+  - "@yarnpkg/plugin-patch"
+  - "@yarnpkg/plugin-pnp"
+  - "@yarnpkg/plugin-pnpm"
+  - "@yarnpkg/plugin-stage"
+  - "@yarnpkg/plugin-typescript"
+  - "@yarnpkg/plugin-version"
+  - "@yarnpkg/plugin-workspace-tools"
+  - "@yarnpkg/builder"
+  - "@yarnpkg/core"
+  - "@yarnpkg/doctor"

packages/acceptance-tests/pkg-tests-core/sources/utils/tests.ts

@@ -458,6 +458,9 @@ export const startPackageServer = ({type}: { type: keyof typeof packageServerUrl
           return processError(response, 401, `Invalid`);
         }
 
+        if (typeof body.readme !== `string` && name === `readme-required`)
+          return processError(response, 400, `Missing readme`);
+
         const [version] = Object.keys(body.versions);
         if (!body.versions[version].gitHead && name === `githead-required`)
           return processError(response, 400, `Missing gitHead`);

packages/acceptance-tests/pkg-tests-specs/sources/commands/publish.test.ts

@@ -1,3 +1,5 @@
+import {npath, xfs} from '@yarnpkg/fslib';
+
 export {};
 
 const {
@@ -68,4 +70,20 @@ describe(`publish`, () =>   {
       },
     })).resolves.toBeTruthy();
   }));
+
+  test(`should publish a package with the readme content`, makeTemporaryEnv({
+    name: `readme-required`,
+    version: `1.0.0`,
+  }, async ({path, run, source}) => {
+    await run(`install`);
+
+    const readmePath = npath.toPortablePath(`${path}/README.md`);
+    await xfs.writeFilePromise(readmePath, `# title\n`);
+
+    await run(`npm`, `publish`, {
+      env: {
+        YARN_NPM_AUTH_TOKEN: validLogins.fooUser.npmAuthToken,
+      },
+    });
+  }));
 });

packages/plugin-npm/sources/npmPublishUtils.ts

@@ -1,16 +1,21 @@
-import {execUtils}              from '@yarnpkg/core';
-import {Workspace, structUtils} from '@yarnpkg/core';
-import {PortablePath}           from '@yarnpkg/fslib';
-import {packUtils}              from '@yarnpkg/plugin-pack';
-import {createHash}             from 'crypto';
-import ssri                     from 'ssri';
-import {URL}                    from 'url';
-
-import {normalizeRegistry}      from './npmConfigUtils';
-
-export async function makePublishBody(workspace: Workspace, buffer: Buffer, {access, tag, registry, gitHead}: {access: string | undefined, tag: string, registry: string, gitHead?: string}) {
-  const configuration = workspace.project.configuration;
-
+import {execUtils, Ident}         from '@yarnpkg/core';
+import {Workspace, structUtils}   from '@yarnpkg/core';
+import {PortablePath, xfs, npath} from '@yarnpkg/fslib';
+import {packUtils}                from '@yarnpkg/plugin-pack';
+import {createHash}               from 'crypto';
+import ssri                       from 'ssri';
+import {URL}                      from 'url';
+
+import {normalizeRegistry}        from './npmConfigUtils';
+
+type PublishAdditionalParams = {
+  access: string | undefined;
+  tag: string;
+  registry: string;
+  gitHead?: string;
+};
+
+export async function makePublishBody(workspace: Workspace, buffer: Buffer, {access, tag, registry, gitHead}: PublishAdditionalParams) {
   const ident = workspace.manifest.name!;
   const version = workspace.manifest.version!;
 
@@ -19,17 +24,8 @@ export async function makePublishBody(workspace: Workspace, buffer: Buffer, {acc
   const shasum = createHash(`sha1`).update(buffer).digest(`hex`);
   const integrity = ssri.fromData(buffer).toString();
 
-  if (typeof access === `undefined`) {
-    if (workspace.manifest.publishConfig && typeof workspace.manifest.publishConfig.access === `string`) {
-      access = workspace.manifest.publishConfig.access;
-    } else if (configuration.get(`npmPublishAccess`) !== null) {
-      access = configuration.get(`npmPublishAccess`)!;
-    } else if (ident.scope) {
-      access = `restricted`;
-    } else {
-      access = `public`;
-    }
-  }
+  const publishAccess = access ?? getPublishAccess(workspace, ident);
+  const readmeContent = await getReadmeContent(workspace);
 
   const raw = await packUtils.genPackageManifest(workspace);
 
@@ -50,7 +46,7 @@ export async function makePublishBody(workspace: Workspace, buffer: Buffer, {acc
       },
     },
     name,
-    access,
+    access: publishAccess,
 
     [`dist-tags`]: {
       [tag]: version,
@@ -75,6 +71,7 @@ export async function makePublishBody(workspace: Workspace, buffer: Buffer, {acc
         },
       },
     },
+    readme: readmeContent,
   };
 }
 
@@ -88,3 +85,39 @@ export async function getGitHead(workingDir: PortablePath) {
     return undefined;
   }
 }
+
+export function getPublishAccess(workspace: Workspace, ident: Ident): string {
+  const configuration = workspace.project.configuration;
+
+  if (workspace.manifest.publishConfig && typeof workspace.manifest.publishConfig.access === `string`)
+    return workspace.manifest.publishConfig.access;
+
+  if (configuration.get(`npmPublishAccess`) !== null)
+    return configuration.get(`npmPublishAccess`)!;
+
+  const access = ident.scope
+    ? `restricted`
+    : `public`;
+
+  return access;
+}
+
+export async function getReadmeContent(workspace: Workspace): Promise<string>  {
+  const readmePath = npath.toPortablePath(`${workspace.cwd}/README.md`);
+
+  const ident = workspace.manifest.name!;
+  const packageName = structUtils.stringifyIdent(ident);
+
+  let readme = `# ${packageName}\n`;
+  try {
+    readme = await xfs.readFilePromise(readmePath, `utf8`);
+  } catch (err) {
+    if (err.code === `ENOENT`) {
+      return readme;
+    } else {
+      throw err;
+    }
+  }
+
+  return readme;
+}