- Code refactor and package release

- Handle peer dependencies on binded packages

Author: s-yadav

.babelrc

@@ -0,0 +1,7 @@
+{
+  "presets": [["@babel/preset-env", {
+    "targets": {
+      "node": "8"
+    }
+  }]]
+}

.eslintrc

@@ -0,0 +1,8 @@
+{
+  "parser": "babel-eslint",
+  "extends": "standard",
+  "rules": {
+    "comma-dangle": ["error", "always-multiline"],
+    "semi": ["error", "always"]
+  } 
+}

.gitignore

@@ -0,0 +1,3 @@
+# exclude lib files and node modules
+node_modules
+lib

.npmignore

@@ -0,0 +1,12 @@
+# exclude source files and node modules
+src
+node_modules
+
+# exlude dot files
+.babelrc
+.eslintrc
+.gitignore
+.npmignore
+
+# exclude lock file
+yarn.lock

package.json

@@ -0,0 +1,30 @@
+{
+  "name": "packagebind",
+  "version": "0.1.0",
+  "description": "Connect packages to your application with HMR and babel config",
+  "main": "lib/index.js",
+  "repository": "https://github.com/interviewstreet/packagebind.git",
+  "author": "s-yadav <[email protected]>",
+  "license": "MIT",
+  "scripts": {
+    "build": "babel src -d lib"
+  },
+  "peerDependencies": {
+    "babel-plugin-module-resolver": "3.2.0"
+  },
+  "dependencies": {
+    "lodash": "^4.17.11"
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.4.3",
+    "@babel/core": "^7.4.3",
+    "@babel/preset-env": "^7.4.3",
+    "babel-eslint": "^10.0.1",
+    "eslint": "^5.16.0",
+    "eslint-config-standard": "^12.0.0",
+    "eslint-plugin-import": "^2.17.0",
+    "eslint-plugin-node": "^8.0.1",
+    "eslint-plugin-promise": "^4.1.1",
+    "eslint-plugin-standard": "^4.0.0"
+  }
+}

src/index.js

@@ -0,0 +1,87 @@
+import path from 'path';
+import { resolvePath } from 'babel-plugin-module-resolver';
+import { cloneDeep } from 'lodash';
+
+import {
+  isFromCurrentRepo,
+  findRepoRootPath,
+  getLinkedBabelrc,
+  getLinkedPackageJSON,
+  getAliases,
+  getFilesRepo,
+} from './utils';
+
+/**
+ * Get the new babel config with optimized settings for linked aliases
+ */
+export default function packagebind (babelConfig) {
+  /** We are cloning babelrc here so we can mutate it directly to keep logic simpler */
+  const cloneBabelrc = cloneDeep(babelConfig);
+  const { plugins = [] } = cloneBabelrc;
+
+  const moduleResolver = plugins.find(
+    plugin => Array.isArray(plugin) && plugin[0] === 'module-resolver'
+  );
+
+  const aliases = getAliases(plugins);
+
+  const linkedRepos = Object.keys(aliases).filter((aliasKey) => {
+    const aliasPath = path.resolve(aliases[aliasKey]);
+    return isFromCurrentRepo(aliasPath);
+  });
+
+  const linkedReposMeta = linkedRepos.map((name) => {
+    const rootPath = findRepoRootPath(aliases[name]);
+    const babelConfig = getLinkedBabelrc(rootPath);
+    const packageJSON = getLinkedPackageJSON(rootPath);
+    return {
+      name,
+      rootPath,
+      babelConfig,
+      packageJSON,
+    };
+  });
+
+  /** TODO: Add plugins from the linked packages as well.
+   * For now that is not required as the plugins added on this repo is super set of all plugin used on linked repos
+   * For now just get the alias from those babel files
+   * */
+
+  const aliasMaps = {};
+
+  linkedReposMeta.forEach((meta) => {
+    const { babelConfig, name, rootPath, packageJSON } = meta;
+
+    aliasMaps[name] = {};
+
+    // Add alias from linked babelConfig
+    if (babelConfig) {
+      const aliases = getAliases(babelConfig.plugins);
+      if (aliases) {
+        aliasMaps[name] = Object.entries(aliases).reduce((updatedAliases, [key, value]) => {
+          updatedAliases[key] = path.resolve(rootPath, value);
+          return updatedAliases;
+        }, aliasMaps[name]);
+      }
+    }
+
+    // Add peer dependencies to aliasMaps to make sure the dependency conflict doesn't happens
+    if (packageJSON.peerDependencies) {
+      Object.keys(packageJSON.peerDependencies).forEach((module) => {
+        aliasMaps[name][module] = path.resolve(rootPath, 'node_modules', module);
+      });
+    }
+  });
+
+  moduleResolver[1].resolvePath = (sourcePath, currentFile, opts) => {
+    opts = cloneDeep(opts);
+    const repo = getFilesRepo(currentFile, linkedReposMeta);
+    if (repo !== 'currentRepo' && aliasMaps[repo]) {
+      opts.alias = { ...opts.alias, ...aliasMaps[repo] };
+    }
+    const realPath = resolvePath(sourcePath, currentFile, opts);
+    return realPath;
+  };
+
+  return cloneBabelrc;
+}

src/packagebind.js

@@ -0,0 +1,73 @@
+import { readFileSync, existsSync } from 'fs';
+import path from 'path';
+
+/**
+ * For a given path return if the path is from current repo or not
+ */
+export function isFromCurrentRepo(filePath) {
+  const currentRepoDir = process.cwd();
+  return filePath.startsWith(currentRepoDir);
+}
+
+/**
+ * given a alias path find the root path for that repo 
+ * */
+export function findRepoRootPath(aliasPath) {
+  const fullAliasPath = path.resolve(aliasPath);
+  let rootPath = fullAliasPath;
+
+  while (rootPath.includes('/') && !existsSync(`${rootPath}/package.json`)) {
+    rootPath = rootPath.substring(0, rootPath.lastIndexOf('/'));
+  }
+
+  return rootPath;
+}
+
+/**
+ * given a repo path get the babel config of the linked repository
+ * */
+export function getLinkedBabelrc(repoPath) {
+  if (existsSync(`${repoPath}/.babelrc`)) {
+    return JSON.parse(readFileSync(`${repoPath}/.babelrc`, 'utf8'));
+  } else if (existsSync(`${repoPath}/babel.config.js`)) {
+    return require(`${repoPath}/babel.config.js`);
+  }
+  return null;
+}
+
+/**
+ * given a repo path return its package.json
+ */
+export function getLinkedPackageJSON(repoPath) {
+  if (existsSync(`${repoPath}/package.json`)) {
+    return JSON.parse(readFileSync(`${repoPath}/package.json`, 'utf8'));
+  } else if (existsSync(`${repoPath}/babel.config.js`)) {
+    return {};
+  }
+}
+
+/**
+ * From the plugins array of a babel config extract the aliases.
+ * */
+export function getAliases(plugins = []) {
+  const moduleResolver = plugins.find(
+    plugin => Array.isArray(plugin) && plugin[0] === 'module-resolver'
+  );
+  if (moduleResolver) {
+    return moduleResolver[1].alias;
+  }
+  return null;
+}
+
+
+/**
+ * Finds the repository name on which the file path exist.
+ * It returns currentRepo if the file is from the same repo, otherwise it returns the repository name
+ */
+export function getFilesRepo(filePath, linkedReposMeta) {
+  if (isFromCurrentRepo(filePath)) {
+    return 'currentRepo';
+  }
+
+  return linkedReposMeta.find(({ rootPath }) => filePath.startsWith(rootPath)).name;
+}