eslint-config-brightspace 0.25.3 → 1.0.0

package/README.md

@@ -1,6 +1,6 @@
 # eslint-config-brightspace
-[![NPM version][npm-image]][npm-url]
-[![Dependency Status][dependencies-image]][dependencies-url]
+
+[![NPM version](https://img.shields.io/npm/v/eslint-config-brightspace.svg)](https://npmjs.org/package/eslint-config-brightspace-url)
 
 Common Brightspace eslint configs.
 
@@ -12,88 +12,40 @@ npm install eslint-config-brightspace
 
 ## Usage
 
-Simply specify the `extends` property in the `.eslintrc` file as shown below. **Note:** omit the "eslint-config" when specifying the module, since eslint assumes it.
-
-### Default Config
-
-Specify the `extends` property in the `.eslintrc.json` file:
+Set the `extends` property in the `.eslintrc.json` file, replacing `<environment>` with the desired environment-specific config.
 
 ```json
 {
-  "extends": "brightspace"
+  "extends": "brightspace/<environment>"
 }
 ```
 
 ### Environment Specific Configs
 
-Specify the desired config for the `extends` property:
+| Environment | Description |
+|--|--|
+| `browser-config` | use with code that runs in a browser |
+| `lit-config` | use with [Lit](https://lit.dev/) projects |
+| `testing-config` | use with [@brightspace-ui/testing](https://github.com/BrightspaceUI/testing) test code |
+| `node-config` | use with [Node.js](https://nodejs.org) projects |
+| `react-config` | use with [React](https://react.dev/) projects |
 
-* `browser-config` : sets up browser globals
-* `lit-config` : sets up env for browser globals and lit rules for lit elements
-* `node-config` : sets up node globals including es6 env features
-* `react-config` : sets up env for jsx and es6, including globals for jest
-* `open-wc-testing-config` : sets up env for [@open-wc/testing](https://open-wc.org/testing)
-* `polymer-config` : sets up env for browser globals and polymer web components
-* `polymer-3-config` : sets up env for browser globals and polymer web components for polymer 3
-* `wct-config` : sets up env for web component tester tests
-* `wct-polymer-3-config` : sets up env for web component tester tests for polymer 3
+Example:
 
 ```json
 {
-  "extends": "brightspace/react-config"
+  "extends": "brightspace/lit-config"
 }
 ```
 
-See the [eslint rules](http://eslint.org/docs/rules/) for more details on rule configuration.  See the [eslint shareable configs](http://eslint.org/docs/developer-guide/shareable-configs.html) for more details on creating configs.
-
-## Contributing
-
-Contributions are welcome, please submit a pull request!
-
-### Code Style
-
-This repository is configured with [EditorConfig](http://editorconfig.org) rules and contributions should make use of them.
-
-## Versioning & Releasing
-
-> TL;DR: Commits prefixed with `fix:` and `feat:` will trigger patch and minor releases when merged to `main`. Read on for more details...
-
-The [semantic-release GitHub Action](https://github.com/BrightspaceUI/actions/tree/main/semantic-release) is called from the `release.yml` GitHub Action workflow to handle version changes and releasing.
-
-### Version Changes
-
-All version changes should obey [semantic versioning](https://semver.org/) rules:
-1. **MAJOR** version when you make incompatible API changes,
-2. **MINOR** version when you add functionality in a backwards compatible manner, and
-3. **PATCH** version when you make backwards compatible bug fixes.
-
-The next version number will be determined from the commit messages since the previous release. Our semantic-release configuration uses the [Angular convention](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular) when analyzing commits:
-* Commits which are prefixed with `fix:` or `perf:` will trigger a `patch` release. Example: `fix: validate input before using`
-* Commits which are prefixed with `feat:` will trigger a `minor` release. Example: `feat: add toggle() method`
-* To trigger a MAJOR release, include `BREAKING CHANGE:` with a space or two newlines in the footer of the commit message
-* Other suggested prefixes which will **NOT** trigger a release: `build:`, `ci:`, `docs:`, `style:`, `refactor:` and `test:`. Example: `docs: adding README for new component`
-
-To revert a change, add the `revert:` prefix to the original commit message. This will cause the reverted change to be omitted from the release notes. Example: `revert: fix: validate input before using`.
-
-### Releases
-
-When a release is triggered, it will:
-* Update the version in `package.json`
-* Tag the commit
-* Create a GitHub release (including release notes)
-* Deploy a new package to NPM
+See the [eslint rules](https://eslint.org/docs/latest/rules/) for more details on rule configuration.  See the [eslint shareable configs](https://eslint.org/docs/latest/extend/shareable-configs.html) for more details on creating configs.
 
-### Releasing from Maintenance Branches
+## Developing and Contributing
 
-Occasionally you'll want to backport a feature or bug fix to an older release. `semantic-release` refers to these as [maintenance branches](https://semantic-release.gitbook.io/semantic-release/usage/workflow-configuration#maintenance-branches).
+After cloning the repo, run `npm install` to install dependencies.
 
-Maintenance branch names should be of the form: `+([0-9])?(.{+([0-9]),x}).x`.
+### Versioning and Releasing
 
-Regular expressions are complicated, but this essentially means branch names should look like:
-* `1.15.x` for patch releases on top of the `1.15` release (after version `1.16` exists)
-* `2.x` for feature releases on top of the `2` release (after version `3` exists)
+This repo is configured to use `semantic-release`. Commits prefixed with `fix:` and `feat:` will trigger patch and minor releases when merged to `main`.
 
-[npm-url]: https://npmjs.org/package/eslint-config-brightspace
-[npm-image]: https://img.shields.io/npm/v/eslint-config-brightspace.svg
-[dependencies-url]: https://david-dm.org/brightspace/eslint-config-brightspace
-[dependencies-image]: https://img.shields.io/david/Brightspace/eslint-config-brightspace.svg
+To learn how to create major releases and release from maintenance branches, refer to the [semantic-release GitHub Action](https://github.com/BrightspaceUI/actions/tree/main/semantic-release) documentation.

package/browser-config.js

@@ -8,7 +8,7 @@ module.exports = {
 	},
 	"env": {
 		"browser": true,
-		"es2021": true
+		"es2024": true
 	},
 	"plugins": [
 		"html",

package/index.js

@@ -1,3 +1,41 @@
+// nr = not as per eslint:recommended
+
 module.exports = {
-	"extends": ["eslint:recommended","./common-config.js"]
+	"extends": ["eslint:recommended"],
+	"rules": {
+		"comma-spacing": 2, // nr
+		"eol-last": 2, // nr
+		"eqeqeq": [2, "always", { "null": "ignore" }], // nr
+		"indent": [2, "tab", { "SwitchCase": 1 }], // nr
+		"keyword-spacing": 2,
+		"linebreak-style": ["error", "unix"], // nr
+		"new-parens": 2, // nr
+		"no-debugger": 2,
+		"no-dupe-args": 2,
+		"no-dupe-keys": 2,
+		"no-duplicate-case": 2,
+		"no-ex-assign": 2,
+		"no-fallthrough": 2,
+		"no-invalid-this": 2, // nr
+		"no-multiple-empty-lines": [2, {"max": 1}], // nr
+		"no-multi-spaces": 2, // nr
+		"no-new-wrappers": 2, // nr
+		"no-trailing-spaces": 2, // nr
+		"no-undef": 2,
+		"no-unneeded-ternary": 2, // nr
+		"no-unreachable": 2,
+		"no-unused-vars": [2, {"vars": "all", "args": "after-used"}],
+		"no-use-before-define": [2, "nofunc"], // nr
+		"no-var": 2, // nr
+		"object-curly-spacing": [2, "always"],
+		"prefer-const": 2, // nr
+		"quotes": [2, "single", "avoid-escape"], // nr
+		"semi": 2, // nr
+		"space-before-blocks": [2, "always"], // nr
+		"space-before-function-paren": [2, "never"], //nr
+		"space-in-parens": [2, "never"],
+		"space-infix-ops": 2, // nr
+		"strict": [2, "global"], // nr
+		"valid-typeof": 2
+	}
 };

package/lit-config.js

@@ -52,17 +52,22 @@ module.exports = {
 	"rules": {
 		"lit/attribute-value-entities": 2,
 		"lit/binding-positions": 2,
+		"lit/lifecycle-super": 2,
 		"lit/no-duplicate-template-bindings": 2,
 		"lit/no-invalid-escape-sequences": 2,
 		"lit/no-invalid-html": 2,
+		"lit/no-legacy-imports": 2,
 		"lit/no-legacy-template-syntax": 2,
 		"lit/no-private-properties": [2, { "private": "^(__|_)" }],
 		"lit/no-property-change-update": 2,
+		"lit/no-native-attributes": 1,
 		"lit/no-template-arrow": 2,
 		"lit/no-template-bind": 2,
 		"lit/no-template-map": 0,
+		"lit/no-this-assign-in-render": 2,
 		"lit/no-useless-template-literals": 2,
 		"lit/no-value-attribute": 2,
+		"lit/prefer-nothing": 2,
 		...sortMemberRules
 	}
 };

package/node-config.js

@@ -1,7 +1,10 @@
 module.exports = {
   "extends": "./index.js",
   "env": {
-    "es2022": true,
+    "es2024": true,
     "node": true
-  }
+  },
+  "parserOptions": {
+    "sourceType": "module"
+  },
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-config-brightspace",
-  "version": "0.25.3",
+  "version": "1.0.0",
   "description": "Common Brightspace eslint configs.",
   "main": "index.js",
   "scripts": {
@@ -17,19 +17,12 @@
   ],
   "files": [
     "browser-config.js",
-    "common-config.js",
     "index.js",
     "lit-config.js",
     "node-config.js",
-    "open-wc-testing-config.js",
-    "polymer-3-config.js",
-    "polymer-config.js",
-    "polymer-sort-member-config.js",
     "react-config.js",
     "sort-member-config.js",
-    "wct-config.js",
-    "wct-lit-config.js",
-    "wct-polymer-3-config.js"
+    "testing-config.js"
   ],
   "author": "D2L Corporation",
   "license": "Apache-2.0",

package/{open-wc-testing-config.js → testing-config.js}

@@ -1,8 +1,7 @@
 module.exports = {
   "extends": "./lit-config.js",
-    "env": {
-      "mocha": true,
-      "node": true
+  "env": {
+    "mocha": true
   },
   "rules": {
     "no-invalid-this": 0

package/common-config.js

@@ -1,41 +0,0 @@
-
-// nr = not as per eslint:recommended
-
-module.exports = {
-  "rules": {
-    "comma-spacing": 2, // nr
-    "eol-last": 2, // nr
-    "eqeqeq": [2, "always", { "null": "ignore" }], // nr
-    "indent": [2, "tab", { "SwitchCase": 1 }], // nr
-    "keyword-spacing": 2,
-    "linebreak-style": ["error", "unix"], // nr
-    "new-parens": 2, // nr
-    "no-debugger": 2,
-    "no-dupe-args": 2,
-    "no-dupe-keys": 2,
-    "no-duplicate-case": 2,
-    "no-ex-assign": 2,
-    "no-fallthrough": 2,
-    "no-invalid-this": 2, // nr
-    "no-multiple-empty-lines": [2, {"max": 1}], // nr
-	"no-multi-spaces": 2, // nr
-	"no-new-wrappers": 2, // nr
-    "no-trailing-spaces": 2, // nr
-    "no-undef": 2,
-    "no-unneeded-ternary": 2, // nr
-    "no-unreachable": 2,
-    "no-unused-vars": [2, {"vars": "all", "args": "after-used"}],
-    "no-use-before-define": [2, "nofunc"], // nr
-	"no-var": 2, // nr
-    "object-curly-spacing": [2, "always"],
-    "prefer-const": 2, // nr
-    "quotes": [2, "single", "avoid-escape"], // nr
-    "semi": 2, // nr
-    "space-before-blocks": [2, "always"], // nr
-    "space-before-function-paren": [2, "never"], //nr
-    "space-in-parens": [2, "never"],
-    "space-infix-ops": 2, // nr
-    "strict": [2, "global"], // nr
-    "valid-typeof": 2
-  }
-};

package/polymer-3-config.js

@@ -1,12 +0,0 @@
-const { sortMemberRules } = require('./polymer-sort-member-config');
-
-module.exports = {
-	"extends": "./browser-config.js",
-	"plugins": [
-		"sort-class-members"
-	],
-	"rules": {
-		"strict": 0,
-		...sortMemberRules
-	}
-};

package/polymer-config.js

@@ -1,12 +0,0 @@
-const { sortMemberRules } = require('./polymer-sort-member-config');
-
-module.exports = {
-	"extends": "./browser-config.js",
-	"plugins": [
-		"sort-class-members"
-	],
-	"rules": {
-		"strict": 0,
-		...sortMemberRules
-	}
-};

package/polymer-sort-member-config.js

@@ -1,22 +0,0 @@
-const { getSortMemberRules } = require('./sort-member-config');
-
-module.exports.sortMemberRules = getSortMemberRules([
-	"[static-property-is]",
-	"[static-property-properties]",
-	"[static-property-styles]",
-	"[static-properties]",
-	"[static-methods]",
-	"[properties]",
-	"constructor",
-	"[accessor-pairs]",
-	"[accessors]",
-	"[methods]",
-	"[private-accessor-pairs]",
-	"[private-accessors]",
-	"[private-properties]",
-	"[private-methods]"
-], {
-	"static-property-is": [{ "name": "is", "static": true }],
-	"static-property-properties": [{ "name": "properties", "static": true }],
-	"static-property-styles":  [{ "name": "styles", "static": true }]
-});

package/wct-config.js

@@ -1,17 +0,0 @@
-module.exports = {
-  "extends": "./polymer-config.js",
-  "env": {
-    "es6": true,
-    "mocha": true
-  },
-  "globals": {
-    "a11ySuite": true,
-    "assert": true,
-    "fixture": true,
-    "flush": true,
-    "expect": true,
-    "MockInteractions": true,
-    "sinon": true,
-    "WCT": true
-  }
-};

package/wct-lit-config.js

@@ -1,20 +0,0 @@
-module.exports = {
-  "extends": "./lit-config.js",
-  "env": {
-    "mocha": true,
-    "node": true
-  },
-  "globals": {
-    "assert": true,
-    "fixture": true,
-    "flush": true,
-    "expect": true,
-    "MockInteractions": true,
-    "sinon": true,
-    "WCT": true
-  },
-  "rules": {
-    "no-invalid-this": 0,
-    "prefer-arrow-callback": 0
-  }
-};

package/wct-polymer-3-config.js

@@ -1,17 +0,0 @@
-module.exports = {
-  "extends": "./polymer-3-config.js",
-  "env": {
-    "es6": true,
-    "mocha": true
-  },
-  "globals": {
-    "a11ySuite": true,
-    "assert": true,
-    "fixture": true,
-    "flush": true,
-    "expect": true,
-    "MockInteractions": true,
-    "sinon": true,
-    "WCT": true
-  }
-};