@bigbinary/neeto-editor 0.3.38 → 0.3.41

package/.browserslistrc

@@ -0,0 +1 @@
+defaults

package/.eslint-rules/custom.js

@@ -0,0 +1 @@
+module.exports = {};

package/.eslint-rules/globals.js

@@ -0,0 +1,11 @@
+module.exports = {
+  // Globals can be disabled with the string "off"
+  // "writable" to allow the variable to be overwritten or "readonly" to disallow overwriting.
+  globals: {
+    Atomics: "readonly",
+    SharedArrayBuffer: "readonly",
+    // Makes logger function available everywhere. Else eslint will complaint of undef-var.
+    logger: "readonly",
+    module: "writable"
+  }
+};

package/.eslint-rules/helpers/index.js

@@ -0,0 +1,52 @@
+const fs = require("fs");
+
+const buildPathGroupsBasedOnWebpackAliases = ({
+  customJSRoot = "app/javascript/",
+  customAliasPath = "config/webpack/alias.js"
+}) => {
+  const rootOfProject = __dirname + `/../../`;
+
+  const isFile = filePath =>
+    fs.existsSync(filePath) && fs.lstatSync(filePath).isFile();
+
+  const webpackAliasPath = rootOfProject + customAliasPath;
+
+  const hasWebpackAliasConfig = isFile(webpackAliasPath);
+
+  const isRailsProject = isFile(rootOfProject + "Gemfile");
+
+  const emptyPathGroups = [];
+
+  if (!hasWebpackAliasConfig || !isRailsProject) return emptyPathGroups;
+
+  const {
+    resolve: { alias }
+  } = require(webpackAliasPath);
+
+  const railsJSFilesRoot = rootOfProject + customJSRoot;
+
+  const pathGroups = Object.entries(alias).map(([name, path]) => {
+    // sometimes alias might be already resolved to full absolute path
+    const isAleadyAnAbsolutePath =
+      path.includes("cypress-tests/") || path.includes("app/");
+
+    const absolutePath = isAleadyAnAbsolutePath
+      ? path
+      : `${railsJSFilesRoot}${path}`;
+    const wildCard =
+      isFile(absolutePath + ".js") || isFile(absolutePath + ".jsx")
+        ? ""
+        : "/**";
+
+    let group = "internal";
+    if (name === "neetoui") {
+      group = "external";
+    }
+
+    return { pattern: `${name}${wildCard}`, group };
+  });
+
+  return pathGroups;
+};
+
+module.exports = { buildPathGroupsBasedOnWebpackAliases };

package/.eslint-rules/imports/enforced.js

@@ -0,0 +1,20 @@
+module.exports = {
+  rules: {
+    // not-auto-fixable: Prefer a default export if module exports a single name.
+    "import/prefer-default-export": "off",
+    // not-auto-fixable: Forbid a module from importing a module with a dependency path back to itself.
+    "import/no-cycle": ["error", { maxDepth: 1, ignoreExternal: true }],
+    // not-auto-fixable: Prevent unnecessary path segments in import and require statements.
+    "import/no-useless-path-segments": ["error", { noUselessIndex: true }],
+    // not-auto-fixable: Report any invalid exports, i.e. re-export of the same name.
+    "import/export": "error",
+    // not-auto-fixable: Forbid the use of mutable exports with var or let.
+    "import/no-mutable-exports": "error",
+    // not-auto-fixable: Ensure all imports appear before other statements.
+    "import/first": "error",
+    // not-auto-fixable: Ensure all exports appear after other statements.
+    "import/exports-last": "error",
+    // auto-fixable: Enforce a newline after import statements.
+    "import/newline-after-import": ["error", { count: 1 }]
+  }
+};

package/.eslint-rules/imports/order.js

@@ -0,0 +1,65 @@
+const { buildPathGroupsBasedOnWebpackAliases } = require(__dirname +
+  "/../helpers");
+const pathGroups = buildPathGroupsBasedOnWebpackAliases({});
+
+const pathGroupForKeepingReactImportsAtTop = {
+  pattern: "react+(-native|)",
+  group: "external",
+  position: "before"
+};
+
+/*
+Example pathGroups structure. Adding this here
+so that if anyone wants to add custom config,
+they can make use of this:
+[
+  { pattern: 'apis/**', group: 'internal' },
+  { pattern: 'common/**', group: 'internal' },
+  { pattern: 'components/**', group: 'internal' },
+  { pattern: 'constants/**', group: 'internal' },
+  { pattern: 'contexts/**', group: 'internal' },
+  { pattern: 'reducers/**', group: 'internal' },
+  { pattern: 'Constants', group: 'internal' },
+  { pattern: 'neetoui/**', group: 'external' },
+  {
+    pattern: 'react+(-native|)',
+    group: 'external',
+    position: 'before'
+  }
+]
+*/
+pathGroups.push(pathGroupForKeepingReactImportsAtTop);
+
+module.exports = {
+  rules: {
+    // auto-fixable: Enforce a convention in module import order - we enforce https://www.bigbinary.com/react-best-practices/sort-import-statements
+    "import/order": [
+      "error",
+      {
+        "newlines-between": "always",
+        alphabetize: { order: "asc", caseInsensitive: true },
+        warnOnUnassignedImports: true,
+        groups: [
+          "builtin",
+          "external",
+          "internal",
+          "index",
+          "sibling",
+          "parent",
+          "object",
+          "type"
+        ],
+        /*
+         * Currently we check for existence of webpack alias
+         * config and then iterate over the aliases and create
+         * these pathGroups. Only caveat with this mechanism
+         * is that in VSCode eslint plugin won't dynamically
+         * read it. But eslint cli would!
+         */
+        pathGroups,
+        // Ignore react imports so that they're always ordered to the top of the file.
+        pathGroupsExcludedImportTypes: ["react", "react-native"]
+      }
+    ]
+  }
+};

package/.eslint-rules/overrides.js

@@ -0,0 +1,24 @@
+module.exports = {
+  // Currently we are using this section for excluding certain files from certain rules.
+  overrides: [
+    {
+      files: [
+        ".eslintrc.js",
+        ".prettierrc.js",
+        "app/assets/**/*",
+        "app/javascript/packs/**/*",
+        "*.json"
+      ],
+      rules: {
+        "import/order": "off",
+        "react-hooks/rules-of-hooks": "off"
+      }
+    },
+    {
+      files: ["app/javascript/packs/**/*.{js,jsx}"],
+      rules: {
+        "no-redeclare": "off"
+      }
+    }
+  ]
+};

package/.eslint-rules/promise.js

@@ -0,0 +1,8 @@
+module.exports = {
+  rules: {
+    // not-auto-fixable: ensure people use async/await promising chaining rather than using "then-catch-finally" statements
+    "promise/prefer-await-to-then": "error",
+    // auto-fixable: avoid calling "new" on a Promise static method like reject, resolve etc
+    "promise/no-new-statics": "error"
+  }
+};

package/.eslint-rules/react.js

@@ -0,0 +1,36 @@
+module.exports = {
+  rules: {
+    // not-auto-fixable: Prevent missing props validation in a React component definition.
+    "react/prop-types": "off",
+    // not-auto-fixable: Detect unescaped HTML entities, which might represent malformed tags.
+    "react/no-unescaped-entities": "off",
+    // not-auto-fixable: Prevent missing displayName in a React component definition. Useful when using React extensions in browser and checking for component name.
+    "react/display-name": "error",
+    // not-auto-fixable: Reports when this.state is accessed within setState.
+    "react/no-access-state-in-setstate": "error",
+    // not-auto-fixable: Prevent usage of dangerous JSX props. Currently jam3 plugin will take care of handling this.
+    "react/no-danger": "off",
+    // not-auto-fixable: Report when a DOM element is using both children and dangerouslySetInnerHTML.
+    "react/no-danger-with-children": "warn",
+    // not-auto-fixable: Prevent definitions of unused prop types.
+    "react/no-unused-prop-types": "error",
+    // not-auto-fixable: Report missing key props in iterators/collection literals. Important rule!
+    "react/jsx-key": "error",
+    // not-auto-fixable: Enforce no duplicate props.
+    "react/jsx-no-duplicate-props": "error",
+    // not-auto-fixable: Disallow undeclared variables in JSX.
+    "react/jsx-no-undef": "error",
+    // not-auto-fixable: Enforce PascalCase for user-defined JSX components.
+    "react/jsx-pascal-case": ["error", { allowNamespace: true }],
+    // not-auto-fixable: Prevent React to be incorrectly marked as unused.
+    "react/jsx-uses-react": "error",
+    // not-auto-fixable: Prevent variables used in JSX to be marked as unused.
+    "react/jsx-uses-vars": "error",
+    // not-auto-fixable: Ensures https://reactjs.org/docs/hooks-rules.html.
+    "react-hooks/rules-of-hooks": "error",
+    // not-auto-fixable: Ensures https://reactjs.org/docs/hooks-rules.html - Checks effect dependencies.
+    "react-hooks/exhaustive-deps": "warn",
+    // auto-fixable: A fragment is redundant if it contains only one child, or if it is the child of a html element, and is not a keyed fragment.
+    "react/jsx-no-useless-fragment": ["error", { allowExpressions: true }],
+  },
+};

package/.eslintignore

@@ -0,0 +1,12 @@
+public
+coverage
+db
+docs
+log
+.scripts
+.semaphore
+test
+tmp
+.vscode
+babel.config.js
+app/javascript/packs

package/.eslintrc.js

@@ -1,20 +1,38 @@
 module.exports = {
   env: {
-    browser: true,
+    browser: true, // window object etc part of browser are made available globally.
+    es2020: true, // to include BigInt support
     es6: true,
+    commonjs: true,
+    node: true,
   },
-  extends: ["eslint:recommended", "plugin:react/recommended"],
+  /*
+   * The order of extending each plugin matters a LOT!!
+   * Thus don't change order of items in this array
+   * unless you're sure of it.
+   */
+  extends: [
+    "plugin:cypress/recommended",
+    "plugin:json/recommended",
+    "eslint:recommended",
+    "plugin:react/recommended",
+    "./.eslint-rules/globals",
+    "./.eslint-rules/imports/order",
+    "./.eslint-rules/overrides",
+    // ensure that you don't add custom rules
+    // without taking permission from team leads.
+    "./.eslint-rules/custom",
+    // custom rules cannot override the following rules.
+    "./.eslint-rules/imports/enforced",
+    "./.eslint-rules/react",
+    "./.eslint-rules/promise",
+    "prettier",
+  ],
   settings: {
     react: {
       version: "detect",
     },
   },
-  globals: {
-    Atomics: "readonly",
-    SharedArrayBuffer: "readonly",
-    logger: true,
-    __dirname: true,
-  },
   parserOptions: {
     ecmaFeatures: {
       jsx: true,
@@ -22,11 +40,70 @@ module.exports = {
     ecmaVersion: 2018,
     sourceType: "module",
   },
-  parser: "babel-eslint",
-  plugins: ["react"],
+  // babel-eslint is deprecated now. This is the latest package.
+  parser: "@babel/eslint-parser",
+  plugins: [
+    "react",
+    "prettier",
+    "import",
+    "react-hooks",
+    "promise",
+    "jam3",
+    "unused-imports",
+  ],
   rules: {
-    semi: ["error", "always"],
+    // auto-fixable: Respect all Prettier rules and apply it.
+    "prettier/prettier": "error",
+    // not-auto-fixable: No unused variables allowed.
+    "no-unused-vars": ["error", { argsIgnorePattern: "^_" }],
+    // not-auto-fixable: No undefined variables allowed.
+    "no-undef": "error",
+    // not-auto-fixable: Dont use console statements. Use logger which babel will remove during bundling.
     "no-console": "error",
-    "react/prop-types": 0,
+    // not-auto-fixable: require `return` statements to either always or never specify values.
+    "consistent-return": "error",
+    // auto-fixable: sadly this doesn't support guard clauses yet.
+    "padding-line-between-statements": [
+      "error",
+      { blankLine: "always", prev: "if", next: ["if", "return"] },
+    ],
+    // auto-fixable: Single line statements needn't have any braces. But in all other cases enforce curly braces.
+    curly: ["error", "multi-line"],
+    // auto-fixable: Remove the else part, if the "if" or "else-if" chain has a return statement
+    "no-else-return": "error",
+    // not-auto-fixable: Prevent un-sanitized dangerouslySetInnerHTML.
+    "jam3/no-sanitizer-with-danger": [
+      2,
+      {
+        wrapperName: ["dompurify", "sanitizer", "sanitize"],
+      },
+    ],
+    // auto-fixable: Requires trailing commas when the last element or property is in a different line than the closing ] or }
+    "comma-dangle": [
+      "error",
+      {
+        arrays: "always-multiline",
+        objects: "always-multiline",
+        imports: "always-multiline",
+        exports: "always-multiline",
+        functions: "never",
+      },
+    ],
+    // auto-fixable: If a variable is never reassigned, using the const declaration is better.
+    "prefer-const": "error",
+    // auto-fixable: It is considered good practice to use the type-safe equality operators === and !==.
+    eqeqeq: "error",
+    // not-auto-fixable: Rule flags optional chaining expressions in positions where short-circuiting to undefined causes throwing a TypeError afterward.
+    "no-unsafe-optional-chaining": "error",
+    // auto-fixable: Remove all unused imports.
+    "unused-imports/no-unused-imports": "error",
+    // auto-fixable-1-level-deep: Using nested ternary operators make the code unreadable. Use if/else or switch with if/else. If it's JSX then move it out into a function or a variable. It's fine to use nestedTernary in JSX when it makes code more readable.
+    "no-nested-ternary": "warn",
+    // auto-fixable: Enforces no braces where they can be omitted.
+    "arrow-body-style": ["error", "as-needed"],
+    // auto-fixable: Suggests using template literals instead of string concatenation.
+    "prefer-template": "error",
+    // auto-fixable: Disallows ternary operators when simpler alternatives exist.
+    "no-unneeded-ternary": ["error", { defaultAssignment: false }],
   },
 };

package/.node-version

@@ -0,0 +1 @@
+16.5

package/.nvmrc

@@ -0,0 +1 @@
+16.5

package/.prettierrc.js

@@ -0,0 +1,16 @@
+module.exports = {
+  tailwindConfig: "./tailwind.config.js",
+  trailingComma: "es5",
+  arrowParens: "avoid",
+  printWidth: 80,
+  tabWidth: 2,
+  useTabs: false,
+  semi: true,
+  quoteProps: "as-needed",
+  jsxSingleQuote: false,
+  singleQuote: false,
+  bracketSpacing: true,
+  bracketSameLine: false,
+  proseWrap: "always",
+  endOfLine: "lf",
+};

package/.vscode/settings.json

@@ -0,0 +1,6 @@
+{
+  "files.trimTrailingWhitespace": true,
+  "files.trimFinalNewlines": true,
+  "editor.formatOnSave": true,
+  "yaml.format.enable": true
+}

package/babel.config.js

@@ -0,0 +1,15 @@
+module.exports = api => {
+  api.cache(true);
+  return {
+    presets: ["@babel/preset-env", "@babel/preset-react"],
+    plugins: ["@babel/plugin-proposal-class-properties"],
+    env: {
+      production: {
+        plugins: [
+          "@babel/plugin-proposal-class-properties",
+          "@babel/plugin-transform-runtime",
+        ],
+      },
+    },
+  };
+};