All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.sonar.plugins.javascript.eslint.EslintRule Maven / Gradle / Ivy

There is a newer version: 10.17.0.28100
Show newest version
/*
 * SonarQube JavaScript Plugin
 * Copyright (C) 2011-2023 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.eslint;

import java.util.List;
import java.util.Set;
import java.util.function.Predicate;
import java.util.stream.Collectors;
import org.sonar.api.batch.fs.InputFile;
import org.sonar.plugins.javascript.JavaScriptLanguage;
import org.sonar.plugins.javascript.TypeScriptLanguage;

class EslintRule {

  static final String UCFG_ESLINT_KEY = "ucfg";

  final String key;
  final List fileTypeTarget;
  final List configurations;
  final String language;

  EslintRule(
    String key,
    List configurations,
    List fileTypeTarget,
    String language
  ) {
    this.key = key;
    this.fileTypeTarget =
      fileTypeTarget.stream().map(InputFile.Type::name).collect(Collectors.toList());
    this.configurations = configurations;
    // unfortunately we can't check this using types, so it's enforced at runtime
    if (!JavaScriptLanguage.KEY.equals(language) && !TypeScriptLanguage.KEY.equals(language)) {
      throw new IllegalArgumentException("Invalid language " + language);
    }
    this.language = language;
  }

  @Override
  public String toString() {
    return key;
  }

  public String getKey() {
    return key;
  }

  static boolean containsRuleWithKey(List rules, String eslintKey) {
    return rules.stream().anyMatch(ruleMatcher(eslintKey));
  }

  static EslintRule findFirstRuleWithKey(List rules, String eslintKey) {
    return rules.stream().filter(ruleMatcher(eslintKey)).findFirst().orElse(null);
  }

  static List findAllBut(List rules, Set blackListRuleKeys) {
    return rules
      .stream()
      .filter(rule -> !blackListRuleKeys.contains(rule.key))
      .collect(Collectors.toList());
  }

  private static Predicate ruleMatcher(String eslintKey) {
    return rule -> rule.key.equals(eslintKey);
  }
}