eslint-plugin-security 1.7.1 → 2.0.0

package/.github/workflows/ci.yml

@@ -17,7 +17,7 @@ jobs:
           persist-credentials: false
       - uses: actions/setup-node@v3
         with:
-          node-version: '16.x'
+          node-version: 18
 
       - name: Install Packages
         run: npm install
@@ -30,12 +30,12 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest]
-        node: [18.x, 16.x, 14.x, 12.x, '12.22.0']
+        node: [12.22.0, 12, 14, 16, 18, 20]
         include:
           - os: windows-latest
-            node: '16.x'
+            node: 18
           - os: macOS-latest
-            node: '16.x'
+            node: 18
     runs-on: ${{ matrix.os }}
     permissions:
       contents: read

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## [2.0.0](https://www.github.com/eslint-community/eslint-plugin-security/compare/v1.7.1...v2.0.0) (2023-10-17)
+
+
+### ⚠ BREAKING CHANGES
+
+* switch the recommended config to flat (#118)
+
+### Features
+
+* switch the recommended config to flat ([#118](https://www.github.com/eslint-community/eslint-plugin-security/issues/118)) ([e20a366](https://www.github.com/eslint-community/eslint-plugin-security/commit/e20a3664c2f638466286ae9a97515722fc98f97c))
+
 ### [1.7.1](https://www.github.com/eslint-community/eslint-plugin-security/compare/v1.7.0...v1.7.1) (2023-02-02)
 
 

package/README.md

@@ -20,12 +20,12 @@ yarn add --dev eslint-plugin-security
 
 ## Usage
 
-Add the following to your `.eslintrc` file:
+Add the following to your `eslint.config.js` file:
 
 ```js
-"extends": [
-  "plugin:security/recommended"
-]
+const pluginSecurity = require('eslint-plugin-security');
+
+module.exports = [pluginSecurity.configs.recommended];
 ```
 
 ## Developer guide

package/docs/the-dangers-of-square-bracket-notation.md

@@ -94,7 +94,7 @@ Well, yes and no. Is this particular vector a widespread problem? No, because cu
 
 Yes, we are talking about some fairly extreme edge cases, but don't make the assumption that your code doesn't have problems because of that - I have seen this issue in production code with some regularity. And, for the majority of node developers, a large portion of application code was not written by them, but rather included through required modules which may contain peculiar flaws like this one.
 
-Edge cases are uncommon, but because they are uncommon the problems with them are not well known, and they frequently go un-noticed during code review. If the code works, these types of problems tend to disappear. If the code works, and the problems are buried in a module nested n-levels deep, it's likely it won't be found until it causes problems, and by then it's too late. A blind require is essentially running untrusted code in your application. Be [aware of what you require.](https://requiresafe.com)
+Edge cases are uncommon, but because they are uncommon the problems with them are not well known, and they frequently go un-noticed during code review. If the code works, these types of problems tend to disappear. If the code works, and the problems are buried in a module nested n-levels deep, it's likely it won't be found until it causes problems, and by then it's too late. A blind require is essentially running untrusted code in your application. Be aware of the code you're requiring.
 
 ## How do I fix it?
 

package/eslint.config.js

@@ -0,0 +1,43 @@
+'use strict';
+
+const jsPlugin = require('@eslint/js');
+const prettierConfig = require('eslint-config-prettier');
+const eslintPluginRecommendedConfig = require('eslint-plugin-eslint-plugin/configs/recommended');
+
+const eslintPluginConfigs = [
+  eslintPluginRecommendedConfig,
+  {
+    rules: {
+      'eslint-plugin/prefer-message-ids': 'off', // TODO: enable
+      'eslint-plugin/require-meta-docs-description': ['error', { pattern: '^(Detects|Enforces|Requires|Disallows) .+\\.$' }],
+      'eslint-plugin/require-meta-docs-url': [
+        'error',
+        {
+          pattern: 'https://github.com/eslint-community/eslint-plugin-security/blob/main/docs/rules/{{name}}.md',
+        },
+      ],
+      'eslint-plugin/require-meta-schema': 'off', // TODO: enable
+      'eslint-plugin/require-meta-type': 'off', // TODO: enable
+    },
+  },
+];
+
+module.exports = [
+  jsPlugin.configs.recommended,
+  prettierConfig,
+  ...eslintPluginConfigs,
+  {
+    languageOptions: {
+      sourceType: 'commonjs',
+    },
+  },
+  {
+    files: ['test/**/*.js'],
+    languageOptions: {
+      globals: {
+        describe: 'readonly',
+        it: 'readonly',
+      },
+    },
+  },
+];

package/index.js

@@ -4,7 +4,13 @@
 
 'use strict';
 
-module.exports = {
+const pkg = require('./package.json');
+
+const plugin = {
+  meta: {
+    name: pkg.name,
+    version: pkg.version,
+  },
   rules: {
     'detect-unsafe-regex': require('./rules/detect-unsafe-regex'),
     'detect-non-literal-regexp': require('./rules/detect-non-literal-regexp'),
@@ -37,25 +43,29 @@ module.exports = {
     'detect-new-buffer': 0,
     'detect-bidi-characters': 0,
   },
-  configs: {
-    recommended: {
-      plugins: ['security'],
-      rules: {
-        'security/detect-buffer-noassert': 'warn',
-        'security/detect-child-process': 'warn',
-        'security/detect-disable-mustache-escape': 'warn',
-        'security/detect-eval-with-expression': 'warn',
-        'security/detect-new-buffer': 'warn',
-        'security/detect-no-csrf-before-method-override': 'warn',
-        'security/detect-non-literal-fs-filename': 'warn',
-        'security/detect-non-literal-regexp': 'warn',
-        'security/detect-non-literal-require': 'warn',
-        'security/detect-object-injection': 'warn',
-        'security/detect-possible-timing-attacks': 'warn',
-        'security/detect-pseudoRandomBytes': 'warn',
-        'security/detect-unsafe-regex': 'warn',
-        'security/detect-bidi-characters': 'warn',
-      },
-    },
+  configs: {}, // was assigned later so we can reference `plugin`
+};
+
+const recommended = {
+  plugins: { security: plugin },
+  rules: {
+    'security/detect-buffer-noassert': 'warn',
+    'security/detect-child-process': 'warn',
+    'security/detect-disable-mustache-escape': 'warn',
+    'security/detect-eval-with-expression': 'warn',
+    'security/detect-new-buffer': 'warn',
+    'security/detect-no-csrf-before-method-override': 'warn',
+    'security/detect-non-literal-fs-filename': 'warn',
+    'security/detect-non-literal-regexp': 'warn',
+    'security/detect-non-literal-require': 'warn',
+    'security/detect-object-injection': 'warn',
+    'security/detect-possible-timing-attacks': 'warn',
+    'security/detect-pseudoRandomBytes': 'warn',
+    'security/detect-unsafe-regex': 'warn',
+    'security/detect-bidi-characters': 'warn',
   },
 };
+
+Object.assign(plugin.configs, { recommended });
+
+module.exports = plugin;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-security",
-  "version": "1.7.1",
+  "version": "2.0.0",
   "description": "Security rules for eslint",
   "main": "index.js",
   "scripts": {
@@ -46,12 +46,13 @@
     "safe-regex": "^2.1.1"
   },
   "devDependencies": {
+    "@eslint/js": "^8.51.0",
     "changelog": "1.3.0",
-    "eslint": "^8.11.0",
+    "eslint": "^8.51.0",
     "eslint-config-nodesecurity": "^1.3.1",
     "eslint-config-prettier": "^8.5.0",
     "eslint-doc-generator": "^1.0.2",
-    "eslint-plugin-eslint-plugin": "^5.0.2",
+    "eslint-plugin-eslint-plugin": "^5.1.1",
     "lint-staged": "^12.3.7",
     "markdownlint-cli": "^0.32.2",
     "mocha": "^9.2.2",

package/.eslintrc

@@ -1,31 +0,0 @@
-{
-  "extends": ["eslint:recommended", "prettier", "plugin:eslint-plugin/recommended"],
-  "parserOptions": {
-    "ecmaVersion": "latest"
-  },
-  "env": {
-    "node": true,
-    "es2020": true
-  },
-  "rules": {
-    "eslint-plugin/prefer-message-ids": "off", // TODO: enable
-    "eslint-plugin/require-meta-docs-description": ["error", { "pattern": "^(Detects|Enforces|Requires|Disallows) .+\\.$" }],
-    "eslint-plugin/require-meta-docs-url": [
-      "error",
-      {
-        "pattern": "https://github.com/eslint-community/eslint-plugin-security/blob/main/docs/rules/{{name}}.md"
-      }
-    ],
-    "eslint-plugin/require-meta-schema": "off", // TODO: enable
-    "eslint-plugin/require-meta-type": "off" // TODO: enable
-  },
-  "overrides": [
-    {
-      "files": ["test/**/*.js"],
-      "globals": {
-        "describe": "readonly",
-        "it": "readonly"
-      }
-    }
-  ]
-}