org.sonar.plugins.javascript.rules.EslintRulesDefinition Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sonar-javascript-plugin Show documentation

Code Analyzer for JavaScript/TypeScript/CSS

There is a newer version: 10.17.0.28100

Show newest version

/*
 * SonarQube JavaScript Plugin
 * Copyright (C) 2011-2024 SonarSource SA
 * mailto:info AT sonarsource DOT com
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.sonar.plugins.javascript.rules;

import java.util.HashMap;
import java.util.Map;
import org.sonar.api.server.rule.RulesDefinition;
import org.sonar.plugins.javascript.JavaScriptLanguage;
import org.sonarsource.analyzer.commons.ExternalRuleLoader;

public class EslintRulesDefinition implements RulesDefinition {

  public static final String REPOSITORY_KEY = "eslint_repo";
  public static final String LINTER_NAME = "ESLint";

  private static final String[] ESLINT_PLUGINS = {
    "@angular-eslint",
    "@angular-eslint-template",
    "@typescript-eslint",
    "angular",
    "core",
    "ember",
    "flowtype",
    "import",
    "jsx-a11y",
    "node",
    "promise",
    "react",
    "react-hooks",
    "sonarjs",
    "vue",
  };

  private static final Map RULE_LOADERS = new HashMap<>();

  static {
    for (String plugin : ESLINT_PLUGINS) {
      RULE_LOADERS.put(
        plugin,
        new ExternalRuleLoader(
          REPOSITORY_KEY,
          LINTER_NAME,
          "org/sonar/l10n/javascript/rules/eslint/" + plugin + ".json",
          JavaScriptLanguage.KEY
        )
      );
    }
  }

  @Override
  public void define(Context context) {
    RULE_LOADERS.forEach((s, externalRuleLoader) ->
      externalRuleLoader.createExternalRuleRepository(context)
    );
  }

  public static ExternalRuleLoader loader(String eslintKey) {
    if (eslintKey.contains("/")) {
      var keyParts = eslintKey.split("/");
      var pluginName = keyParts[0];

      /*  This is to handle `@angular-eslint/eslint-plugin-template` where the rule keys have 3 segments, 
          like `@angular-eslint/template/banana-in-box`. Here the plugin name would be `@angular-eslint/template`, 
          which is further sanitized to `@angular-eslint-template` to avoid `/` in the filename.      
      */
      if (keyParts.length > 2) {
        pluginName = keyParts[0] + "-" + keyParts[1];
      }
      if (RULE_LOADERS.containsKey(pluginName)) {
        return RULE_LOADERS.get(pluginName);
      }
    }

    return RULE_LOADERS.get("core");
  }
}