-
-
Notifications
You must be signed in to change notification settings - Fork 23
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Implement JavaScript-based constraints
- Loading branch information
Showing
12 changed files
with
2,999 additions
and
2,810 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| v16 | ||
| v18 |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,206 @@ | ||
| /** @type {import('@yarnpkg/types')} */ | ||
| const { defineConfig } = require('@yarnpkg/types'); | ||
| const { readFile } = require('fs/promises'); | ||
| const { basename, resolve } = require('path'); | ||
|
|
||
| /** | ||
| * Aliases for the Yarn type definitions, to make the code more readable. | ||
| * | ||
| * @typedef {import('@yarnpkg/types').Yarn.Constraints.Workspace} Workspace | ||
| * @typedef {import('@yarnpkg/types').Yarn.Constraints.Dependency} Dependency | ||
| */ | ||
|
|
||
| /** | ||
| * The base URL for the GitHub repository. | ||
| * | ||
| * @type {string} | ||
| */ | ||
| const BASE_URL = 'https://github.com/MetaMask/'; | ||
|
|
||
| /** | ||
| * Get the absolute path to a file within the workspace. | ||
| * | ||
| * @param {Workspace} workspace - The workspace. | ||
| * @param {string} path - The path to the file, relative to the workspace root. | ||
| * @returns {string} The absolute path to the file. | ||
| */ | ||
| function getWorkspacePath(workspace, path) { | ||
| return resolve(__dirname, workspace.cwd, path); | ||
| } | ||
|
|
||
| /** | ||
| * Get the contents of a file within the workspace. The file is expected to be | ||
| * encoded as UTF-8. | ||
| * | ||
| * @param {Workspace} workspace - The workspace. | ||
| * @param {string} path - The path to the file, relative to the workspace root. | ||
| * @returns {Promise<string>} The contents of the file. | ||
| */ | ||
| async function getWorkspaceFile(workspace, path) { | ||
| return await readFile(getWorkspacePath(workspace, path), 'utf8'); | ||
| } | ||
|
|
||
| /** | ||
| * Expect that the workspace has the given field, and that it is a non-null | ||
| * value. If the field is not present, or is null, this will log an error, and | ||
| * cause the constraint to fail. | ||
| * | ||
| * If a value is provided, this will also verify that the field is equal to the | ||
| * given value. | ||
| * | ||
| * @param {Workspace} workspace - The workspace to check. | ||
| * @param {string} field - The field to check. | ||
| * @param {any} [value] - The value to check. | ||
| */ | ||
| function expectWorkspaceField(workspace, field, value) { | ||
| const fieldValue = workspace.manifest[field]; | ||
| if (fieldValue === null) { | ||
| workspace.error(`Missing required field "${field}".`); | ||
| return; | ||
| } | ||
|
|
||
| if (value) { | ||
| workspace.set(field, value); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Expect that the workspace has a description, and that it is a non-null | ||
| * string. If the description is not present, or is null, this will log an | ||
| * error, and cause the constraint to fail. | ||
| * | ||
| * This will also verify that the description does not end with a period. | ||
| * | ||
| * @param {Workspace} workspace - The workspace to check. | ||
| */ | ||
| function expectWorkspaceDescription(workspace) { | ||
| expectWorkspaceField(workspace, 'description'); | ||
|
|
||
| const { description } = workspace.manifest; | ||
| if (typeof description !== 'string') { | ||
| workspace.error( | ||
| `Expected description to be a string, but got ${typeof description}.`, | ||
| ); | ||
| return; | ||
| } | ||
|
|
||
| if (description.endsWith('.')) { | ||
| workspace.set('description', description.slice(0, -1)); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Expect that if a dependency is listed under "dependencies", it is not also | ||
| * listed under "devDependencies". If it is, this will log an error, and cause | ||
| * the constraint to fail. | ||
| * | ||
| * @param {Workspace} workspace - The workspace to check. | ||
| */ | ||
| function expectWorkspaceDependencies(workspace) { | ||
| workspace.pkg.dependencies.forEach((dependency) => { | ||
| // `workspace.pkg` does not have a `devDependencies` field, so we need to | ||
| // check the `manifest` instead. | ||
| const isDependency = Boolean( | ||
| workspace.manifest.dependencies?.[dependency.ident], | ||
| ); | ||
| const isDevDependency = Boolean( | ||
| workspace.manifest.devDependencies?.[dependency.ident], | ||
| ); | ||
|
|
||
| if (isDependency && isDevDependency) { | ||
| workspace.unset(`devDependencies.${dependency.ident}`); | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * 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 {Workspace} workspace - The workspace to check. | ||
| * @param {string} workspaceName - The name of the workspace. | ||
| */ | ||
| async function expectReadme(workspace, workspaceName) { | ||
| const readme = await getWorkspaceFile(workspace, 'README.md'); | ||
| if (workspaceName !== 'metamask-module-template') { | ||
| if (readme.includes('## Template Instructions')) { | ||
| workspace.error( | ||
| 'The README.md contains template instructions. These should be removed.', | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| const nvmrc = await getWorkspaceFile(workspace, '.nvmrc'); | ||
| const nodeVersion = nvmrc.trim().replace(/^v/u, ''); | ||
| if ( | ||
| !readme.includes(`[Node.js](https://nodejs.org) version ${nodeVersion}`) | ||
| ) { | ||
| workspace.error( | ||
| `The README.md does not match the Node.js version specified in the .nvmrc file. Please update the README.md to include "version ${nodeVersion}".`, | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| module.exports = defineConfig({ | ||
| async constraints({ Yarn }) { | ||
| const workspace = Yarn.workspace(); | ||
| const workspaceName = basename(__dirname); | ||
| const workspaceRepository = `${BASE_URL}${workspaceName}`; | ||
|
|
||
| // The package must have a name, version, description, and license. | ||
| expectWorkspaceField(workspace, 'name', `@metamask/${workspaceName}`); | ||
| expectWorkspaceField(workspace, 'version'); | ||
| expectWorkspaceField(workspace, 'license'); | ||
| expectWorkspaceDescription(workspace); | ||
|
|
||
| // The package must have a valid README.md file. | ||
| await expectReadme(workspace, workspaceName); | ||
|
|
||
| expectWorkspaceDependencies(workspace); | ||
|
|
||
| // The homepage of the package must match its name. | ||
| workspace.set('homepage', `${workspaceRepository}#readme`); | ||
|
|
||
| // The bugs URL of the package must point to the Issues page for the | ||
| // repository. | ||
| workspace.set('bugs.url', `${workspaceRepository}/issues`); | ||
|
|
||
| // The package must specify Git as the repository type, and match the URL of | ||
| // a repository within the MetaMask organization. | ||
| workspace.set('repository.type', 'git'); | ||
| workspace.set('repository.url', `${workspaceRepository}.git`); | ||
|
|
||
| // The package must specify a minimum Node.js version of 16. | ||
| workspace.set('engines.node', '>=16.0.0'); | ||
|
|
||
| // The package must specify a `types` entrypoint, and an `import` | ||
| // entrypoint. | ||
| workspace.set('types', './dist/types/index.d.ts'); | ||
| workspace.set('exports["."].types', './dist/types/index.d.ts'); | ||
|
|
||
| // The package must specify a `main` and `module` entrypoint, and a | ||
| // `require` and `import` entrypoint. | ||
| workspace.set('main', './dist/cjs/index.js'); | ||
| workspace.set('exports["."].require', './dist/cjs/index.js'); | ||
| workspace.set('module', './dist/esm/index.js'); | ||
| workspace.set('exports["."].import', './dist/esm/index.js'); | ||
|
|
||
| // The package must export a `package.json` file. | ||
| workspace.set('exports["./package.json"]', './package.json'); | ||
|
|
||
| // The list of files included in the package must only include files | ||
| // generated during the build process. | ||
| workspace.set('files[0]', 'dist/cjs/**'); | ||
| workspace.set('files[1]', 'dist/esm/**'); | ||
| workspace.set('files[2]', 'dist/types/**'); | ||
|
|
||
| // The package is public, and should be published to the npm registry. | ||
| workspace.unset('private'); | ||
| workspace.set('publishConfig.access', 'public'); | ||
| workspace.set('publishConfig.registry', 'https://registry.npmjs.org/'); | ||
| }, | ||
| }); |
Oops, something went wrong.