feat: show warning when dependenciesMeta.{built,unplugged} is declared in non-top-level workspace

.yarn/versions/42313c0a.yml

@@ -0,0 +1,33 @@
+releases:
+  "@yarnpkg/cli": minor
+  "@yarnpkg/core": minor
+
+declined:
+  - "@yarnpkg/plugin-compat"
+  - "@yarnpkg/plugin-constraints"
+  - "@yarnpkg/plugin-dlx"
+  - "@yarnpkg/plugin-essentials"
+  - "@yarnpkg/plugin-exec"
+  - "@yarnpkg/plugin-file"
+  - "@yarnpkg/plugin-git"
+  - "@yarnpkg/plugin-github"
+  - "@yarnpkg/plugin-http"
+  - "@yarnpkg/plugin-init"
+  - "@yarnpkg/plugin-interactive-tools"
+  - "@yarnpkg/plugin-link"
+  - "@yarnpkg/plugin-nm"
+  - "@yarnpkg/plugin-npm"
+  - "@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/doctor"
+  - "@yarnpkg/nm"
+  - "@yarnpkg/pnpify"
+  - "@yarnpkg/sdks"

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

@@ -16,7 +16,10 @@ export const mtme = (
       const workspacePath = ppath.join(path, workspace as PortablePath);
       await fsUtils.mkdirp(workspacePath);
 
-      await fsUtils.writeJson(ppath.join(workspacePath, Filename.manifest), await deepResolve(manifest));
+      await fsUtils.writeJson(ppath.join(workspacePath, Filename.manifest), await deepResolve({
+        name: ppath.basename(workspace as PortablePath),
+        ...manifest,
+      }));
     }
   };
 

packages/acceptance-tests/pkg-tests-specs/sources/features/logFilter.test.ts

@@ -225,16 +225,16 @@ describe(`Features`, () => {
       let {stdout} = await run(`install`);
       // sanity check
       expect(stdout).toMatch(/Project validation/);
-      expect(stdout).toMatch(/Resolutions field will be ignored/);
+      expect(stdout).toMatch(/foo: Field only allowed in top-level workspace manifest, will be ignored: resolutions/);
 
       await run(`config`, `set`, `logFilters`, `--json`, JSON.stringify([{
-        text: `foo: Resolutions field will be ignored`,
+        text: `foo: Field only allowed in top-level workspace manifest, will be ignored: resolutions`,
         level: `discard`,
       }]));
 
       ({stdout} = await run(`install`));
       expect(stdout).not.toMatch(/Project validation/);
-      expect(stdout).not.toMatch(/Resolutions field will be ignored/);
+      expect(stdout).not.toMatch(/foo: Field only allowed in top-level workspace manifest, will be ignored: resolutions/);
     }));
 
     test(`it should not print the peer dependencies footer if the section contents are discarded via logFilters`, makeTemporaryEnv({

packages/acceptance-tests/pkg-tests-specs/sources/workspace.test.ts

@@ -57,7 +57,7 @@ describe(`Workspaces tests`, () => {
   );
 
   test(
-    `it should not implicitely make workspaces require-able`,
+    `it should not implicitly make workspaces require-able`,
     makeTemporaryEnv(
       {
         private: true,
@@ -84,7 +84,7 @@ describe(`Workspaces tests`, () => {
   );
 
   test(
-    `it should allow workspaces to require each others`,
+    `it should allow workspaces to require each other`,
     makeTemporaryEnv(
       {
         private: true,
@@ -281,4 +281,48 @@ describe(`Workspaces tests`, () => {
       },
     ),
   );
+
+  test(
+    `it should show warnings when top-level manifest fields are declared inside workspace manifests`,
+    makeTemporaryMonorepoEnv({
+      workspaces: [
+        `packages/*`,
+      ],
+    }, {
+      [`packages/foo`]: {
+        resolutions: {
+          [`x`]: `1.0.0`,
+        },
+      },
+      [`packages/bar`]: {
+        dependenciesMeta: {
+          [`x`]: {
+            built: false,
+          },
+        },
+      },
+      [`packages/baz`]: {
+        dependenciesMeta: {
+          [`x`]: {
+            unplugged: true,
+          },
+        },
+      },
+      [`packages/qux`]: {
+        dependenciesMeta: {
+          [`x`]: {
+            optional: true,
+          },
+        },
+      },
+    }, async ({path, run, source}) => {
+      const {stdout} = await run(`install`);
+
+      expect(stdout).toContain(`foo: Field only allowed in top-level workspace manifest, will be ignored: resolutions`);
+      expect(stdout).toContain(`bar: Field only allowed in top-level workspace manifest, will be ignored: dependenciesMeta ➤ x ➤ built`);
+      expect(stdout).toContain(`baz: Field only allowed in top-level workspace manifest, will be ignored: dependenciesMeta ➤ x ➤ unplugged`);
+
+      expect(stdout).not.toContain(`qux: Field only allowed in top-level workspace manifest, will be ignored: dependenciesMeta ➤ x ➤ optional`);
+    }),
+  );
 });

packages/yarnpkg-core/sources/CorePlugin.ts

@@ -55,8 +55,11 @@ export const CorePlugin: Plugin = {
       // Validate manifest
       const {manifest} = workspace;
 
-      if (manifest.resolutions.length && workspace.cwd !== workspace.project.cwd)
-        manifest.errors.push(new Error(`Resolutions field will be ignored`));
+      if (workspace.cwd !== workspace.project.cwd) {
+        for (const field of manifest.topLevelWorkspaceFields) {
+          manifest.errors.push(new Error(`Field only allowed in top-level workspace manifest, will be ignored: ${field}`));
+        }
+      }
 
       for (const manifestError of manifest.errors) {
         report.reportWarning(MessageName.INVALID_MANIFEST, manifestError.message);

packages/yarnpkg-core/sources/Manifest.ts

@@ -84,10 +84,15 @@ export class Manifest {
   public raw: {[key: string]: any} = {};
 
   /**
-   * errors found in the raw manifest while loading
+   * Errors found in the raw manifest while loading.
    */
   public errors: Array<Error> = [];
 
+  /**
+   * Errors about these fields will be pushed to `this.errors` during the validation step if they are not declared inside the top-level workspace manifest.
+   */
+  public topLevelWorkspaceFields: Set<string> = new Set();
+
   static readonly fileName = `package.json` as Filename;
 
   static readonly allDependencies: Array<AllDependencies> = [`dependencies`, `devDependencies`, `peerDependencies`];
@@ -186,6 +191,7 @@ export class Manifest {
 
     this.raw = data;
     const errors: Array<Error> = [];
+    const topLevelWorkspaceFields: Set<string> = new Set();
 
     this.name = null;
     if (typeof data.name === `string`) {
@@ -427,6 +433,8 @@ export class Manifest {
           errors.push(new Error(`Invalid built meta field for '${pattern}'`));
           continue;
         }
+        if (typeof built !== `undefined`)
+          topLevelWorkspaceFields.add(`dependenciesMeta ➤ ${pattern} ➤ built`);
 
         const optional = tryParseOptionalBoolean(meta.optional, {yamlCompatibilityMode});
         if (optional === null) {
@@ -439,6 +447,8 @@ export class Manifest {
           errors.push(new Error(`Invalid unplugged meta field for '${pattern}'`));
           continue;
         }
+        if (typeof unplugged !== `undefined`)
+          topLevelWorkspaceFields.add(`dependenciesMeta ➤ ${pattern} ➤ unplugged`);
 
         Object.assign(dependencyMeta, {built, optional, unplugged});
       }
@@ -467,6 +477,8 @@ export class Manifest {
 
     this.resolutions = [];
     if (typeof data.resolutions === `object` && data.resolutions !== null) {
+      topLevelWorkspaceFields.add(`resolutions`);
+
       for (const [pattern, reference] of Object.entries(data.resolutions)) {
         if (typeof reference !== `string`) {
           errors.push(new Error(`Invalid resolution entry for '${pattern}'`));
@@ -624,6 +636,7 @@ export class Manifest {
       this.preferUnplugged = null;
 
     this.errors = errors;
+    this.topLevelWorkspaceFields = topLevelWorkspaceFields;
   }
 
   getForScope(type: string) {