@ornikar/eslint-plugin-ornikar 0.0.1 → 20.2.0

package/.eslintrc.json

@@ -1,4 +1,10 @@
 {
   "root": true,
-  "extends": ["@ornikar/eslint-config/node"]
+  "extends": ["@ornikar/eslint-config/node"],
+  "overrides": [
+    {
+      "files": ["rules/test-utils/**/*"],
+      "extends": ["@ornikar/eslint-config/tests-override"]
+    }
+  ]
 }

package/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## [20.2.0](https://github.com/ornikar/eslint-configs/compare/v20.1.1...v20.2.0) (2023-09-19)
+
+
+### Features
+
+* **eslint-plugin-ornikar:** react function return ReactNode [no issue] ([#599](https://github.com/ornikar/eslint-configs/issues/599)) ([2c39241](https://github.com/ornikar/eslint-configs/commit/2c39241f94fa75420c8e0b7885aa47c0dfaa18c4))

package/configs/all.js

@@ -2,7 +2,6 @@
 
 module.exports = {
   rules: {
-    '@ornikar/ornikar/forbid-fetch-import': 'error',
-    '@ornikar/ornikar/react-function-return-react-node': 'error',
+    '@ornikar/ornikar/react-function-component-return-react-node': 'error',
   },
 };

package/docs/rules/react-function-return-react-node.md

@@ -0,0 +1,29 @@
+# Return type of react function component should be ReactNode
+
+💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/sindresorhus/eslint-plugin-unicorn#preset-configs).
+
+<!-- 🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix). -->
+
+## Fail
+
+```tsx
+function Component(): ReactElement {
+  return <div />;
+}
+
+function Component(): ReactElement | null {
+  return <div />;
+}
+```
+
+## Pass
+
+```tsx
+function Component(): ReactNode {
+  return <div />;
+}
+```
+
+## Options
+
+None

package/loadRules.js

@@ -2,6 +2,15 @@
 
 const fs = require('node:fs');
 const path = require('node:path');
+const pkg = require('./package.json');
+
+const repoUrl = 'https://github.com/ornikar/eslint-configs';
+const packagePath = '@ornikar/eslint-plugin-ornikar';
+
+const getDocumentationUrl = (filename) => {
+  const ruleName = path.basename(filename, '.js');
+  return `${repoUrl}/blob/v${pkg.version}/${packagePath}/docs/rules/${ruleName}.md`;
+};
 
 function loadRule(ruleId) {
   // eslint-disable-next-line import/no-dynamic-require, global-require, security/detect-non-literal-require
@@ -13,7 +22,7 @@ function loadRule(ruleId) {
       ...rule.meta,
       docs: {
         ...rule.meta.docs,
-        // url: getDocumentationUrl(ruleId),
+        url: getDocumentationUrl(ruleId),
       },
     },
     create: rule.create,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ornikar/eslint-plugin-ornikar",
-  "version": "0.0.1",
+  "version": "20.2.0",
   "description": "eslint plugin for ornikar",
   "repository": {
     "directory": "@ornikar/eslint-plugin-ornikar",
@@ -32,7 +32,10 @@
     "eslint-plugin-react": "^7.33.2"
   },
   "devDependencies": {
+    "@eslint/eslintrc": "2.1.2",
     "@typescript-eslint/rule-tester": "6.7.0",
-    "@typescript-eslint/utils": "6.7.0"
-  }
+    "@typescript-eslint/utils": "6.7.0",
+    "eslint": "8.49.0"
+  },
+  "gitHead": "84591fd9baf94194eda1ea044933f6f0d52a3231"
 }

package/rules/{react-function-return-react-node.js → react-function-component-return-react-node.js}

@@ -1,6 +1,5 @@
 'use strict';
 
-const { AST_NODE_TYPES } = require('@typescript-eslint/utils');
 const Components = require('eslint-plugin-react/lib/util/Components');
 
 exports.meta = {
@@ -37,7 +36,7 @@ function checkFunctionReturnType(node, onError) {
   if (typeName == null) return;
 
   if (typeName.name !== 'ReactNode') {
-    onError(typeName.name, typeName.range);
+    onError(typeName, typeName.name, typeName.range);
   }
 }
 
@@ -46,10 +45,9 @@ exports.create = Components.detect((context, components) => {
     FunctionDeclaration(node) {
       if (!components.get(node)) return;
 
-      checkFunctionReturnType(node, (currentName, range) =>
+      checkFunctionReturnType(node, (typeName, currentName, range) =>
         context.report({
-          node,
-          loc: range,
+          node: typeName,
           messageId: 'invalidReturnType',
           data: { value: currentName },
           suggest: [

package/rules/{react-function-return-react-node.test.js → react-function-component-return-react-node.test.js}

@@ -1,8 +1,8 @@
 'use strict';
 
 const path = require('node:path');
-const rule = require('./react-function-return-react-node');
-const { RuleTester } = require('./utils/RuleTester');
+const rule = require('./react-function-component-return-react-node');
+const { RuleTester } = require('./test-utils/RuleTester');
 
 const ruleTester = new RuleTester({
   parser: require.resolve('@typescript-eslint/parser'),
@@ -15,7 +15,7 @@ const ruleTester = new RuleTester({
   },
 });
 
-ruleTester.run('react-function-return-react-node', rule, {
+ruleTester.run('react-function-component-return-react-node', rule, {
   valid: [
     {
       code: `
@@ -37,6 +37,9 @@ export function SomeComponent(): ReactElement {
         {
           messageId: 'invalidReturnType',
           data: { value: 'ReactElement' },
+          line: 3,
+          column: 34,
+          endColumn: 46,
           suggestions: [
             {
               messageId: 'replaceReturnType',

package/rules/{utils → test-utils}/RuleTester.js

@@ -1,4 +1,8 @@
+'use strict';
+
+// eslint-disable-next-line import/no-unresolved -- waiting for node 18
 const { after, describe, it } = require('node:test');
+// eslint-disable-next-line import/no-unresolved, import/order -- missing main field
 const { RuleTester } = require('@typescript-eslint/rule-tester');
 
 RuleTester.afterAll = after;

package/.vscode/settings.json

@@ -1,3 +0,0 @@
-{
-  "eslint.workingDirectories": ["../../"]
-}

package/rules/forbid-fetch-import.js

@@ -1,40 +0,0 @@
-'use strict';
-
-exports.meta = {
-  type: 'problem',
-
-  docs: {
-    description: 'Forbid node-fetch import now that fetch is available in node and browsers',
-    category: 'Best Practices',
-    recommended: true,
-  },
-
-  messages: {
-    forbidden: 'import from "{{value}}" is forbidden. Fetch is available in browsers and node since 18.0.0.',
-  },
-};
-
-const fetchLibs = ['node-fetch', 'cross-fetch', 'isomorphic-fetch'];
-
-exports.create = (context) => {
-  const checkNode = (node) => {
-    const importSource = node.source.value.trim();
-
-    if (fetchLibs.includes(importSource)) {
-      context.report({
-        node,
-        messageId: 'forbidden',
-        data: { value: importSource },
-      });
-    }
-  };
-  return {
-    ImportDeclaration: checkNode,
-    ExportNamedDeclaration(node) {
-      if (node.source) {
-        checkNode(node);
-      }
-    },
-    ExportAllDeclaration: checkNode,
-  };
-};

package/rules/forbid-fetch-import.test.js

@@ -1,35 +0,0 @@
-'use strict';
-
-const { RuleTester } = require('eslint');
-const rule = require('./forbid-fetch-import');
-
-const parserOptions = {
-  ecmaVersion: 2018,
-  sourceType: 'module',
-};
-
-const ruleTester = new RuleTester({ parserOptions });
-
-ruleTester.run('forbid-fetch-import', rule, {
-  valid: [
-    {
-      code: `
-      fetch('https://example.com');
-    `,
-    },
-  ],
-  invalid: [
-    {
-      code: `
-      import fetch from 'node-fetch';
-      fetch('https://example.com');
-    `,
-      errors: [
-        {
-          messageId: 'forbidden',
-          data: { value: 'node-fetch' },
-        },
-      ],
-    },
-  ],
-});