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

org.sonar.css.rules.FontFamilyNoMissingGenericFamilyKeyword Maven / Gradle / Ivy

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.css.rules;

import static org.sonar.css.rules.RuleUtils.splitAndTrim;

import java.util.Arrays;
import java.util.List;
import org.sonar.check.Rule;
import org.sonar.check.RuleProperty;

@Rule(key = "S4649")
public class FontFamilyNoMissingGenericFamilyKeyword implements CssRule {

  private static final String DEFAULT_IGNORE_FONT_FAMILIES = "";

  @RuleProperty(
    key = "ignoreFontFamilies",
    description = "Comma-separated list of font families to ignore. Each value can be a string or a regular expression with the syntax /pattern/.",
    defaultValue = "" + DEFAULT_IGNORE_FONT_FAMILIES
  )
  String ignoreFontFamilies = DEFAULT_IGNORE_FONT_FAMILIES;

  @Override
  public String stylelintKey() {
    return "font-family-no-missing-generic-family-keyword";
  }

  @Override
  public List stylelintOptions() {
    return Arrays.asList(true, new StylelintIgnoreOption(splitAndTrim(ignoreFontFamilies)));
  }

  private static class StylelintIgnoreOption {

    // Used by GSON serialization
    private final List ignoreFontFamilies;

    StylelintIgnoreOption(List ignoreFontFamilies) {
      this.ignoreFontFamilies = ignoreFontFamilies;
    }
  }
}