Merge pull request #37 from Expensify/marcaaron-addImportRule

Add `prefer-import-module-contents` custom rule

eslint-plugin-expensify/prefer-import-module-contents.js

@@ -18,6 +18,40 @@ function isEverySpecifierImport(specifiers = []) {
     return _.every(specifiers, specifier => specifier.type === 'ImportSpecifier');
 }
 
+/**
+ * Make an exception for propTypes since they are sometimes bundled with modules.
+ *
+ * @param {Array} specifiers
+ * @returns {Boolean}
+ */
+function hasPropTypesSpecifier(specifiers) {
+    return _.some(specifiers, specifier => /proptypes/.test(lodashGet(specifier, 'imported.name', '').toLowerCase()));
+}
+
+/**
+ * @param {String} source
+ * @returns {Boolean}
+ */
+function isHigherOrderComponent(source) {
+    return /with/.test(source.toLowerCase());
+}
+
+/**
+ * @param {String} source
+ * @returns {Boolean}
+ */
+function isContextComponent(source) {
+    return /context|provider/.test(source.toLowerCase());
+}
+
+/**
+ * @param {String} source
+ * @returns {Boolean}
+ */
+function isJSONFile(source) {
+    return /\.json/.test(source.toLowerCase());
+}
+
 module.exports = {
     create: context => ({
         ImportDeclaration(node) {
@@ -26,14 +60,22 @@ module.exports = {
                 return;
             }
 
-            if (isFromNodeModules(sourceValue)) {
+            if (isFromNodeModules(sourceValue)
+                || isHigherOrderComponent(sourceValue)
+                || isContextComponent(sourceValue)
+                || isJSONFile(sourceValue)
+            ) {
                 return;
             }
 
             if (!node.specifiers || !node.specifiers.length) {
                 return;
             }
 
+            if (hasPropTypesSpecifier(node.specifiers)) {
+                return;
+            }
+
             if (!isEverySpecifierImport(node.specifiers)) {
                 return;
             }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-config-expensify",
-  "version": "2.0.18",
+  "version": "2.0.19",
   "description": "Expensify's ESLint configuration following our style guide",
   "main": "index.js",
   "repository": {

rules/expensify.js

@@ -9,5 +9,6 @@ module.exports = {
         'rulesdir/no-inline-named-export': 'error',
         'rulesdir/prefer-underscore-method': 'error',
         'rulesdir/no-useless-compose': 'error',
+        'rulesdir/prefer-import-module-contents': 'error',
     },
 };