@metamask-previews/oxlint-config-nodejs 0.0.0-preview-d6c6adc

package/CHANGELOG.md

@@ -0,0 +1,10 @@
+# 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]
+
+[Unreleased]: https://github.com/MetaMask/oxlint-config/

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 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,33 @@
+# `@metamask/oxlint-config-nodejs`
+
+MetaMask's [Node.js](https://nodejs.org) Oxlint configuration.
+
+## Usage
+
+```bash
+yarn add --dev \
+    @metamask/oxlint-config@^0.0.0 \
+    @metamask/oxlint-config-nodejs@^0.0.0 \
+    oxlint@^1.82.0
+```
+
+The order in which you extend ESLint rules matters.
+The `@metamask/*` Oxlint configs should be added to the config array _last_,
+with `@metamask/oxlint-config` first, and `@metamask/oxlint-config-*` in any
+order thereafter.
+
+```js
+import base, { createConfig } from '@metamask/oxlint-config';
+import nodejs from '@metamask/oxlint-config-nodejs';
+
+const config = createConfig({
+  extends: [
+    // Any custom shared config should be added here.
+    // ...
+
+    // This should be added last unless you know what you're doing.
+    base,
+    nodejs,
+  ],
+});
+```

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@metamask-previews/oxlint-config-nodejs",
+  "version": "0.0.0-preview-d6c6adc",
+  "description": "Shareable MetaMask Oxlint config for Node.js",
+  "homepage": "https://github.com/MetaMask/oxlint-config#readme",
+  "bugs": {
+    "url": "https://github.com/MetaMask/oxlint-config/issues"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MetaMask/oxlint-config.git"
+  },
+  "files": [
+    "src/",
+    "!src/**/*.test.js"
+  ],
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./src/index.d.ts",
+      "default": "./src/index.js"
+    }
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "changelog:update": "../../scripts/update-changelog.sh @metamask/oxlint-config-nodejs",
+    "changelog:validate": "../../scripts/validate-changelog.sh @metamask/oxlint-config-nodejs",
+    "test": "oxlint ."
+  },
+  "devDependencies": {
+    "@metamask/auto-changelog": "^3.4.4",
+    "@metamask/oxlint-config": "^0.0.0",
+    "oxlint": "^1.82.0",
+    "vitest": "^2.1.9"
+  },
+  "peerDependencies": {
+    "@metamask/oxlint-config": "^0.0.0",
+    "oxlint": "^1.82.0"
+  },
+  "engines": {
+    "node": "^18.18 || >=20"
+  }
+}

package/src/index.d.ts

@@ -0,0 +1,4 @@
+import { OxlintConfig } from 'oxlint';
+
+declare const config: OxlintConfig;
+export default config;

package/src/index.js

@@ -0,0 +1,30 @@
+import { createConfig } from '@metamask/oxlint-config';
+
+const config = createConfig({
+  plugins: ['node'],
+
+  categories: {
+    correctness: 'allow',
+  },
+
+  rules: {
+    // Possible Errors
+    'node/handle-callback-err': ['error', '^(err|error)$'],
+    'node/no-new-require': 'error',
+    'node/no-path-concat': 'error',
+
+    // Stylistic rules
+    'node/callback-return': 'error',
+    'node/exports-style': 'error',
+    'node/global-require': 'error',
+    'node/no-mixed-requires': 'error',
+    'node/no-process-env': 'error',
+    'node/no-sync': 'error',
+
+    // Enabled in the base config, but this should be allowed in Node.js
+    // projects.
+    'import/no-nodejs-modules': 'off',
+  },
+});
+
+export default config;