chore: use prettier instead of clang-format (#7014)

* chore: add and configure prettier * chore: remove clang-format * chore: remove clang-format config * chore: lint additional ts files * chore: fix lint errors in blocks * chore: add prettier-ignore where needed * chore: ignore js blocks when formatting * chore: fix playground html syntax * chore: fix yaml spacing from merge * chore: convert text blocks to use arrow functions * chore: format everything with prettier * chore: fix lint unused imports in blocks
google · May 10, 2023 · 88ff901 · 88ff901
1 parent af991f5
commit 88ff901
Show file tree

Hide file tree

Showing 425 changed files with 29,116 additions and 21,115 deletions.
diff --git a/.clang-format b/.clang-format
diff --git a/.eslintignore b/.eslintignore
@@ -1,7 +1,11 @@
-*_compressed*.js
+# Build Artifacts
 /msg/*
 /build/*
 /dist/*
+/typings/*
+/docs/*
+
+# Tests other than mocha unit tests
 /tests/blocks/*
 /tests/themes/*
 /tests/compile/*
@@ -11,10 +15,14 @@
 /tests/screenshot/*
 /tests/test_runner.js
 /tests/workspace_svg/*
+
+# Demos, scripts, misc
+/node_modules/*
 /generators/*
 /demos/*
 /appengine/*
 /externs/*
 /closure/*
 /scripts/gulpfiles/*
-/typings/*
+CHANGELOG.md
+PULL_REQUEST_TEMPLATE.md
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -1,19 +1,4 @@
 const rules = {
-  'curly': ['error'],
-  'eol-last': ['error'],
-  'keyword-spacing': ['error'],
-  'linebreak-style': ['error', 'unix'],
-  'max-len': [
-    'error',
-    {
-      'code': 100,
-      'tabWidth': 4,
-      'ignoreStrings': true,
-      'ignoreRegExpLiterals': true,
-      'ignoreUrls': true,
-    },
-  ],
-  'no-trailing-spaces': ['error', {'skipBlankLines': true}],
   'no-unused-vars': [
     'warn',
     {
@@ -29,20 +14,12 @@ const rules = {
   // Blockly uses single quotes except for JSON blobs, which must use double
   // quotes.
   'quotes': ['off'],
-  'semi': ['error', 'always'],
-  // Blockly doesn't have space before function paren when defining functions.
-  'space-before-function-paren': ['error', 'never'],
-  // Blockly doesn't have space before function paren when calling functions.
-  'func-call-spacing': ['error', 'never'],
-  'space-infix-ops': ['error'],
   // Blockly uses 'use strict' in files.
   'strict': ['off'],
   // Closure style allows redeclarations.
   'no-redeclare': ['off'],
   'valid-jsdoc': ['error'],
   'no-console': ['off'],
-  'no-multi-spaces': ['error', {'ignoreEOLComments': true}],
-  'operator-linebreak': ['error', 'after'],
   'spaced-comment': [
     'error',
     'always',
@@ -61,27 +38,13 @@ const rules = {
       'allow': ['^opt_', '^_opt_', '^testOnly_'],
     },
   ],
-  // Use clang-format for indentation by running `npm run format`.
-  'indent': ['off'],
   // Blockly uses capital letters for some non-constructor namespaces.
   // Keep them for legacy reasons.
   'new-cap': ['off'],
-  // Mostly use default rules for brace style, but allow single-line blocks.
-  'brace-style': ['error', '1tbs', {'allowSingleLine': true}],
   // Blockly uses objects as maps, but uses Object.create(null) to
   // instantiate them.
   'guard-for-in': ['off'],
   'prefer-spread': ['off'],
-  'comma-dangle': [
-    'error',
-    {
-      'arrays': 'always-multiline',
-      'objects': 'always-multiline',
-      'imports': 'always-multiline',
-      'exports': 'always-multiline',
-      'functions': 'ignore',
-    },
-  ],
 };
 
 /**
@@ -92,10 +55,7 @@ const rules = {
 function buildTSOverride({files, tsconfig}) {
   return {
     'files': files,
-    'plugins': [
-      '@typescript-eslint/eslint-plugin',
-      'jsdoc',
-    ],
+    'plugins': ['@typescript-eslint/eslint-plugin', 'jsdoc'],
     'settings': {
       'jsdoc': {
         'mode': 'typescript',
@@ -111,6 +71,7 @@ function buildTSOverride({files, tsconfig}) {
     'extends': [
       'plugin:@typescript-eslint/recommended',
       'plugin:jsdoc/recommended',
+      'prettier', // Extend again so that these rules are applied last
     ],
     'rules': {
       // TS rules
@@ -130,8 +91,6 @@ function buildTSOverride({files, tsconfig}) {
           'varsIgnorePattern': '^_',
         },
       ],
-      'func-call-spacing': ['off'],
-      '@typescript-eslint/func-call-spacing': ['warn'],
       // Temporarily disable. 23 problems.
       '@typescript-eslint/no-explicit-any': ['off'],
       // Temporarily disable. 128 problems.
@@ -195,21 +154,15 @@ const eslintJSON = {
     'goog': true,
     'exports': true,
   },
-  'extends': [
-    'eslint:recommended',
-    'google',
-  ],
+  'extends': ['eslint:recommended', 'google', 'prettier'],
   // TypeScript-specific config. Uses above rules plus these.
   'overrides': [
     buildTSOverride({
-      files: ['./core/**/*.ts', './core/**/*.tsx'],
+      files: ['./**/*.ts', './**/*.tsx'],
       tsconfig: './tsconfig.json',
     }),
     buildTSOverride({
-      files: [
-        './tests/typescript/**/*.ts',
-        './tests/typescript/**/*.tsx',
-      ],
+      files: ['./tests/typescript/**/*.ts', './tests/typescript/**/*.tsx'],
       tsconfig: './tests/typescript/tsconfig.json',
     }),
     {

diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -1,13 +1,15 @@
 # Contributing to Blockly
 
 Want to contribute? Great!
+
 - First, read this page (including the small print at the end).
 - Second, please make pull requests against develop, not master. If your patch
   needs to go into master immediately, include a note in your PR.
 
 For more information on style guide and other details, head over to the [Blockly Developers site](https://developers.google.com/blockly/guides/modify/contributing).
 
 ### Before you contribute
+
 Before we can use your code, you must sign the
 [Google Individual Contributor License Agreement](https://cla.developers.google.com/about/google-individual)
 (CLA), which you can do online. The CLA is necessary mainly because you own the
@@ -19,22 +21,26 @@ the CLA until after you've submitted your code for review and a member has
 approved it, but you must do it before we can put your code into our codebase.
 
 ### Larger changes
+
 Before you start working on a larger contribution, you should get in touch with
 us first through the issue tracker with your idea so that we can help out and
 possibly guide you. Coordinating up front makes it much easier to avoid
 frustration later on.
 
 ### Code reviews
+
 All submissions, including submissions by project members, require review. We
 use Github pull requests for this purpose.
 
 ### Browser compatibility
-We care strongly about making Blockly work on all browsers.  As of 2022 we
-support Edge, Chrome, Safari, and Firefox.  We will not accept changes that only
-work on a subset of those browsers.  You can check [caniuse.com](https://caniuse.com/)
+
+We care strongly about making Blockly work on all browsers. As of 2022 we
+support Edge, Chrome, Safari, and Firefox. We will not accept changes that only
+work on a subset of those browsers. You can check [caniuse.com](https://caniuse.com/)
 for compatibility information.
 
 ### The small print
+
 Contributions made by corporations are covered by a different agreement than
 the one above, the
 [Software Grant and Corporate Contributor License Agreement](https://cla.developers.google.com/about/google-corporate).
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml
@@ -30,7 +30,7 @@ body:
       value: |
         1. 
         2. 
-        3. 
+        3.
   - type: textarea
     id: stack-trace
     attributes:

diff --git a/.github/ISSUE_TEMPLATE/documentation.yaml b/.github/ISSUE_TEMPLATE/documentation.yaml
@@ -1,4 +1,3 @@
-
 name: Documentation
 description: Report an issue with our documentation
 labels: 'issue: docs, issue: triage'

diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml
@@ -1,4 +1,3 @@
-
 name: Feature request
 description: Suggest an idea for this project
 labels: 'issue: feature request, issue: triage'

diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -5,23 +5,23 @@
 
 version: 2
 updates:
-  - package-ecosystem: "npm" # See documentation for possible values
-    directory: "/" # Location of package manifests
-    target-branch: "develop"
+  - package-ecosystem: 'npm' # See documentation for possible values
+    directory: '/' # Location of package manifests
+    target-branch: 'develop'
     schedule:
-      interval: "weekly"
+      interval: 'weekly'
     commit-message:
-      prefix: "chore(deps)"
+      prefix: 'chore(deps)'
     labels:
-      - "PR: chore"
-      - "PR: dependencies"
-  - package-ecosystem: "github-actions" # See documentation for possible values
-    directory: "/"
-    target-branch: "develop"
+      - 'PR: chore'
+      - 'PR: dependencies'
+  - package-ecosystem: 'github-actions' # See documentation for possible values
+    directory: '/'
+    target-branch: 'develop'
     schedule:
-      interval: "weekly"
+      interval: 'weekly'
     commit-message:
-      prefix: "chore(deps)"
+      prefix: 'chore(deps)'
     labels:
-      - "PR: chore"
-      - "PR: dependencies"
+      - 'PR: chore'
+      - 'PR: dependencies'
diff --git a/.github/release.yml b/.github/release.yml
@@ -4,7 +4,7 @@ changelog:
   exclude:
     labels:
       - ignore-for-release
-      - "PR: chore"
+      - 'PR: chore'
     authors:
       - dependabot
   categories:
@@ -16,17 +16,17 @@ changelog:
         - deprecation
     - title: New features ✨
       labels:
-        - "PR: feature"
+        - 'PR: feature'
     - title: Bug fixes 🐛
       labels:
-        - "PR: fix"
+        - 'PR: fix'
     - title: Cleanup ♻️
       labels:
-        - "PR: docs"
-        - "PR: refactor"
+        - 'PR: docs'
+        - 'PR: refactor'
     - title: Reverted changes ⎌
       labels:
-        - "PR: revert"
+        - 'PR: revert'
     - title: Other changes
       labels:
-        - "*"
+        - '*'
diff --git a/.github/workflows/assign_reviewers.yml b/.github/workflows/assign_reviewers.yml
@@ -16,26 +16,26 @@ jobs:
   requested-reviewer:
     runs-on: ubuntu-latest
     steps:
-    - name: Assign requested reviewer
-      uses: actions/github-script@v6
-      with:
-        script: |
-          try {
-            if (context.payload.pull_request === undefined) {
-            throw new Error("Can't get pull_request payload. " +
-                            'Check a request reviewer event was triggered.');
+      - name: Assign requested reviewer
+        uses: actions/github-script@v6
+        with:
+          script: |
+            try {
+              if (context.payload.pull_request === undefined) {
+              throw new Error("Can't get pull_request payload. " +
+                              'Check a request reviewer event was triggered.');
+              }
+              const reviewers = context.payload.pull_request.requested_reviewers;
+              // Assignees takes in a list of logins rather than the
+              // reviewer object.
+              const reviewerNames = reviewers.map(reviewer => reviewer.login);
+              const {number:issue_number} = context.payload.pull_request;
+              github.rest.issues.addAssignees({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                issue_number: issue_number,
+                assignees: reviewerNames
+              });
+            } catch (error) {
+              core.setFailed(error.message);
             }
-            const reviewers = context.payload.pull_request.requested_reviewers;
-            // Assignees takes in a list of logins rather than the
-            // reviewer object.
-            const reviewerNames = reviewers.map(reviewer => reviewer.login);
-            const {number:issue_number} = context.payload.pull_request;
-            github.rest.issues.addAssignees({
-              owner: context.repo.owner,
-              repo: context.repo.repo,
-              issue_number: issue_number,
-              assignees: reviewerNames
-            });
-          } catch (error) {
-            core.setFailed(error.message);
-          }