chore: add basic project constraints #5152
+204
−0
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,193 @@ | ||
| /* eslint-disable @typescript-eslint/no-var-requires */ | ||
| /*! | ||
| * Copyright 2025 Adobe. All rights reserved. | ||
| * This file is licensed to you under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. You may obtain a copy | ||
| * of the License at http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software distributed under | ||
| * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS | ||
| * OF ANY KIND, either express or implied. See the License for the specific language | ||
| * governing permissions and limitations under the License. | ||
| */ | ||
|
|
||
| /** @type {import('@yarnpkg/types')} */ | ||
| const { defineConfig } = require('@yarnpkg/types'); | ||
| const fg = require('fast-glob'); | ||
|
|
||
| /** | ||
| * The workspace object used in the constraints function | ||
| * @typedef {import('@yarnpkg/types').Yarn.Constraints.Workspace} Workspace | ||
| */ | ||
|
|
||
| module.exports = defineConfig({ | ||
| async constraints({ Yarn }) { | ||
| /** | ||
| * Fetch a list of all the component workspaces using a glob pattern | ||
| * @type {string[]} components | ||
| */ | ||
| const components = fg.sync('packages/*', { | ||
| cwd: __dirname, | ||
| onlyDirectories: true, | ||
| }); | ||
|
|
||
| /** | ||
| * This function checks the workspace for any local package references | ||
| * and ensure that the devDependencies are up-to-date with the latest version | ||
| * currently in the project | ||
| * @param {Workspace} workspace | ||
| * @returns {void} | ||
| */ | ||
| function validateLocalPackages(workspace) { | ||
| // Return early if the workspace does not have any peerDependencies | ||
| if (!workspace.manifest.peerDependencies) { | ||
| return; | ||
| } | ||
|
|
||
| // Start by filtering out the local packages from the external dependencies | ||
| const localPackages = Object.keys( | ||
| workspace.manifest.peerDependencies | ||
| ) | ||
| .filter((pkg) => Yarn.workspace({ ident: pkg })) | ||
|
There was a problem hiding this comment.
There was a problem hiding this comment. See my note on using the standard constraints syntax and tooling. This is not a node script. https://yarnpkg.com/features/constraints There was a problem hiding this comment.
|
||
| .map((pkg) => Yarn.workspace({ ident: pkg })); | ||
|
|
||
| // Iterate over the local packages and ensure that the devDependencies are up-to-date | ||
| for (const localWorkspace of localPackages) { | ||
| const localVersion = localWorkspace.manifest.version; | ||
| workspace.set( | ||
| `devDependencies.${localWorkspace.manifest.name}`, | ||
| localVersion ?? 'workspace:^' | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * A reusable function to add keywords to ensure workspaces | ||
| * include a minimal set of keywords for discoverability | ||
| * with additionalKeywords as an optional parameter to add more | ||
| * specific keywords that are relevant to the workspace | ||
| * @param {string[]} additionalKeywords | ||
| * @returns {string[]} | ||
| */ | ||
| function keywords(additionalKeywords = []) { | ||
| return [ | ||
| 'design-system', | ||
| 'spectrum', | ||
| 'adobe', | ||
| 'adobe-spectrum', | ||
| 'web components', | ||
| 'web-components', | ||
| 'lit-element', | ||
| 'lit-html', | ||
|
Comment on lines
+74
to
+81
There was a problem hiding this comment. Can we add the values to a new array like There was a problem hiding this comment. Minimally beneficial and I'm not sure the abstraction is worth it. If the script was slow to run, I'd say the optimization makes sense but I'm not sure it's worth more abstraction in an already foreign syntax to most contributors. |
||
| ...additionalKeywords, | ||
| ]; | ||
| } | ||
|
|
||
| /** | ||
| * This function rolls up all the component package.json | ||
| * requirements for all workspaces into a single function | ||
| * to simplify into a readable set of operations | ||
| * @param {Workspace} workspace | ||
| * @param {string} folderName | ||
| * @returns {void} | ||
| */ | ||
| function validateComponentPackageJson(workspace, folderName) { | ||
| // Only update the homepage if it does not already exist | ||
| if (!workspace.manifest.homepage) { | ||
| workspace.set( | ||
| 'homepage', | ||
| `https://opensource.adobe.com/spectrum-web-components/components/${folderName}` | ||
| ); | ||
| } | ||
|
|
||
| workspace.set('publishConfig.access', 'public'); | ||
| workspace.set('type', 'module'); | ||
| workspace.set('keywords', keywords(['component', 'css'])); | ||
|
|
||
| // A subset of components have a different entry point than the default | ||
| if ( | ||
| ['clear-button', 'close-button', 'modal', 'opacity-checkerboard'].includes(folderName) | ||
| ) { | ||
| workspace.set('main', `./src/${folderName}.css.js`); | ||
| workspace.set('module', `./src/${folderName}.css.js`); | ||
| } else { | ||
| workspace.set('main', './src/index.js'); | ||
| workspace.set('module', './src/index.js'); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * This function rolls up all the package.json requirements | ||
| * for all workspaces into a single function to simplify | ||
| * the workspace for loop into a readable set of operations | ||
| * @param {Workspace} workspace | ||
| * @returns {void} | ||
| */ | ||
| function validatePackageJson(workspace) { | ||
| const isRoot = workspace.cwd === '.'; | ||
| const isComponent = components.includes(workspace.cwd); | ||
|
|
||
| /** | ||
| * -------------- GLOBAL -------------- | ||
| * Global configuration for all workspaces | ||
| */ | ||
| if ( | ||
| !workspace.manifest.license || | ||
| workspace.manifest.license === '' | ||
| ) { | ||
| workspace.set('license', 'Apache-2.0'); | ||
| } | ||
|
|
||
| workspace.set('author', 'Adobe'); | ||
|
|
||
| workspace.set('repository.type', 'git'); | ||
| workspace.set( | ||
| 'repository.url', | ||
| 'https://github.com/adobe/spectrum-web-components.git' | ||
| ); | ||
|
|
||
| // We don't need to set the directory for the root workspace | ||
| if (!isRoot) { | ||
| workspace.set('repository.directory', workspace.cwd); | ||
| } | ||
|
|
||
| workspace.set( | ||
| 'bugs.url', | ||
| 'https://github.com/adobe/spectrum-web-components/issues' | ||
| ); | ||
|
|
||
| /** | ||
| * -------------- COMPONENTS -------------- | ||
| * Process the components workspaces with component-specific configuration | ||
| */ | ||
| if (isComponent) { | ||
| const folderName = workspace.cwd?.split('/')?.[1]; | ||
|
There was a problem hiding this comment. A more robust approach like this There was a problem hiding this comment. It's important to distinguish the contraints syntax from a node script. This is not a node script. This is a yarn constraints file that uses node syntax. Please do read up on constraints in the documentation: https://yarnpkg.com/features/constraints |
||
| validateComponentPackageJson(workspace, folderName); | ||
| validateLocalPackages(workspace); | ||
| } else { | ||
| /** | ||
| * -------------- OTHER -------------- | ||
| * All other workspaces should have at least the following configuration | ||
| */ | ||
| if (!workspace.manifest.keywords) { | ||
| workspace.set('keywords', keywords()); | ||
| } | ||
|
|
||
| if (!workspace.manifest.homepage) { | ||
| workspace.set( | ||
| 'homepage', | ||
| 'https://opensource.adobe.com/spectrum-web-components/' | ||
| ); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * This loop iterates over all the workspaces in the project | ||
| * and updates the package.json file with the necessary | ||
| */ | ||
| for (const workspace of Yarn.workspaces()) { | ||
| validatePackageJson(workspace); | ||
| } | ||
| }, | ||
| }); | ||
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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fg.sync()is called synchronously here, which might block execution since there are a lot of packages.can we use an async function and
await fg()There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's no difference here between using await or sync because the list of components must be present to validate against in the functions below. This is a preference rather than an important requirement to update during code review. There is the same amount of "blocking execution" as you say, between awaiting an async function as there is using the synchronous version of a function. You only gain benefits from asynchronous if you are running tasks against it as the information becomes available, which we are not.