scratch-blocks 1.1.206 → 1.2.0-beta.1

package/TODO.md

@@ -0,0 +1,16 @@
+# To-Do list for scratch-blocks un-fork
+
+Before this un-forked version of `scratch-blocks` is fully ready for release, we need to:
+
+- [ ] Hook up i18n / l10n
+- [x] Fix or remove Husky
+- [x] Set up CI & CD
+- [ ] Wait for Blockly v12 release, then update Blockly dependencies accordingly
+
+Things we need to do before we consider this project "done" but could wait until after the initial release:
+
+- [ ] Decide what we want to do about tests, then do it
+- [ ] Pick linting rules, apply them, and enforce them
+- [ ] Make sure the gh-pages setup is doing what we want, or remove it
+- [ ] ???
+- [ ] Remove this TODO file once it's empty :)

package/blockly-rc/.eslintignore

@@ -0,0 +1,28 @@
+# Build Artifacts
+/msg/*
+/build/*
+/dist/*
+/typings/*
+/docs/*
+
+# Tests other than mocha unit tests
+/tests/blocks/*
+/tests/themes/*
+/tests/compile/*
+/tests/jsunit/*
+/tests/generators/*
+/tests/mocha/webdriver.js
+/tests/screenshot/*
+/tests/test_runner.js
+/tests/workspace_svg/*
+
+# Demos, scripts, misc
+/node_modules/*
+/generators/*
+/demos/*
+/appengine/*
+/externs/*
+/closure/*
+/scripts/gulpfiles/*
+CHANGELOG.md
+PULL_REQUEST_TEMPLATE.md

package/blockly-rc/.eslintrc.js

@@ -0,0 +1,187 @@
+const rules = {
+  'no-unused-vars': [
+    'error',
+    {
+      'args': 'after-used',
+      // Ignore vars starting with an underscore.
+      'varsIgnorePattern': '^_',
+      // Ignore arguments starting with an underscore.
+      'argsIgnorePattern': '^_',
+    },
+  ],
+  // Blockly uses for exporting symbols. no-self-assign added in eslint 5.
+  'no-self-assign': ['off'],
+  // Blockly uses single quotes except for JSON blobs, which must use double
+  // quotes.
+  'quotes': ['off'],
+  // Blockly uses 'use strict' in files.
+  'strict': ['off'],
+  // Closure style allows redeclarations.
+  'no-redeclare': ['off'],
+  'valid-jsdoc': ['error'],
+  'no-console': ['off'],
+  'spaced-comment': [
+    'error',
+    'always',
+    {
+      'block': {
+        'balanced': true,
+      },
+      'exceptions': ['*'],
+    },
+  ],
+  // Blockly uses prefixes for optional arguments and test-only functions.
+  'camelcase': [
+    'error',
+    {
+      'properties': 'never',
+      'allow': ['^opt_', '^_opt_', '^testOnly_'],
+    },
+  ],
+  // Blockly uses capital letters for some non-constructor namespaces.
+  // Keep them for legacy reasons.
+  'new-cap': ['off'],
+  // Blockly uses objects as maps, but uses Object.create(null) to
+  // instantiate them.
+  'guard-for-in': ['off'],
+  'prefer-spread': ['off'],
+};
+
+/**
+ * Build shared settings for TS linting and add in the config differences.
+ * @return {Object} The override TS linting for given files and a given
+ *     tsconfig.
+ */
+function buildTSOverride({files, tsconfig}) {
+  return {
+    'files': files,
+    'plugins': ['@typescript-eslint/eslint-plugin', 'jsdoc'],
+    'settings': {
+      'jsdoc': {
+        'mode': 'typescript',
+      },
+    },
+    'parser': '@typescript-eslint/parser',
+    'parserOptions': {
+      'project': tsconfig,
+      'tsconfigRootDir': '.',
+      'ecmaVersion': 2020,
+      'sourceType': 'module',
+    },
+    'extends': [
+      'plugin:@typescript-eslint/recommended',
+      'plugin:jsdoc/recommended',
+      'prettier', // Extend again so that these rules are applied last
+    ],
+    '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': [
+        'error',
+        {
+          'argsIgnorePattern': '^_',
+          'varsIgnorePattern': '^_',
+        },
+      ],
+      // 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,
+        },
+      ],
+      'jsdoc/check-tag-names': [
+        'error',
+        {
+          'definedTags': [
+            'sealed',
+            'typeParam',
+            'remarks',
+            'define',
+            'nocollapse',
+            'suppress',
+          ],
+        },
+      ],
+      // 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'],
+      // Ensure there is a blank line between the body and any @tags,
+      // as required by the tsdoc spec (see #6353).
+      'jsdoc/tag-lines': ['error', 'any', {'startLines': 1}],
+    },
+  };
+}
+
+// NOTE: When this output is put directly in `module.exports`, the formatter
+// does not align with the linter.
+const eslintJSON = {
+  'rules': rules,
+  'env': {
+    'es2020': true,
+    'browser': true,
+  },
+  'globals': {
+    'goog': true,
+    'exports': true,
+  },
+  'extends': ['eslint:recommended', 'google', 'prettier'],
+  // TypeScript-specific config. Uses above rules plus these.
+  'overrides': [
+    buildTSOverride({
+      files: ['./**/*.ts', './**/*.tsx'],
+      tsconfig: './tsconfig.json',
+    }),
+    buildTSOverride({
+      files: ['./tests/typescript/**/*.ts', './tests/typescript/**/*.tsx'],
+      tsconfig: './tests/typescript/tsconfig.json',
+    }),
+    {
+      'files': ['./.eslintrc.js'],
+      'env': {
+        'node': true,
+      },
+    },
+  ],
+};
+
+module.exports = eslintJSON;

package/blockly-rc/.gitattributes

@@ -0,0 +1 @@
+* text=auto

package/blockly-rc/.github/CODEOWNERS

@@ -0,0 +1 @@
+* @google/blockly-eng

package/blockly-rc/.github/CONTRIBUTING.md

@@ -0,0 +1,46 @@
+# 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
+copyright to your changes, even after your contribution becomes part of our
+codebase, so we need your permission to use and distribute your code. We also
+need to be sure of various other things—for instance that you'll tell us if you
+know that your code infringes on other people's patents. You don't have to sign
+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/)
+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).

package/blockly-rc/.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -0,0 +1,58 @@
+name: Report a bug 🐛
+description: Report bugs in Blockly, so we can fix them.
+labels: 'issue: bug, issue: triage'
+body:
+  - type: markdown
+    attributes:
+      value: >
+        Thank you for taking the time to fill out a bug report!
+        If you have a question about how to use Blockly in your application,
+        please ask on the [forum](https://groups.google.com/forum/#!forum/blockly) instead of filing an issue.
+  - type: checkboxes
+    id: duplicates
+    attributes:
+      label: Check for duplicates
+      options:
+        - label: I have searched for similar issues before opening a new one.
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: Please provide a clear and concise description of the bug.
+      placeholder: What happened? What did you expect to happen?
+    validations:
+      required: true
+  - type: textarea
+    id: repro
+    attributes:
+      label: Reproduction steps
+      description: What steps should we take to reproduce the issue?
+      value: |
+        1. 
+        2. 
+        3.
+  - type: textarea
+    id: stack-trace
+    attributes:
+      label: Stack trace
+      description: If you saw an error message or stack trace, please include it here.
+      placeholder: The text in this section will be formatted automatically; no need to include backticks.
+      render: shell
+  - type: textarea
+    id: screenshots
+    attributes:
+      label: Screenshots
+      description: Screenshots can help us see the behavior you're describing. Please add a screenshot or gif, especially if you are describing a rendering or visual bug.
+      placeholder: Paste or drag-and-drop an image to upload it.
+  - type: dropdown
+    id: browsers
+    attributes:
+      label: Browsers
+      description: Please select all browsers you've observed this behavior on. If the bug isn't browser-specific, you can leave this blank.
+      multiple: true
+      options:
+        - Chrome desktop
+        - Safari desktop
+        - Firefox desktop
+        - Android mobile
+        - iOS mobile

package/blockly-rc/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,7 @@
+contact_links:
+  - name: Ask a question ❓
+    url: https://groups.google.com/forum/#!forum/blockly
+    about: Go to the Blockly developer forum, where you can ask and answer questions.
+  - name: Report issues with plugins and examples 🧩
+    url: https://github.com/google/blockly-samples/issues/new/choose
+    about: File bugs or feature requests about plugins and samples in our blockly-samples repository.

package/blockly-rc/.github/ISSUE_TEMPLATE/documentation.yaml

@@ -0,0 +1,38 @@
+name: Report a documentation problem 📖
+description: Could our documentation be better? Tell us how.
+labels: 'issue: docs, issue: triage'
+body:
+  - type: markdown
+    attributes:
+      value: >
+        Thanks for helping us improve our developer site documentation!
+        Use this template to describe issues with the content on our
+        [developer site](https://developers.google.com/blockly/guides).
+  - type: input
+    id: link
+    attributes:
+      label: Location
+      description: >
+        A link to the page with the documentation you want us to be updated.
+        If no page exists, describe what the page should be, and where.
+  - type: checkboxes
+    id: type
+    attributes:
+      label: Type
+      description: What kind of content is it?
+      options:
+        - label: Text
+        - label: Image or Gif
+        - label: Other
+  - type: textarea
+    id: content
+    attributes:
+      label: Suggested content
+      description: Your suggestion for improved documentation. If it's helpful, also include the old content for comparison.
+    validations:
+      required: true
+  - type: textarea
+    id: context
+    attributes:
+      label: Additional context
+      description: Add any other context about the problem. If this is related to a specific pull request, link to it.

package/blockly-rc/.github/ISSUE_TEMPLATE/feature_request.yaml

@@ -0,0 +1,39 @@
+name: Make a feature request ✨
+description: Suggest an idea to make Blockly better.
+labels: 'issue: feature request, issue: triage'
+body:
+  - type: markdown
+    attributes:
+      value: >
+        Thank you for taking the time to fill out a feature request!
+        If you have a question about how to use Blockly in your application,
+        please ask on the [forum](https://groups.google.com/forum/#!forum/blockly) instead of filing an issue.
+  - type: checkboxes
+    id: duplicates
+    attributes:
+      label: Check for duplicates
+      options:
+        - label: I have searched for similar issues before opening a new one.
+  - type: textarea
+    id: problem
+    attributes:
+      label: Problem
+      description: Is your feature request related to a problem? Please describe.
+      placeholder: I'm always frustrated when...
+  - type: textarea
+    id: request
+    attributes:
+      label: Request
+      description: Describe your feature request and how it solves your problem.
+    validations:
+      required: true
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Alternatives considered
+      description: Describe any alternative solutions or features you've considered.
+  - type: textarea
+    id: context
+    attributes:
+      label: Additional context
+      description: Add any other context or screenshots about the feature request here.

package/blockly-rc/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,42 @@
+<!--
+  - Thanks for submitting code to Blockly!  Please fill out the following as part of
+  - your pull request so we can review your code more easily.
+  -->
+
+## The basics
+
+<!-- TODO: Verify the following, checking each box with an 'x' between the brackets: [x] -->
+
+- [ ] I [validated my changes](https://developers.google.com/blockly/guides/contribute/core#making_and_verifying_a_change)
+
+## The details
+### Resolves
+
+<!-- TODO: What Github issue does this resolve? Please include a link. -->
+Fixes 
+
+### Proposed Changes
+
+<!-- TODO: Describe what this Pull Request does.  Include screenshots if applicable. -->
+
+### Reason for Changes
+
+<!--TODO: Explain why these changes should be made.  Include screenshots if applicable. -->
+
+### Test Coverage
+
+<!-- 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
+
+<!-- TODO: Does any documentation need to be created or updated because of this PR?
+  -        If so please explain.
+  -->
+
+### Additional Information
+
+<!-- Anything else we should know? -->

package/blockly-rc/.github/dependabot.yml

@@ -0,0 +1,27 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: 'npm' # See documentation for possible values
+    directory: '/' # Location of package manifests
+    target-branch: 'develop'
+    schedule:
+      interval: 'weekly'
+    commit-message:
+      prefix: 'chore(deps)'
+    labels:
+      - 'PR: chore'
+      - 'PR: dependencies'
+  - package-ecosystem: 'github-actions' # See documentation for possible values
+    directory: '/'
+    target-branch: 'develop'
+    schedule:
+      interval: 'weekly'
+    commit-message:
+      prefix: 'chore(deps)'
+    labels:
+      - 'PR: chore'
+      - 'PR: dependencies'

package/blockly-rc/.github/release.yml

@@ -0,0 +1,32 @@
+# release.yml
+
+changelog:
+  exclude:
+    labels:
+      - ignore-for-release
+      - 'PR: chore'
+    authors:
+      - dependabot
+  categories:
+    - title: Breaking changes 🛠
+      labels:
+        - breaking change
+    - title: Deprecations 🧹 - APIs that may be removed in future releases
+      labels:
+        - deprecation
+    - title: New features ✨
+      labels:
+        - 'PR: feature'
+    - title: Bug fixes 🐛
+      labels:
+        - 'PR: fix'
+    - title: Cleanup ♻️
+      labels:
+        - 'PR: docs'
+        - 'PR: refactor'
+    - title: Reverted changes ⎌
+      labels:
+        - 'PR: revert'
+    - title: Other changes
+      labels:
+        - '*'

package/blockly-rc/.github/workflows/appengine_deploy.yml

@@ -0,0 +1,54 @@
+# Workflow that prepares files and deploys to appengine
+
+name: Deploy to App Engine
+
+# Controls when the workflow will run
+on:
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  prepare:
+    name: Prepare
+    runs-on: ubuntu-latest
+
+    steps:
+      # Checks-out the repository under $GITHUB_WORKSPACE.
+      # When running manually this checks out the master branch.
+      - uses: actions/checkout@v4
+
+      - name: Prepare demo files
+        # Install all dependencies, then copy all the files needed for demos.
+        run: |
+          npm install
+          npm run prepareDemos
+
+      - name: Upload
+        uses: actions/upload-artifact@v4
+        with:
+          name: appengine_files
+          path: _deploy/
+
+  deploy:
+    name: Deploy
+    runs-on: ubuntu-latest
+    # The prepare step must succeed for this step to run.
+    needs: prepare
+    steps:
+      - name: Download prepared files
+        uses: actions/download-artifact@v4
+        with:
+          name: appengine_files
+          path: _deploy/
+
+      - name: Deploy to App Engine
+        uses: google-github-actions/deploy-appengine@v2.1.2
+        # For parameters see:
+        # https://github.com/google-github-actions/deploy-appengine#inputs
+        with:
+          working_directory: _deploy/
+          deliverables: app.yaml
+          project_id: ${{ secrets.GCP_PROJECT }}
+          credentials: ${{ secrets.GCP_SA_KEY }}
+          promote: false
+          version: vtest

package/blockly-rc/.github/workflows/assign_reviewers.yml

@@ -0,0 +1,41 @@
+name: Assign requested reviewers
+
+# This workflow adds requested reviewers as assignees. If you remove a
+# requested reviewer, it will not remove them as an assignee.
+#
+# See https://github.com/google/blockly/issues/5643 for more
+# information on why this was added.
+#
+# N.B.: Runs with a read-write repo token.  Do not check out the
+# submitted branch!
+on:
+  pull_request_target:
+    types: [review_requested]
+
+jobs:
+  requested-reviewer:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Assign requested reviewer
+        uses: actions/github-script@v7
+        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);
+            }