feat(config): rules

Signed-off-by: Lexus Drumgold <unicornware@flexdevelopment.llc>

Author: unicornware

.eslintrc.base.cjs

@@ -717,7 +717,7 @@ const config = {
         'unicorn/no-static-only-class': 0,
         'unicorn/no-thenable': 2,
         'unicorn/no-this-assignment': 2,
-        'unicorn/no-unreadable-array-destructuring': 2,
+        'unicorn/no-unreadable-array-destructuring': 0,
         'unicorn/no-unsafe-regex': 0,
         'unicorn/no-unused-properties': 2,
         'unicorn/no-useless-fallback-in-spread': 2,

__fixtures__/signed-off-by.ts

@@ -0,0 +1,6 @@
+/**
+ * @file Test Fixtures - SIGNED_OFF_BY
+ * @module fixtures/SIGNED_OFF_BY
+ */
+
+export default 'Signed-off-by: Lexus Drumgold <unicornware@flexdevelopment.llc>'

__tests__/setup/index.ts

@@ -4,4 +4,5 @@
  */
 
 import './chai'
+import './matchers'
 import './serializers'

__tests__/setup/matchers/index.ts

@@ -0,0 +1,8 @@
+/**
+ * @file Entry Point - Custom Matchers
+ * @module tests/setup/matchers
+ * @see https://vitest.dev/guide/extending-matchers.html
+ */
+
+import './level'
+import './rule-outcome'

__tests__/setup/matchers/level.ts

@@ -0,0 +1,43 @@
+/**
+ * @file Custom Matchers - ruleOutcome
+ * @module tests/setup/matchers/ruleOutcome
+ */
+
+import type { MatcherState, SyncExpectationResult } from '@vitest/expect'
+import { get } from 'radash'
+
+/**
+ * Expects a commit linting rule to be of a certain severity level.
+ *
+ * @this {MatcherState}
+ *
+ * @param {MatcherState} this - Matcher state
+ * @param {unknown} received - Received value
+ * @param {0 | 1 | 2} level - Expected rule config severity
+ * @return {SyncExpectationResult} Expectation result
+ */
+function level(
+  this: MatcherState,
+  received: unknown,
+  level: 0 | 1 | 2
+): SyncExpectationResult {
+  /**
+   * Constructs an expectation result message.
+   *
+   * @return {string} Expectation result message
+   */
+  const message = (): string => {
+    return `expected rule to have severity ${level}`
+  }
+
+  return Array.isArray(received)
+    ? {
+        actual: received,
+        expected: level,
+        message,
+        pass: get(received, received.length === 1 ? '0' : '2') === level
+      }
+    : { actual: received, expected: level, message, pass: false }
+}
+
+expect.extend({ level })

__tests__/setup/matchers/rule-outcome.ts

@@ -0,0 +1,64 @@
+/**
+ * @file Custom Matchers - ruleOutcome
+ * @module tests/setup/matchers/ruleOutcome
+ */
+
+import type cl from '@commitlint/types'
+import type { MatcherState, SyncExpectationResult } from '@vitest/expect'
+
+/**
+ * Expects an array of {@linkcode cl.RuleOutcome} objects to include a specific
+ * {@linkcode cl.LintRuleOutcome}.
+ *
+ * @this {MatcherState}
+ *
+ * @param {MatcherState} this - Matcher state
+ * @param {unknown} received - Received value
+ * @param {string} name - Name of expected {@linkcode cl.LintRuleOutcome}
+ * @param {0 | 1 | 2} level - Expected {@linkcode cl.RuleConfigSeverity}
+ * @return {SyncExpectationResult} Expectation result
+ */
+function ruleOutcome(
+  this: MatcherState,
+  received: unknown,
+  name: string,
+  level: 0 | 1 | 2
+): SyncExpectationResult {
+  /**
+   * Constructs an expectation result message.
+   *
+   * @return {string} Expectation result message
+   */
+  const message = (): string => {
+    /**
+     * Stringified version of {@linkcode received}.
+     *
+     * @const {string} rs
+     */
+    const rs: string = `${this.utils.printReceived(received)}`
+
+    return `expected ${rs} to have rule outcome "${name}" of severity ${level}`
+  }
+
+  /**
+   * Expected values.
+   *
+   * @const {[Pick<cl.LintRuleOutcome, 'name' | 'level'>]} expected
+   */
+  const expected: [Pick<cl.LintRuleOutcome, 'level' | 'name'>] = [
+    { level: level, name }
+  ]
+
+  return Array.isArray(received)
+    ? {
+        actual: received,
+        expected,
+        message,
+        pass: received.find((outcome: cl.LintRuleOutcome): boolean => {
+          return outcome.name === name && outcome.level === level
+        })
+      }
+    : { actual: received, expected, message, pass: false }
+}
+
+expect.extend({ ruleOutcome })

__tests__/ts/v4/tsconfig.json

@@ -29,6 +29,7 @@
     "noUnusedParameters": false,
     "outDir": "../../../dist",
     "paths": {
+      "#fixtures/*": ["__fixtures__/*"],
       "#src": ["src/index"],
       "#src/*": ["src/*"],
       "#tests/*": ["__tests__/*"]

__tests__/utils/signoff.ts

@@ -0,0 +1,19 @@
+/**
+ * @file Test Utilities - signoff
+ * @module tests/utils/signoff
+ */
+
+import SIGNED_OFF_BY from '#fixtures/signed-off-by'
+
+/**
+ * Adds a `Signed-off-by` trailer to the given `commit` message.
+ *
+ * @param {string} commit - Commit to sign
+ * @param {number?} [lines=1] - Number of leading blank lines
+ * @return {string} `commit` with `Signed-off-by` trailer
+ */
+const signoff = (commit: string, lines: number = 1): string => {
+  return commit + `\n${'\n'.repeat(lines)}${SIGNED_OFF_BY}`
+}
+
+export default signoff

package.json

@@ -105,6 +105,7 @@
     "@typescript-eslint/parser": "5.53.0",
     "@vates/toggle-scripts": "1.0.0",
     "@vitest/coverage-c8": "0.29.1",
+    "@vitest/expect": "0.29.1",
     "@vitest/ui": "0.29.1",
     "add-stream": "1.0.0",
     "chai": "4.3.7",