Skip to content

Latest commit

 

History

History
33 lines (25 loc) · 1.2 KB

README.md

File metadata and controls

33 lines (25 loc) · 1.2 KB
Raw

Type Token Use

This rule is intended enforce use of Carbon type tokens, functions, mixins and CSS classes as defined. https://www.carbondesignsystem.com/guidelines/typography/overview/

Often Carbon fonts are set through the use of mixins, which this linter does not check for.

Carbon recommends using the mixin approach which is why these functions are optional.

Default props

const defaultOptions = {
  // include standard type properties
  includeProps: ["font", "/^font-*/", "line-height", "letterSpacing"],
  acceptValues: ["/inherit|initial/"],
  acceptsScopes: ["type"],
  carbonPath: undefined // allows a different path for node_modules (supports monorepo with multiple carbon versions),
   e.g. packages/proj1/node_modules/@carbon
  carbonModulePostfix: undefined, // optional for use in conjunction with `carbonPath` to where a Carbon module has been renamed e.g. `-10` with a carbonPath of `node_modules/@carbon` will use `node_modules/@carbon/type-10`
  enforceScopes: false
};

Fix

The automatic fixes for the type rule are as follows.

  • V11: Remove carbon-- prefix from function names with e.g. carbon--font-width;