@monkvision/eslint-config-typescript-react 4.0.7

package/LICENSE

@@ -0,0 +1,32 @@
+The Clear BSD License
+
+Copyright (c) [2022] [Monk](http://monk.ai)
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted (subject to the limitations in the disclaimer
+below) provided that the following conditions are met:
+
+     * Redistributions of source code must retain the above copyright notice,
+     this list of conditions and the following disclaimer.
+
+     * Redistributions in binary form must reproduce the above copyright
+     notice, this list of conditions and the following disclaimer in the
+     documentation and/or other materials provided with the distribution.
+
+     * Neither the name of the copyright holder nor the names of its
+     contributors may be used to endorse or promote products derived from this
+     software without specific prior written permission.
+
+NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY
+THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
+CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
+BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
+IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,61 @@
+# @monkvision/eslint-config-typescript-react
+
+This package provides the base ESlint configuration used in MonkJs TypeScript React projects.
+
+# Installation
+
+To install this eslint configuration, simply run the following command :
+
+```
+yarn add -D @monkvision/eslint-config-typescript-react
+```
+
+Until ESlint flat config is implemented (_see the note below_), you will also need to install the required peer
+dependencies.
+
+# How to Use
+
+To extend this config, simply place the following snipplet in your `.eslintrc.js` to include the config :
+
+```javascript
+module.exports = {
+  extends: ["@monkvision/eslint-config-typescript-react"],
+  parserOptions: {
+    project: ["./tsconfig.json"],
+  },
+};
+```
+
+Note that you need to manually specify the path to your tsconfig.json or the parser won't be able to locate your
+Typescript config.
+
+# A note reguarding ESlint Flat Configs
+
+Due to the limitations of how ESlint works right now, shared ESlint configurations **need** to specify their
+dependencies (such as other configs, plugins etc...) as peer dependencies. This forces developers that want to use our
+config to manually download each one of our dependencies. This is obviously very cumbersome and kind of misses the whole
+point of a shared config. This is even more true when it comes to monorepos. There are ways of bypassing this limitation
+([@rushstack/eslint-patch](https://www.npmjs.com/package/@rushstack/eslint-patch) etc...) but they come with their own
+limitations and are considered as "patches" rather than actual features.
+
+However, in August 2022, the ESlint team came up with
+[a new config system called ESlint Flat Config](https://eslint.org/blog/2022/08/new-config-system-part-1/). This new
+config system allows (among other things) for a shared config to declare its dependencies as dev (or regular)
+dependencies, and include them in the config file (by importing them as a node package). This is obviously great news
+for us, since it basically means that all the issues listed in the previous paragraph will be solved. However, we need
+to give time to ESlint configs and plugins packages to adapt to this new config system. For instance, the
+typescript-eslint package created [an issue](https://github.com/typescript-eslint/typescript-eslint/issues/5938) on the
+08/11 to update their config system.
+
+This means that for now, we need to stick with the old config and its peer dependencies, and keep an eye on the package
+updates until the new ESlint config system is mature enough for us to migrate to it.
+
+Some references to read more about this subject :
+
+- https://github.com/eslint/eslint/issues/3458
+- https://eslint.org/blog/2022/08/new-config-system-part-1/
+- https://eslint.org/blog/2022/08/new-config-system-part-2/
+- https://eslint.org/blog/2022/08/new-config-system-part-3/
+- https://github.com/eslint/eslint/issues/13481
+- https://eslint.org/docs/latest/user-guide/configuring/configuration-files-new
+- https://github.com/typescript-eslint/typescript-eslint/issues/5938

package/index.js

@@ -0,0 +1,30 @@
+const OFF = 0;
+const WARN = 1;
+const ERROR = 2;
+
+module.exports = {
+  root: true,
+  extends: [
+    '@monkvision/eslint-config-typescript',
+    'plugin:jsx-a11y/recommended',
+  ],
+  plugins: ['react', 'react-hooks', 'jsx-a11y'],
+  parser: '@typescript-eslint/parser',
+  rules: {
+    'no-console': ERROR,
+    'react/function-component-definition': [ERROR, { namedComponent: 'arrow-function' }],
+    'jsx-a11y/media-has-caption': OFF,
+    'jsx-a11y/anchor-has-content': OFF,
+    'jsx-a11y/anchor-is-valid': OFF,
+    'jsx-a11y/no-noninteractive-element-interactions': OFF,
+  },
+  ignorePatterns: ['**/*.js', 'node_modules', 'dist'],
+  overrides: [
+    {
+      files: ['test/**/*.{ts,tsx}'],
+      rules: {
+        'import/first': OFF,
+      },
+    },
+  ],
+};

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@monkvision/eslint-config-typescript-react",
+  "packageManager": "yarn@3.2.4",
+  "version": "4.0.7",
+  "description": "The base ESLint config that used in MonkJs TypeScript React projects",
+  "author": "monkvision",
+  "main": "index.js",
+  "license": "BSD-3-Clause-Clear",
+  "files": [
+    "index.js",
+    "LICENSE",
+    "README.md"
+  ],
+  "peerDependencies": {
+    "@monkvision/eslint-config-typescript": "*",
+    "eslint-plugin-jsx-a11y": "^6.7.1",
+    "eslint-plugin-react": "^7.27.1",
+    "eslint-plugin-react-hooks": "^4.3.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/monkvision/monkjs.git"
+  },
+  "keywords": [
+    "monkvision",
+    "style guide",
+    "lint",
+    "eslint",
+    "config",
+    "es6",
+    "es2015",
+    "es2016",
+    "es2017",
+    "es2018",
+    "typescript",
+    "react"
+  ],
+  "bugs": {
+    "url": "https://github.com/monkvision/monkjs/issues"
+  },
+  "homepage": "https://github.com/monkvision/monkjs",
+  "gitHead": "f132e4e5bc390aa304e25a05f3f72f5e1dca6b13"
+}