chore: rewrite eslint plugin in typescript (#96)

* chore: rewrite eslint plugin in typescript

* fix: build before lint step because it is required for doc generation

* docs: add build step in docs on how to generate eslint docs

* fix: add dist to eslintignore

* chore: remove eslint plugin node and use typescript eslint plugin

* chore: add eslint prettier plugin

Author: pierrezimmermannbam

.github/workflows/publish.yml

@@ -23,6 +23,9 @@ jobs:
       - name: Install dependencies
         run: yarn --immutable
 
+      - name: Build
+        run: yarn build
+
       - name: Set up .npmrc file
         run: echo "//registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }}" > ~/.npmrc
 

.github/workflows/quality-eslint.yml

@@ -36,6 +36,9 @@ jobs:
       - name: Install dependencies
         run: yarn --frozen-lockfile
 
+      - name: Build
+        run: yarn build
+
       - name: Linter
         run: yarn lint
 

.gitignore

@@ -1 +1,2 @@
-node_modules/
+node_modules/
+dist

packages/eslint-plugin/.eslint-doc-generatorrc.js

@@ -0,0 +1,11 @@
+import prettier from "prettier";
+import type { GenerateOptions } from "eslint-doc-generator";
+
+const config: GenerateOptions = {
+  postprocess: (content, path) =>
+    prettier.format(content, { parser: "markdown" }),
+  urlRuleDoc: (path) =>
+    `https://github.com/bamlab/react-native-project-config/blob/main/packages/eslint-plugin/docs/rules/${path}.md`,
+};
+
+export default config;

packages/eslint-plugin/.eslint-doc-generatorrc.ts

@@ -0,0 +1 @@
+/dist

packages/eslint-plugin/.eslintignore

@@ -5,8 +5,11 @@ module.exports = {
   extends: [
     "eslint:recommended",
     "plugin:eslint-plugin/recommended",
-    "plugin:node/recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:prettier/recommended",
   ],
+  parser: "@typescript-eslint/parser",
+  plugins: ["@typescript-eslint"],
   rules: {
     "eslint-plugin/require-meta-docs-description": [
       2,
@@ -24,11 +27,5 @@ module.exports = {
   env: {
     node: true,
   },
-  overrides: [
-    {
-      files: ["tests/**/*.js"],
-      env: { mocha: true },
-    },
-  ],
   ignorePatterns: ["example-app"],
 };

packages/eslint-plugin/.eslintrc.js

@@ -103,6 +103,7 @@ Creating new rules is quite simple:
 1. Update the README and run the tests:
 
    ```bash
+   yarn build
    yarn update:eslint-docs
    yarn lint
    yarn test

packages/eslint-plugin/CONTRIBUTING.md

@@ -0,0 +1,14 @@
+import type { Config } from "jest";
+
+const config: Config = {
+  verbose: true,
+  preset: "ts-jest",
+  testEnvironment: "node",
+  transform: {
+    "^.+\\.tsx?$": "ts-jest",
+  },
+  testRegex: "(/__tests__/.*|(\\.|/)(test|spec))\\.tsx?$",
+  moduleFileExtensions: ["ts", "tsx", "js", "jsx", "json", "node"],
+};
+
+export default config;

packages/eslint-plugin/jest.config.ts

@@ -1,9 +1,6 @@
-// @ts-check
-"use strict";
+import { defineConfig } from "eslint-define-config";
 
-const { defineConfig } = require("eslint-define-config");
-
-module.exports = defineConfig({
+export const a11yconfig = defineConfig({
   extends: ["plugin:react-native-a11y/all"],
   rules: {
     "react-native-a11y/has-accessibility-hint": "off",