eslint-plugin-gamut 2.4.4-alpha.e3cc4a.0 → 2.4.4-alpha.e426ef.0

package/dist/index.d.ts

@@ -12,6 +12,10 @@ declare const rules: {
     'no-kbd-element': import("@typescript-eslint/utils/dist/ts-eslint").RuleModule<"noKbdElement", [], {
         JSXOpeningElement(node: import("@typescript-eslint/types/dist/generated/ast-spec").JSXOpeningElement): void;
     }>;
+    'no-raw-z-index': import("@typescript-eslint/utils/dist/ts-eslint").RuleModule<"noRawZIndex", [], {
+        Property(node: import("@typescript-eslint/types/dist/generated/ast-spec").Property): void;
+        JSXAttribute(node: import("@typescript-eslint/types/dist/generated/ast-spec").JSXAttribute): void;
+    }>;
     'prefer-themed': import("@typescript-eslint/utils/dist/ts-eslint").RuleModule<"preferThemed", [], {
         TaggedTemplateExpression(node: import("@typescript-eslint/types/dist/generated/ast-spec").TaggedTemplateExpression): void;
     }>;

package/dist/index.js

@@ -8,6 +8,7 @@ const gamut_import_paths_1 = __importDefault(require("./gamut-import-paths"));
 const no_css_standalone_1 = __importDefault(require("./no-css-standalone"));
 const no_inline_style_1 = __importDefault(require("./no-inline-style"));
 const no_kbd_element_1 = __importDefault(require("./no-kbd-element"));
+const no_raw_z_index_1 = __importDefault(require("./no-raw-z-index"));
 const prefer_themed_1 = __importDefault(require("./prefer-themed"));
 const recommended_1 = __importDefault(require("./recommended"));
 exports.recommended = recommended_1.default;
@@ -16,6 +17,7 @@ const rules = {
     'no-css-standalone': no_css_standalone_1.default,
     'no-inline-style': no_inline_style_1.default,
     'no-kbd-element': no_kbd_element_1.default,
+    'no-raw-z-index': no_raw_z_index_1.default,
     'prefer-themed': prefer_themed_1.default,
 };
 exports.rules = rules;

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.tsx"],"names":[],"mappings":";;;;;;AAAA,8EAAoD;AACpD,4EAAkD;AAClD,wEAA8C;AAC9C,sEAA4C;AAC5C,oEAA2C;AAC3C,gEAAwC;AAUxB,sBAVT,qBAAW,CAUS;AAR3B,MAAM,KAAK,GAAG;IACZ,cAAc,EAAE,4BAAgB;IAChC,mBAAmB,EAAE,2BAAe;IACpC,iBAAiB,EAAE,yBAAa;IAChC,gBAAgB,EAAE,wBAAY;IAC9B,eAAe,EAAE,uBAAY;CAC9B,CAAC;AAEO,sBAAK"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.tsx"],"names":[],"mappings":";;;;;;AAAA,8EAAoD;AACpD,4EAAkD;AAClD,wEAA8C;AAC9C,sEAA4C;AAC5C,sEAA2C;AAC3C,oEAA2C;AAC3C,gEAAwC;AAWxB,sBAXT,qBAAW,CAWS;AAT3B,MAAM,KAAK,GAAG;IACZ,cAAc,EAAE,4BAAgB;IAChC,mBAAmB,EAAE,2BAAe;IACpC,iBAAiB,EAAE,yBAAa;IAChC,gBAAgB,EAAE,wBAAY;IAC9B,gBAAgB,EAAE,wBAAW;IAC7B,eAAe,EAAE,uBAAY;CAC9B,CAAC;AAEO,sBAAK"}

package/dist/no-raw-z-index.d.ts

@@ -0,0 +1,6 @@
+import { TSESTree } from '@typescript-eslint/utils';
+declare const _default: import("@typescript-eslint/utils/dist/ts-eslint").RuleModule<"noRawZIndex", [], {
+    Property(node: TSESTree.Property): void;
+    JSXAttribute(node: TSESTree.JSXAttribute): void;
+}>;
+export default _default;

package/dist/no-raw-z-index.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = require("@typescript-eslint/utils");
+const createRule_1 = require("./createRule");
+/**
+ * True for a numeric literal, including a negated one like `-1`.
+ */
+const isNumericLiteral = (node) => {
+    if (!node)
+        return false;
+    if (node.type === utils_1.AST_NODE_TYPES.Literal && typeof node.value === 'number') {
+        return true;
+    }
+    return (node.type === utils_1.AST_NODE_TYPES.UnaryExpression &&
+        (node.operator === '-' || node.operator === '+') &&
+        isNumericLiteral(node.argument));
+};
+const isZIndexKey = (key) => (key.type === utils_1.AST_NODE_TYPES.Identifier && key.name === 'zIndex') ||
+    (key.type === utils_1.AST_NODE_TYPES.Literal && key.value === 'zIndex') ||
+    (key.type === utils_1.AST_NODE_TYPES.Literal && key.value === 'z-index');
+exports.default = (0, createRule_1.createRule)({
+    create(context) {
+        return {
+            // Style objects: `{ zIndex: 1 }` / `{ 'z-index': 1 }`
+            Property(node) {
+                if (isZIndexKey(node.key) && isNumericLiteral(node.value)) {
+                    context.report({ messageId: 'noRawZIndex', node: node.value });
+                }
+            },
+            // JSX props: `<Box zIndex={1} />`
+            JSXAttribute(node) {
+                if (node.name.type === utils_1.AST_NODE_TYPES.JSXIdentifier &&
+                    node.name.name === 'zIndex' &&
+                    node.value?.type === utils_1.AST_NODE_TYPES.JSXExpressionContainer &&
+                    isNumericLiteral(node.value.expression)) {
+                    context.report({ messageId: 'noRawZIndex', node: node.value });
+                }
+            },
+        };
+    },
+    defaultOptions: [],
+    meta: {
+        docs: {
+            description: 'Discourage raw numeric z-index values which can lead to z-index stacking issues and encourage usage of semantic tokens from the `zIndices` scale.',
+            recommended: 'error',
+        },
+        messages: {
+            noRawZIndex: 'Semantic tokens from the `zIndices` scale (e.g. `zIndices.modal`) are recommendedinstead of a raw z-index number. For a deliberate in-between value, disable this rule inline with a justifying comment.',
+        },
+        type: 'suggestion',
+        schema: [],
+    },
+    name: 'no-raw-z-index',
+});
+//# sourceMappingURL=no-raw-z-index.js.map

package/dist/no-raw-z-index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"no-raw-z-index.js","sourceRoot":"","sources":["../src/no-raw-z-index.ts"],"names":[],"mappings":";;AAAA,oDAAoE;AAEpE,6CAA0C;AAE1C;;GAEG;AACH,MAAM,gBAAgB,GAAG,CAAC,IAAsC,EAAW,EAAE;IAC3E,IAAI,CAAC,IAAI;QAAE,OAAO,KAAK,CAAC;IACxB,IAAI,IAAI,CAAC,IAAI,KAAK,sBAAc,CAAC,OAAO,IAAI,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC3E,OAAO,IAAI,CAAC;IACd,CAAC;IACD,OAAO,CACL,IAAI,CAAC,IAAI,KAAK,sBAAc,CAAC,eAAe;QAC5C,CAAC,IAAI,CAAC,QAAQ,KAAK,GAAG,IAAI,IAAI,CAAC,QAAQ,KAAK,GAAG,CAAC;QAChD,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAChC,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,GAAkB,EAAW,EAAE,CAClD,CAAC,GAAG,CAAC,IAAI,KAAK,sBAAc,CAAC,UAAU,IAAI,GAAG,CAAC,IAAI,KAAK,QAAQ,CAAC;IACjE,CAAC,GAAG,CAAC,IAAI,KAAK,sBAAc,CAAC,OAAO,IAAI,GAAG,CAAC,KAAK,KAAK,QAAQ,CAAC;IAC/D,CAAC,GAAG,CAAC,IAAI,KAAK,sBAAc,CAAC,OAAO,IAAI,GAAG,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC;AAEnE,kBAAe,IAAA,uBAAU,EAAC;IACxB,MAAM,CAAC,OAAO;QACZ,OAAO;YACL,sDAAsD;YACtD,QAAQ,CAAC,IAAI;gBACX,IAAI,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;oBAC1D,OAAO,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,aAAa,EAAE,IAAI,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;gBACjE,CAAC;YACH,CAAC;YACD,kCAAkC;YAClC,YAAY,CAAC,IAAI;gBACf,IACE,IAAI,CAAC,IAAI,CAAC,IAAI,KAAK,sBAAc,CAAC,aAAa;oBAC/C,IAAI,CAAC,IAAI,CAAC,IAAI,KAAK,QAAQ;oBAC3B,IAAI,CAAC,KAAK,EAAE,IAAI,KAAK,sBAAc,CAAC,sBAAsB;oBAC1D,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,UAA2B,CAAC,EACxD,CAAC;oBACD,OAAO,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,aAAa,EAAE,IAAI,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;gBACjE,CAAC;YACH,CAAC;SACF,CAAC;IACJ,CAAC;IACD,cAAc,EAAE,EAAE;IAClB,IAAI,EAAE;QACJ,IAAI,EAAE;YACJ,WAAW,EACT,mJAAmJ;YACrJ,WAAW,EAAE,OAAO;SACrB;QACD,QAAQ,EAAE;YACR,WAAW,EACT,0MAA0M;SAC7M;QACD,IAAI,EAAE,YAAY;QAClB,MAAM,EAAE,EAAE;KACX;IACD,IAAI,EAAE,gBAAgB;CACvB,CAAC,CAAC"}

package/dist/recommended.d.ts

@@ -2,6 +2,7 @@ declare const _default: {
     rules: {
         'gamut/no-css-standalone': string;
         'gamut/no-inline-style': string;
+        'gamut/no-raw-z-index': string;
         'gamut/prefer-themed': string;
         'gamut/gamut-import-paths': string;
     };

package/dist/recommended.js

@@ -4,6 +4,7 @@ exports.default = {
     rules: {
         'gamut/no-css-standalone': 'error',
         'gamut/no-inline-style': 'error',
+        'gamut/no-raw-z-index': 'error',
         'gamut/prefer-themed': 'off',
         'gamut/gamut-import-paths': 'error',
     },

package/dist/recommended.js.map

@@ -1 +1 @@
-{"version":3,"file":"recommended.js","sourceRoot":"","sources":["../src/recommended.ts"],"names":[],"mappings":";;AAAA,kBAAe;IACb,KAAK,EAAE;QACL,yBAAyB,EAAE,OAAO;QAClC,uBAAuB,EAAE,OAAO;QAChC,qBAAqB,EAAE,KAAK;QAC5B,0BAA0B,EAAE,OAAO;KACpC;CACF,CAAC"}
+{"version":3,"file":"recommended.js","sourceRoot":"","sources":["../src/recommended.ts"],"names":[],"mappings":";;AAAA,kBAAe;IACb,KAAK,EAAE;QACL,yBAAyB,EAAE,OAAO;QAClC,uBAAuB,EAAE,OAAO;QAChC,sBAAsB,EAAE,OAAO;QAC/B,qBAAqB,EAAE,KAAK;QAC5B,0BAA0B,EAAE,OAAO;KACpC;CACF,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "eslint-plugin-gamut",
   "description": "Shared eslint plugin for Gamut applications",
-  "version": "2.4.4-alpha.e3cc4a.0",
+  "version": "2.4.4-alpha.e426ef.0",
   "author": "Codecademy Engineering <dev@codecademy.com>",
   "dependencies": {
     "@typescript-eslint/utils": "^5.15.0"