Skip to content

Fix lint:teams package script #6941

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+18 −21
Open

Fix lint:teams package script #6941

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 18 additions & 21 deletions scripts/lint-teams-json.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
import { readJsonFile } from '@metamask/utils/node';
import { getPluginConfiguration } from '@yarnpkg/cli';
import { Configuration, Project, structUtils } from '@yarnpkg/core';
import { ppath } from '@yarnpkg/fslib';
import execa from 'execa';
import path from 'path';

type Workspace = {
location: string;
name: string;
};

// Run the script immediately.
main().catch(console.error);

/**
Expand All @@ -16,17 +20,9 @@ main().catch(console.error);
async function main() {
const releaseableWorkspaces = await getPublicWorkspaces();
const releaseablePackageNames = releaseableWorkspaces.map((workspace) => {
const packageName = workspace.manifest.name;
if (packageName === null) {
throw new Error(
`${structUtils.stringifyIdent(
workspace.anchoredDescriptor,
)} has no name in its manifest`,
);
}
// The package names in teams.json omit the leading "@", so we do that here
// too in order to be consistent
return structUtils.stringifyIdent(packageName).slice(1);
return workspace.name.slice(1);
});

const teams = await readJsonFile<Record<string, string>>(
Expand All @@ -52,18 +48,19 @@ async function main() {
}

/**
* Uses the Yarn API to gather the Yarn workspaces inside of this project (the
* packages that are matched by the `workspaces` field inside of
* Uses the `yarn` executable to gather the Yarn workspaces inside of this
* project (the packages that are matched by the `workspaces` field inside of
* `package.json`).
*
* @returns The list of workspaces.
*/
async function getPublicWorkspaces() {
const cwd = ppath.resolve('..', ppath.cwd());
const configuration = await Configuration.find(cwd, getPluginConfiguration());
const { project } = await Project.find(configuration, cwd);
async function getPublicWorkspaces(): Promise<Workspace[]> {
const { stdout } = await execa('yarn', [
'workspaces',
'list',
'--json',
'--no-private',
]);

return project.workspaces.filter((workspace) => {
return !workspace.manifest.private;
});
return stdout.split('\n').map((line) => JSON.parse(line));
Copy link

@cursor cursor bot Oct 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bug: Trailing Newlines Break JSON Parsing

The getPublicWorkspaces function splits yarn workspaces list stdout by newlines and parses each line as JSON. Command-line tools often output trailing newlines or empty lines, which causes JSON.parse('') to throw a SyntaxError and crash the script. This is a regression in error handling.

Fix in Cursor Fix in Web

Copy link
Contributor Author

@mcmire mcmire Oct 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suppose so. We use this in other scripts though and it hasn't been a problem there, so I'm okay with this.

}
Loading