Update test environments and lint configuration

Update Jest (unit + integration) and Playwright (e2e) test environments. Includes stability improvements for e2e tests using newer, more stable methods per the Playwright docs.

- Update Jest 26 => 27
- Update Jest-related libs (babel parser)
- Update Playwright 1.8 => Playwright Test 1.18
- Update ESLint 5 => 8
- Update ESLint-related libs (parser, prettier, Jest, Playwright)
- Fix e2e stability issues by replacing PW `$` method calls
- Refactor e2e test runner from Jest to Playwright Test
- Refactor e2e test files for Playwright Test
- Refactor `fix-lint` script name to `lint:fix` for consistency
- Refactor npm scripts order for readability
- Remove unnecessary configs and libs
- Remove example image snapshots

Author: jhildenbiddle

.eslintignore

@@ -1,10 +1,9 @@
 .git
-packages/docsify-server-renderer/build.js
-node_modules
+**/*.md
 build
-server.js
+docs
 lib
+node_modules
+packages/docsify-server-renderer/build.js
+server.js
 themes
-build
-docs/
-**/*.md

.eslintrc.js

@@ -1,24 +1,28 @@
+const prettierConfig = require('./.prettierrc');
+
 module.exports = {
   root: true,
-  parser: 'babel-eslint',
+  extends: [
+    'eslint:recommended',
+    'plugin:import/recommended',
+    'plugin:prettier/recommended', // Must be last
+  ],
+  parser: '@babel/eslint-parser',
   parserOptions: {
     sourceType: 'module',
     ecmaVersion: 2019,
   },
+  plugins: ['prettier', 'import'],
   env: {
     browser: true,
-    node: true,
     es6: true,
+    node: true,
   },
-  plugins: ['prettier', 'import'],
-  extends: ['eslint:recommended', 'plugin:import/recommended'],
   settings: {
     'import/ignore': ['node_modules', '.json$'],
   },
   rules: {
-    'prettier/prettier': ['error'],
     camelcase: ['warn'],
-    'no-useless-escape': ['warn'],
     curly: ['error', 'all'],
     'dot-notation': ['error'],
     eqeqeq: ['error'],
@@ -33,9 +37,11 @@ module.exports = {
     'no-proto': ['error'],
     'no-return-assign': ['error'],
     'no-self-compare': ['error'],
-    'no-shadow': ['warn'],
     'no-shadow-restricted-names': ['error'],
+    'no-shadow': ['warn'],
+    'no-unused-vars': ['error', { args: 'none' }],
     'no-useless-call': ['error'],
+    'no-useless-escape': ['warn'],
     'no-var': ['error'],
     'no-void': ['error'],
     'no-with': ['error'],
@@ -46,18 +52,21 @@ module.exports = {
 
     // Import rules
     // Search way how integrate with `lerna`
-    'import/no-unresolved': 'off',
     'import/imports-first': ['error'],
     'import/newline-after-import': ['error'],
     'import/no-duplicates': ['error'],
     'import/no-mutable-exports': ['error'],
-    'import/no-named-as-default': ['error'],
     'import/no-named-as-default-member': ['error'],
+    'import/no-named-as-default': ['error'],
+    'import/no-unresolved': 'off',
     'import/order': ['warn'],
+
+    // Prettier (Must be last)
+    'prettier/prettier': ['warn', prettierConfig],
   },
   globals: {
-    Docsify: 'writable',
     $docsify: 'writable',
+    Docsify: 'writable',
     dom: 'writable',
   },
 };

.gitignore

@@ -1,10 +1,12 @@
-*.log
 .DS_Store
 .idea
+*.log
 __diff_output__
-lib/
+_playwright-report
+_playwright-results
+lib
 node_modules
-themes/
+themes
 
 # exceptions
 !.gitkeep

.npmignore

@@ -1,5 +1,5 @@
 .eslintignore
 .eslintrc
-.github/
+.github
 .gitignore
 .travis.yml

.prettierrc.js

@@ -1,4 +1,4 @@
 module.exports = {
+  arrowParens: 'avoid',
   singleQuote: true,
-  trailingComma: 'es5',
 };

.vscode/settings.json

@@ -1,3 +1,4 @@
 {
-  "editor.defaultFormatter": "esbenp.prettier-vscode"
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "cSpell.words": ["coverpage"]
 }

jest.config.js

@@ -2,60 +2,28 @@ const { TEST_HOST } = require('./test/config/server.js');
 
 const sharedConfig = {
   errorOnDeprecated: true,
-  globals: {
-    TEST_HOST,
-  },
   globalSetup: './test/config/jest.setup.js',
   globalTeardown: './test/config/jest.teardown.js',
   resetModules: true,
   restoreMocks: true,
+  setupFilesAfterEnv: ['<rootDir>/test/config/jest.setup-tests.js'],
+  testEnvironment: 'jsdom',
+  testURL: `${TEST_HOST}/_blank.html`,
 };
 
 module.exports = {
-  // Adding globals to config root for easier importing into .eslint.js, but
-  // as of Jest 26.4.2 these globals need to be added to each project config
-  // as well.
-  globals: sharedConfig.globals,
   projects: [
-    // Unit Tests (Jest)
+    // Unit Tests
     {
-      ...sharedConfig,
       displayName: 'unit',
-      setupFilesAfterEnv: ['<rootDir>/test/config/jest.setup-tests.js'],
+      ...sharedConfig,
       testMatch: ['<rootDir>/test/unit/*.test.js'],
-      testURL: `${TEST_HOST}/_blank.html`,
     },
-    // Integration Tests (Jest)
+    // Integration Tests
     {
-      ...sharedConfig,
       displayName: 'integration',
-      setupFilesAfterEnv: ['<rootDir>/test/config/jest.setup-tests.js'],
-      testMatch: ['<rootDir>/test/integration/*.test.js'],
-      testURL: `${TEST_HOST}/_blank.html`,
-    },
-    // E2E Tests (Jest + Playwright)
-    {
       ...sharedConfig,
-      displayName: 'e2e',
-      preset: 'jest-playwright-preset',
-      setupFilesAfterEnv: [
-        '<rootDir>/test/config/jest-playwright.setup-tests.js',
-      ],
-      testEnvironmentOptions: {
-        'jest-playwright': {
-          // prettier-ignore
-          browsers: [
-            'chromium',
-            'firefox',
-            'webkit',
-          ],
-          launchOptions: {
-            // headless: false,
-            // devtools: true,
-          },
-        },
-      },
-      testMatch: ['<rootDir>/test/e2e/*.test.js'],
+      testMatch: ['<rootDir>/test/integration/*.test.js'],
     },
   ],
 };