@atlaskit/eslint-plugin-design-system 8.37.3 → 8.38.0

package/dist/esm/rules/use-tokens-space/transformers/style-property/style-map.js

@@ -0,0 +1,73 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+var _tokenMap;
+// TODO: https://product-fabric.atlassian.net/browse/DSP-16054
+var tokenMap = (_tokenMap = {
+  '-2px': 'space.negative.025',
+  '-4px': 'space.negative.050',
+  '-6px': 'space.negative.075',
+  '-8px': 'space.negative.100',
+  '-12px': 'space.negative.150',
+  '-16px': 'space.negative.200',
+  '-20px': 'space.negative.250',
+  '-24px': 'space.negative.300',
+  '-32px': 'space.negative.400'
+}, _defineProperty(_tokenMap, -2, 'space.negative.025'), _defineProperty(_tokenMap, -4, 'space.negative.050'), _defineProperty(_tokenMap, -6, 'space.negative.075'), _defineProperty(_tokenMap, -8, 'space.negative.100'), _defineProperty(_tokenMap, -12, 'space.negative.150'), _defineProperty(_tokenMap, -16, 'space.negative.200'), _defineProperty(_tokenMap, -20, 'space.negative.250'), _defineProperty(_tokenMap, -24, 'space.negative.300'), _defineProperty(_tokenMap, -32, 'space.negative.400'), _defineProperty(_tokenMap, '2px', 'space.025'), _defineProperty(_tokenMap, '4px', 'space.050'), _defineProperty(_tokenMap, '6px', 'space.075'), _defineProperty(_tokenMap, '8px', 'space.100'), _defineProperty(_tokenMap, '12px', 'space.150'), _defineProperty(_tokenMap, '16px', 'space.200'), _defineProperty(_tokenMap, '20px', 'space.250'), _defineProperty(_tokenMap, '24px', 'space.300'), _defineProperty(_tokenMap, '32px', 'space.400'), _defineProperty(_tokenMap, '40px', 'space.500'), _defineProperty(_tokenMap, '48px', 'space.600'), _defineProperty(_tokenMap, '64px', 'space.800'), _defineProperty(_tokenMap, '80px', 'space.1000'), _defineProperty(_tokenMap, 2, 'space.025'), _defineProperty(_tokenMap, 4, 'space.050'), _defineProperty(_tokenMap, 6, 'space.075'), _defineProperty(_tokenMap, 8, 'space.100'), _defineProperty(_tokenMap, 12, 'space.150'), _defineProperty(_tokenMap, 16, 'space.200'), _defineProperty(_tokenMap, 20, 'space.250'), _defineProperty(_tokenMap, 24, 'space.300'), _defineProperty(_tokenMap, 32, 'space.400'), _defineProperty(_tokenMap, 40, 'space.500'), _defineProperty(_tokenMap, 48, 'space.600'), _defineProperty(_tokenMap, 64, 'space.800'), _defineProperty(_tokenMap, 80, 'space.1000'), _defineProperty(_tokenMap, '-0.125rem', 'space.negative.025'), _defineProperty(_tokenMap, '-0.25rem', 'space.negative.050'), _defineProperty(_tokenMap, '-0.375rem', 'space.negative.075'), _defineProperty(_tokenMap, '-0.5rem', 'space.negative.100'), _defineProperty(_tokenMap, '-0.75rem', 'space.negative.150'), _defineProperty(_tokenMap, '-1rem', 'space.negative.200'), _defineProperty(_tokenMap, '-1.25rem', 'space.negative.250'), _defineProperty(_tokenMap, '-1.5rem', 'space.negative.300'), _defineProperty(_tokenMap, '-2rem', 'space.negative.400'), _defineProperty(_tokenMap, '0.125rem', 'space.025'), _defineProperty(_tokenMap, '0.25rem', 'space.050'), _defineProperty(_tokenMap, '0.375rem', 'space.075'), _defineProperty(_tokenMap, '0.5rem', 'space.100'), _defineProperty(_tokenMap, '0.75rem', 'space.150'), _defineProperty(_tokenMap, '1rem', 'space.200'), _defineProperty(_tokenMap, '1.25rem', 'space.250'), _defineProperty(_tokenMap, '1.5rem', 'space.300'), _defineProperty(_tokenMap, '2rem', 'space.400'), _defineProperty(_tokenMap, '2.5rem', 'space.500'), _defineProperty(_tokenMap, '3rem', 'space.600'), _defineProperty(_tokenMap, '4rem', 'space.800'), _defineProperty(_tokenMap, '5rem', 'space.1000'), _defineProperty(_tokenMap, '-0.125em', 'space.negative.025'), _defineProperty(_tokenMap, '-0.25em', 'space.negative.050'), _defineProperty(_tokenMap, '-0.375em', 'space.negative.075'), _defineProperty(_tokenMap, '-0.5em', 'space.negative.100'), _defineProperty(_tokenMap, '-0.75em', 'space.negative.150'), _defineProperty(_tokenMap, '-1em', 'space.negative.200'), _defineProperty(_tokenMap, '-1.25em', 'space.negative.250'), _defineProperty(_tokenMap, '-1.5em', 'space.negative.300'), _defineProperty(_tokenMap, '-2em', 'space.negative.400'), _defineProperty(_tokenMap, '0.125em', 'space.025'), _defineProperty(_tokenMap, '0.25em', 'space.050'), _defineProperty(_tokenMap, '0.375em', 'space.075'), _defineProperty(_tokenMap, '0.5em', 'space.100'), _defineProperty(_tokenMap, '0.75em', 'space.150'), _defineProperty(_tokenMap, '1em', 'space.200'), _defineProperty(_tokenMap, '1.25em', 'space.250'), _defineProperty(_tokenMap, '1.5em', 'space.300'), _defineProperty(_tokenMap, '2em', 'space.400'), _defineProperty(_tokenMap, '2.5em', 'space.500'), _defineProperty(_tokenMap, '3em', 'space.600'), _defineProperty(_tokenMap, '4em', 'space.800'), _defineProperty(_tokenMap, '5em', 'space.1000'), _tokenMap);
+export var styleMap = {
+  'column-gap': tokenMap,
+  columnGap: tokenMap,
+  gap: tokenMap,
+  'grid-column-gap': tokenMap,
+  'grid-row-gap': tokenMap,
+  gridColumnGap: tokenMap,
+  gridRowGap: tokenMap,
+  'margin-block-end': tokenMap,
+  'margin-block-start': tokenMap,
+  'margin-block': tokenMap,
+  'margin-bottom': tokenMap,
+  'margin-inline-end': tokenMap,
+  'margin-inline-start': tokenMap,
+  'margin-inline': tokenMap,
+  'margin-left': tokenMap,
+  'margin-right': tokenMap,
+  'margin-top': tokenMap,
+  'outline-offset': tokenMap,
+  outlineOffset: tokenMap,
+  'padding-block-end': tokenMap,
+  'padding-block-start': tokenMap,
+  'padding-block': tokenMap,
+  'padding-bottom': tokenMap,
+  'padding-inline-end': tokenMap,
+  'padding-inline-start': tokenMap,
+  'padding-inline': tokenMap,
+  'padding-left': tokenMap,
+  'padding-right': tokenMap,
+  'padding-top': tokenMap,
+  'row-gap': tokenMap,
+  rowGap: tokenMap,
+  margin: tokenMap,
+  marginBlock: tokenMap,
+  marginBlockEnd: tokenMap,
+  marginBlockStart: tokenMap,
+  marginBottom: tokenMap,
+  marginInline: tokenMap,
+  marginInlineEnd: tokenMap,
+  marginInlineStart: tokenMap,
+  marginLeft: tokenMap,
+  marginRight: tokenMap,
+  marginTop: tokenMap,
+  padding: tokenMap,
+  paddingBlock: tokenMap,
+  paddingBlockEnd: tokenMap,
+  paddingBlockStart: tokenMap,
+  paddingBottom: tokenMap,
+  paddingInline: tokenMap,
+  paddingInlineEnd: tokenMap,
+  paddingInlineStart: tokenMap,
+  paddingLeft: tokenMap,
+  paddingRight: tokenMap,
+  paddingTop: tokenMap
+  // bottom: tokenMap,
+  // left: tokenMap,
+  // right: tokenMap,
+  // top: tokenMap,
+};

package/dist/esm/rules/use-tokens-space/transformers/style-property/supported.js

@@ -0,0 +1,8 @@
+export default {
+  values: {
+    ignore: ['auto', 'initial', 'inherit', 'unset', 'revert', 'revert-layer', 'none',
+    // outline-offset can be set to none
+    // Currently the DST opinion is that 0 is valid. It doesn't need to be converted to `space.0`
+    0, '0', '0px', '0em', '0rem']
+  }
+};

package/dist/esm/rules/use-tokens-space/transformers/style-property/upsert-import-declaration.js

@@ -0,0 +1,29 @@
+import * as ast from '../../../../ast-nodes';
+
+/**
+ * Currently this is defined here because it's not very general purpose.
+ * If we were to move this to `ast-nodes`, half the implementation would be in `Root`,
+ * and the other half would be in `Import`.
+ *
+ * TODO: Refactor and move to `ast-nodes`
+ *
+ * Note: It does not handle default imports, namespace imports, or aliased imports.
+ */
+export var upsertImportDeclaration = function upsertImportDeclaration(_ref, context, fixer) {
+  var module = _ref.module,
+    specifiers = _ref.specifiers;
+  // Find any imports that match the packageName
+  var root = context.getSourceCode().ast.body;
+  var importDeclarations = ast.Root.findImportsByModule(root, module);
+
+  // The import doesn't exist yet, we can just insert a whole new one
+  if (importDeclarations.length === 0) {
+    return ast.Root.insertImport(root, {
+      module: module,
+      specifiers: specifiers
+    }, fixer);
+  }
+
+  // The import exists so, modify the existing one
+  return ast.Import.insertNamedSpecifiers(importDeclarations[0], specifiers, fixer);
+};

package/dist/esm/rules/use-tokens-space/utils/index.js

@@ -0,0 +1 @@
+export { isStringOrNumber } from './is-string-or-number';

package/dist/esm/rules/use-tokens-space/utils/is-string-or-number.js

@@ -0,0 +1,3 @@
+export var isStringOrNumber = function isStringOrNumber(value) {
+  return typeof value === 'string' || typeof value === 'number';
+};

package/dist/types/ast-nodes/object-entry.d.ts

@@ -1,7 +1,17 @@
 import type { Rule } from 'eslint';
 import { Property, SpreadElement } from 'eslint-codemod-utils';
-declare const ObjectEntry: {
+export declare const ObjectEntry: {
+    getProperty(node: Property): {
+        type: 'Identifier';
+        value: string;
+    } | {
+        type: 'Literal';
+        value: string;
+    } | {
+        type: undefined;
+        value: undefined;
+    };
+    getValue(node: Property): string | number | bigint | true | RegExp | undefined;
     deleteEntry(node: Property | SpreadElement, context: Rule.RuleContext, fixer: Rule.RuleFixer): Rule.Fix;
     getPropertyName(node: Property | SpreadElement): string | undefined;
 };
-export { ObjectEntry };

package/dist/types/ast-nodes/object.d.ts

@@ -48,5 +48,6 @@ declare const ASTObjectExpression: {
      * Will result in `{ padding: 'space.100', margin: 'space.200'}`.
      */
     appendEntry(node: ObjectExpression, key: string, value: string, fixer: Rule.RuleFixer): Rule.Fix;
+    recurse(node: ObjectExpression, callback: Function): void;
 };
 export { ASTObjectExpression as Object };

package/dist/types/index.codegen.d.ts

@@ -32,6 +32,7 @@ export declare const configs: {
             '@atlaskit/design-system/use-href-in-link-item': string;
             '@atlaskit/design-system/use-primitives': string;
             '@atlaskit/design-system/use-primitives-text': string;
+            '@atlaskit/design-system/use-tokens-space': string;
             '@atlaskit/design-system/use-tokens-typography': string;
             '@atlaskit/design-system/use-visually-hidden': string;
         };

package/dist/types/presets/all.codegen.d.ts

@@ -1,6 +1,6 @@
 /**
  * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
- * @codegen <<SignedSource::d90c2cf5e100daf98915f9467f2e5663>>
+ * @codegen <<SignedSource::d95217b658f807294de3c81123068bf1>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 declare const _default: {
@@ -35,6 +35,7 @@ declare const _default: {
         '@atlaskit/design-system/use-href-in-link-item': string;
         '@atlaskit/design-system/use-primitives': string;
         '@atlaskit/design-system/use-primitives-text': string;
+        '@atlaskit/design-system/use-tokens-space': string;
         '@atlaskit/design-system/use-tokens-typography': string;
         '@atlaskit/design-system/use-visually-hidden': string;
     };

package/dist/types/rules/index.codegen.d.ts

@@ -32,6 +32,7 @@ declare const _default: {
     'use-href-in-link-item': import("eslint").Rule.RuleModule;
     'use-primitives': import("eslint").Rule.RuleModule;
     'use-primitives-text': import("eslint").Rule.RuleModule;
+    'use-tokens-space': import("eslint").Rule.RuleModule;
     'use-tokens-typography': import("eslint").Rule.RuleModule;
     'use-visually-hidden': import("eslint").Rule.RuleModule;
 };

package/dist/types/rules/use-tokens-space/index.d.ts

@@ -0,0 +1,3 @@
+import type { Rule } from 'eslint';
+declare const rule: Rule.RuleModule;
+export default rule;

package/dist/types/rules/use-tokens-space/transformers/index.d.ts

@@ -0,0 +1 @@
+export { StyleProperty } from './style-property';

package/dist/types/rules/use-tokens-space/transformers/style-property/index.d.ts

@@ -0,0 +1,26 @@
+import type { Rule } from 'eslint';
+import { Property } from 'eslint-codemod-utils';
+type Ref = {
+    node: Property;
+    token?: string;
+    fallback?: string | number;
+};
+type Check = {
+    success: false;
+    ref: undefined;
+} | {
+    success: true;
+    ref: Ref;
+};
+export declare const StyleProperty: {
+    lint(node: Rule.Node, { context }: {
+        context: Rule.RuleContext;
+    }): void;
+    _check(node: Rule.Node): Check;
+    /**
+     * All required validation steps have been taken care of before this
+     * transformer is called, so it just goes ahead providing all necessary fixes
+     */
+    _fix(ref: Ref, context: Rule.RuleContext): (fixer: Rule.RuleFixer) => Rule.Fix[];
+};
+export {};

package/dist/types/rules/use-tokens-space/transformers/style-property/style-map.d.ts

@@ -0,0 +1,7 @@
+declare const tokenMap: {
+    [key: string]: string;
+};
+export declare const styleMap: {
+    [key: string]: typeof tokenMap;
+};
+export {};

package/dist/types/rules/use-tokens-space/transformers/style-property/supported.d.ts

@@ -0,0 +1,6 @@
+declare const _default: {
+    values: {
+        ignore: (string | number)[];
+    };
+};
+export default _default;

package/dist/types/rules/use-tokens-space/transformers/style-property/upsert-import-declaration.d.ts

@@ -0,0 +1,14 @@
+import type { Rule } from 'eslint';
+/**
+ * Currently this is defined here because it's not very general purpose.
+ * If we were to move this to `ast-nodes`, half the implementation would be in `Root`,
+ * and the other half would be in `Import`.
+ *
+ * TODO: Refactor and move to `ast-nodes`
+ *
+ * Note: It does not handle default imports, namespace imports, or aliased imports.
+ */
+export declare const upsertImportDeclaration: ({ module, specifiers, }: {
+    module: string;
+    specifiers: string[];
+}, context: Rule.RuleContext, fixer: Rule.RuleFixer) => Rule.Fix | undefined;

package/dist/types/rules/use-tokens-space/utils/index.d.ts

@@ -0,0 +1 @@
+export { isStringOrNumber } from './is-string-or-number';

package/dist/types/rules/use-tokens-space/utils/is-string-or-number.d.ts

@@ -0,0 +1 @@
+export declare const isStringOrNumber: (value: string | number | bigint | true | RegExp | undefined) => value is string | number;

package/dist/types-ts4.5/ast-nodes/object-entry.d.ts

@@ -1,7 +1,17 @@
 import type { Rule } from 'eslint';
 import { Property, SpreadElement } from 'eslint-codemod-utils';
-declare const ObjectEntry: {
+export declare const ObjectEntry: {
+    getProperty(node: Property): {
+        type: 'Identifier';
+        value: string;
+    } | {
+        type: 'Literal';
+        value: string;
+    } | {
+        type: undefined;
+        value: undefined;
+    };
+    getValue(node: Property): string | number | bigint | true | RegExp | undefined;
     deleteEntry(node: Property | SpreadElement, context: Rule.RuleContext, fixer: Rule.RuleFixer): Rule.Fix;
     getPropertyName(node: Property | SpreadElement): string | undefined;
 };
-export { ObjectEntry };

package/dist/types-ts4.5/ast-nodes/object.d.ts

@@ -48,5 +48,6 @@ declare const ASTObjectExpression: {
      * Will result in `{ padding: 'space.100', margin: 'space.200'}`.
      */
     appendEntry(node: ObjectExpression, key: string, value: string, fixer: Rule.RuleFixer): Rule.Fix;
+    recurse(node: ObjectExpression, callback: Function): void;
 };
 export { ASTObjectExpression as Object };

package/dist/types-ts4.5/index.codegen.d.ts

@@ -32,6 +32,7 @@ export declare const configs: {
             '@atlaskit/design-system/use-href-in-link-item': string;
             '@atlaskit/design-system/use-primitives': string;
             '@atlaskit/design-system/use-primitives-text': string;
+            '@atlaskit/design-system/use-tokens-space': string;
             '@atlaskit/design-system/use-tokens-typography': string;
             '@atlaskit/design-system/use-visually-hidden': string;
         };

package/dist/types-ts4.5/presets/all.codegen.d.ts

@@ -1,6 +1,6 @@
 /**
  * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
- * @codegen <<SignedSource::d90c2cf5e100daf98915f9467f2e5663>>
+ * @codegen <<SignedSource::d95217b658f807294de3c81123068bf1>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 declare const _default: {
@@ -35,6 +35,7 @@ declare const _default: {
         '@atlaskit/design-system/use-href-in-link-item': string;
         '@atlaskit/design-system/use-primitives': string;
         '@atlaskit/design-system/use-primitives-text': string;
+        '@atlaskit/design-system/use-tokens-space': string;
         '@atlaskit/design-system/use-tokens-typography': string;
         '@atlaskit/design-system/use-visually-hidden': string;
     };

package/dist/types-ts4.5/rules/index.codegen.d.ts

@@ -36,6 +36,7 @@ declare const _default: {
     'use-href-in-link-item': import("eslint").Rule.RuleModule;
     'use-primitives': import("eslint").Rule.RuleModule;
     'use-primitives-text': import("eslint").Rule.RuleModule;
+    'use-tokens-space': import("eslint").Rule.RuleModule;
     'use-tokens-typography': import("eslint").Rule.RuleModule;
     'use-visually-hidden': import("eslint").Rule.RuleModule;
 };

package/dist/types-ts4.5/rules/use-tokens-space/index.d.ts

@@ -0,0 +1,3 @@
+import type { Rule } from 'eslint';
+declare const rule: Rule.RuleModule;
+export default rule;

package/dist/types-ts4.5/rules/use-tokens-space/transformers/index.d.ts

@@ -0,0 +1 @@
+export { StyleProperty } from './style-property';

package/dist/types-ts4.5/rules/use-tokens-space/transformers/style-property/index.d.ts

@@ -0,0 +1,26 @@
+import type { Rule } from 'eslint';
+import { Property } from 'eslint-codemod-utils';
+type Ref = {
+    node: Property;
+    token?: string;
+    fallback?: string | number;
+};
+type Check = {
+    success: false;
+    ref: undefined;
+} | {
+    success: true;
+    ref: Ref;
+};
+export declare const StyleProperty: {
+    lint(node: Rule.Node, { context }: {
+        context: Rule.RuleContext;
+    }): void;
+    _check(node: Rule.Node): Check;
+    /**
+     * All required validation steps have been taken care of before this
+     * transformer is called, so it just goes ahead providing all necessary fixes
+     */
+    _fix(ref: Ref, context: Rule.RuleContext): (fixer: Rule.RuleFixer) => Rule.Fix[];
+};
+export {};

package/dist/types-ts4.5/rules/use-tokens-space/transformers/style-property/style-map.d.ts

@@ -0,0 +1,7 @@
+declare const tokenMap: {
+    [key: string]: string;
+};
+export declare const styleMap: {
+    [key: string]: typeof tokenMap;
+};
+export {};

package/dist/types-ts4.5/rules/use-tokens-space/transformers/style-property/supported.d.ts

@@ -0,0 +1,6 @@
+declare const _default: {
+    values: {
+        ignore: (string | number)[];
+    };
+};
+export default _default;

package/dist/types-ts4.5/rules/use-tokens-space/transformers/style-property/upsert-import-declaration.d.ts

@@ -0,0 +1,14 @@
+import type { Rule } from 'eslint';
+/**
+ * Currently this is defined here because it's not very general purpose.
+ * If we were to move this to `ast-nodes`, half the implementation would be in `Root`,
+ * and the other half would be in `Import`.
+ *
+ * TODO: Refactor and move to `ast-nodes`
+ *
+ * Note: It does not handle default imports, namespace imports, or aliased imports.
+ */
+export declare const upsertImportDeclaration: ({ module, specifiers, }: {
+    module: string;
+    specifiers: string[];
+}, context: Rule.RuleContext, fixer: Rule.RuleFixer) => Rule.Fix | undefined;

package/dist/types-ts4.5/rules/use-tokens-space/utils/index.d.ts

@@ -0,0 +1 @@
+export { isStringOrNumber } from './is-string-or-number';

package/dist/types-ts4.5/rules/use-tokens-space/utils/is-string-or-number.d.ts

@@ -0,0 +1 @@
+export declare const isStringOrNumber: (value: string | number | bigint | true | RegExp | undefined) => value is string | number;

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": "8.37.3",
+  "version": "8.38.0",
   "author": "Atlassian Pty Ltd",
   "license": "Apache-2.0",
   "publishConfig": {