@atlaskit/eslint-plugin-design-system 10.20.0 → 10.21.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/eslint-plugin-design-system
 
+## 10.21.0
+
+### Minor Changes
+
+- [#142522](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/142522)
+  [`42f1b0abdb783`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/42f1b0abdb783) -
+  Disallow ALL CAPS styles in XCSS using the `use-latest-xcss-syntax-typography` rule.
+
 ## 10.20.0
 
 ### Minor Changes

package/dist/cjs/rules/use-latest-xcss-syntax-typography/config/index.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.getConfig = void 0;
 var defaults = {
   failSilently: false,
-  patterns: ['restricted-property', 'wrapped-token-value']
+  patterns: ['restricted-property', 'wrapped-token-value', 'restricted-capitalisation']
 };
 var getConfig = exports.getConfig = function getConfig(overrides) {
   return Object.assign({}, defaults, overrides);

package/dist/cjs/rules/use-latest-xcss-syntax-typography/index.js

@@ -23,6 +23,7 @@ var rule = (0, _createRule.createLintRule)({
     messages: {
       noRestrictedTypographyProperties: "Don't set '{{ property }}' on xcss as it allows invalid combinations of typography tokens. ".concat(typescriptErrorMessage),
       noRestrictedTypographyPropertiesHeading: "Don't set '{{ property }}' on xcss in combination with 'font' heading tokens. ".concat(typescriptErrorMessage),
+      noRestrictedCapitalisation: "Avoid using ALL CAPS as it reduces readability and is bad for accessibility.",
       noWrappedTokenTypographyValues: "Don't wrap typography tokens in xcss. ".concat(typescriptErrorMessage)
     }
   },
@@ -41,6 +42,18 @@ var rule = (0, _createRule.createLintRule)({
           config: config
         });
       },
+      'CallExpression[callee.name="xcss"] ObjectExpression > Property > Identifier[name=textTransform]': function CallExpressionCalleeNameXcssObjectExpressionPropertyIdentifierNameTextTransform(node) {
+        return _linters.RestrictedCapitalisation.lint(node, {
+          context: context,
+          config: config
+        });
+      },
+      'CallExpression[callee.name="xcss"] ObjectExpression > Property > Literal[value=textTransform]': function CallExpressionCalleeNameXcssObjectExpressionPropertyLiteralValueTextTransform(node) {
+        return _linters.RestrictedCapitalisation.lint(node, {
+          context: context,
+          config: config
+        });
+      },
       'CallExpression[callee.name="xcss"] ObjectExpression > Property > Identifier[name=/(font|fontFamily|fontWeight)/]': function CallExpressionCalleeNameXcssObjectExpressionPropertyIdentifierNameFontFontFamilyFontWeight(node) {
         return _linters.WrappedTokenValue.lint(node, {
           context: context,

package/dist/cjs/rules/use-latest-xcss-syntax-typography/linters/common.js

@@ -2,4 +2,9 @@
 
 Object.defineProperty(exports, "__esModule", {
   value: true
-});
+});
+exports.isPropertyName = isPropertyName;
+var _eslintCodemodUtils = require("eslint-codemod-utils");
+function isPropertyName(node, name) {
+  return (0, _eslintCodemodUtils.isNodeOfType)(node, 'Identifier') && node.name === name || (0, _eslintCodemodUtils.isNodeOfType)(node, 'Literal') && node.value === name;
+}

package/dist/cjs/rules/use-latest-xcss-syntax-typography/linters/index.js

@@ -3,6 +3,12 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+Object.defineProperty(exports, "RestrictedCapitalisation", {
+  enumerable: true,
+  get: function get() {
+    return _restrictedCapitalisation.RestrictedCapitalisation;
+  }
+});
 Object.defineProperty(exports, "RestrictedProperty", {
   enumerable: true,
   get: function get() {
@@ -16,4 +22,5 @@ Object.defineProperty(exports, "WrappedTokenValue", {
   }
 });
 var _restrictedProperty = require("./restricted-property");
+var _restrictedCapitalisation = require("./restricted-capitalisation");
 var _wrappedTokenValue = require("./wrapped-token-value");

package/dist/cjs/rules/use-latest-xcss-syntax-typography/linters/restricted-capitalisation.js

@@ -0,0 +1,37 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.RestrictedCapitalisation = void 0;
+var _eslintCodemodUtils = require("eslint-codemod-utils");
+var _common = require("./common");
+/* eslint-disable @repo/internal/react/require-jsdoc */
+
+var RestrictedCapitalisation = exports.RestrictedCapitalisation = {
+  lint: function lint(node, _ref) {
+    var context = _ref.context,
+      config = _ref.config;
+    if (RestrictedCapitalisation._check(node, {
+      context: context,
+      config: config
+    })) {
+      context.report({
+        node: node,
+        messageId: 'noRestrictedCapitalisation'
+      });
+    }
+  },
+  _check: function _check(node, _ref2) {
+    var config = _ref2.config;
+    if (!config.patterns.includes('restricted-capitalisation')) {
+      return false;
+    }
+
+    // Prevent text transform being used to uppercase all characters
+    if ((0, _common.isPropertyName)(node, 'textTransform') && (0, _eslintCodemodUtils.isNodeOfType)(node.parent, 'Property') && (0, _eslintCodemodUtils.isNodeOfType)(node.parent.value, 'Literal')) {
+      return node.parent.value.value === 'uppercase';
+    }
+    return true;
+  }
+};

package/dist/cjs/rules/use-latest-xcss-syntax-typography/linters/restricted-property.js

@@ -5,6 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.RestrictedProperty = void 0;
 var _eslintCodemodUtils = require("eslint-codemod-utils");
+var _common = require("./common");
 function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t.return || t.return(); } finally { if (u) throw o; } } }; }
 function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
 function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; } /* eslint-disable @repo/internal/react/require-jsdoc */
@@ -38,7 +39,7 @@ var RestrictedProperty = exports.RestrictedProperty = {
     }
 
     // Prevent font weight being used in combination with heading tokens
-    if ((0, _eslintCodemodUtils.isNodeOfType)(node, 'Identifier') && node.name === 'fontWeight' || (0, _eslintCodemodUtils.isNodeOfType)(node, 'Literal') && node.value === 'fontWeight') {
+    if ((0, _common.isPropertyName)(node, 'fontWeight')) {
       if ((0, _eslintCodemodUtils.isNodeOfType)(node.parent.parent, 'ObjectExpression')) {
         var _iterator = _createForOfIteratorHelper(node.parent.parent.properties),
           _step;

package/dist/es2019/rules/use-latest-xcss-syntax-typography/config/index.js

@@ -1,6 +1,6 @@
 const defaults = {
   failSilently: false,
-  patterns: ['restricted-property', 'wrapped-token-value']
+  patterns: ['restricted-property', 'wrapped-token-value', 'restricted-capitalisation']
 };
 export const getConfig = overrides => {
   return Object.assign({}, defaults, overrides);

package/dist/es2019/rules/use-latest-xcss-syntax-typography/index.js

@@ -1,7 +1,7 @@
 import { createLintRule } from '../utils/create-rule';
 import { errorBoundary } from '../utils/error-boundary';
 import { getConfig } from './config';
-import { RestrictedProperty, WrappedTokenValue } from './linters';
+import { RestrictedCapitalisation, RestrictedProperty, WrappedTokenValue } from './linters';
 const typescriptErrorMessage = 'There is ongoing work to make this a TypeScript error. Once that happens, you will have to delete/refactor anyway.';
 const rule = createLintRule({
   meta: {
@@ -17,6 +17,7 @@ const rule = createLintRule({
     messages: {
       noRestrictedTypographyProperties: `Don't set '{{ property }}' on xcss as it allows invalid combinations of typography tokens. ${typescriptErrorMessage}`,
       noRestrictedTypographyPropertiesHeading: `Don't set '{{ property }}' on xcss in combination with 'font' heading tokens. ${typescriptErrorMessage}`,
+      noRestrictedCapitalisation: `Avoid using ALL CAPS as it reduces readability and is bad for accessibility.`,
       noWrappedTokenTypographyValues: `Don't wrap typography tokens in xcss. ${typescriptErrorMessage}`
     }
   },
@@ -31,6 +32,14 @@ const rule = createLintRule({
         context,
         config
       }),
+      'CallExpression[callee.name="xcss"] ObjectExpression > Property > Identifier[name=textTransform]': node => RestrictedCapitalisation.lint(node, {
+        context,
+        config
+      }),
+      'CallExpression[callee.name="xcss"] ObjectExpression > Property > Literal[value=textTransform]': node => RestrictedCapitalisation.lint(node, {
+        context,
+        config
+      }),
       'CallExpression[callee.name="xcss"] ObjectExpression > Property > Identifier[name=/(font|fontFamily|fontWeight)/]': node => WrappedTokenValue.lint(node, {
         context,
         config

package/dist/es2019/rules/use-latest-xcss-syntax-typography/linters/common.js

@@ -1 +1,4 @@
-export {};
+import { isNodeOfType } from 'eslint-codemod-utils';
+export function isPropertyName(node, name) {
+  return isNodeOfType(node, 'Identifier') && node.name === name || isNodeOfType(node, 'Literal') && node.value === name;
+}

package/dist/es2019/rules/use-latest-xcss-syntax-typography/linters/index.js

@@ -1,2 +1,3 @@
 export { RestrictedProperty } from './restricted-property';
+export { RestrictedCapitalisation } from './restricted-capitalisation';
 export { WrappedTokenValue } from './wrapped-token-value';

package/dist/es2019/rules/use-latest-xcss-syntax-typography/linters/restricted-capitalisation.js

@@ -0,0 +1,33 @@
+/* eslint-disable @repo/internal/react/require-jsdoc */
+
+import { isNodeOfType } from 'eslint-codemod-utils';
+import { isPropertyName } from './common';
+export const RestrictedCapitalisation = {
+  lint(node, {
+    context,
+    config
+  }) {
+    if (RestrictedCapitalisation._check(node, {
+      context,
+      config
+    })) {
+      context.report({
+        node,
+        messageId: 'noRestrictedCapitalisation'
+      });
+    }
+  },
+  _check(node, {
+    config
+  }) {
+    if (!config.patterns.includes('restricted-capitalisation')) {
+      return false;
+    }
+
+    // Prevent text transform being used to uppercase all characters
+    if (isPropertyName(node, 'textTransform') && isNodeOfType(node.parent, 'Property') && isNodeOfType(node.parent.value, 'Literal')) {
+      return node.parent.value.value === 'uppercase';
+    }
+    return true;
+  }
+};

package/dist/es2019/rules/use-latest-xcss-syntax-typography/linters/restricted-property.js

@@ -1,6 +1,7 @@
 /* eslint-disable @repo/internal/react/require-jsdoc */
 
 import { isNodeOfType } from 'eslint-codemod-utils';
+import { isPropertyName } from './common';
 export const RestrictedProperty = {
   lint(node, {
     context,
@@ -33,7 +34,7 @@ export const RestrictedProperty = {
     }
 
     // Prevent font weight being used in combination with heading tokens
-    if (isNodeOfType(node, 'Identifier') && node.name === 'fontWeight' || isNodeOfType(node, 'Literal') && node.value === 'fontWeight') {
+    if (isPropertyName(node, 'fontWeight')) {
       if (isNodeOfType(node.parent.parent, 'ObjectExpression')) {
         for (const property of node.parent.parent.properties) {
           var _property$value$value;

package/dist/esm/rules/use-latest-xcss-syntax-typography/config/index.js

@@ -1,6 +1,6 @@
 var defaults = {
   failSilently: false,
-  patterns: ['restricted-property', 'wrapped-token-value']
+  patterns: ['restricted-property', 'wrapped-token-value', 'restricted-capitalisation']
 };
 export var getConfig = function getConfig(overrides) {
   return Object.assign({}, defaults, overrides);

package/dist/esm/rules/use-latest-xcss-syntax-typography/index.js

@@ -1,7 +1,7 @@
 import { createLintRule } from '../utils/create-rule';
 import { errorBoundary } from '../utils/error-boundary';
 import { getConfig } from './config';
-import { RestrictedProperty, WrappedTokenValue } from './linters';
+import { RestrictedCapitalisation, RestrictedProperty, WrappedTokenValue } from './linters';
 var typescriptErrorMessage = 'There is ongoing work to make this a TypeScript error. Once that happens, you will have to delete/refactor anyway.';
 var rule = createLintRule({
   meta: {
@@ -17,6 +17,7 @@ var rule = createLintRule({
     messages: {
       noRestrictedTypographyProperties: "Don't set '{{ property }}' on xcss as it allows invalid combinations of typography tokens. ".concat(typescriptErrorMessage),
       noRestrictedTypographyPropertiesHeading: "Don't set '{{ property }}' on xcss in combination with 'font' heading tokens. ".concat(typescriptErrorMessage),
+      noRestrictedCapitalisation: "Avoid using ALL CAPS as it reduces readability and is bad for accessibility.",
       noWrappedTokenTypographyValues: "Don't wrap typography tokens in xcss. ".concat(typescriptErrorMessage)
     }
   },
@@ -35,6 +36,18 @@ var rule = createLintRule({
           config: config
         });
       },
+      'CallExpression[callee.name="xcss"] ObjectExpression > Property > Identifier[name=textTransform]': function CallExpressionCalleeNameXcssObjectExpressionPropertyIdentifierNameTextTransform(node) {
+        return RestrictedCapitalisation.lint(node, {
+          context: context,
+          config: config
+        });
+      },
+      'CallExpression[callee.name="xcss"] ObjectExpression > Property > Literal[value=textTransform]': function CallExpressionCalleeNameXcssObjectExpressionPropertyLiteralValueTextTransform(node) {
+        return RestrictedCapitalisation.lint(node, {
+          context: context,
+          config: config
+        });
+      },
       'CallExpression[callee.name="xcss"] ObjectExpression > Property > Identifier[name=/(font|fontFamily|fontWeight)/]': function CallExpressionCalleeNameXcssObjectExpressionPropertyIdentifierNameFontFontFamilyFontWeight(node) {
         return WrappedTokenValue.lint(node, {
           context: context,

package/dist/esm/rules/use-latest-xcss-syntax-typography/linters/common.js

@@ -1 +1,4 @@
-export {};
+import { isNodeOfType } from 'eslint-codemod-utils';
+export function isPropertyName(node, name) {
+  return isNodeOfType(node, 'Identifier') && node.name === name || isNodeOfType(node, 'Literal') && node.value === name;
+}

package/dist/esm/rules/use-latest-xcss-syntax-typography/linters/index.js

@@ -1,2 +1,3 @@
 export { RestrictedProperty } from './restricted-property';
+export { RestrictedCapitalisation } from './restricted-capitalisation';
 export { WrappedTokenValue } from './wrapped-token-value';

package/dist/esm/rules/use-latest-xcss-syntax-typography/linters/restricted-capitalisation.js

@@ -0,0 +1,31 @@
+/* eslint-disable @repo/internal/react/require-jsdoc */
+
+import { isNodeOfType } from 'eslint-codemod-utils';
+import { isPropertyName } from './common';
+export var RestrictedCapitalisation = {
+  lint: function lint(node, _ref) {
+    var context = _ref.context,
+      config = _ref.config;
+    if (RestrictedCapitalisation._check(node, {
+      context: context,
+      config: config
+    })) {
+      context.report({
+        node: node,
+        messageId: 'noRestrictedCapitalisation'
+      });
+    }
+  },
+  _check: function _check(node, _ref2) {
+    var config = _ref2.config;
+    if (!config.patterns.includes('restricted-capitalisation')) {
+      return false;
+    }
+
+    // Prevent text transform being used to uppercase all characters
+    if (isPropertyName(node, 'textTransform') && isNodeOfType(node.parent, 'Property') && isNodeOfType(node.parent.value, 'Literal')) {
+      return node.parent.value.value === 'uppercase';
+    }
+    return true;
+  }
+};

package/dist/esm/rules/use-latest-xcss-syntax-typography/linters/restricted-property.js

@@ -4,6 +4,7 @@ function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length)
 /* eslint-disable @repo/internal/react/require-jsdoc */
 
 import { isNodeOfType } from 'eslint-codemod-utils';
+import { isPropertyName } from './common';
 export var RestrictedProperty = {
   lint: function lint(node, _ref) {
     var context = _ref.context,
@@ -34,7 +35,7 @@ export var RestrictedProperty = {
     }
 
     // Prevent font weight being used in combination with heading tokens
-    if (isNodeOfType(node, 'Identifier') && node.name === 'fontWeight' || isNodeOfType(node, 'Literal') && node.value === 'fontWeight') {
+    if (isPropertyName(node, 'fontWeight')) {
       if (isNodeOfType(node.parent.parent, 'ObjectExpression')) {
         var _iterator = _createForOfIteratorHelper(node.parent.parent.properties),
           _step;

package/dist/types/rules/use-latest-xcss-syntax-typography/config/index.d.ts

@@ -1,4 +1,4 @@
-type Pattern = 'restricted-property' | 'wrapped-token-value';
+type Pattern = 'restricted-property' | 'wrapped-token-value' | 'restricted-capitalisation';
 export interface RuleConfig {
     failSilently: boolean;
     patterns: Pattern[];

package/dist/types/rules/use-latest-xcss-syntax-typography/linters/common.d.ts

@@ -4,3 +4,4 @@ export type MetaData = {
     context: Rule.RuleContext;
     config: RuleConfig;
 };
+export declare function isPropertyName(node: Rule.Node, name: string): boolean;

package/dist/types/rules/use-latest-xcss-syntax-typography/linters/index.d.ts

@@ -1,2 +1,3 @@
 export { RestrictedProperty } from './restricted-property';
+export { RestrictedCapitalisation } from './restricted-capitalisation';
 export { WrappedTokenValue } from './wrapped-token-value';

package/dist/types/rules/use-latest-xcss-syntax-typography/linters/restricted-capitalisation.d.ts

@@ -0,0 +1,6 @@
+import type { Rule } from 'eslint';
+import { type MetaData } from './common';
+export declare const RestrictedCapitalisation: {
+    lint(node: Rule.Node, { context, config }: MetaData): void;
+    _check(node: Rule.Node, { config }: MetaData): boolean;
+};

package/dist/types-ts4.5/rules/use-latest-xcss-syntax-typography/config/index.d.ts

@@ -1,4 +1,4 @@
-type Pattern = 'restricted-property' | 'wrapped-token-value';
+type Pattern = 'restricted-property' | 'wrapped-token-value' | 'restricted-capitalisation';
 export interface RuleConfig {
     failSilently: boolean;
     patterns: Pattern[];

package/dist/types-ts4.5/rules/use-latest-xcss-syntax-typography/linters/common.d.ts

@@ -4,3 +4,4 @@ export type MetaData = {
     context: Rule.RuleContext;
     config: RuleConfig;
 };
+export declare function isPropertyName(node: Rule.Node, name: string): boolean;

package/dist/types-ts4.5/rules/use-latest-xcss-syntax-typography/linters/index.d.ts

@@ -1,2 +1,3 @@
 export { RestrictedProperty } from './restricted-property';
+export { RestrictedCapitalisation } from './restricted-capitalisation';
 export { WrappedTokenValue } from './wrapped-token-value';

package/dist/types-ts4.5/rules/use-latest-xcss-syntax-typography/linters/restricted-capitalisation.d.ts

@@ -0,0 +1,6 @@
+import type { Rule } from 'eslint';
+import { type MetaData } from './common';
+export declare const RestrictedCapitalisation: {
+    lint(node: Rule.Node, { context, config }: MetaData): void;
+    _check(node: Rule.Node, { config }: MetaData): boolean;
+};

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@atlaskit/eslint-plugin-design-system",
 	"description": "The essential plugin for use with the Atlassian Design System.",
-	"version": "10.20.0",
+	"version": "10.21.0",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
 	"publishConfig": {