Add prettier && force snapshot tests to use posix paths

Author: shilman

.prettierrc

@@ -0,0 +1,7 @@
+{
+  "printWidth": 100,
+  "tabWidth": 2,
+  "bracketSpacing": true,
+  "trailingComma": "es5",
+  "singleQuote": true
+}

src/index.js

@@ -3,6 +3,7 @@ import * as _ from 'lodash';
 import * as ReactDocgen from 'react-docgen';
 import * as reactDocgenHandlers from 'react-docgen/dist/handlers';
 import actualNameHandler from './actualNameHandler';
+import { relativePath } from './relativePath';
 
 const defaultHandlers = Object.values(reactDocgenHandlers).map(handler => handler);
 
@@ -12,8 +13,8 @@ export default function({ types: t }) {
       Program: {
         exit(path, state) {
           injectReactDocgenInfo(path, state, this.file.code, t);
-        }
-      }
+        },
+      },
     },
   };
 }
@@ -28,22 +29,22 @@ function injectReactDocgenInfo(path, state, code, t) {
       resolver = ReactDocgen.resolver[state.opts.resolver];
     }
 
-    let customHandlers = []
+    let customHandlers = [];
     if (state.opts.handlers) {
       state.opts.handlers.forEach(handler => {
-        customHandlers.push(require(handler))
-      })
+        customHandlers.push(require(handler));
+      });
     }
 
-    const handlers = [...defaultHandlers, ...customHandlers, actualNameHandler]
+    const handlers = [...defaultHandlers, ...customHandlers, actualNameHandler];
     docgenResults = ReactDocgen.parse(code, resolver, handlers);
 
     if (state.opts.removeMethods) {
       docgenResults.forEach(function(docgenResult) {
         delete docgenResult.methods;
-      })
+      });
     }
-  } catch(e) {
+  } catch (e) {
     // this is for debugging the error only, do not ship this console log or else it pollutes the webpack output
     // console.log(e);
     return;
@@ -61,12 +62,13 @@ function injectReactDocgenInfo(path, state, code, t) {
     const docNode = buildObjectExpression(docgenResult, t);
     const docgenInfo = t.expressionStatement(
       t.assignmentExpression(
-        "=",
+        '=',
         t.memberExpression(t.identifier(exportName), t.identifier('__docgenInfo')),
         docNode
-      ));
+      )
+    );
 
-    const exportPath = program.get('body').find((node) => isExportCurrent(node, exportName, t));
+    const exportPath = program.get('body').find(node => isExportCurrent(node, exportName, t));
 
     if (exportPath) {
       exportPath.insertBefore(docgenInfo);
@@ -81,80 +83,60 @@ function injectReactDocgenInfo(path, state, code, t) {
 function injectDocgenGlobal(className, path, state, t) {
   const program = path.scope.getProgramParent().path;
 
-  if(!state.opts.DOC_GEN_COLLECTION_NAME) {
+  if (!state.opts.DOC_GEN_COLLECTION_NAME) {
     return;
   }
 
   const globalName = state.opts.DOC_GEN_COLLECTION_NAME;
-  const filePath = Path.relative('./', Path.resolve('./', path.hub.file.opts.filename));
+  const filePath = relativePath(path.hub.file.opts.filename);
   const globalNode = t.ifStatement(
     t.binaryExpression(
       '!==',
-      t.unaryExpression(
-        'typeof',
-        t.identifier(globalName)
-      ),
+      t.unaryExpression('typeof', t.identifier(globalName)),
       t.stringLiteral('undefined')
     ),
     t.blockStatement([
       t.expressionStatement(
         t.assignmentExpression(
           '=',
-          t.memberExpression(
-            t.identifier(globalName),
-            t.stringLiteral(filePath),
-            true
-          ),
+          t.memberExpression(t.identifier(globalName), t.stringLiteral(filePath), true),
           t.objectExpression([
-            t.objectProperty(
-              t.identifier('name'),
-              t.stringLiteral(className)
-            ),
+            t.objectProperty(t.identifier('name'), t.stringLiteral(className)),
             t.objectProperty(
               t.identifier('docgenInfo'),
-              t.memberExpression(
-                t.identifier(className),
-                t.identifier('__docgenInfo')
-              )
+              t.memberExpression(t.identifier(className), t.identifier('__docgenInfo'))
             ),
-            t.objectProperty(
-              t.identifier('path'),
-              t.stringLiteral(filePath)
-            )
+            t.objectProperty(t.identifier('path'), t.stringLiteral(filePath)),
           ])
         )
-      )
+      ),
     ])
   );
   program.pushContainer('body', globalNode);
 }
 
-function buildObjectExpression(obj, t){
-  if(_.isPlainObject(obj)) {
+function buildObjectExpression(obj, t) {
+  if (_.isPlainObject(obj)) {
     const children = [];
     for (let key in obj) {
       if (key === 'actualName') continue;
-      if(!obj.hasOwnProperty(key) || _.isUndefined(obj[key])) continue;
-      children.push(
-        t.objectProperty(
-          t.stringLiteral(key),
-          buildObjectExpression(obj[key], t)
-        ));
+      if (!obj.hasOwnProperty(key) || _.isUndefined(obj[key])) continue;
+      children.push(t.objectProperty(t.stringLiteral(key), buildObjectExpression(obj[key], t)));
     }
     return t.objectExpression(children);
   } else if (_.isString(obj)) {
     return t.stringLiteral(obj);
   } else if (_.isBoolean(obj)) {
     return t.booleanLiteral(obj);
-  } else if (_.isNumber(obj)){
+  } else if (_.isNumber(obj)) {
     return t.numericLiteral(obj);
   } else if (_.isArray(obj)) {
     const children = [];
-    obj.forEach(function (val) {
+    obj.forEach(function(val) {
       children.push(buildObjectExpression(val, t));
     });
     return t.ArrayExpression(children);
-  } else if(_.isNull(obj)) {
+  } else if (_.isNull(obj)) {
     return t.nullLiteral();
   }
 }
@@ -170,22 +152,18 @@ function isExportCurrent(path, exportName, t) {
   if (t.isExportDefaultDeclaration(path)) {
     const decl = path.get('declaration');
 
-    const identifier = (
-      decl.isIdentifier() // export default MyComp
-        ? decl.node.name
-        : getComponentFromHoC(decl) // export default withHoC(MyComp)
-    );
+    const identifier = decl.isIdentifier() // export default MyComp
+      ? decl.node.name
+      : getComponentFromHoC(decl); // export default withHoC(MyComp)
 
     if (identifier === exportName) {
-      return true
+      return true;
     }
   }
 
   if (t.isExportNamedDeclaration(path)) {
-    return path.get('specifiers').find((sp) => (
-      sp.node.exported.name === exportName
-    ))
+    return path.get('specifiers').find(sp => sp.node.exported.name === exportName);
   }
 
-  return false
+  return false;
 }

src/relativePath.js

@@ -0,0 +1,3 @@
+import * as Path from 'path';
+
+export const relativePath = filename => Path.relative('./', Path.resolve('./', filename));

test/index.test.js

@@ -1,31 +1,38 @@
-import "jest-specific-snapshot";
-import path from "path";
-import fs from "fs";
-import { transformFileSync } from "@babel/core";
-import plugin from "../src";
+import 'jest-specific-snapshot';
+import path from 'path';
+import fs from 'fs';
+import { transformFileSync } from '@babel/core';
+import plugin from '../src';
 
-describe("Add propType doc to react components", () => {
-  const fixturesDir = path.join(__dirname, "fixtures");
+jest.mock('../src/relativePath', () => ({
+  relativePath: filename => {
+    const { posix } = require('path');
+    return posix.relative('./', posix.resolve('./', filename));
+  },
+}));
+
+describe('Add propType doc to react components', () => {
+  const fixturesDir = path.join(__dirname, 'fixtures');
   fs.readdirSync(fixturesDir).map(caseName => {
     // Ignore macOS directory files
-    if (caseName.indexOf(".DS_Store") < 0) {
-      it(`should ${caseName.split("-").join(" ")}`, () => {
+    if (caseName.indexOf('.DS_Store') < 0) {
+      it(`should ${caseName.split('-').join(' ')}`, () => {
         const fixtureDir = path.join(fixturesDir, caseName);
-        const inputPath = path.join(fixtureDir, "input.js");
-        const outputPath = path.join(fixtureDir, "output.js");
+        const inputPath = path.join(fixtureDir, 'input.js');
+        const outputPath = path.join(fixtureDir, 'output.js');
         const options = {
-          presets: ["@babel/env", "@babel/flow", "@babel/react"],
+          presets: ['@babel/env', '@babel/flow', '@babel/react'],
           plugins: [
             [
               plugin,
               {
-                DOC_GEN_COLLECTION_NAME: "STORYBOOK_REACT_CLASSES",
-                handlers: ["react-docgen-deprecation-handler"]
-              }
+                DOC_GEN_COLLECTION_NAME: 'STORYBOOK_REACT_CLASSES',
+                handlers: ['react-docgen-deprecation-handler'],
+              },
             ],
-            "@babel/plugin-proposal-class-properties"
+            '@babel/plugin-proposal-class-properties',
           ],
-          babelrc: false
+          babelrc: false,
         };
 
         const output = transformFileSync(inputPath, options).code;