@metamask/eslint-config-browser 11.0.0

package/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [11.0.0]
+### Added
+- Initial release of this package.
+
+[Unreleased]: https://github.com/MetaMask/eslint-config/compare/v11.0.0...HEAD
+[11.0.0]: https://github.com/MetaMask/eslint-config/releases/tag/v11.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 MetaMask
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,36 @@
+# `@metamask/eslint-config-browser`
+
+MetaMask's ESLint configuration for browser environments.
+
+## Usage
+
+Our default export contains a base set of ESLint rules for ES6+:
+
+```bash
+yarn add --dev \
+    @metamask/eslint-config@^11.0.0 \
+    @metamask/eslint-config-browser@^11.0.0 \
+    eslint@^8.27.0 \
+    eslint-config-prettier@^8.5.0 \
+    eslint-plugin-import@^2.26.0 \
+    eslint-plugin-jsdoc@^39.6.2 \
+    eslint-plugin-prettier@^4.2.1 \
+    prettier@^2.7.1
+```
+
+The order in which you extend ESLint rules matters.
+The `@metamask/*` eslint configs should be added to the `extends` array _last_,
+with `@metamask/eslint-config` first, and `@metamask/eslint-config-*` in any
+order thereafter.
+
+```js
+module.exports = {
+  root: true,
+
+  extends: [
+    // These should be added last unless you know what you're doing.
+    '@metamask/eslint-config',
+    '@metamask/eslint-config-browser',
+  ],
+};
+```

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@metamask/eslint-config-browser",
+  "version": "11.0.0",
+  "description": "Shareable MetaMask ESLint plugin for browser environments.",
+  "homepage": "https://github.com/MetaMask/eslint-config#readme",
+  "bugs": {
+    "url": "https://github.com/MetaMask/eslint-config/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MetaMask/eslint-config.git"
+  },
+  "license": "MIT",
+  "main": "src/index.js",
+  "files": [
+    "src/"
+  ],
+  "scripts": {
+    "lint:changelog": "auto-changelog validate",
+    "publish": "npm publish",
+    "test": "eslint ."
+  },
+  "devDependencies": {
+    "@metamask/auto-changelog": "^3.0.0",
+    "eslint": "^8.27.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-jsdoc": "^39.6.2",
+    "eslint-plugin-prettier": "^4.2.1",
+    "prettier": "^2.7.1"
+  },
+  "peerDependencies": {
+    "@metamask/eslint-config": "^11.0.0",
+    "eslint": "^8.27.0"
+  },
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}

package/src/environment.json

@@ -0,0 +1,45 @@
+{
+  "no-restricted-globals": [
+    "error",
+    {
+      "name": "__dirname",
+      "message": "This global is not available in the browser environment."
+    },
+    {
+      "name": "__filename",
+      "message": "This global is not available in the browser environment."
+    },
+    {
+      "name": "Buffer",
+      "message": "This global is not available in the browser environment."
+    },
+    {
+      "name": "clearImmediate",
+      "message": "This global is not available in the browser environment."
+    },
+    {
+      "name": "exports",
+      "message": "This global is not available in the browser environment."
+    },
+    {
+      "name": "global",
+      "message": "This global is not available in the browser environment."
+    },
+    {
+      "name": "module",
+      "message": "This global is not available in the browser environment."
+    },
+    {
+      "name": "process",
+      "message": "This global is not available in the browser environment."
+    },
+    {
+      "name": "require",
+      "message": "This global is not available in the browser environment."
+    },
+    {
+      "name": "setImmediate",
+      "message": "This global is not available in the browser environment."
+    }
+  ]
+}

package/src/index.js

@@ -0,0 +1,11 @@
+const environmentRules = require('./environment.json');
+
+module.exports = {
+  env: {
+    browser: true,
+  },
+
+  rules: {
+    ...environmentRules,
+  },
+};

package/src/index.test.js

@@ -0,0 +1,18 @@
+const { ESLint } = require('eslint');
+
+const config = require('.');
+
+describe('index', () => {
+  it('is a valid ESLint config', async () => {
+    const api = new ESLint({
+      baseConfig: config,
+      useEslintrc: false,
+    });
+
+    const result = await api.lintText(`console.log('Hello, world!');\n`);
+
+    expect(result[0].messages).toStrictEqual([]);
+    expect(result[0].warningCount).toBe(0);
+    expect(result[0].errorCount).toBe(0);
+  });
+});