@bigbinary/neeto-playwright-commons 1.1.0 → 1.1.1

package/README.md

@@ -11,6 +11,22 @@ Install from npm:
 yarn add "@bigbinary/neeto-playwright-commons@latest"
 ```
 
+## Usage
+
+You can import the utility functions and constants from the
+`@bigbinary/neeto-playwright-commons` wherever required.
+
+```js
+import { COMMON_SELECTORS } from "@bigbinary/neeto-playwright-common";
+```
+
+## Exported Functions
+
+- [Common default configurations](./docs/default-configurations.md)
+- [Custom commands](./docs/custom-commands.md)
+- [Util functions](./docs/util-functions.md)
+- [Selectors and texts](./docs/selectors-and-texts.md)
+
 ## Other references
 
 - [Development instructions](./docs/general/development-instructions.md)

package/configs/eslint/common.js

@@ -0,0 +1,88 @@
+const commonEslintConfig = ({
+  ignorePatterns = [],
+  extendsOverrides = [],
+  overrideRules = {},
+  tsconfigRootDir = "",
+}) => {
+  return {
+    ignorePatterns,
+    env: { browser: true, es2021: true, node: true },
+    extends: [
+      "eslint:recommended",
+      "plugin:@typescript-eslint/recommended",
+      "plugin:playwright/recommended",
+      ...extendsOverrides,
+    ],
+    overrides: [
+      {
+        env: { node: true },
+        files: [".eslintrc.{js,cjs}"],
+        parserOptions: { sourceType: "script" },
+      },
+      {
+        env: { node: true },
+        files: ["*.ts", "*.spec.ts"],
+        parser: "@typescript-eslint/parser",
+        parserOptions: {
+          ecmaVersion: "latest",
+          sourceType: "module",
+          tsconfigRootDir,
+          project: ["./tsconfig.json"],
+        },
+        plugins: ["@typescript-eslint", "import"],
+        rules: {
+          "@typescript-eslint/no-floating-promises": "error",
+          "no-unused-vars": "off",
+          "@typescript-eslint/no-unused-vars": ["error"],
+          "@typescript-eslint/no-explicit-any": [
+            "error",
+            { ignoreRestArgs: true },
+          ],
+
+          "playwright/expect-expect": "off",
+          "playwright/no-conditional-in-test": "warn",
+          "playwright/no-nth-methods": "error",
+          "playwright/no-page-pause": "error",
+          "playwright/no-raw-locators": "warn",
+          "playwright/no-useless-await": "error",
+          "playwright/no-useless-not": "error",
+          "playwright/no-wait-for-timeout": "error",
+          "playwright/prefer-strict-equal": "warn",
+          "playwright/prefer-to-be": "warn",
+          "playwright/prefer-to-contain": "error",
+          "playwright/prefer-to-have-count": "error",
+          "playwright/prefer-to-have-length": "error",
+          "playwright/prefer-web-first-assertions": "error",
+          "playwright/require-top-level-describe": "error",
+          "playwright/require-soft-assertions": "off",
+          "playwright/valid-expect": "error",
+          "playwright/prefer-lowercase-title": [
+            "error",
+            { ignoreTopLevelDescribe: true, allowedPrefixes: ["Step"] },
+          ],
+          "import/order": [
+            "error",
+            {
+              "newlines-between": "always",
+              alphabetize: { order: "asc", caseInsensitive: true },
+              warnOnUnassignedImports: true,
+              groups: [
+                "builtin",
+                "external",
+                "internal",
+                "index",
+                "sibling",
+                "parent",
+                "object",
+                "type",
+              ],
+            },
+          ],
+          ...overrideRules,
+        },
+      },
+    ],
+  };
+};
+
+module.exports = commonEslintConfig;

package/configs/eslint/host.js

@@ -0,0 +1,15 @@
+const eslintConfig = require("./common");
+
+const hostEslintConfig = ({ rules = {}, tsconfigRootDir = "" }) => {
+  return eslintConfig({
+    tsconfigRootDir,
+    extendsOverrides: ["../.eslintrc.js"],
+    overrideRules: {
+      "@bigbinary/neeto/use-standard-date-time-formats": "warn",
+      "@bigbinary/neeto/no-dangling-constants": "off",
+      ...rules,
+    },
+  });
+};
+
+module.exports = hostEslintConfig;