Add Yarn-related rules

package.json

@@ -54,6 +54,8 @@
     "chalk": "^4.1.2",
     "dependency-graph": "^0.11.0",
     "execa": "^5.1.1",
+    "pony-cause": "^2.1.10",
+    "superstruct": "^1.0.3",
     "yargs": "^17.7.2"
   },
   "devDependencies": {

src/execute-rules.ts

@@ -65,6 +65,31 @@ export type RootRuleExecutionResultNode = {
   children: RuleExecutionResultNode[];
 };
 
+/**
+ * The arguments passed to every rule's `execute` method.
+ */
+export type RuleExecutionArguments = {
+  /**
+   * A reference to a template repository that serves as a baseline for the
+   * project.
+   */
+  template: MetaMaskRepository;
+  /**
+   * A reference to the project repository.
+   */
+  project: MetaMaskRepository;
+  /**
+   * A supporting function that causes the rule to pass.
+   */
+  pass: () => SuccessfulPartialRuleExecutionResult;
+  /**
+   * A supporting function that causes the rule to fail.
+   */
+  fail: (
+    failures: FailedPartialRuleExecutionResult['failures'],
+  ) => FailedPartialRuleExecutionResult;
+};
+
 /**
  * A lint rule that can be executed against a project.
  */
@@ -85,14 +110,7 @@ export type Rule = {
   /**
    * The "body" of the rule.
    */
-  execute(args: {
-    project: MetaMaskRepository;
-    template: MetaMaskRepository;
-    pass: () => SuccessfulPartialRuleExecutionResult;
-    fail: (
-      failures: FailedPartialRuleExecutionResult['failures'],
-    ) => FailedPartialRuleExecutionResult;
-  }): Promise<PartialRuleExecutionResult>;
+  execute(args: RuleExecutionArguments): Promise<PartialRuleExecutionResult>;
 };
 
 /**
@@ -218,8 +236,8 @@ async function executeRule({
 }
 
 /**
- * A helper intended to be used in a rule which ends its execution by marking it
- * as passing.
+ * A helper for a rule which is intended to end its execution by marking it as
+ * passing.
  *
  * @returns Part of a successful rule execution result (the rest will be filled
  * in automatically).
@@ -231,8 +249,8 @@ export function pass(): SuccessfulPartialRuleExecutionResult {
 }
 
 /**
- * A helper intended to be used in a rule which ends its execution by marking it
- * as failing.
+ * A helper for a rule which is intended to end its execution by marking it as
+ * failing.
  *
  * @param failures - The list of associated failures.
  * @returns Part of a failed rule execution result (the rest will be filled