@atlaskit/icon-object 6.3.9 → 6.5.0

package/build/index.tsx

@@ -7,39 +7,39 @@ import fs from 'fs-extra';
 const root = pkgDir.sync();
 
 const config16: IconBuildConfig = {
-  srcDir: path.resolve(root!, 'svgs_raw'),
-  processedDir: path.resolve(root!, 'svgs'),
-  destDir: path.resolve(root!, 'glyph'),
-  maxWidth: 16,
-  maxHeight: 16,
-  glob: '**/16.svg',
-  size: 'small',
-  baseIconEntryPoint: '@atlaskit/icon/base',
-  isColorsDisabled: true,
+	srcDir: path.resolve(root!, 'svgs_raw'),
+	processedDir: path.resolve(root!, 'svgs'),
+	destDir: path.resolve(root!, 'glyph'),
+	maxWidth: 16,
+	maxHeight: 16,
+	glob: '**/16.svg',
+	size: 'small',
+	baseIconEntryPoint: '@atlaskit/icon/base',
+	isColorsDisabled: true,
 };
 
 const config24: IconBuildConfig = {
-  srcDir: path.resolve(root!, 'svgs_raw'),
-  processedDir: path.resolve(root!, 'svgs'),
-  destDir: path.resolve(root!, 'glyph'),
-  maxWidth: 24,
-  maxHeight: 24,
-  glob: '**/24.svg',
-  size: 'medium',
-  baseIconEntryPoint: '@atlaskit/icon/base',
-  isColorsDisabled: true,
+	srcDir: path.resolve(root!, 'svgs_raw'),
+	processedDir: path.resolve(root!, 'svgs'),
+	destDir: path.resolve(root!, 'glyph'),
+	maxWidth: 24,
+	maxHeight: 24,
+	glob: '**/24.svg',
+	size: 'medium',
+	baseIconEntryPoint: '@atlaskit/icon/base',
+	isColorsDisabled: true,
 };
 
 tidy(config16)
-  .then(() => Promise.all([build(config16), build(config24)]))
-  .then(([sixteen, twentyfour]) => {
-    const allIcons = [...sixteen, ...twentyfour];
-    const iconDocs = createIconDocs(allIcons, '@atlaskit/icon-object', {}, [
-      'object',
-      'icon-object',
-    ]);
+	.then(() => Promise.all([build(config16), build(config24)]))
+	.then(([sixteen, twentyfour]) => {
+		const allIcons = [...sixteen, ...twentyfour];
+		const iconDocs = createIconDocs(allIcons, '@atlaskit/icon-object', {}, [
+			'object',
+			'icon-object',
+		]);
 
-    console.log('@atlaskit-icon-object built');
+		console.log('@atlaskit-icon-object built');
 
-    return fs.outputFile(path.resolve(root!, 'src/metadata.tsx'), iconDocs);
-  });
+		return fs.outputFile(path.resolve(root!, 'src/metadata.tsx'), iconDocs);
+	});

package/codemods/6.1.0-metadata-entry.tsx

@@ -1,118 +1,111 @@
-import core, {
-  API,
-  FileInfo,
-  ImportSpecifier,
-  ASTPath,
-  ImportDefaultSpecifier,
-  Options,
+import type {
+	API,
+	default as core,
+	FileInfo,
+	ImportSpecifier,
+	ASTPath,
+	ImportDefaultSpecifier,
+	Options,
 } from 'jscodeshift';
-import { Collection } from 'jscodeshift/src/Collection';
+import { type Collection } from 'jscodeshift/src/Collection';
 
 export const packageName = '@atlaskit/icon-object';
 
-export default function transformer(
-  file: FileInfo,
-  api: API,
-  options: Options,
-) {
-  const j = api.jscodeshift;
-  const root = j(file.source, { quote: 'auto' });
-  if (hasImportDeclaration(j, root, packageName)) {
-    const imports = root.find(j.ImportSpecifier, {
-      imported: { name: 'metadata' },
-    });
-    imports.forEach((p: ASTPath<ImportSpecifier | ImportDefaultSpecifier>) => {
-      if (p.parentPath.parentPath.node.source.value !== packageName) {
-        return;
-      }
-      if (p.parentPath.node.specifiers.length === 1) {
-        p.node.type = 'ImportDefaultSpecifier';
-        p.parentPath.node.source.value = `${packageName}/metadata`;
-      } else if (p.node.local) {
-        tryCreateImport({
-          j,
-          base: root,
-          packageName: `${packageName}/metadata`,
-          relativeToPackage: packageName,
-        });
-        addToImport({
-          j,
-          base: root,
-          packageName: `${packageName}/metadata`,
-          importSpecifier: j.importDefaultSpecifier(
-            j.identifier(p.node.local.name),
-          ),
-        });
-        p.replace();
-      }
-    });
-    return root.toSource(options.printOptions || { quote: 'single' });
-  }
-  return file.source;
+export default function transformer(file: FileInfo, api: API, options: Options) {
+	const j = api.jscodeshift;
+	const root = j(file.source, { quote: 'auto' });
+	if (hasImportDeclaration(j, root, packageName)) {
+		const imports = root.find(j.ImportSpecifier, {
+			imported: { name: 'metadata' },
+		});
+		imports.forEach((p: ASTPath<ImportSpecifier | ImportDefaultSpecifier>) => {
+			if (p.parentPath.parentPath.node.source.value !== packageName) {
+				return;
+			}
+			if (p.parentPath.node.specifiers.length === 1) {
+				p.node.type = 'ImportDefaultSpecifier';
+				p.parentPath.node.source.value = `${packageName}/metadata`;
+			} else if (p.node.local) {
+				tryCreateImport({
+					j,
+					base: root,
+					packageName: `${packageName}/metadata`,
+					relativeToPackage: packageName,
+				});
+				addToImport({
+					j,
+					base: root,
+					packageName: `${packageName}/metadata`,
+					importSpecifier: j.importDefaultSpecifier(j.identifier(p.node.local.name)),
+				});
+				p.replace();
+			}
+		});
+		return root.toSource(options.printOptions || { quote: 'single' });
+	}
+	return file.source;
 }
 
 function hasImportDeclaration(
-  j: core.JSCodeshift,
-  source: ReturnType<typeof j>,
-  importPath: string,
+	j: core.JSCodeshift,
+	source: ReturnType<typeof j>,
+	importPath: string,
 ) {
-  return !!source
-    .find(j.ImportDeclaration)
-    .filter((path) => path.node.source.value === importPath).length;
+	return !!source.find(j.ImportDeclaration).filter((path) => path.node.source.value === importPath)
+		.length;
 }
 
 function tryCreateImport({
-  j,
-  base,
-  relativeToPackage,
-  packageName,
+	j,
+	base,
+	relativeToPackage,
+	packageName,
 }: {
-  j: core.JSCodeshift;
-  base: Collection<any>;
-  relativeToPackage: string;
-  packageName: string;
+	j: core.JSCodeshift;
+	base: Collection<any>;
+	relativeToPackage: string;
+	packageName: string;
 }) {
-  const exists: boolean =
-    base
-      .find(j.ImportDeclaration)
-      .filter((path) => path.value.source.value === packageName).length > 0;
+	const exists: boolean =
+		base.find(j.ImportDeclaration).filter((path) => path.value.source.value === packageName)
+			.length > 0;
 
-  if (exists) {
-    return;
-  }
+	if (exists) {
+		return;
+	}
 
-  base
-    .find(j.ImportDeclaration)
-    .filter((path) => path.value.source.value === relativeToPackage)
-    .insertBefore(j.importDeclaration([], j.literal(packageName)));
+	base
+		.find(j.ImportDeclaration)
+		.filter((path) => path.value.source.value === relativeToPackage)
+		.insertBefore(j.importDeclaration([], j.literal(packageName)));
 }
 
 function addToImport({
-  j,
-  base,
-  importSpecifier,
-  packageName,
+	j,
+	base,
+	importSpecifier,
+	packageName,
 }: {
-  j: core.JSCodeshift;
-  base: Collection<any>;
-  importSpecifier: ImportSpecifier | ImportDefaultSpecifier;
-  packageName: string;
+	j: core.JSCodeshift;
+	base: Collection<any>;
+	importSpecifier: ImportSpecifier | ImportDefaultSpecifier;
+	packageName: string;
 }) {
-  base
-    .find(j.ImportDeclaration)
-    .filter((path) => path.value.source.value === packageName)
-    .replaceWith((declaration) => {
-      return j.importDeclaration(
-        [
-          // we are appending to the existing specifiers
-          // We are doing a filter hear because sometimes specifiers can be removed
-          // but they hand around in the declaration
-          ...(declaration.value.specifiers || []).filter(
-            (item) => item.type === 'ImportSpecifier' && item.imported != null,
-          ),
-          importSpecifier,
-        ],
-        j.literal(packageName),
-      );
-    });
+	base
+		.find(j.ImportDeclaration)
+		.filter((path) => path.value.source.value === packageName)
+		.replaceWith((declaration) => {
+			return j.importDeclaration(
+				[
+					// we are appending to the existing specifiers
+					// We are doing a filter hear because sometimes specifiers can be removed
+					// but they hand around in the declaration
+					...(declaration.value.specifiers || []).filter(
+						(item) => item.type === 'ImportSpecifier' && item.imported != null,
+					),
+					importSpecifier,
+				],
+				j.literal(packageName),
+			);
+		});
 }

package/codemods/__tests__/6.1.0-metadata-entry.tsx

@@ -5,122 +5,122 @@ import transformer, { packageName } from '../6.1.0-metadata-entry';
 const defineInlineTest = require('jscodeshift/dist/testUtils').defineInlineTest;
 
 describe('Update imports', () => {
-  defineInlineTest(
-    { default: transformer, parser: 'tsx' },
-    {},
-    `
+	defineInlineTest(
+		{ default: transformer, parser: 'tsx' },
+		{},
+		`
       import { metadata } from '${packageName}';
       console.log(metadata);
     `,
-    `
+		`
       import metadata from '${packageName}/metadata';
       console.log(metadata);
     `,
-    'should replace named metadata import from main entry point with default import from dedicated entry point',
-  );
-  defineInlineTest(
-    { default: transformer, parser: 'tsx' },
-    {},
-    `
+		'should replace named metadata import from main entry point with default import from dedicated entry point',
+	);
+	defineInlineTest(
+		{ default: transformer, parser: 'tsx' },
+		{},
+		`
       import { metadata as data } from '${packageName}';
       console.log(data);
     `,
-    `
+		`
       import data from '${packageName}/metadata';
       console.log(data);
     `,
-    'should preserve renaming when converting from named import to default import',
-  );
-  defineInlineTest(
-    { default: transformer, parser: 'tsx' },
-    {},
-    `
+		'should preserve renaming when converting from named import to default import',
+	);
+	defineInlineTest(
+		{ default: transformer, parser: 'tsx' },
+		{},
+		`
       import { a, metadata, b } from '${packageName}';
       console.log(metadata);
     `,
-    `
+		`
       import metadata from '${packageName}/metadata';
       import { a, b } from '${packageName}';
       console.log(metadata);
     `,
-    'should preserve other named imports',
-  );
-  defineInlineTest(
-    { default: transformer, parser: 'tsx' },
-    {},
-    `
+		'should preserve other named imports',
+	);
+	defineInlineTest(
+		{ default: transformer, parser: 'tsx' },
+		{},
+		`
       import { a, metadata as data, b } from '${packageName}';
       console.log(data);
     `,
-    `
+		`
       import data from '${packageName}/metadata';
       import { a, b } from '${packageName}';
       console.log(data);
     `,
-    'should preserve other named imports, as well as metadata renaming',
-  );
-  defineInlineTest(
-    { default: transformer, parser: 'tsx' },
-    {},
-    `
+		'should preserve other named imports, as well as metadata renaming',
+	);
+	defineInlineTest(
+		{ default: transformer, parser: 'tsx' },
+		{},
+		`
       import Icon, { a, metadata as data, b } from '${packageName}';
       console.log(a, data, b);
     `,
-    `
+		`
       import data from '${packageName}/metadata';
       import Icon, { a, b } from '${packageName}';
       console.log(a, data, b);
     `,
-    'should preserve other named imports and default import, as well as metadata renaming',
-  );
-  defineInlineTest(
-    { default: transformer, parser: 'tsx' },
-    {},
-    `
+		'should preserve other named imports and default import, as well as metadata renaming',
+	);
+	defineInlineTest(
+		{ default: transformer, parser: 'tsx' },
+		{},
+		`
       import metadata from '${packageName}/metadata';
       console.log(metadata);
     `,
-    `
+		`
       import metadata from '${packageName}/metadata';
       console.log(metadata);
     `,
-    'should not affect existing good imports',
-  );
-  defineInlineTest(
-    { default: transformer, parser: 'tsx' },
-    {},
-    `
+		'should not affect existing good imports',
+	);
+	defineInlineTest(
+		{ default: transformer, parser: 'tsx' },
+		{},
+		`
       import { metadata } from 'not-${packageName}';
     `,
-    `
+		`
       import { metadata } from 'not-${packageName}';
     `,
-    'should not affect other packages',
-  );
-  defineInlineTest(
-    { default: transformer, parser: 'tsx' },
-    {},
-    `
+		'should not affect other packages',
+	);
+	defineInlineTest(
+		{ default: transformer, parser: 'tsx' },
+		{},
+		`
       import { metadata } from '${packageName}/foo';
     `,
-    `
+		`
       import { metadata } from '${packageName}/foo';
     `,
-    'should not affect other entrypoints',
-  );
-  defineInlineTest(
-    { default: transformer, parser: 'tsx' },
-    {},
-    `
+		'should not affect other entrypoints',
+	);
+	defineInlineTest(
+		{ default: transformer, parser: 'tsx' },
+		{},
+		`
       import { metadata } from '@atlaskit/icon';
       import { metadata as objectIconMetadata } from '@atlaskit/icon-object';
       import { metadata as fileTypeIconMetadata } from '@atlaskit/icon-file-type';
     `,
-    `
+		`
       import { metadata } from '@atlaskit/icon';
       import objectIconMetadata from '@atlaskit/icon-object/metadata';
       import { metadata as fileTypeIconMetadata } from '@atlaskit/icon-file-type';
     `,
-    'should work as expected on a real-world case',
-  );
+		'should work as expected on a real-world case',
+	);
 });

package/constellation/index/examples.mdx

@@ -11,7 +11,8 @@ import IconObject24 from '../../examples/constellation/icon-object-24.tsx';
 
 Use the small size when space is at a premium.
 
-Elements in this icon are simplified, rearranged or filled in because there is significantly less space.
+Elements in this icon are simplified, rearranged or filled in because there is significantly less
+space.
 
 This icon is designed on a 16px grid and uses 1px strokes.
 

package/constellation/index/icon-explorer.mdx

@@ -6,6 +6,7 @@ import IconExplorer from '@af/icon-explorer';
 
 ## Icon explorer
 
-Search and copy icon import paths from the `@atlaskit/icon-object` package. Select an icon to copy import to clipboard.
+Search and copy icon import paths from the `@atlaskit/icon-object` package. Select an icon to copy
+import to clipboard.
 
 <IconExplorer iconType="object" />

package/constellation/index/usage.mdx

@@ -4,9 +4,11 @@ order: 3
 
 ## Usage
 
-Object icons represent an Atlassian-specific content type. They can trigger actions such as opening a page in Confluence, an issue in Jira, or a pull request in Bitbucket.
+Object icons represent an Atlassian-specific content type. They can trigger actions such as opening
+a page in Confluence, an issue in Jira, or a pull request in Bitbucket.
 
-Unlike a standard icon, object icons help people identify the content type fast. This reduces cognitive load for people across products and platforms.
+Unlike a standard icon, object icons help people identify the content type fast. This reduces
+cognitive load for people across products and platforms.
 
 Object icons can be in:
 
@@ -25,14 +27,17 @@ Object icons can be in:
 
 ### Color
 
-Object icons are assigned specific colors. For cross-product and platform consistency, don’t change the color of the object icon.
+Object icons are assigned specific colors. For cross-product and platform consistency, don’t change
+the color of the object icon.
 
 ## Accessibility
 
 ![Icon Object with tooltip](images/icon-object-tooltip.png)
 
-- Use object icons in combination with a title and meta-information, such as author, creation date, or sub-heading.
-- Pair object icons with [tooltips](/components/tooltip). On hover, the tooltip reveals the specific content type of the icon.
+- Use object icons in combination with a title and meta-information, such as author, creation date,
+  or sub-heading.
+- Pair object icons with [tooltips](/components/tooltip). On hover, the tooltip reveals the specific
+  content type of the icon.
 
 ## Related
 

package/docs/0-intro.tsx

@@ -1,15 +1,14 @@
 import React from 'react';
 
 import { md } from '@atlaskit/docs';
+import Link from '@atlaskit/link';
 import SectionMessage from '@atlaskit/section-message';
 
 export default md`
 ${(
-  <SectionMessage appearance="information">
-    This component is now documented on{' '}
-    <a href="https://atlassian.design/components/icon-object">
-      atlassian.design
-    </a>
-  </SectionMessage>
+	<SectionMessage appearance="information">
+		This component is now documented on{' '}
+		<Link href="https://atlassian.design/components/icon-object">atlassian.design</Link>
+	</SectionMessage>
 )}
 `;

package/metadata/package.json

@@ -6,7 +6,7 @@
   "sideEffects": false,
   "types": "../dist/types/entry-points/metadata.d.ts",
   "typesVersions": {
-    ">=4.5 <4.9": {
+    ">=4.5 <5.4": {
       "*": [
         "../dist/types-ts4.5/entry-points/metadata.d.ts"
       ]