org.sonar.css.checks.common.DoNotUseShorthandPropertyCheck Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of css-checks Show documentation
There is a newer version: 4.13
/*
 * SonarQube CSS / SCSS / Less Analyzer
 * Copyright (C) 2013-2017 David RACODON
 * mailto: [email protected]
 *
 * 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.checks.common;

import java.util.Set;
import java.util.stream.Collectors;

import org.sonar.check.Priority;
import org.sonar.check.Rule;
import org.sonar.css.checks.Tags;
import org.sonar.css.model.property.StandardProperty;
import org.sonar.css.model.property.StandardPropertyFactory;
import org.sonar.plugins.css.api.tree.css.PropertyDeclarationTree;
import org.sonar.plugins.css.api.visitors.DoubleDispatchVisitorCheck;
import org.sonar.squidbridge.annotations.SqaleConstantRemediation;

@Rule(
  key = "do-not-use-shorthand-properties",
  name = "Shorthand properties should not be used",
  priority = Priority.MINOR,
  tags = {Tags.PITFALL, Tags.UNDERSTANDABILITY})
@SqaleConstantRemediation("5min")
public class DoNotUseShorthandPropertyCheck extends DoubleDispatchVisitorCheck {

  private static final Set SHORTHAND_PROPERTIES = StandardPropertyFactory.getAll()
    .stream()
    .filter(StandardProperty::isShorthand)
    .map(StandardProperty::getName)
    .collect(Collectors.toSet());

  @Override
  public void visitPropertyDeclaration(PropertyDeclarationTree tree) {
    StandardProperty standardProperty = tree.property().standardProperty();
    String propertyName = standardProperty.getName();

    if (SHORTHAND_PROPERTIES.contains(propertyName)
      && tree.value().sanitizedValueElements().size() > 1) {
      addPreciseIssue(
        tree.property(),
        "Replace this \"" + propertyName + "\" shorthand property with its longhand properties: "
          + standardProperty.getShorthandForPropertyNames().stream().sorted().collect(Collectors.joining(", ")));
    }

    super.visitPropertyDeclaration(tree);
  }

}