prefer-gradient

Try in Playground
chakra-ui

oscar143

Best PracticeInformational

0

No tags

No CWE or CVE

We should use chakra bgGradient props with chakra's gradient functions rather than CSS

Ast Rule: html element


prefer-gradient

How to write a rule
const TYPES = {
  string: getPropStringValue,
  sequence: getPropSequenceValue,
  array: getPropArrayValue,
  object: getPropObjectValue,
  object_element: getPropObjectValue,
  functiondefinition: () => {},
};

function getTag(node) {
  if (node && node.tag) {
    return node.tag.value;
  }
}

function getProp(attributes = [], prop = "") {
  if (!prop) return;

  return attributes.find((attribute) => {
    if (attribute && attribute.name && attribute.name.value) {
      return attribute.name.value === prop;
    }
  });
}

function getPropStringValue(value) {
  if (value.value === "true") {
    return true;
  }

  if (value.value === "false") {
    return false;
  }

  if (value.value === "undefined") {
    return undefined;
  }

  if (value.value === "null") {
    return null;
  }

  if (!isNaN(value.value)) {
    return Number(value.value);
  }

  return value.value.replace(/^[\"\`\']/g, "").replace(/[\"\`\']$/g, "");
}

function getPropArrayValue(value) {
  const array = [];
  const arrayElements = value.elements;

  if (arrayElements.length) {
    for (const element of arrayElements) {
      array.push(TYPES[element.astType](element));
    }
  }

  return array;
}

function getPropObjectValue(value) {
  const object = {};
  const objectElements = value.elements;

  if (objectElements.length) {
    for (const element of objectElements) {
      object[element.name.value] = TYPES[element.value.astType](element.value);
    }
  }

  return object;
}

function getPropSequenceValue(value) {
  if (value.elements.length) {
    const element = value.elements[0];

    if (element) {
      return TYPES[element.astType](element);
    }
  }
}

function extractValue(attribute, extractor) {
  if (attribute) {
    // Null valued attributes imply truthiness.
    // For example: <div aria-hidden />
    if (attribute.value === null) return true;

    return extractor(attribute.value);
  }
}

function getValue(value) {
  return TYPES[value.astType](value);
}

function getPropValue(attribute) {
  return extractValue(attribute, getValue);
}

function debugObject(object) {
  for (const property in object) {
    console.log(`${property}: ${JSON.stringify(object[property])}`);
  }
}

function propHasValue(attribute) {
  const value = getPropValue(attribute);

  if (typeof value !== "boolean") {
    return !!value;
  }

  return false;
}

function visit(node) {
  const bgGradientProp = getProp(node.attributes, "bgGradient");
  const bgGradientValue = getPropValue(bgGradientProp);


  if (
    bgGradientValue?.startsWith("linear-gradient") ||
    bgGradientValue?.startsWith("radial-gradient") ||
    bgGradientValue?.startsWith("conic-gradient")
  ) {
    const error = buildError(
      bgGradientProp.start.line,
      bgGradientProp.start.col,
      bgGradientProp.end.line,
      bgGradientProp.end.col,
      `Prefer chakra's linear, radial and conic utilities`,
      "INFO",
      "BEST_PRACTICES"
    );

    addError(error);
  }
}

good.jsx

Expected test result: no error

<Box bgGradient='linear(to-l, #7928CA, #FF0080)' />
<Box bgGradient='radial(farthest-corner at 50% 50%, #fff, #000)' />
<Box bgGradient='conic(#fff, #000)' />

bad.jsx

Expected test result: no error

<Box bgGradient="linear-gradient(to left, rgb(0, 0, 0) 15%, rgb(255, 255, 255) 15%)" />
<Box bgGradient="radial-gradient(farthest-corner at 50% 50%, #fff, #000)" />
<Box bgGradient="conic-gradient(#fff, #000)" />
Add comment

Log in to add a comment


    Be the first one to leave a comment!

Codiga Logo
Codiga Hub
  • Rulesets
  • Playground
  • Snippets
  • Cookbooks
soc-2 icon

We are SOC-2 Compliance Certified

G2 high performer medal

Codiga – All rights reserved 2022.