Function expectReadme

yarn.config.cjs:140–162

* Expect that the workspace has a README.md file, and that it is a non-empty * string. The README.md is expected to: * * - Not contain template instructions (unless the workspace is the module * template itself). * - Match the version of Node.js specified in the `.nvmrc` file. * * @param {Wor

(workspace, workspaceName)

 * @returns {Promise<void>}
 */
async function expectReadme(workspace, workspaceName) {
  const readme = await getWorkspaceFile(workspace, 'README.md');
  if (
    workspaceName !== 'metamask-module-template' &&
    readme.includes('## Template Instructions')
  ) {
    workspace.error(
      'The README.md contains template instructions. These instructions should be removed.',
    );
  }

  if (!readme.includes(`yarn add @metamask/${workspaceName}`)) {
    workspace.error(
      `The README.md does not contain an example of how to install the package using Yarn (\`yarn add @metamask/${workspaceName}\`). Please add an example.`,
    );
  }

  if (!readme.includes(`npm install @metamask/${workspaceName}`)) {
    workspace.error(
      `The README.md does not contain an example of how to install the package using npm (\`npm install @metamask/${workspaceName}\`). Please add an example.`,
    );
  }
}

/**
 * Expect that the workspace has a pull_request_template.md file, and that it