Merge branch 'develop' into pin-script-versions

Author: Koooooo-7

.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,16 @@ module.exports = {
     'no-proto': ['error'],
     'no-return-assign': ['error'],
     'no-self-compare': ['error'],
-    'no-shadow': ['warn'],
     'no-shadow-restricted-names': ['error'],
+    'no-shadow': [
+      'error',
+      {
+        allow: ['Events', 'Fetch', 'Lifecycle', 'Render', 'Router'],
+      },
+    ],
+    '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 +57,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',
   },
 };

.github/workflows/lint.yml

@@ -2,41 +2,78 @@ name: Build & Test
 
 on:
   push:
-    branches:
-      - master
-      - develop
+    branches: [master, develop]
   pull_request:
-    branches:
-      - master
-      - develop
+    branches: [master, develop]
 
 jobs:
-  build:
+  lint:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: ['lts/*']
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'npm'
+      - name: Install dependencies
+        run: npm ci --ignore-scripts
+      - name: Build
+        run: npm run build
+      - name: Lint
+        run: npm run lint
+
+  test-jest:
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
       matrix:
-        node-version: [12.x, 14.x]
+        node-version: ['lts/*']
         os: ['macos-latest', 'ubuntu-latest', 'windows-latest']
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'npm'
+      - name: Install dependencies
+        run: npm ci --ignore-scripts
+      - name: Build
+        run: npm run build
+      - name: Unit Tests
+        run: npm run test:unit -- --ci --runInBand
+      - name: Integration Tests
+        run: npm run test:integration -- --ci --runInBand
 
+  test-playwright:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: ['lts/*']
     steps:
       - uses: actions/checkout@v2
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v1
+      - name: Setup Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
         with:
           node-version: ${{ matrix.node-version }}
-      - name: bootstrap
-        run: npm run bootstrap
-      - name: unit tests
-        run: npm run test:unit -- -ci --runInBand
-      - name: integration tests
-        run: npm run test:integration -- -ci --runInBand
-      - uses: microsoft/playwright-github-action@v1
-      - name: e2e tests
-        run: npm run test:e2e -- --ci --runInBand
-      - name: Upload artifacts (diff output)
+          cache: 'npm'
+      - name: Install dependencies
+        run: npm ci --ignore-scripts
+      - name: Build
+        run: npm run build
+      - name: Install Playwright
+        run: npx playwright install --with-deps
+      - name: E2E Tests (Playwright)
+        run: npm run test:e2e
+      - name: Store artifacts
         uses: actions/upload-artifact@v2
         if: failure()
         with:
-          name: ${{ matrix.os }}-${{ matrix.node-version }}-diff-output
-          path: ${{ github.workspace }}/test/**/__diff_output__/*
+          name: ${{ matrix.os }}-${{ matrix.node-version }}-artifacts
+          path: |
+            _playwright-results/
+            _playwright-report/

.github/workflows/test.yml

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

.gitignore

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

.npmignore

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

.prettierrc.js

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

.vscode/settings.json

@@ -12,9 +12,7 @@
   <a href="#backers"><img alt="Backers on Open Collective" src="https://opencollective.com/docsify/backers/badge.svg?style=flat-square"></a>
   <a href="#sponsors">
     <img alt="Sponsors on Open Collective" src="https://opencollective.com/docsify/sponsors/badge.svg?style=flat-square"></a>
-  <a><img src="https://github.com/docsifyjs/docsify/workflows/Unit%20tests%20Suite/badge.svg?branch=develop&amp;event=push" alt="Unit tests Suite"></a>
-  <a><img src="https://github.com/docsifyjs/docsify/workflows/Linting%20Checks/badge.svg?branch=develop&amp;event=push" alt="Linting Checks"></a>
-  <a><img src="https://github.com/docsifyjs/docsify/workflows/Testing%20the%20e2e%20test%20suites/badge.svg?branch=develop&amp;event=push" alt="Testing the e2e test suites"></a>
+  <a href="https://github.com/docsifyjs/docsify/actions/workflows/test.yml"><img src="https://github.com/docsifyjs/docsify/actions/workflows/test.yml/badge.svg" alt="Build & Test"></a>
   <a href="https://www.npmjs.com/package/docsify"><img alt="npm" src="https://img.shields.io/npm/v/docsify.svg?style=flat-square"></a>
   <a href="https://github.com/QingWei-Li/donate"><img alt="donate" src="https://img.shields.io/badge/%24-donate-ff69b4.svg?style=flat-square"></a>
   <a href="https://discord.gg/3NwKFyR"><img alt="Join Discord community and chat about Docsify" src="https://img.shields.io/discord/713647066802421792.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2&cacheSeconds=60"></a>

README.md

@@ -4,7 +4,7 @@
 
 ## What it is
 
-docsify generates your documentation website on the fly. Unlike GitBook, it does not generate static html files. Instead, it smartly loads and parses your Markdown files and displays them as a website. To start using it, all you need to do is create an `index.html` and [deploy it on GitHub Pages](deploy.md).
+Docsify generates your documentation website on the fly. Unlike GitBook, it does not generate static html files. Instead, it smartly loads and parses your Markdown files and displays them as a website. To start using it, all you need to do is create an `index.html` and [deploy it on GitHub Pages](deploy.md).
 
 See the [Quick start](quickstart.md) guide for more details.