Add a manifest warning when no icon is found

MetaMask · Feb 15, 2024 · afc0a4b · afc0a4b
1 parent 7be3338
commit afc0a4b
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 0 deletions.
diff --git a/packages/snaps-utils/src/manifest/manifest.test.ts b/packages/snaps-utils/src/manifest/manifest.test.ts
@@ -128,6 +128,22 @@ describe('checkManifest', () => {
     expect(warnings[0]).toMatch('Missing recommended package.json properties');
   });
 
+  it('returns a warning if manifest has no defined icon', async () => {
+    const manifest = getSnapManifest();
+
+    // Remove icon
+    manifest.source.location.npm.iconPath = undefined;
+
+    await fs.writeFile(MANIFEST_PATH, JSON.stringify(manifest));
+
+    const { updated, warnings } = await checkManifest(BASE_PATH);
+    expect(updated).toBe(true);
+    expect(warnings).toHaveLength(1);
+    expect(warnings[0]).toMatch(
+      'No icon found in `source.location.npm.iconPath`. It is highly recommended for your Snap to have an icon.',
+    );
+  });
+
   it('return errors if the manifest is invalid', async () => {
     await fs.writeFile(
       MANIFEST_PATH,

diff --git a/packages/snaps-utils/src/manifest/manifest.ts b/packages/snaps-utils/src/manifest/manifest.ts
@@ -191,6 +191,12 @@ export async function checkManifest(
     );
   }
 
+  if (!snapFiles.svgIcon) {
+    warnings.push(
+      'No icon found in `source.location.npm.iconPath`. It is highly recommended for your Snap to have an icon.',
+    );
+  }
+
   if (writeManifest) {
     try {
       const newManifest = `${JSON.stringify(