eslint-config-scratch 9.0.9 → 10.0.0

package/.github/workflows/deploy.yml

@@ -2,29 +2,35 @@ name: Build eslint-config-scratch
 
 on:
   push:
-permissions: 
+permissions:
   contents: write # publish a GitHub release
   pages: write # deploy to GitHub Pages
   issues: write # comment on released issues
   pull-requests: write # comment on released pull requests
 jobs:
-    build-eslint:
-        runs-on: ubuntu-latest
-        steps:
-        - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
-        - uses: wagoid/commitlint-github-action@5ce82f5d814d4010519d15f0552aec4f17a1e1fe # v5
-        - name: Use Node.js 18
-          uses: actions/setup-node@f1f314fca9dfce2769ece7d933488f076716723e # v1
-          with:
-            node-version: 18.x
-        - name: Install Dependencies
-          run: npm install
-        - name: Test
-          run: npm test
-        - name: Semantic Release
-          if: github.ref == 'refs/heads/master' && github.event_name == 'push'
-          env:
-            NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-            GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          run: npx --no -- semantic-release
-    
+  build-eslint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
+      - uses: wagoid/commitlint-github-action@b948419dd99f3fd78a6548d48f94e3df7f6bf3ed # v6
+      - uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4
+        with:
+          cache: 'npm'
+          node-version-file: '.nvmrc'
+      - name: Info
+        run: |
+          cat <<EOF
+          Node version: $(node --version)
+          NPM version: $(npm --version)
+          github.event.pull_request.head.label: ${{ github.event.pull_request.head.label }}
+          github.head_ref: ${{ github.head_ref }}
+          github.ref: ${{ github.ref }}
+          github.workflow: ${{ github.workflow }}
+          EOF
+      - run: npm ci
+      - run: npm test
+      - name: Semantic Release
+        env:
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: npx --no -- semantic-release

package/.github/workflows/signature-assistant.yml

@@ -0,0 +1,31 @@
+name: 'Signature Assistant'
+on:
+  issue_comment:
+    types: [created]
+  pull_request_target:
+    types: [opened, closed, synchronize]
+
+permissions:
+  actions: write
+  contents: read
+  pull-requests: write
+  statuses: write
+
+jobs:
+  CLA-Assistant:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 'CLA Assistant'
+        if: (github.event.comment.body == 'recheck' || github.event.comment.body == 'I have read the CLA Document and I hereby sign the CLA') || github.event_name == 'pull_request_target'
+        uses: contributor-assistant/github-action@ca4a40a7d1004f18d9960b404b97e5f30a505a08 # v2.6.1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          # the below token should have repo scope and must be manually added by you in the repository's secrets
+          PERSONAL_ACCESS_TOKEN: ${{ secrets.GHA_AGREEMENTS_PAT }}
+        with:
+          remote-organization-name: 'scratchfoundation'
+          remote-repository-name: 'scratch-agreements'
+          path-to-signatures: 'signatures/version1/cla.json'
+          path-to-document: 'https://github.com/scratchfoundation/scratch-agreements/blob/main/CLA.md'
+          branch: 'main'
+          allowlist: semantic-release-bot,*[bot]

package/.nvmrc

@@ -0,0 +1 @@
+22

package/.prettierignore

@@ -0,0 +1 @@
+/CHANGELOG.md

package/CHANGELOG.md

@@ -3,6 +3,25 @@
 All notable changes to this project will be documented in this file. See
 [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [10.0.0](https://github.com/scratchfoundation/eslint-config-scratch/compare/v9.1.0...v10.0.0) (2025-03-31)
+
+
+* chore!: major version bump for next-gen style rules ([3687676](https://github.com/scratchfoundation/eslint-config-scratch/commit/368767667304775ef75e5c440cf9958f94e0b0a1))
+
+
+### BREAKING CHANGES
+
+* There have been several major style changes since
+v9.0.9, and they were accidentally released as v9.1.0 at first. This
+commit is meant to force a bump to v10.
+
+# [9.1.0](https://github.com/scratchfoundation/eslint-config-scratch/compare/v9.0.9...v9.1.0) (2025-03-31)
+
+
+### Features
+
+* enable linting MD and HTML files ([a95140a](https://github.com/scratchfoundation/eslint-config-scratch/commit/a95140a52cffca0614d13751fe5cf9594d045b75))
+
 ## [9.0.9](https://github.com/scratchfoundation/eslint-config-scratch/compare/v9.0.8...v9.0.9) (2024-09-11)
 
 

package/LICENSE

@@ -1,4 +1,6 @@
-Copyright (c) 2016, Massachusetts Institute of Technology
+BSD 3-Clause License
+
+Copyright (c) Scratch Foundation
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

package/README.md

@@ -1,69 +1,180 @@
 # Scratch ESLint config
 
-[![Greenkeeper badge](https://badges.greenkeeper.io/LLK/eslint-config-scratch.svg)](https://greenkeeper.io/)
+`eslint-config-scratch` defines `eslint` and `prettier` rules for Scratch Javascript and TypeScript projects.
+Generally speaking, this configuration uses `prettier` for code style and formatting and `eslint` to flag potential
+mistakes and encourage code that's easier to read and understand.
 
-#### eslint-config-scratch defines the eslint rules used for Scratch Javascript projects
+## Quick Start
 
-## Installation
-
-Install the config along with its peer dependencies, eslint and babel-eslint.
+Install the config along with its peer dependencies, `eslint` and `prettier`:
 
 ```bash
-npm install -DE eslint-config-scratch eslint@^8 @babel/eslint-parser@^7
+npm install -D eslint-config-scratch eslint@^9 prettier@^3
 ```
 
-If you're using the React config, also install the dependency for that
+Add `eslint.config.mjs` to your project root (pick the `export` line appropriate for your project):
 
-```bash
-npm install -DE eslint-plugin-react@^7
-```
+```js
+// myProjectRoot/eslint.config.mjs
+import { makeEslintConfig } from 'eslint-config-scratch'
 
-## Usage
-The configuration is split up into several modules:
-* `scratch`: The base configuration. Always extend this.
-* `scratch/node`: Rules for node, e.g., server-side code, tests, and scripts
-* `scratch/es6`: Rules for ES6, for use when you're transpiling with webpack
-* `scratch/react`: Rules for React projects
-
-Usually web projects have a mix of node and web environment files. To lint both
-with the appropriate rules, set up a base `.eslintrc.js` with the rules for node
-and then override the node configuration in `src` (where web code usually lives).
-E.g., with a file structure like this:
-```
-scratch-project
-- .eslintrc.js
-- package.json
-- src
-  - .eslintrc.js
-  - index.js
+// for a TypeScript project:
+export default makeEslintConfig({ globals: 'browser', tsconfigRootDir: import.meta.dirname })
+
+// for plain JavaScript:
+export default makeEslintConfig({ globals: 'browser' })
 ```
-Your config files should be set up like
-```javascript
-// scratch-project/.eslintrc.js
-module.exports = {
-    extends: ['scratch', 'scratch/es6', 'scratch/node']
-};
-
-// scratch-project/src/.eslintrc.js
-module.exports = {
-    root: true,
-    extends: ['scratch', 'scratch/es6', 'scratch/react'],
-    env: {
-        browser: true
-    }
-};
+
+Add `prettier.config.mjs` to your project root as well:
+
+```js
+// myProjectRoot/prettier.config.mjs
+import { makePrettierConfig } from 'eslint-config-scratch'
+
+export default makePrettierConfig()
 ```
-This will set up all the files in the project for linting as Node.js by default,
-except for those in `src/`, which will be linted as ES6 and React files.
 
-If you're linting React, also make sure your lint script lints `.jsx` files:
+Finally, add scripts like these to your `package.json`:
+
 ```json
 "scripts": {
-    "lint": "eslint . --ext .js,.jsx"
+  "format": "prettier --write . && eslint --fix",
+  "lint": "eslint && prettier --check .",
 }
 ```
 
+## Basic Configuration
+
+The `makeEslintConfig` function takes options to adjust the ESLint configuration object for your project. Most
+projects should start with something like this:
+
+```mjs
+// myProjectRoot/eslint.config.mjs
+import { makeEslintConfig } from 'eslint-config-scratch'
+
+export default makeEslintConfig({
+  // Optional: specify global variables available in your environment
+  globals: 'browser',
+
+  // Optional: enables rules that use type info, some of which work in JS too
+  tsconfigRootDir: import.meta.dirname,
+})
+```
+
+If you have no `tsconfig.json` (or `jsconfig.json`) in your project, you can skip the `tsconfigRootDir` option. Rules
+that require type information will be disabled or replaced with less strict alternatives that work without type info.
+
+### Globals
+
+The `globals` property is optional. If present, it can take several forms:
+
+- a string, interpreted as a key in the `globals` object exported by the `globals` package.
+  - Examples: `'browser'`, `'node'`, `'es2021'`, `'jest'`, etc.
+- an object, set up as described in the "Specifying Globals" section of the [ESLint documentation](https://eslint.org/docs/latest/use/configure/language-options#using-configuration-files)
+  - Example: `{ myGlobal: 'readonly', anotherGlobal: 'writable' }`
+- an array of zero or more of any mixture of the above
+
+```mjs
+// myProjectRoot/eslint.config.mjs
+import { makeEslintConfig } from 'eslint-config-scratch'
+
+export default makeEslintConfig({
+  // Optional: enables rules that use type info, some of which work in JS too
+  tsconfigRootDir: import.meta.dirname,
+
+  // Optional: specify global variables available in your environment
+  // Warning: this is a very silly configuration
+  globals: [
+    'shared-node-browser',
+    {
+      fun: 'readonly',
+      thing: false,
+    },
+    'es2021',
+    {
+      whyNot: 'writable',
+    },
+  ],
+})
+```
+
+### Further Customization
+
+The return value of the `makeEslintConfig` function is a standard ESLint configuration array. This means you can
+customize your configuration further like this:
+
+```mjs
+// myProjectRoot/eslint.config.mjs
+import { makeEslintConfig } from 'eslint-config-scratch'
+
+export default [
+  ...makeEslintConfig({
+    // Optional: enables rules that use type info, some of which work in JS too
+    tsconfigRootDir: import.meta.dirname,
+
+    // Optional: specify global variables available in your environment
+    globals: 'browser',
+  }),
+  // Add custom rules or overrides here
+  {
+    files: ['*.test.js'],
+    rules: {
+      'no-console': 'off', // Allow console logs in test files
+    },
+  },
+]
+```
+
+All ESLint configuration options are available this way. You can use this to handle globals yourself if the simplified
+`globals` configuration from above doesn't meet your needs:
+
+```mjs
+// myProjectRoot/eslint.config.mjs
+import { makeEslintConfig } from 'eslint-config-scratch'
+import globals from 'globals'
+
+export default [
+  ...makeEslintConfig({
+    // Optional: enables rules that use type info, some of which work in JS too
+    tsconfigRootDir: import.meta.dirname,
+  }),
+  {
+    files: ['src/main/**.js'],
+    languageOptions: {
+      globals: globals.node,
+    },
+  },
+  {
+    files: ['src/renderer/**.js'],
+    languageOptions: {
+      globals: {
+        ...globals.browser,
+        MY_CUSTOM_GLOBAL: 'readonly',
+      },
+    },
+  },
+]
+```
+
+Of course, another option would be to place a different `eslint.config.mjs` file in each subdirectory. If you have
+multiple `tsconfig.json` or `jsconfig.json` files in your project, it likely makes sense to have an
+`eslint.config.mjs` file beside each one.
+
+## Legacy Styles
+
+Scratch used very different styling rules in `eslint-config-scratch@^9` and below. If you need to use those rules, you
+can use the rule sets under `legacy/`:
+
+- `eslint-config-scratch/legacy`: Legacy base configuration, not configured for any particular environment
+- `eslint-config-scratch/legacy/es6`: Legacy rules for targeting Scratch's supported web browsers
+- `eslint-config-scratch/legacy/node`: Legacy rules for targeting Node.js
+- `eslint-config-scratch/legacy/react`: Legacy rules for targeting Scratch's supported web browsers with React
+
+New projects should not use these rule sets. They may disappear in the future. Scratch did not use Prettier at this
+time, so there is no legacy Prettier configuration.
+
 ## Committing
+
 This project uses [semantic release](https://github.com/semantic-release/semantic-release)
 to ensure version bumps follow semver so that projects using the config don't
 break unexpectedly.
@@ -71,7 +182,8 @@ break unexpectedly.
 In order to automatically determine the type of version bump necessary, semantic
 release expects commit messages to be formatted following
 [conventional-changelog](https://github.com/bcoe/conventional-changelog-standard/blob/master/convention.md).
-```
+
+```raw
 <type>(<scope>): <subject>
 <BLANK LINE>
 <body>
@@ -84,16 +196,17 @@ where you would include `BREAKING CHANGE` and `ISSUES FIXED` sections if
 applicable.
 
 `type` is one of:
-* `fix`: A bug fix **Causes a patch release (0.0.x)**
-* `feat`: A new feature **Causes a minor release (0.x.0)**
-* `docs`: Documentation only changes
-* `style`: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
-* `refactor`: A code change that neither fixes a bug nor adds a feature
-* `perf`: A code change that improves performance **May or may not cause a minor release. It's not clear.**
-* `test`: Adding missing tests or correcting existing tests
-* `ci`: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
-* `chore`: Other changes that don't modify src or test files
-* `revert`: Reverts a previous commit
+
+- `fix`: A bug fix **Causes a patch release (0.0.x)**
+- `feat`: A new feature **Causes a minor release (0.x.0)**
+- `docs`: Documentation only changes
+- `style`: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
+- `refactor`: A code change that neither fixes a bug nor adds a feature
+- `perf`: A code change that improves performance **May or may not cause a minor release. It's not clear.**
+- `test`: Adding missing tests or correcting existing tests
+- `ci`: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
+- `chore`: Other changes that don't modify src or test files
+- `revert`: Reverts a previous commit
 
 Use the [commitizen CLI](https://github.com/commitizen/cz-cli) to make commits
 formatted in this way:
@@ -106,8 +219,9 @@ npm install
 Now you're ready to make commits using `git cz`.
 
 ## Breaking changes
+
 If you're committing a change that makes the linter more strict, or will
 otherwise require changes to existing code, ensure your commit specifies a
-breaking change.  In your commit body, prefix the changes with "BREAKING CHANGE: "
+breaking change. In your commit body, prefix the changes with "BREAKING CHANGE: "
 This will cause a major version bump so downstream projects must choose to upgrade
 the config and will not break the build unexpectedly.

package/commitlint.config.mjs

@@ -0,0 +1,10 @@
+// Do not rename, migrate, or convert this file without checking the `wagoid/commitlint-github-action` documentation!
+// `commitlint.config.mjs` is the only supported config file name as of `wagoid/commitlint-github-action@v6`
+
+/**
+ * @type {import('@commitlint/types').UserConfig}
+ */
+export default {
+  extends: ['@commitlint/config-conventional'],
+  ignores: [message => message.startsWith('chore(release):')],
+}

package/eslint.config.mjs

@@ -0,0 +1,4 @@
+import { makeEslintConfig } from './lib/index.mjs'
+
+/** @type {import('typescript-eslint').ConfigArray} */
+export default makeEslintConfig({ globals: 'node' })