chore: add prettier checking and format markdown files (DimensionDev#…

…1625)
himself65 · Sep 28, 2020 · 06c00e7 · 06c00e7
1 parent 547ae6b
commit 06c00e7
Show file tree

Hide file tree

Showing 17 changed files with 392 additions and 397 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -4,111 +4,111 @@
 #
 version: 2.1
 executors:
-    maskbook_node:
-        docker:
-            - image: circleci/node:14.4.0
-        working_directory: ~/repo
+  maskbook_node:
+    docker:
+      - image: circleci/node:14.4.0
+    working_directory: ~/repo
 commands:
-    restore_workspace:
-        description: 'Restore the workspace'
-        steps:
-            - attach_workspace:
-                  at: ~/
+  restore_workspace:
+    description: 'Restore the workspace'
+    steps:
+      - attach_workspace:
+          at: ~/
 jobs:
-    install_dependencies:
-        executor: maskbook_node
-        steps:
-            - checkout
-            - restore_cache:
-                  name: Restore Yarn Package Cache
-                  keys:
-                      - v2-maskbook-cache
-            - run:
-                  name: Install Dependencies
-                  command: yarn install --link-duplicates --frozen-lockfile
-            - save_cache:
-                  name: Save Yarn Package Cache
-                  key: v2-maskbook-cache
-                  paths:
-                      - ~/.cache/yarn
-            - persist_to_workspace:
-                  root: ~/
-                  paths:
-                      - repo
-    build:
-        executor: maskbook_node
-        steps:
-            - restore_workspace
-            - run:
-                  name: Install zip
-                  command: sudo apt-get install zip
-            - run:
-                  name: Build Maskbook
-                  command: yarn build-ci
-            - store_artifacts:
-                  path: Maskbook.base.zip
-                  destination: /Maskbook.base.zip
-            - store_artifacts:
-                  path: Maskbook.iOS.zip
-                  destination: /Maskbook.iOS.zip
-            - store_artifacts:
-                  path: Maskbook.chromium.zip
-                  destination: /Maskbook.chromium.zip
-            - store_artifacts:
-                  path: Maskbook.firefox.zip
-                  destination: /Maskbook.firefox.zip
-            - store_artifacts:
-                  path: Maskbook.gecko.zip
-                  destination: /Maskbook.gecko.zip
-            - store_artifacts:
-                  path: Maskbook.chromium-beta.zip
-                  destination: /Maskbook.chromium-beta.zip
-            - persist_to_workspace:
-                  root: ~/repo/
-                  paths:
-                      - Maskbook.base.zip
-                      - Maskbook.iOS.zip
-                      - Maskbook.chromium.zip
-                      - Maskbook.chromium-beta.zip
-                      - Maskbook.firefox.zip
-                      - Maskbook.gecko.zip
-    publish-github-release:
-        docker:
-            - image: cibuilds/github:0.10
-        steps:
-            - restore_workspace
-            - run:
-                  name: 'Publish Release on GitHub'
-                  command: |
-                      set -o nounset
-                      mkdir ~/repo/release
-                      mv ~/*.zip ~/repo/release/
-                      cd ~/repo/release
-                      ghr -t ${GITHUB_TOKEN} -u ${CIRCLE_PROJECT_USERNAME} -r ${CIRCLE_PROJECT_REPONAME} -c ${CIRCLE_SHA1} -b "✔ No breaking changes. / ⚠ Has breaking changes!
+  install_dependencies:
+    executor: maskbook_node
+    steps:
+      - checkout
+      - restore_cache:
+          name: Restore Yarn Package Cache
+          keys:
+            - v2-maskbook-cache
+      - run:
+          name: Install Dependencies
+          command: yarn install --link-duplicates --frozen-lockfile
+      - save_cache:
+          name: Save Yarn Package Cache
+          key: v2-maskbook-cache
+          paths:
+            - ~/.cache/yarn
+      - persist_to_workspace:
+          root: ~/
+          paths:
+            - repo
+  build:
+    executor: maskbook_node
+    steps:
+      - restore_workspace
+      - run:
+          name: Install zip
+          command: sudo apt-get install zip
+      - run:
+          name: Build Maskbook
+          command: yarn build-ci
+      - store_artifacts:
+          path: Maskbook.base.zip
+          destination: /Maskbook.base.zip
+      - store_artifacts:
+          path: Maskbook.iOS.zip
+          destination: /Maskbook.iOS.zip
+      - store_artifacts:
+          path: Maskbook.chromium.zip
+          destination: /Maskbook.chromium.zip
+      - store_artifacts:
+          path: Maskbook.firefox.zip
+          destination: /Maskbook.firefox.zip
+      - store_artifacts:
+          path: Maskbook.gecko.zip
+          destination: /Maskbook.gecko.zip
+      - store_artifacts:
+          path: Maskbook.chromium-beta.zip
+          destination: /Maskbook.chromium-beta.zip
+      - persist_to_workspace:
+          root: ~/repo/
+          paths:
+            - Maskbook.base.zip
+            - Maskbook.iOS.zip
+            - Maskbook.chromium.zip
+            - Maskbook.chromium-beta.zip
+            - Maskbook.firefox.zip
+            - Maskbook.gecko.zip
+  publish-github-release:
+    docker:
+      - image: cibuilds/github:0.10
+    steps:
+      - restore_workspace
+      - run:
+          name: 'Publish Release on GitHub'
+          command: |
+            set -o nounset
+            mkdir ~/repo/release
+            mv ~/*.zip ~/repo/release/
+            cd ~/repo/release
+            ghr -t ${GITHUB_TOKEN} -u ${CIRCLE_PROJECT_USERNAME} -r ${CIRCLE_PROJECT_REPONAME} -c ${CIRCLE_SHA1} -b "✔ No breaking changes. / ⚠ Has breaking changes!
 
-                      🆕 New Feature
+            🆕 New Feature
 
-                      🔐 Security
+            🔐 Security
 
-                      🎨 UI Improvements
+            🎨 UI Improvements
 
-                      🐛 Bug Fixes
+            🐛 Bug Fixes
 
-                      👩‍💻 Miscellaneous" -replace -draft $(git describe HEAD) ~/repo/release
-                  # -b BODY \         # Set text describing the contents of the release
-                  # -delete \         # Delete release and its git tag in advance if it exists (same as -recreate)
-                  # -n TITLE \        # Set release title
+            👩‍💻 Miscellaneous" -replace -draft $(git describe HEAD) ~/repo/release
+          # -b BODY \         # Set text describing the contents of the release
+          # -delete \         # Delete release and its git tag in advance if it exists (same as -recreate)
+          # -n TITLE \        # Set release title
 workflows:
-    version: 2
-    main:
-        jobs:
+  version: 2
+  main:
+    jobs:
+      - install_dependencies
+      - build:
+          requires:
             - install_dependencies
-            - build:
-                  requires:
-                      - install_dependencies
-            - publish-github-release:
-                  requires:
-                      - build
-                  filters:
-                      branches:
-                          only: released
+      - publish-github-release:
+          requires:
+            - build
+          filters:
+            branches:
+              only: released
diff --git a/.dependabot/config.yml b/.dependabot/config.yml
@@ -1,12 +1,12 @@
 version: 1
 update_configs:
-  - package_manager: "javascript"
-    directory: "/"
-    update_schedule: "monthly"
+  - package_manager: 'javascript'
+    directory: '/'
+    update_schedule: 'monthly'
 
     default_reviewers:
-      - "Jack-Works"
-      - "guanbinrui"
-      - "septs"
+      - 'Jack-Works'
+      - 'guanbinrui'
+      - 'septs'
     default_labels:
-      - "Dependencies"
+      - 'Dependencies'
diff --git a/.editorconfig b/.editorconfig
@@ -10,3 +10,6 @@ indent_style = space
 
 [{.*rc,ts*.json,package.json}]
 indent_size = 2
+
+[*.{yaml,yml,md}]
+indent_size = 2
diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md
@@ -1,37 +1,44 @@
 ---
 name: Bug
 about: Report a bug
-title: "[Bug] "
+title: '[Bug] '
 labels: 'Type: Bug'
 assignees: Jack-Works,jk234ert
-
 ---
 
-# Bug Report 
+# Bug Report
 
 ## Environment
 
 ### System
 
 - [ ] Windows
-    - OS Version:
+
+  - OS Version:
+
 - [ ] Mac OS X
-    - OS Version:
+
+  - OS Version:
+
 - [ ] Linux
-    - Linux Distribution:
-    - OS Version:
+
+  - Linux Distribution:
+  - OS Version:
 
 ### Platform/Browser
 
 - [ ] Chrome
-  - Maskbook Version: 
+
+  - Maskbook Version:
   - Browser Version:
 
 - [ ] Firefox
+
   - Maskbook Version:
   - Browser Version:
 
 - [ ] Android
+
   - Maskbook Version:
   - Android Version:
 
@@ -41,15 +48,14 @@ assignees: Jack-Works,jk234ert
 
 ### Build Variant
 
-- Where do you get Maskbook? 
+- Where do you get Maskbook?
   - [ ] Store
   - [ ] ZIP
   - [ ] Self-Compiled
-    - Build Commit: /* Optionally attach a Commit ID, if it is from an pre-release branch head */
-
+    - Build Commit: /_Optionally attach a Commit ID, if it is from an pre-release branch head_/
 
 ## Bug Info
 
 ### Actual Behavior
 
-/* What happened? */
+/_What happened?_/
diff --git a/.github/ISSUE_TEMPLATE/demand.md b/.github/ISSUE_TEMPLATE/demand.md
@@ -1,10 +1,9 @@
 ---
 name: Demand
 about: PRD for new demand
-title: "[Demand] "
+title: '[Demand] '
 labels: 'Demand: Draft'
 assignees: neruthes
-
 ---
 
 ## Catalogue
@@ -14,7 +13,7 @@ assignees: neruthes
 - [ ] Maskbook Plugin Feature
 - [ ] Security/Cryptography Feature
 - [ ] Other
-    - /* List it here */
+  - /_List it here_/
 
 ## Part 1: Introduction and Background
 

diff --git a/.github/ISSUE_TEMPLATE/release.md b/.github/ISSUE_TEMPLATE/release.md
@@ -1,11 +1,10 @@
 ---
 name: Release
 about: Create a new Release
-title: "release"
-
+title: 'release'
 ---
 
-<!-- 
+<!--
 
 If you want to bump the major version, e.g. `1.x.y` to `2.0.0`, set title as "release major"
 

diff --git a/.github/ISSUE_TEMPLATE/task.md b/.github/ISSUE_TEMPLATE/task.md
@@ -1,15 +1,15 @@
 ---
 name: Task
 about: Non-coding task
-title: "[Task] "
+title: '[Task] '
 labels: Non-Coding Task
 assignees: ''
-
 ---
 
 ## Introduction and Background
-/* Describe the background of this task */
+
+/_Describe the background of this task_/
 
 ## Content
 
-/* Actual content here... */
+/_Actual content here..._/
diff --git a/.github/RELEASE-TEMPLATE.md b/.github/RELEASE-TEMPLATE.md
@@ -1,12 +1,14 @@
 # Chrome Web Store
+
 - [ ] Install as a new user, set up Facebook
 - [ ] Install as a new user, set up Twitter
 - [ ] Install as a new user, set up Facebook, and Twitter
 - [ ] Set up in the last released version, then upgrade to this version (Can be omitted if there is nothing need to be "upgrade")
 - [ ] Install as a returning user
-- [ ] Release on the Chrome Web Store (https://chrome.google.com/webstore/developer/edit/jkoeaghipilijlahjplgbfiocjhldnap)
+- [ ] Release on the Chrome Web Store (<https://chrome.google.com/webstore/developer/edit/jkoeaghipilijlahjplgbfiocjhldnap>)
 
 # Firefox Addon
+
 - [ ] Install as a new user, set up Facebook
 - [ ] Install as a new user, set up Twitter
 - [ ] Install as a new user, set up Facebook, and Twitter
@@ -17,8 +19,9 @@
 - [ ] (Firefox for Android) Install as a new user, set up Facebook, and Twitter
 - [ ] (Firefox for Android) Install as a returning user
 - [ ] (Firefox for Android) Setup in the last released version, then upgrade to this version (Can be omitted if there is nothing need to be "upgrade")
-- [ ] Release on the Firefox Addon (https://addons.mozilla.org/en-US/developers/addon/maskbook/edit)
+- [ ] Release on the Firefox Addon (<https://addons.mozilla.org/en-US/developers/addon/maskbook/edit>)
 
 # Release on GitHub
+
 - [ ] Changelog
-    - [ ] Release on Github
+  - [ ] Release on Github