Merge pull request #46 from CodeshiftCommunity/presets

Presets

Author: danieldelcore

.changeset/dull-experts-lie.md

@@ -0,0 +1,5 @@
+---
+'@codeshift/cli': minor
+---
+
+CLI now supports the concept of presets, for cases where non-versioned codemods are necessary. Also exposes the cli binary as @codeshift/cli

community/@atlaskit__breadcrumbs/11.0.0/_tests_/elevate-stateless-to-default.spec.ts renamed to community/@atlaskit__breadcrumbs/11.0.0/__tests__/elevate-stateless-to-default.spec.ts

@@ -3,4 +3,7 @@ export default {
   transforms: {
     '11.0.0': require.resolve('./11.0.0/transform'),
   },
+  presets: {
+    'styled-to-emotion-10': require.resolve('./styled-to-emotion-10/transform'),
+  },
 };

community/@atlaskit__breadcrumbs/11.0.0/_tests_/remove-has-separator.spec.ts renamed to community/@atlaskit__breadcrumbs/11.0.0/__tests__/remove-has-separator.spec.ts

@@ -0,0 +1,68 @@
+jest.autoMockOff();
+
+const defineInlineTest = require('jscodeshift/dist/testUtils').defineInlineTest;
+
+import transformer from './transform';
+
+describe('Transform import', () => {
+  defineInlineTest(
+    { default: transformer, parser: 'tsx' },
+    {},
+    "import styled from 'styled-components';",
+    "import styled from '@emotion/styled';",
+    'it transforms standard styled-component imports',
+  );
+
+  defineInlineTest(
+    { default: transformer, parser: 'tsx' },
+    {},
+    `
+    import styled from 'styled-components';
+    import react from 'react';
+    `,
+    `
+    import styled from '@emotion/styled';
+    import react from 'react';
+    `,
+    'it ignores other imports',
+  );
+
+  defineInlineTest(
+    { default: transformer, parser: 'tsx' },
+    {},
+    "import { keyframes } from 'styled-components';",
+    "import { keyframes } from '@emotion/core';",
+    'it correctly detects misc core imports',
+  );
+
+  defineInlineTest(
+    { default: transformer, parser: 'tsx' },
+    {},
+    "import styled, { css } from 'styled-components';",
+    "import { css } from '@emotion/core';\nimport styled from '@emotion/styled';",
+    'it correctly splits out core and styled imports',
+  );
+
+  defineInlineTest(
+    { default: transformer, parser: 'tsx' },
+    {},
+    "import styled, { ThemeProvider } from 'styled-components';",
+    `
+    import styled from '@emotion/styled';
+import { ThemeProvider } from 'emotion-theming';
+    `,
+    'it correctly splits out core and themed imports',
+  );
+
+  defineInlineTest(
+    { default: transformer, parser: 'tsx' },
+    {},
+    "import styled, { css, ThemeProvider, withTheme } from 'styled-components';",
+    `
+    import { css } from '@emotion/core';
+import styled from '@emotion/styled';
+import { ThemeProvider, withTheme } from 'emotion-theming';
+    `,
+    'it correctly splits out core and multiple themed imports',
+  );
+});

community/@atlaskit__breadcrumbs/11.0.0/_tests_/rename-breadcrumbs.spec.ts renamed to community/@atlaskit__breadcrumbs/11.0.0/__tests__/rename-breadcrumbs.spec.ts

@@ -0,0 +1,97 @@
+import core, {
+  FileInfo,
+  API,
+  ASTPath,
+  ImportDeclaration,
+  ImportSpecifier,
+  Options,
+} from 'jscodeshift';
+
+function buildCoreImportDeclaration(
+  j: core.JSCodeshift,
+  path: ASTPath<ImportDeclaration>,
+) {
+  const coreExports = ['css', 'keyframes'];
+  const specifiers: ImportSpecifier[] = [];
+
+  j(path)
+    .find(j.ImportSpecifier)
+    .filter((specifier: any) =>
+      coreExports.includes(specifier.value.imported.name),
+    )
+    .forEach((specifier: any) => {
+      specifiers.push(
+        j.importSpecifier(j.identifier(specifier.value.imported.name)),
+      );
+    });
+
+  return specifiers.length
+    ? j.importDeclaration(specifiers, j.literal('@emotion/core'))
+    : null;
+}
+
+function buildStyledImportDeclaration(
+  j: core.JSCodeshift,
+  path: ASTPath<ImportDeclaration>,
+) {
+  const specifier = j(path)
+    .find(j.ImportDefaultSpecifier)
+    .filter((specifier: any) => specifier.value.local!.name === 'styled');
+
+  return specifier && specifier.length
+    ? j.importDeclaration(
+        [
+          j.importDefaultSpecifier(
+            j.identifier(specifier.get(0).node.local!.name),
+          ),
+        ],
+        j.literal('@emotion/styled'),
+      )
+    : null;
+}
+
+function buildThemingImportDeclaration(
+  j: core.JSCodeshift,
+  path: ASTPath<ImportDeclaration>,
+) {
+  const themingExports = ['ThemeProvider', 'withTheme'];
+  const specifiers: ImportSpecifier[] = [];
+
+  j(path)
+    .find(j.ImportSpecifier)
+    .filter((specifier: any) =>
+      themingExports.includes(specifier.value.imported.name),
+    )
+    .forEach((specifier: any) => {
+      specifiers.push(
+        j.importSpecifier(j.identifier(specifier.value.imported.name)),
+      );
+    });
+
+  return specifiers && specifiers.length
+    ? j.importDeclaration(specifiers, j.literal('emotion-theming'))
+    : null;
+}
+
+/**
+ * Converts all imports of `styled-components` to `@emotion/styled`
+ */
+export default function transformer(
+  fileInfo: FileInfo,
+  { jscodeshift: j }: API,
+  options: Options,
+) {
+  const source = j(fileInfo.source)
+    .find(j.ImportDeclaration)
+    .filter((path: any) => path.node.source.value === 'styled-components')
+    .forEach((path: any) => {
+      j(path).replaceWith([
+        buildCoreImportDeclaration(j, path),
+        buildStyledImportDeclaration(j, path),
+        buildThemingImportDeclaration(j, path),
+      ]);
+    })
+    .toSource(options.printOptions || { quote: 'single' });
+
+  return source;
+}

community/@atlaskit__breadcrumbs/11.0.0/_tests_/transform.spec.ts renamed to community/@atlaskit__breadcrumbs/11.0.0/__tests__/transform.spec.ts

@@ -7,6 +7,7 @@
   "license": "MIT",
   "repository": "https://github.com/CodeshiftCommunity/CodeshiftCommunity/tree/master/packages/cli",
   "bin": {
+    "@codeshift/cli": "./bin/codeshift-cli.js",
     "codeshift-cli": "./bin/codeshift-cli.js"
   },
   "scripts": {

community/@atlaskit__button/15.0.0/_tests_/transform.spec.ts renamed to community/@atlaskit__button/15.0.0/__tests__/transform.spec.ts

@@ -12,23 +12,16 @@ jest.mock('live-plugin-manager', () => ({
           '19.0.0': `${codemodName}/path/to/19.js`,
           '20.0.0': `${codemodName}/path/to/20.js`,
         },
+        presets: {
+          'update-formatting': `${codemodName}/path/to/update-formatting.js`,
+          'update-imports': `${codemodName}/path/to/update-imports.js`,
+        },
       },
     }),
     uninstallAll: () => Promise.resolve(),
   }),
 }));
 
-// jest.mock('fs-extra', () => ({
-//   readdir: () =>
-//     Promise.resolve([
-//       '18.0.0',
-//       '19.0.0',
-//       '20.0.0',
-//       'codeshift.config.js',
-//       'index.ts',
-//     ]),
-// }));
-
 // @ts-ignore
 import * as jscodeshift from 'jscodeshift/src/Runner';
 
@@ -242,6 +235,25 @@ describe('main', () => {
         expect.any(Object),
       );
     });
+    it('should run multiple transforms of the same package', async () => {
+      await main([mockPath], {
+        packages: '@myscope/[email protected]@19.0.0',
+        parser: 'babel',
+        extensions: 'js',
+      });
+
+      expect(jscodeshift.run).toHaveBeenCalledTimes(2);
+      expect(jscodeshift.run).toHaveBeenCalledWith(
+        '@codeshift/mod-myscope__mylib/path/to/19.js',
+        expect.any(Array),
+        expect.any(Object),
+      );
+      expect(jscodeshift.run).toHaveBeenCalledWith(
+        '@codeshift/mod-myscope__mylib/path/to/20.js',
+        expect.any(Array),
+        expect.any(Object),
+      );
+    });
 
     it('should handle empty package transforms', async () => {
       await main([mockPath], {
@@ -270,7 +282,24 @@ describe('main', () => {
       } catch (error) {
         // @ts-ignore
         expect(error.message).toMatch(
-          'Invalid version provided to the --packages flag. Package mylib@NOT_SEMVER is missing version. Please try: "@[scope]/[package]@[version]" for example @mylib/[email protected]',
+          'Invalid version provided to the --packages flag. Unable to resolve version "NOT_SEMVER" for package "mylib". Please try: "[scope]/[package]@[version]" for example @mylib/[email protected]',
+        );
+      }
+    });
+
+    it('should throw when transform is not found', async () => {
+      expect.assertions(1);
+
+      try {
+        await main([mockPath], {
+          packages: '[email protected]',
+          parser: 'babel',
+          extensions: 'js',
+        });
+      } catch (error) {
+        // @ts-ignore
+        expect(error.message).toMatch(
+          'Invalid version provided to the --packages flag. Unable to resolve version "120.0.0" for package "mylib"',
         );
       }
     });
@@ -299,4 +328,93 @@ describe('main', () => {
       );
     });
   });
+
+  describe('when running presets with the -p flag', () => {
+    it('should run single preset', async () => {
+      await main([mockPath], {
+        packages: 'mylib#update-formatting',
+        parser: 'babel',
+        extensions: 'js',
+      });
+
+      expect(jscodeshift.run).toHaveBeenCalledTimes(1);
+      expect(jscodeshift.run).toHaveBeenCalledWith(
+        '@codeshift/mod-mylib/path/to/update-formatting.js',
+        expect.arrayContaining([mockPath]),
+        expect.objectContaining({
+          parser: 'babel',
+          extensions: 'js',
+        }),
+      );
+    });
+
+    it('should run multiple presets', async () => {
+      await main([mockPath], {
+        packages: 'mylib#update-formatting,mylib#update-imports',
+        parser: 'babel',
+        extensions: 'js',
+      });
+
+      expect(jscodeshift.run).toHaveBeenCalledTimes(2);
+      expect(jscodeshift.run).toHaveBeenCalledWith(
+        '@codeshift/mod-mylib/path/to/update-formatting.js',
+        expect.arrayContaining([mockPath]),
+        expect.objectContaining({
+          parser: 'babel',
+          extensions: 'js',
+        }),
+      );
+      expect(jscodeshift.run).toHaveBeenCalledWith(
+        '@codeshift/mod-mylib/path/to/update-imports.js',
+        expect.arrayContaining([mockPath]),
+        expect.objectContaining({
+          parser: 'babel',
+          extensions: 'js',
+        }),
+      );
+    });
+
+    it('should run multiple presets of the same package', async () => {
+      await main([mockPath], {
+        packages: 'mylib#update-formatting#update-imports',
+        parser: 'babel',
+        extensions: 'js',
+      });
+
+      expect(jscodeshift.run).toHaveBeenCalledTimes(2);
+      expect(jscodeshift.run).toHaveBeenCalledWith(
+        '@codeshift/mod-mylib/path/to/update-formatting.js',
+        expect.arrayContaining([mockPath]),
+        expect.objectContaining({
+          parser: 'babel',
+          extensions: 'js',
+        }),
+      );
+      expect(jscodeshift.run).toHaveBeenCalledWith(
+        '@codeshift/mod-mylib/path/to/update-imports.js',
+        expect.arrayContaining([mockPath]),
+        expect.objectContaining({
+          parser: 'babel',
+          extensions: 'js',
+        }),
+      );
+    });
+
+    it('should throw when preset is not found', async () => {
+      expect.assertions(1);
+
+      try {
+        await main([mockPath], {
+          packages: 'mylib#does-not-exist',
+          parser: 'babel',
+          extensions: 'js',
+        });
+      } catch (error) {
+        // @ts-ignore
+        expect(error.message).toMatch(
+          'Invalid preset provided to the --packages flag. Unable to resolve preset "does-not-exist" for package "mylib"',
+        );
+      }
+    });
+  });
 });