@discord/eslint-plugin-discord-intl 0.26.0-rc.2 → 0.26.0

package/index.js

@@ -1,10 +1,12 @@
 module.exports = {
   rules: {
+    'no-avoidable-exact-plurals': require('./rules/native/no-avoidable-exact-plurals'),
     'no-repeated-plural-names': require('./rules/native/no-repeated-plural-names'),
     'no-repeated-plural-options': require('./rules/native/no-repeated-plural-options'),
     'no-trimmable-whitespace': require('./rules/native/no-trimmable-whitespace'),
     'no-unicode-variable-names': require('./rules/native/no-unicode-variable-names'),
     'no-duplicate-message-keys': require('./rules/native/no-duplicate-message-keys'),
+    'no-unsafe-variable-syntax': require('./rules/native/no-unsafe-variable-syntax'),
 
     'use-static-access': require('./rules/use-static-access'),
     'no-opaque-messages-objects': require('./rules/no-opaque-messages-objects'),
@@ -14,10 +16,12 @@ module.exports = {
       plugins: ['@discord/discord-intl'],
       rules: {
         // Native rules
+        '@discord/discord-intl/no-avoidable-exact-plurals': 'error',
         '@discord/discord-intl/no-trimmable-whitespace': 'error',
         '@discord/discord-intl/no-repeated-plural-names': 'error',
         '@discord/discord-intl/no-repeated-plural-options': 'error',
         '@discord/discord-intl/no-unicode-variable-names': 'error',
+        '@discord/discord-intl/no-unsafe-variable-syntax': 'error',
 
         // JS rules
         '@discord/discord-intl/use-static-access': 'error',

package/lib/native-validation.js

@@ -1,5 +1,8 @@
 /** @typedef {import('eslint').Rule.RuleListener} RuleListener */
 /** @typedef {import('eslint').Rule.RuleContext} RuleContext */
+/** @typedef {import('eslint').Rule.ReportDescriptor} ReportDescriptor */
+/** @typedef {import('eslint').Rule.ReportDescriptorLocation} ReportDescriptorLocation */
+/** @typedef {import('eslint').AST.SourceLocation} SourceLocation */
 /** @typedef {import('eslint').SourceCode} SourceCode */
 /** @typedef {import("@discord/intl-loader-core/types").IntlDiagnostic} IntlDiagnostic */
 
@@ -63,10 +66,13 @@ function processAndValidateNative(sourceCode, fileName, content) {
         description: error.message,
         key: error.key ?? 'file',
         file: error.file ?? processingFileName,
-        line: error.line ?? 0,
-        col: error.col ?? 0,
+        messageLine: error.line ?? 0,
+        messageCol: error.col ?? 0,
+        start: 0,
+        end: content.length,
         locale: error.locale ?? 'definition',
-        severity: 'error',
+        category: 'correctness',
+        fixes: [],
       });
     }
   }
@@ -98,6 +104,23 @@ function traverseAndReportMatchingNativeValidations(context, predicate) {
     context.sourceCode.text,
   );
 
+  /**
+   * @param {IntlDiagnostic} diagnostic
+   * @returns {SourceLocation}
+   */
+  function reportedSpan(diagnostic) {
+    const messageOffset = context.sourceCode.getIndexFromLoc({
+      line: diagnostic.messageLine,
+      column: diagnostic.messageCol,
+    });
+
+    context.sourceCode.getNodeByRangeIndex(messageOffset);
+    return {
+      start: context.sourceCode.getLocFromIndex(messageOffset + diagnostic.start),
+      end: context.sourceCode.getLocFromIndex(messageOffset + diagnostic.end),
+    };
+  }
+
   return traverseMessageDefinitions(context, (_property, value, _definition, name) => {
     if (name == null) return;
     const diagnostics = validations[name];
@@ -106,10 +129,36 @@ function traverseAndReportMatchingNativeValidations(context, predicate) {
     for (const diagnostic of diagnostics) {
       if (!predicate(diagnostic)) continue;
 
-      context.report({
-        node: value,
+      /** @type {ReportDescriptor} */
+      const report = {
+        loc: reportedSpan(diagnostic),
         message: diagnostic.description,
-      });
+      };
+      if (diagnostic.fixes.length > 0 && value.range != null) {
+        // Add 1 because ESLint 8 works on 1-based column indices.
+        const valueStart = value.range[0] + 1;
+        report.fix = (fixer) => {
+          return diagnostic.fixes.map((fix) =>
+            fixer.replaceTextRange([valueStart + fix.start, valueStart + fix.end], fix.replacement),
+          );
+        };
+
+        const suggestableFixes = diagnostic.fixes.filter((fix) => fix.message != null);
+        if (suggestableFixes.length > 0 && value.range != null) {
+          const valueStart = value.range[0];
+
+          report.suggest = suggestableFixes.map((fix) => ({
+            desc: /** @type {string} */ (fix.message),
+            fix: (fixer) =>
+              fixer.replaceTextRange(
+                [valueStart + fix.start, valueStart + fix.end],
+                fix.replacement,
+              ),
+          }));
+        }
+      }
+
+      context.report(report);
     }
   });
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@discord/eslint-plugin-discord-intl",
-  "version": "0.26.0-rc.2",
+  "version": "0.26.0",
   "license": "MIT",
   "type": "commonjs",
   "description": "ESLint plugin for validating and linting messages and translations using @discord/intl",
@@ -11,7 +11,7 @@
   },
   "dependencies": {
     "@typescript-eslint/scope-manager": "^8.8.1",
-    "@discord/intl-loader-core": "0.26.0-rc.2"
+    "@discord/intl-loader-core": "0.26.0"
   },
   "devDependencies": {
     "@types/eslint": "^8.56.12",

package/rules/native/no-avoidable-exact-plurals.js

@@ -0,0 +1,18 @@
+const { traverseAndReportMatchingNativeValidations } = require('../../lib/native-validation');
+
+module.exports = /** @type {import('eslint').Rule.RuleModule} */ ({
+  meta: {
+    fixable: 'code',
+    docs: {
+      description:
+        'Disallow `=0` and `=1` plural selectors unless necessary, and replace `0` and `1` values with `#` of them.',
+      category: 'Best Practices',
+    },
+  },
+  create(context) {
+    return traverseAndReportMatchingNativeValidations(
+      context,
+      (diagnostic) => diagnostic.name === 'NoAvoidableExactPlurals',
+    );
+  },
+});

package/rules/native/no-trimmable-whitespace.js

@@ -3,6 +3,7 @@ const { traverseAndReportMatchingNativeValidations } = require('../../lib/native
 module.exports = /** @type {import('eslint').Rule.RuleModule} */ ({
   meta: {
     fixable: 'code',
+    hasSuggestions: true,
     docs: {
       description: 'Disallow whitespace at the beginning and end of intl messages',
       category: 'Best Practices',

package/rules/native/no-unsafe-variable-syntax.js

@@ -0,0 +1,17 @@
+const { traverseAndReportMatchingNativeValidations } = require('../../lib/native-validation');
+
+module.exports = /** @type {import('eslint').Rule.RuleModule} */ ({
+  meta: {
+    fixable: 'code',
+    docs: {
+      description: 'Disallow the obsoleted "unsafe variable" syntax (`!!{}!!`)',
+      category: 'Best Practices',
+    },
+  },
+  create(context) {
+    return traverseAndReportMatchingNativeValidations(
+      context,
+      (diagnostic) => diagnostic.name === 'NoUnsafeVariableSyntax',
+    );
+  },
+});