@rushstack/eslint-config 3.6.9 → 3.7.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rushstack/eslint-config",
-  "version": "3.6.9",
+  "version": "3.7.0",
   "description": "A TypeScript ESLint ruleset designed for large teams and projects",
   "license": "MIT",
   "repository": {
@@ -29,10 +29,10 @@
     "@typescript-eslint/typescript-estree": "~6.19.0",
     "eslint-plugin-promise": "~6.1.1",
     "eslint-plugin-react": "~7.33.2",
-    "eslint-plugin-tsdoc": "~0.2.16",
-    "@rushstack/eslint-patch": "1.10.2",
-    "@rushstack/eslint-plugin-packlets": "0.9.1",
+    "eslint-plugin-tsdoc": "~0.3.0",
+    "@rushstack/eslint-patch": "1.10.3",
     "@rushstack/eslint-plugin": "0.15.1",
+    "@rushstack/eslint-plugin-packlets": "0.9.1",
     "@rushstack/eslint-plugin-security": "0.8.1"
   },
   "devDependencies": {

package/profile/_common.js

@@ -3,6 +3,161 @@
 
 const macros = require('./_macros');
 
+const namingConventionRuleOptions = [
+  {
+    // We should be stricter about 'enumMember', but it often functions legitimately as an ad hoc namespace.
+    selectors: ['variable', 'enumMember', 'function'],
+
+    format: ['camelCase', 'UPPER_CASE', 'PascalCase'],
+    leadingUnderscore: 'allow',
+
+    filter: {
+      regex: [
+        // This is a special exception for naming patterns that use an underscore to separate two camel-cased
+        // parts.  Example:  "checkBox1_onChanged" or "_checkBox1_onChanged"
+        '^_?[a-z][a-z0-9]*([A-Z][a-z]?[a-z0-9]*)*_[a-z][a-z0-9]*([A-Z][a-z]?[a-z0-9]*)*$'
+      ]
+        .map((x) => `(${x})`)
+        .join('|'),
+      match: false
+    }
+  },
+
+  {
+    selectors: ['parameter'],
+
+    format: ['camelCase'],
+
+    filter: {
+      regex: [
+        // Silently accept names with a double-underscore prefix; we would like to be more strict about this,
+        // pending a fix for https://github.com/typescript-eslint/typescript-eslint/issues/2240
+        '^__'
+      ]
+        .map((x) => `(${x})`)
+        .join('|'),
+      match: false
+    }
+  },
+
+  // Genuine properties
+  {
+    selectors: ['parameterProperty', 'accessor'],
+    enforceLeadingUnderscoreWhenPrivate: true,
+
+    format: ['camelCase', 'UPPER_CASE'],
+
+    filter: {
+      regex: [
+        // Silently accept names with a double-underscore prefix; we would like to be more strict about this,
+        // pending a fix for https://github.com/typescript-eslint/typescript-eslint/issues/2240
+        '^__',
+        // Ignore quoted identifiers such as { "X+Y": 123 }.  Currently @typescript-eslint/naming-convention
+        // cannot detect whether an identifier is quoted or not, so we simply assume that it is quoted
+        // if-and-only-if it contains characters that require quoting.
+        '[^a-zA-Z0-9_]',
+        // This is a special exception for naming patterns that use an underscore to separate two camel-cased
+        // parts.  Example:  "checkBox1_onChanged" or "_checkBox1_onChanged"
+        '^_?[a-z][a-z0-9]*([A-Z][a-z]?[a-z0-9]*)*_[a-z][a-z0-9]*([A-Z][a-z]?[a-z0-9]*)*$'
+      ]
+        .map((x) => `(${x})`)
+        .join('|'),
+      match: false
+    }
+  },
+
+  // Properties that incorrectly match other contexts
+  // See issue https://github.com/typescript-eslint/typescript-eslint/issues/2244
+  {
+    selectors: ['property'],
+    enforceLeadingUnderscoreWhenPrivate: true,
+
+    // The @typescript-eslint/naming-convention "property" selector matches cases like this:
+    //
+    //   someLegacyApiWeCannotChange.invokeMethod({ SomeProperty: 123 });
+    //
+    // and this:
+    //
+    //   const { CONSTANT1, CONSTANT2 } = someNamespace.constants;
+    //
+    // Thus for now "property" is more like a variable than a class member.
+    format: ['camelCase', 'UPPER_CASE', 'PascalCase'],
+    leadingUnderscore: 'allow',
+
+    filter: {
+      regex: [
+        // Silently accept names with a double-underscore prefix; we would like to be more strict about this,
+        // pending a fix for https://github.com/typescript-eslint/typescript-eslint/issues/2240
+        '^__',
+        // Ignore quoted identifiers such as { "X+Y": 123 }.  Currently @typescript-eslint/naming-convention
+        // cannot detect whether an identifier is quoted or not, so we simply assume that it is quoted
+        // if-and-only-if it contains characters that require quoting.
+        '[^a-zA-Z0-9_]',
+        // This is a special exception for naming patterns that use an underscore to separate two camel-cased
+        // parts.  Example:  "checkBox1_onChanged" or "_checkBox1_onChanged"
+        '^_?[a-z][a-z0-9]*([A-Z][a-z]?[a-z0-9]*)*_[a-z][a-z0-9]*([A-Z][a-z]?[a-z0-9]*)*$'
+      ]
+        .map((x) => `(${x})`)
+        .join('|'),
+      match: false
+    }
+  },
+
+  {
+    selectors: ['method'],
+    enforceLeadingUnderscoreWhenPrivate: true,
+
+    // A PascalCase method can arise somewhat legitimately in this way:
+    //
+    // class MyClass {
+    //    public static MyReactButton(props: IButtonProps): JSX.Element {
+    //      . . .
+    //    }
+    // }
+    format: ['camelCase', 'PascalCase'],
+    leadingUnderscore: 'allow',
+
+    filter: {
+      regex: [
+        // Silently accept names with a double-underscore prefix; we would like to be more strict about this,
+        // pending a fix for https://github.com/typescript-eslint/typescript-eslint/issues/2240
+        '^__',
+        // This is a special exception for naming patterns that use an underscore to separate two camel-cased
+        // parts.  Example:  "checkBox1_onChanged" or "_checkBox1_onChanged"
+        '^_?[a-z][a-z0-9]*([A-Z][a-z]?[a-z0-9]*)*_[a-z][a-z0-9]*([A-Z][a-z]?[a-z0-9]*)*$'
+      ]
+        .map((x) => `(${x})`)
+        .join('|'),
+      match: false
+    }
+  },
+
+  // Types should use PascalCase
+  {
+    // Group selector for: class, interface, typeAlias, enum, typeParameter
+    selectors: ['class', 'typeAlias', 'enum', 'typeParameter'],
+    format: ['PascalCase'],
+    leadingUnderscore: 'allow'
+  },
+
+  {
+    selectors: ['interface'],
+
+    // It is very common for a class to implement an interface of the same name.
+    // For example, the Widget class may implement the IWidget interface.  The "I" prefix
+    // avoids the need to invent a separate name such as "AbstractWidget" or "WidgetInterface".
+    // In TypeScript it is also common to declare interfaces that are implemented by primitive
+    // objects, here the "I" prefix also helps by avoiding spurious conflicts with classes
+    // by the same name.
+    format: ['PascalCase'],
+
+    custom: {
+      regex: '^_?I[A-Z]',
+      match: true
+    }
+  }
+];
+
 // Rule severity guidelines
 // ------------------------
 //
@@ -207,160 +362,7 @@ function buildRules(profile) {
           // Docs: https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/docs/rules/naming-convention.md
           '@typescript-eslint/naming-convention': [
             'warn',
-            ...macros.expandNamingConventionSelectors([
-              {
-                // We should be stricter about 'enumMember', but it often functions legitimately as an ad hoc namespace.
-                selectors: ['variable', 'enumMember', 'function'],
-
-                format: ['camelCase', 'UPPER_CASE', 'PascalCase'],
-                leadingUnderscore: 'allow',
-
-                filter: {
-                  regex: [
-                    // This is a special exception for naming patterns that use an underscore to separate two camel-cased
-                    // parts.  Example:  "checkBox1_onChanged" or "_checkBox1_onChanged"
-                    '^_?[a-z][a-z0-9]*([A-Z][a-z]?[a-z0-9]*)*_[a-z][a-z0-9]*([A-Z][a-z]?[a-z0-9]*)*$'
-                  ]
-                    .map((x) => `(${x})`)
-                    .join('|'),
-                  match: false
-                }
-              },
-
-              {
-                selectors: ['parameter'],
-
-                format: ['camelCase'],
-
-                filter: {
-                  regex: [
-                    // Silently accept names with a double-underscore prefix; we would like to be more strict about this,
-                    // pending a fix for https://github.com/typescript-eslint/typescript-eslint/issues/2240
-                    '^__'
-                  ]
-                    .map((x) => `(${x})`)
-                    .join('|'),
-                  match: false
-                }
-              },
-
-              // Genuine properties
-              {
-                selectors: ['parameterProperty', 'accessor'],
-                enforceLeadingUnderscoreWhenPrivate: true,
-
-                format: ['camelCase', 'UPPER_CASE'],
-
-                filter: {
-                  regex: [
-                    // Silently accept names with a double-underscore prefix; we would like to be more strict about this,
-                    // pending a fix for https://github.com/typescript-eslint/typescript-eslint/issues/2240
-                    '^__',
-                    // Ignore quoted identifiers such as { "X+Y": 123 }.  Currently @typescript-eslint/naming-convention
-                    // cannot detect whether an identifier is quoted or not, so we simply assume that it is quoted
-                    // if-and-only-if it contains characters that require quoting.
-                    '[^a-zA-Z0-9_]',
-                    // This is a special exception for naming patterns that use an underscore to separate two camel-cased
-                    // parts.  Example:  "checkBox1_onChanged" or "_checkBox1_onChanged"
-                    '^_?[a-z][a-z0-9]*([A-Z][a-z]?[a-z0-9]*)*_[a-z][a-z0-9]*([A-Z][a-z]?[a-z0-9]*)*$'
-                  ]
-                    .map((x) => `(${x})`)
-                    .join('|'),
-                  match: false
-                }
-              },
-
-              // Properties that incorrectly match other contexts
-              // See issue https://github.com/typescript-eslint/typescript-eslint/issues/2244
-              {
-                selectors: ['property'],
-                enforceLeadingUnderscoreWhenPrivate: true,
-
-                // The @typescript-eslint/naming-convention "property" selector matches cases like this:
-                //
-                //   someLegacyApiWeCannotChange.invokeMethod({ SomeProperty: 123 });
-                //
-                // and this:
-                //
-                //   const { CONSTANT1, CONSTANT2 } = someNamespace.constants;
-                //
-                // Thus for now "property" is more like a variable than a class member.
-                format: ['camelCase', 'UPPER_CASE', 'PascalCase'],
-                leadingUnderscore: 'allow',
-
-                filter: {
-                  regex: [
-                    // Silently accept names with a double-underscore prefix; we would like to be more strict about this,
-                    // pending a fix for https://github.com/typescript-eslint/typescript-eslint/issues/2240
-                    '^__',
-                    // Ignore quoted identifiers such as { "X+Y": 123 }.  Currently @typescript-eslint/naming-convention
-                    // cannot detect whether an identifier is quoted or not, so we simply assume that it is quoted
-                    // if-and-only-if it contains characters that require quoting.
-                    '[^a-zA-Z0-9_]',
-                    // This is a special exception for naming patterns that use an underscore to separate two camel-cased
-                    // parts.  Example:  "checkBox1_onChanged" or "_checkBox1_onChanged"
-                    '^_?[a-z][a-z0-9]*([A-Z][a-z]?[a-z0-9]*)*_[a-z][a-z0-9]*([A-Z][a-z]?[a-z0-9]*)*$'
-                  ]
-                    .map((x) => `(${x})`)
-                    .join('|'),
-                  match: false
-                }
-              },
-
-              {
-                selectors: ['method'],
-                enforceLeadingUnderscoreWhenPrivate: true,
-
-                // A PascalCase method can arise somewhat legitimately in this way:
-                //
-                // class MyClass {
-                //    public static MyReactButton(props: IButtonProps): JSX.Element {
-                //      . . .
-                //    }
-                // }
-                format: ['camelCase', 'PascalCase'],
-                leadingUnderscore: 'allow',
-
-                filter: {
-                  regex: [
-                    // Silently accept names with a double-underscore prefix; we would like to be more strict about this,
-                    // pending a fix for https://github.com/typescript-eslint/typescript-eslint/issues/2240
-                    '^__',
-                    // This is a special exception for naming patterns that use an underscore to separate two camel-cased
-                    // parts.  Example:  "checkBox1_onChanged" or "_checkBox1_onChanged"
-                    '^_?[a-z][a-z0-9]*([A-Z][a-z]?[a-z0-9]*)*_[a-z][a-z0-9]*([A-Z][a-z]?[a-z0-9]*)*$'
-                  ]
-                    .map((x) => `(${x})`)
-                    .join('|'),
-                  match: false
-                }
-              },
-
-              // Types should use PascalCase
-              {
-                // Group selector for: class, interface, typeAlias, enum, typeParameter
-                selectors: ['class', 'typeAlias', 'enum', 'typeParameter'],
-                format: ['PascalCase'],
-                leadingUnderscore: 'allow'
-              },
-
-              {
-                selectors: ['interface'],
-
-                // It is very common for a class to implement an interface of the same name.
-                // For example, the Widget class may implement the IWidget interface.  The "I" prefix
-                // avoids the need to invent a separate name such as "AbstractWidget" or "WidgetInterface".
-                // In TypeScript it is also common to declare interfaces that are implemented by primitive
-                // objects, here the "I" prefix also helps by avoiding spurious conflicts with classes
-                // by the same name.
-                format: ['PascalCase'],
-
-                custom: {
-                  regex: '^_?I[A-Z]',
-                  match: true
-                }
-              }
-            ])
+            ...macros.expandNamingConventionSelectors(namingConventionRuleOptions)
           ],
 
           // STANDARDIZED BY:   @typescript-eslint\eslint-plugin\dist\configs\recommended.json
@@ -834,4 +836,6 @@ function buildRules(profile) {
     ]
   };
 }
+
 exports.buildRules = buildRules;
+exports.namingConventionRuleOptions = namingConventionRuleOptions;

package/profile/_macros.js

@@ -86,7 +86,7 @@ function expandNamingConventionSelectors(inputBlocks) {
 
       const expandedBlock2 = {
         ...block,
-        modifiers: ['private'],
+        modifiers: [...(block.modifiers ?? []), 'private'],
         leadingUnderscore: 'require'
       };
       delete expandedBlock2.enforceLeadingUnderscoreWhenPrivate;