feat(rules): no-missing-pkg-files checks browser and types fields

Closes #304
boneskull · Aug 24, 2023 · 2beb84f · 2beb84f
1 parent 79b7a95
commit 2beb84f
Show file tree

Hide file tree

Showing 4 changed files with 83 additions and 0 deletions.
diff --git a/src/rules/builtin/no-missing-pkg-files.ts b/src/rules/builtin/no-missing-pkg-files.ts
@@ -13,6 +13,12 @@ const noMissingPkgFiles = createRule({
     if (opts?.bin !== false) {
       fieldsToCheck.push('bin');
     }
+    if (opts?.browser !== false) {
+      fieldsToCheck.push('browser');
+    }
+    if (opts?.types !== false) {
+      fieldsToCheck.push('types');
+    }
 
     /**
      * @param relativePath Path from package root to file
@@ -68,6 +74,16 @@ const noMissingPkgFiles = createRule({
       .default(true)
       .optional()
       .describe('Check the "bin" field (if it exists)'),
+    browser: z
+      .boolean()
+      .default(true)
+      .optional()
+      .describe('Check the "browser" field (if it exists)'),
+    types: z
+      .boolean()
+      .default(true)
+      .optional()
+      .describe('Check the "types" field (if it exists)'),
     fields: z
       .array(z.string().min(1))
       .optional()

diff --git a/test/e2e/rules/fixture/no-missing-pkg-files-browser/package.json b/test/e2e/rules/fixture/no-missing-pkg-files-browser/package.json
@@ -0,0 +1,5 @@
+{
+  "name": "no-missing-pkg-files-types",
+  "version": "1.0.0",
+  "browser": "index.browser.js"
+}
diff --git a/test/e2e/rules/fixture/no-missing-pkg-files-types/package.json b/test/e2e/rules/fixture/no-missing-pkg-files-types/package.json
@@ -0,0 +1,5 @@
+{
+  "name": "no-missing-pkg-files-types",
+  "version": "1.0.0",
+  "types": "index.d.ts"
+}
diff --git a/test/e2e/rules/no-missing-pkg-files.spec.ts b/test/e2e/rules/no-missing-pkg-files.spec.ts
@@ -70,6 +70,7 @@ describe('midnight-smoker', function () {
             });
           });
         });
+
         describe('when the "bin" field is a string', function () {
           beforeEach(function () {
             ({ruleConfig, pkg} = setupRuleTest(
@@ -99,6 +100,62 @@ describe('midnight-smoker', function () {
             );
           });
         });
+
+        describe('when the "types" field is a string', function () {
+          beforeEach(function () {
+            ({ruleConfig, pkg} = setupRuleTest('no-missing-pkg-files-types'));
+          });
+
+          it('should return a RuleFailure', async function () {
+            await expect(
+              applyRules(ruleConfig, pkg, ruleCont),
+              'to be fulfilled with value satisfying',
+              {
+                failed: [
+                  {
+                    rule: noMissingPkgFiles.toJSON(),
+                    message:
+                      'File from "types" field unreadable at path: index.d.ts',
+                    context: {
+                      pkgJson: expect.it('to be an object'),
+                      pkgJsonPath: expect.it('to be a string'),
+                      pkgPath: expect.it('to be a string'),
+                      severity: RuleSeverities.ERROR,
+                    },
+                  },
+                ],
+              },
+            );
+          });
+        });
+
+        describe('when the "browser" field is a string', function () {
+          beforeEach(function () {
+            ({ruleConfig, pkg} = setupRuleTest('no-missing-pkg-files-browser'));
+          });
+
+          it('should return a RuleFailure', async function () {
+            await expect(
+              applyRules(ruleConfig, pkg, ruleCont),
+              'to be fulfilled with value satisfying',
+              {
+                failed: [
+                  {
+                    rule: noMissingPkgFiles.toJSON(),
+                    message:
+                      'File from "browser" field unreadable at path: index.browser.js',
+                    context: {
+                      pkgJson: expect.it('to be an object'),
+                      pkgJsonPath: expect.it('to be a string'),
+                      pkgPath: expect.it('to be a string'),
+                      severity: RuleSeverities.ERROR,
+                    },
+                  },
+                ],
+              },
+            );
+          });
+        });
       });
 
       describe('when run with options', function () {