chore: refactor tests to vitest

Author: hnrq

.eslintignore

@@ -10,35 +10,28 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [18.x]
+        node-version: [22]
 
     steps:
-    - uses: actions/checkout@v4
+      - uses: actions/checkout@v4
 
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v4
-      with:
-        node-version: ${{ matrix.node-version }}
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
 
-    - name: Get Yarn cache directory
-      id: yarn-cache-dir-path
-      run: echo "dir=$(yarn cache dir)" >> $GITHUB_OUTPUT
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'pnpm'
 
-    - name: Use Yarn cache
-      uses: actions/cache@v4
-      id: yarn-cache
-      with:
-        path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
-        key: ${{ runner.os }}-yarn-${{ matrix.node-version }}-${{ hashFiles('**/yarn.lock') }}
+      - name: Install dependencies
+        run: pnpm i --frozen-lockfile
 
-    - name: Install dependencies
-      run: yarn install --prefer-offline --frozen-lockfile
+      - name: Test
+        run: pnpm test
 
-    - name: Test
-      run: yarn run test
+      - name: Lint
+        run: pnpm lint
 
-    - name: Lint
-      run: yarn run lint
-
-    - name: Build
-      run: yarn run build
+      - name: Build
+        run: pnpm build

.eslintrc

@@ -22,22 +22,22 @@ jobs:
     steps:
       - name: Checkout Repo
         uses: actions/checkout@v4
-      
+
       - name: Use Node.js
         uses: actions/setup-node@v4
 
       - name: Install dependencies
-        run: yarn install --frozen-lockfile
+        run: pnpm install --frozen-lockfile
 
       - name: Build packages
-        run: yarn build
+        run: pnpm build
 
       - name: PR or Publish
         id: changesets
         uses: changesets/action@v1
         with:
-          version: yarn run changeset version
-          publish: yarn run changeset publish
+          version: pnpm changeset version
+          publish: pnpm changeset publish
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/ci.yml

@@ -7,7 +7,6 @@
 npm-debug.log
 /src
 /reports
-yarn-error.log
 /.vscode
 /docs
 /.github

.github/workflows/release.yml

@@ -0,0 +1 @@
+v23.10.0

.npmignore

@@ -0,0 +1,25 @@
+import type { RuleTester } from 'eslint';
+import deepmerge from 'deepmerge';
+
+const defaultLanguageOptions = {
+  ecmaVersion: 2020,
+  parserOptions: {
+    ecmaFeatures: {
+      jsx: true,
+    },
+  },
+};
+
+const languageOptionsMapper = (
+  testCase: RuleTester.ValidTestCase | RuleTester.InvalidTestCase,
+) => ({
+  ...testCase,
+  errors: (<RuleTester.InvalidTestCase>testCase).errors,
+  options: testCase.options ?? [],
+  languageOptions: deepmerge(
+    defaultLanguageOptions,
+    testCase.languageOptions ?? {},
+  ),
+});
+
+export default languageOptionsMapper;

.nvmrc

@@ -1,44 +1,46 @@
-/* eslint-env jest */
-/* eslint global-require: 0 */
-
-import assert from 'assert';
-import fs from 'fs';
-import path from 'path';
 import plugin from '../src';
+import type { Rule } from 'eslint';
 
-const rules = fs
-  .readdirSync(path.resolve(__dirname, '../src/rules/'))
-  .map((f) => path.basename(f, '.js'));
+const rules = import.meta.glob<true, string, { default: Rule.RuleModule }>(
+  '../src/rules/*.ts',
+  { eager: true },
+);
 
 describe('all rule files should be exported by the plugin', () => {
-  rules.forEach((ruleName) => {
-    it(`should export ${ruleName}`, () => {
-      assert.equal(
-        plugin.rules[ruleName],
-        require(path.join('../src/rules', ruleName)) // eslint-disable-line
+  it.each(Object.entries(rules))(
+    `exports %s`,
+    (rulePath, { default: ruleModule }) => {
+      const ruleName = rulePath.split('/').at(-1)?.replace('.ts', '');
+      expect(plugin.rules[ruleName as keyof typeof plugin.rules]).toEqual(
+        ruleModule,
       );
-    });
-  });
+    },
+  );
 });
 
-describe('configurations', () => {
-  const configs = ['basic', 'ios', 'android', 'all'];
-
-  configs.forEach((name) => {
-    it(`should export a '${name}' configuration`, () => {
-      assert(plugin.configs[name]);
-    });
-  });
+describe('configs', () => {
+  it.each(['basic', 'ios', 'android', 'all'])(
+    `exports a %s config`,
+    (config) => {
+      expect(
+        plugin.configs[config as keyof typeof plugin.configs],
+      ).toBeTruthy();
+    },
+  );
 });
 
 describe('schemas', () => {
-  rules.forEach((ruleName) => {
-    it(`${ruleName} should export a schema with type object`, () => {
-      const rule = require(path.join('../src/rules', ruleName)); // eslint-disable-line
-      const schema = rule.meta && rule.meta.schema && rule.meta.schema[0];
-      const { type } = schema;
+  it.each(
+    Object.entries(rules).filter(([filename]) => !filename.includes('index')),
+  )(
+    `%s exports a schema with type object`,
+    async (_, { default: ruleModule }) => {
+      const schema =
+        ruleModule.meta &&
+        ruleModule.meta.schema &&
+        (ruleModule.meta.schema as { type: string }[])[0];
 
-      assert.deepEqual(type, 'object');
-    });
-  });
+      expect((schema as { type: string }).type).toBe('object');
+    },
+  );
 });

__tests__/__util__/languageOptionsMapper.ts

@@ -9,7 +9,7 @@
 // -----------------------------------------------------------------------------
 
 import { RuleTester } from 'eslint';
-import parserOptionsMapper from '../../__util__/parserOptionsMapper';
+import languageOptionsMapper from '../../__util__/languageOptionsMapper';
 import rule from '../../../src/rules/has-accessibility-hint';
 
 // -----------------------------------------------------------------------------
@@ -39,13 +39,13 @@ ruleTester.run('has-accessibility-hint', rule, {
                 accessibilityHint="Navigates to the previous screen"
               />`,
     },
-  ].map(parserOptionsMapper),
+  ].map(languageOptionsMapper),
   invalid: [
     {
       code: `<TouchableOpacity
                 accessibilityLabel="Go back"
               />`,
       errors: [expectedError],
     },
-  ].map(parserOptionsMapper),
+  ].map(languageOptionsMapper),
 });

__tests__/__util__/parserOptionsMapper.ts

@@ -9,7 +9,7 @@
 // -----------------------------------------------------------------------------
 
 import { RuleTester } from 'eslint';
-import parserOptionsMapper from '../../__util__/parserOptionsMapper';
+import languageOptionsMapper from '../../__util__/languageOptionsMapper';
 import rule from '../../../src/rules/has-accessibility-props';
 
 // -----------------------------------------------------------------------------
@@ -18,7 +18,7 @@ import rule from '../../../src/rules/has-accessibility-props';
 
 const ruleTester = new RuleTester();
 
-const expectedError = (touchable) => ({
+const expectedError = (touchable: string) => ({
   message: `<${touchable}> must only have either the accessibilityRole prop or both accessibilityTraits and accessibilityComponentType props set`,
   type: 'JSXOpeningElement',
 });
@@ -67,9 +67,6 @@ ruleTester.run('has-accessibility-props', rule, {
     {
       code: '<TouchableWithoutFeedback />;',
     },
-    {
-      code: '<TouchableNativeFeedback />;',
-    },
     {
       code: '<div><TouchableOpacity /></div>;',
     },
@@ -92,7 +89,7 @@ ruleTester.run('has-accessibility-props', rule, {
         },
       ],
     },
-  ].map(parserOptionsMapper),
+  ].map(languageOptionsMapper),
   invalid: [
     {
       code: '<TouchableOpacity accessibilityTraits="none"/>;',
@@ -106,14 +103,6 @@ ruleTester.run('has-accessibility-props', rule, {
       code: '<TouchableHighlight accessibilityComponentType="none"/>;',
       errors: [expectedError('TouchableHighlight')],
     },
-    {
-      code: '<TouchableHighlight accessibilityComponentType="none"/>;',
-      errors: [expectedError('TouchableHighlight')],
-    },
-    {
-      code: '<TouchableWithoutFeedback accessibilityComponentType="none"/>;',
-      errors: [expectedError('TouchableWithoutFeedback')],
-    },
     {
       code: '<TouchableWithoutFeedback accessibilityComponentType="none"/>;',
       errors: [expectedError('TouchableWithoutFeedback')],
@@ -122,10 +111,6 @@ ruleTester.run('has-accessibility-props', rule, {
       code: '<TouchableNativeFeedback accessibilityComponentType="none"/>;',
       errors: [expectedError('TouchableNativeFeedback')],
     },
-    {
-      code: '<TouchableNativeFeedback accessibilityComponentType="none"/>;',
-      errors: [expectedError('TouchableNativeFeedback')],
-    },
     {
       code: '<TouchableOpacity accessibilityRole="none" accessibilityComponentType="none" />;',
       errors: [expectedError('TouchableOpacity')],
@@ -138,5 +123,5 @@ ruleTester.run('has-accessibility-props', rule, {
       code: '<TouchableOpacity accessibilityRole="none" accessibilityComponentType="none" accessibilityTraits="none" />;',
       errors: [expectedError('TouchableOpacity')],
     },
-  ].map(parserOptionsMapper),
+  ].map(languageOptionsMapper),
 });

__tests__/__util__/ruleOptionsMapperFactory.ts

@@ -9,7 +9,7 @@
 // -----------------------------------------------------------------------------
 
 import { RuleTester } from 'eslint';
-import parserOptionsMapper from '../../__util__/parserOptionsMapper';
+import languageOptionsMapper from '../../__util__/languageOptionsMapper';
 import rule from '../../../src/rules/has-valid-accessibility-actions';
 
 // -----------------------------------------------------------------------------
@@ -86,7 +86,7 @@ ruleTester.run('has-valid-accessibility-actions', rule, {
               onAccessibilityAction={this.props.onAccessibilityAction}
             />`,
     },
-  ].map(parserOptionsMapper),
+  ].map(languageOptionsMapper),
   invalid: [
     {
       code: `<View
@@ -220,5 +220,5 @@ ruleTester.run('has-valid-accessibility-actions', rule, {
         },
       ],
     },
-  ].map(parserOptionsMapper),
+  ].map(languageOptionsMapper),
 });