release!: v9.0.0

Merge pull request #6483 from google/rc_2022_10

.eslintignore

@@ -17,3 +17,4 @@
 /externs/*
 /closure/*
 /scripts/gulpfiles/*
+/typings/*

.eslintrc.json

@@ -39,7 +39,7 @@
         "strict": ["off"],
         // Closure style allows redeclarations.
         "no-redeclare": ["off"],
-        "valid-jsdoc": ["error", {"requireReturn": false}],
+        "valid-jsdoc": ["error"],
         "no-console": ["off"],
         "no-multi-spaces": ["error", { "ignoreEOLComments": true }],
         "operator-linebreak": ["error", "after"],
@@ -78,11 +78,89 @@
         "browser": true
     },
     "globals": {
-        "Blockly": true,
         "goog": true,
         "exports": true
     },
     "extends": [
         "eslint:recommended", "google"
-    ]
+    ],
+    // TypeScript-specific config. Uses above rules plus these.
+    "overrides": [{
+        "files": ["**/*.ts", "**/*.tsx"],
+        "plugins": [
+            "@typescript-eslint/eslint-plugin",
+            "jsdoc"
+        ],
+        "settings": {
+            "jsdoc": {
+                "mode": "typescript"
+            }
+        },
+        "parser":  "@typescript-eslint/parser",
+        "parserOptions": {
+            "project": "./tsconfig.json",
+            "tsconfigRootDir": ".",
+            "ecmaVersion": 2020,
+            "sourceType": "module"
+        },
+        "extends": [
+            "plugin:@typescript-eslint/recommended",
+            "plugin:jsdoc/recommended"
+        ],
+        "rules": {
+            // TS rules
+            // Blockly uses namespaces to do declaration merging in some cases.
+            "@typescript-eslint/no-namespace": ["off"],
+            // Use the updated TypeScript-specific rule.
+            "no-invalid-this": ["off"],
+            "@typescript-eslint/no-invalid-this": ["error"],
+            // Needs decision. 601 problems.
+            "@typescript-eslint/no-non-null-assertion": ["off"],
+            // Use TS-specific rule.
+            "no-unused-vars": ["off"],
+            "@typescript-eslint/no-unused-vars": ["warn", {
+                "argsIgnorePattern": "^_",
+                "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.
+            "require-jsdoc": ["off"],
+            // Temporarily disable. 55 problems.
+            "@typescript-eslint/ban-types": ["off"],
+            // Temporarily disable. 33 problems.
+            "@typescript-eslint/no-empty-function": ["off"],
+            // Temporarily disable. 3 problems.
+            "@typescript-eslint/no-empty-interface": ["off"],
+
+            // TsDoc rules (using JsDoc plugin)
+            // Disable built-in jsdoc verifier.
+            "valid-jsdoc": ["off"],
+            // Don't require types in params and returns docs.
+            "jsdoc/require-param-type": ["off"],
+            "jsdoc/require-returns-type": ["off"],
+            // params and returns docs are optional.
+            "jsdoc/require-param-description": ["off"],
+            "jsdoc/require-returns": ["off"],
+            // Disable for now (breaks on `this` which is not really a param).
+            "jsdoc/require-param": ["off"],
+            // Don't auto-add missing jsdoc. Only required on exported items.
+            "jsdoc/require-jsdoc": ["warn", {"enableFixer": false, "publicOnly": true}],
+            // Disable because of false alarms with Closure-supported tags.
+            // Re-enable after Closure is removed.
+            "jsdoc/check-tag-names": ["off"],
+            // Re-enable after Closure is removed. There shouldn't even be types in the TsDoc.
+            // These are "types" because of Closure's @suppress {warningName}
+            "jsdoc/no-undefined-types": ["off"],
+            "jsdoc/valid-types": ["off"],
+            // Disabled due to not handling `this`. If re-enabled, checkDestructured option
+            // should be left as false.
+            "jsdoc/check-param-names": ["off", {"checkDestructured": false}],
+            // Allow any text in the license tag. Other checks are not relevant.
+            "jsdoc/check-values": ["off"]
+
+        }
+    }]
 }

.github/CONTRIBUTING.md

@@ -29,9 +29,9 @@ 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 2017 we 
-support IE 10 and 11, 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

.github/PULL_REQUEST_TEMPLATE.md

@@ -35,11 +35,11 @@
 
 ### Test Coverage
 
-<!-- TODO: Please do one of the following:
-  -    * Create unit tests, and explain here how they cover your changes.
-  -    * List steps you used for manual testing, and explain how they cover
-  -      your changes.
-  -->
+<!-- TODO: Please create unit tests, and explain here how they cover
+           your changes, or tell us how you tested it manually. If
+           your changes include browser-specific behaviour, include
+           information about the browser and device that you used for
+           testing. -->
 
 ### Documentation
 

.github/release-please.yml

@@ -4,3 +4,4 @@ packageName: blockly
 manifest: true
 manifestConfig: release-please-config.json
 manifestFile: .release-please-manifest.json
+handleGHRelease: true

.github/workflows/appengine_deploy.yml

@@ -15,7 +15,7 @@ jobs:
     steps:
       # Checks-out the repository under $GITHUB_WORKSPACE.
       # When running manually this checks out the master branch.
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Prepare demo files
         # Install all dependencies, then copy all the files needed for demos.
@@ -24,7 +24,7 @@ jobs:
           npm run prepareDemos
 
       - name: Upload
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: appengine_files
           path: _deploy/
@@ -36,13 +36,13 @@ jobs:
     needs: prepare
     steps:
       - name: Download prepared files
-        uses: actions/download-artifact@v2
+        uses: actions/download-artifact@v3
         with:
           name: appengine_files
           path: _deploy/
 
       - name: Deploy to App Engine
-        uses: google-github-actions/deploy-appengine@v0.2.0
+        uses: google-github-actions/deploy-appengine@v0.8.0
         # For parameters see:
         # https://github.com/google-github-actions/deploy-appengine#inputs
         with:

.github/workflows/assign_reviewers.yml

@@ -17,7 +17,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Assign requested reviewer
-      uses: actions/github-script@v5
+      uses: actions/github-script@v6
       with:
         script: |
           try {

.github/workflows/build.yml

@@ -17,11 +17,11 @@ jobs:
         # TODO (#2114): re-enable osx build.
         # os: [ubuntu-latest, macos-latest]
         os: [ubuntu-latest]
-        node-version: [12.x, 14.x, 16.x]
+        node-version: [14.x, 16.x]
         # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
       with:
         persist-credentials: false
 
@@ -31,7 +31,7 @@ jobs:
         ssh://git@github.com/
 
     - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
+      uses: actions/setup-node@v3
       with:
         node-version: ${{ matrix.node-version }}
 
@@ -55,10 +55,10 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
 
     - name: Use Node.js 16.x
-      uses: actions/setup-node@v1
+      uses: actions/setup-node@v3
       with:
         node-version: 16.x
 

.github/workflows/check_clang_format.yml

@@ -11,9 +11,9 @@ jobs:
   clang-formatter:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
 
-    - uses: DoozyX/clang-format-lint-action@v0.13
+    - uses: DoozyX/clang-format-lint-action@v0.14
       with:
         source: 'core'
         extensions: 'js,ts'

.github/workflows/tag_module_cleanup.yml

@@ -16,7 +16,7 @@ jobs:
     # Add the type: cleanup label
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/github-script@a3e7071a34d7e1f219a8a4de9a5e0a34d1ee1293
+      - uses: actions/github-script@v6
         with:
           script: |
             // Note that pull requests are considered issues and "shared"

.github/workflows/update_metadata.yml

@@ -17,12 +17,12 @@ jobs:
 
     steps:
     - name: Check Out Blockly
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
       with:
         ref: 'develop'
 
     - name: Use Node.js 16.x
-      uses: actions/setup-node@v1
+      uses: actions/setup-node@v3
       with:
         node-version: 16.x
 
@@ -36,7 +36,7 @@ jobs:
       run: source ./tests/scripts/update_metadata.sh
 
     - name: Create Pull Request
-      uses: peter-evans/create-pull-request@9825ae65b1cb54b543b938503728b432a0176d29
+      uses: peter-evans/create-pull-request@171dd555b9ab6b18fa02519fdfacbb8bf671e1b4
       with:
         commit-message: Update build artifact sizes in check_metadata.sh
         delete-branch: true

.gitignore

@@ -8,6 +8,7 @@ build-debug.log
 *.pyc
 *.komodoproject
 /nbproject/private/
+tsdoc-metadata.json
 
 tests/compile/main_compressed.js
 tests/compile/main_compressed.js.map
@@ -18,3 +19,4 @@ local_build/local_*_compressed.js
 chromedriver
 build/
 dist/
+temp/

README.md

@@ -1,4 +1,4 @@
-# Blockly [![Build Status]( https://travis-ci.org/google/blockly.svg?branch=master)](https://travis-ci.org/google/blockly)
+# Blockly
 
 Google's Blockly is a library that adds a visual code editor to web and mobile apps. The Blockly editor uses interlocking, graphical blocks to represent code concepts like variables, logical expressions, loops, and more. It allows users to apply programming principles without having to worry about syntax or the intimidation of a blinking cursor on the command line.  All code is free and open source.
 
@@ -41,11 +41,9 @@ Want to make Blockly better? We welcome contributions to Blockly in the form of
 
 ## Releases
 
-The next major release will be during the last week of **March 2022**.
-
 We release by pushing the latest code to the master branch, followed by updating the npm package, our [docs](https://developers.google.com/blockly), and [demo pages](https://google.github.io/blockly-samples/). We typically release a new version of Blockly once a quarter (every 3 months). If there are breaking bugs, such as a crash when performing a standard action or a rendering issue that makes Blockly unusable, we will cherry-pick fixes to master between releases to fix them. The [releases page](https://github.com/google/blockly/releases) has a list of all releases.
 
-Releases are tagged by the release date (YYYYMMDD) with a leading major version number and a trailing '.0' in case we ever need a major or patch version (such as [2.20190722.1](https://github.com/google/blockly/tree/2.20190722.1)). Releases that have breaking changes or are otherwise not backwards compatible will have a new major version. Patch versions are reserved for bug-fix patches between scheduled releases.
+We use [semantic versioning](https://semver.org/). Releases that have breaking changes or are otherwise not backwards compatible will have a new major version. Patch versions are reserved for bug-fix patches between scheduled releases.
 
 We now have a [beta release on npm](https://www.npmjs.com/package/blockly?activeTab=versions). If you'd like to test the upcoming release, or try out a not-yet-released new API, you can use the beta channel with: