org.sonar.css.plugin.CssRules Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sonar-css-plugin Show documentation
Code Analyzer for CSS
The newest version!
/*
 * SonarCSS
 * Copyright (C) 2018-2021 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.css.plugin;

import com.google.gson.JsonElement;
import com.google.gson.JsonObject;
import com.google.gson.JsonSerializationContext;
import com.google.gson.JsonSerializer;
import java.lang.reflect.Type;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import javax.annotation.Nullable;
import org.sonar.api.batch.rule.CheckFactory;
import org.sonar.api.batch.rule.Checks;
import org.sonar.api.rule.RuleKey;
import org.sonar.css.plugin.rules.AtRuleNoUnknown;
import org.sonar.css.plugin.rules.BlockNoEmpty;
import org.sonar.css.plugin.rules.ColorNoInvalidHex;
import org.sonar.css.plugin.rules.CommentNoEmpty;
import org.sonar.css.plugin.rules.CssRule;
import org.sonar.css.plugin.rules.DeclarationBlockNoDuplicateProperties;
import org.sonar.css.plugin.rules.DeclarationBlockNoShorthandPropertyOverrides;
import org.sonar.css.plugin.rules.FontFamilyNoDuplicateNames;
import org.sonar.css.plugin.rules.FontFamilyNoMissingGenericFamilyKeyword;
import org.sonar.css.plugin.rules.FunctionCalcNoInvalid;
import org.sonar.css.plugin.rules.FunctionCalcNoUnspacedOperator;
import org.sonar.css.plugin.rules.FunctionLinearGradientNoNonstandardDirection;
import org.sonar.css.plugin.rules.KeyframeDeclarationNoImportant;
import org.sonar.css.plugin.rules.MediaFeatureNameNoUnknown;
import org.sonar.css.plugin.rules.NoDescendingSpecificity;
import org.sonar.css.plugin.rules.NoDuplicateAtImportRules;
import org.sonar.css.plugin.rules.NoDuplicateSelectors;
import org.sonar.css.plugin.rules.NoEmptySource;
import org.sonar.css.plugin.rules.NoExtraSemicolons;
import org.sonar.css.plugin.rules.NoInvalidDoubleSlashComments;
import org.sonar.css.plugin.rules.PropertyNoUnknown;
import org.sonar.css.plugin.rules.SelectorPseudoClassNoUnknown;
import org.sonar.css.plugin.rules.SelectorPseudoElementNoUnknown;
import org.sonar.css.plugin.rules.SelectorTypeNoUnknown;
import org.sonar.css.plugin.rules.StringNoNewline;
import org.sonar.css.plugin.rules.UnitNoUnknown;

public class CssRules {

  private final Map stylelintKeyToRuleKey;
  private final StylelintConfig config = new StylelintConfig();

  public CssRules(CheckFactory checkFactory) {
    Checks checks = checkFactory.create(CssRulesDefinition.REPOSITORY_KEY)
      .addAnnotatedChecks((Iterable) getRuleClasses());
    Collection enabledRules = checks.all();
    stylelintKeyToRuleKey = new HashMap<>();
    for (CssRule rule : enabledRules) {
      stylelintKeyToRuleKey.put(rule.stylelintKey(), checks.ruleKey(rule));
      config.rules.put(rule.stylelintKey(), rule.stylelintOptions());
    }
  }

  public static List> getRuleClasses() {
    return Collections.unmodifiableList(Arrays.asList(
      AtRuleNoUnknown.class,
      BlockNoEmpty.class,
      ColorNoInvalidHex.class,
      CommentNoEmpty.class,
      DeclarationBlockNoDuplicateProperties.class,
      DeclarationBlockNoShorthandPropertyOverrides.class,
      FontFamilyNoDuplicateNames.class,
      FontFamilyNoMissingGenericFamilyKeyword.class,
      FunctionCalcNoUnspacedOperator.class,
      FunctionCalcNoInvalid.class,
      FunctionLinearGradientNoNonstandardDirection.class,
      KeyframeDeclarationNoImportant.class,
      MediaFeatureNameNoUnknown.class,
      NoDescendingSpecificity.class,
      NoDuplicateAtImportRules.class,
      NoDuplicateSelectors.class,
      NoEmptySource.class,
      NoExtraSemicolons.class,
      NoInvalidDoubleSlashComments.class,
      PropertyNoUnknown.class,
      SelectorPseudoClassNoUnknown.class,
      SelectorPseudoElementNoUnknown.class,
      SelectorTypeNoUnknown.class,
      StringNoNewline.class,
      UnitNoUnknown.class
    ));
  }

  @Nullable
  public RuleKey getActiveSonarKey(String stylelintKey) {
    return stylelintKeyToRuleKey.get(stylelintKey);
  }

  public StylelintConfig getConfig() {
    return config;
  }

  public boolean isEmpty() {
    return stylelintKeyToRuleKey.isEmpty();
  }

  public static class StylelintConfig implements JsonSerializer {
    Map> rules = new HashMap<>();

    @Override
    public JsonElement serialize(StylelintConfig src, Type typeOfSrc, JsonSerializationContext context) {
      JsonObject stylelintJson = new JsonObject();
      JsonObject rulesJson = new JsonObject();
      stylelintJson.add("rules", rulesJson);
      for (Entry> stylelintOptions : rules.entrySet()) {
        List