Merge pull request #396 from monkvision/feature/mn-154-monkjs-4.0.0-init

Added MonkJs 4.0.0 directory

Author: souyahia-monk

.gitignore

@@ -84,7 +84,3 @@ demo.dev.monk.yml
 # yarn
 .yarn/cache
 .yarn/install-state.gz
-
-# refacto files
-demos
-packages/example

monkjs-4.0.0/.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

monkjs-4.0.0/.gitignore

@@ -0,0 +1,14 @@
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions
+
+# Swap the comments on the following lines if you don't wish to use zero-installs
+# Documentation here: https://yarnpkg.com/features/zero-installs
+#!.yarn/cache
+.pnp.*
+
+node_modules
+.idea

monkjs-4.0.0/.yarn/plugins/@yarnpkg/plugin-typescript.cjs

@@ -0,0 +1,9 @@
+nodeLinker: node-modules
+
+plugins:
+  - path: .yarn/plugins/@yarnpkg/plugin-workspace-tools.cjs
+    spec: "@yarnpkg/plugin-workspace-tools"
+  - path: .yarn/plugins/@yarnpkg/plugin-typescript.cjs
+    spec: "@yarnpkg/plugin-typescript"
+
+yarnPath: .yarn/releases/yarn-3.2.4.cjs

monkjs-4.0.0/.yarn/plugins/@yarnpkg/plugin-workspace-tools.cjs

@@ -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.

monkjs-4.0.0/.yarn/releases/yarn-3.2.4.cjs

@@ -0,0 +1,65 @@
+# @monkvision/eslint-config-react
+This package provides the base ESlint configuration for @monkvision Node.js packages that use React with Typescript.
+
+# Installation
+To install this eslint configuration, simply run the following command :
+
+```
+yarn add -D @monkvision/eslint-config-react
+```
+
+If you are installing this package as a dev dependency in the @monkvision yarn workspace, you can add the following line
+in the dev dependencies of your package.json :
+
+```
+"@monkvision/eslint-config-react": "workspace:*"
+```
+
+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-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 and 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 like the official Monk repository, in
+which **every single package** has the same huge list of ESlint dependencies even though we have, right next to them, a
+single shared ESlint config. 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 all of 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, and for now. 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

monkjs-4.0.0/.yarnrc.yml

@@ -0,0 +1,53 @@
+const OFF = 0, WARN = 1, ERROR = 2;
+
+module.exports = {
+  extends: [
+    'react-app',
+    'react-app/jest',
+    'airbnb',
+    'airbnb/hooks',
+    'plugin:promise/recommended',
+    'plugin:import/errors',
+    'plugin:import/warnings',
+    'plugin:import/typescript',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:@typescript-eslint/recommended-requiring-type-checking',
+    'plugin:prettier/recommended',
+  ],
+  plugins: ['@typescript-eslint', 'jest', 'import', 'prettier'],
+  parser: '@typescript-eslint/parser',
+  settings: {
+    'import/resolver': {
+      node: {
+        extensions: ['.js', '.jsx', '.ts', '.tsx'],
+      },
+    },
+  },
+  rules: {
+    'prettier/prettier': ERROR,
+    'import/prefer-default-export': OFF,
+    'import/extensions': OFF,
+    'promise/always-return': OFF,
+    '@typescript-eslint/lines-between-class-members': OFF,
+    'no-plusplus' : [
+      ERROR,
+      { allowForLoopAfterthoughts: true },
+    ],
+  },
+  overrides: [
+    {
+      files: ['*.ts', '*.tsx'],
+      rules: {
+        '@typescript-eslint/no-shadow': [ERROR],
+        'no-shadow': OFF,
+        'no-undef': OFF,
+      },
+    },
+    {
+      files: ['test/**/*.{ts,tsx}'],
+      rules: {
+        'import/first': OFF,
+      },
+    },
+  ],
+}