@hubspot/eslint-config-ui-extensions 0.7.2

package/README.md

@@ -0,0 +1,47 @@
+# @hubspot/eslint-config-ui-extensions
+
+[eslint shareable configs](https://eslint.org/docs/latest/extend/shareable-configs) for building UI Extensions on HubSpot with React.
+
+## Installation
+
+You'll first need to install [ESLint](https://eslint.org/) and alongside this package:
+
+```sh
+npm i --save-dev eslint @hubspot/eslint-config-ui-extensions
+```
+
+
+## Usage
+
+Create an .eslintrc.js file in the root of your project:
+
+```js
+module.exports = {
+  extends: "@hubspot/ui-extensions",
+  ignorePatterns: ["node_modules", "dist"],
+};
+```
+
+For those using TypeScript, we'll likely expand this package to include a base setup in the near future, but in the meantime you can start here and follow these steps to get TS support:
+
+- `npm i --save-dev @typescript-eslint/parser @typescript-eslint/eslint-plugin`
+- Adapt your lint script in package.json (if applicable) to make sure you're targeting your source files, perhaps something like `"lint": "npx eslint . --ext .ts,.tsx"`
+- Update your eslintrc config:
+
+```diff
+-extends: ['@hubspot/ui-extensions'],
++extends: ['@hubspot/ui-extensions', 'plugin:@typescript-eslint/recommended'],
++plugins: ['@typescript-eslint'],
+```
+
+Running `npm run lint`, you should now see TypeScript-aware linting in your terminal output and it will likely automatically work inside your editor of choice as well (though some editors may require additional config steps).
+
+
+## Rules
+
+This config extends the following configs, meaning you can customize the `rules` entry in your project-level config to include any rules from these packages:
+
+- ['eslint:recommended'](https://eslint.org/docs/latest/rules/)
+- ['plugin:react/recommended'](https://www.npmjs.com/package/eslint-plugin-react)
+- ['plugin:react-hooks/recommended'](https://github.com/facebook/react/tree/main/packages/eslint-plugin-react-hooks)
+- ['prettier'](https://www.npmjs.com/package/eslint-config-prettier)

package/eslintrc.js

@@ -0,0 +1,12 @@
+// eslint-disable-next-line no-undef
+module.exports = {
+  root: true,
+  extends: [
+    'eslint:recommended',
+    'plugin:eslint-plugin/recommended',
+    'plugin:node/recommended',
+  ],
+  env: {
+    node: true,
+  },
+};

package/lib/index.js

@@ -0,0 +1,57 @@
+const { languageOptions } = require('./runtime');
+
+/**
+ * @see https://github.com/eslint/eslint/issues/3458
+ * @see https://www.npmjs.com/package/@rushstack/eslint-patch
+ */
+require('@rushstack/eslint-patch/modern-module-resolution');
+
+// eslint-disable-next-line no-undef
+module.exports = {
+  env: {
+    browser: false,
+    es6: true,
+    worker: true,
+  },
+  plugins: ['react', 'react-hooks'],
+  extends: [
+    'eslint:recommended',
+    'plugin:react/recommended',
+    'plugin:react-hooks/recommended',
+    'prettier',
+  ],
+  globals: languageOptions.globals,
+  parserOptions: {
+    sourceType: languageOptions.sourceType,
+    ecmaVersion: languageOptions.ecmaVersion,
+    ecmaFeatures: {
+      jsx: true,
+    },
+  },
+  settings: {
+    react: {
+      version: 'detect',
+    },
+  },
+  rules: {
+    'react/prop-types': [1, { skipUndeclared: true }],
+    'no-restricted-globals': [
+      'error',
+      {
+        name: 'importScripts',
+        message: 'function is undefined',
+      },
+    ],
+  },
+  overrides: [
+    {
+      env: {
+        node: true,
+      },
+      files: ['.eslintrc.{js,cjs}', 'eslint.config.js'],
+      parserOptions: {
+        sourceType: 'script',
+      },
+    },
+  ],
+};

package/lib/runtime.js

@@ -0,0 +1,17 @@
+const globals = require('globals');
+
+// eslint-disable-next-line no-undef
+module.exports = {
+  languageOptions: {
+    ecmaVersion: 6,
+    sourceType: 'module',
+    globals: {
+      ...globals.worker,
+      importScripts: 'off',
+      console: true,
+      React: true,
+      RemoteUI: true,
+      hubspot: true,
+    },
+  },
+};

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@hubspot/eslint-config-ui-extensions",
+  "version": "0.7.2",
+  "description": "eslint plugins for HubSpot React-based UI Extensions",
+  "keywords": [
+    "eslint",
+    "eslintplugin",
+    "eslint-plugin"
+  ],
+  "main": "./lib/index.js",
+  "exports": "./lib/index.js",
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "lint": "npm-run-all \"lint:*\"",
+    "lint:eslint-docs": "npm-run-all \"update:eslint-docs -- --check\"",
+    "lint:js": "eslint .",
+    "build": "echo 'no build command'",
+    "test": "echo 'mocha tests --recursive'",
+    "update:eslint-docs": "eslint-doc-generator"
+  },
+  "dependencies": {
+    "@rushstack/eslint-patch": "^1.3.3",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-plugin-react": "^7.33.1",
+    "eslint-plugin-react-hooks": "^4.6.0",
+    "globals": "^13.21.0"
+  },
+  "devDependencies": {
+    "eslint": "^8.19.0",
+    "eslint-doc-generator": "^1.0.0",
+    "eslint-plugin-eslint-plugin": "^5.0.0",
+    "eslint-plugin-node": "^11.1.0",
+    "npm-run-all": "^4.1.5"
+  },
+  "engines": {
+    "node": "^16.0.0 || >= 18.0.0"
+  },
+  "peerDependencies": {
+    "eslint": ">=8"
+  },
+  "peerDependenciesMeta": {
+    "typescript": {
+      "optional": true
+    }
+  },
+  "license": "MIT",
+  "gitHead": "7d2ae57e8f02e9b63468aa3881002d39078962e0"
+}