Initial plugin with import rule

Author: mtscout6

.babelrc

@@ -0,0 +1,3 @@
+{
+  "stage": 1
+}

.editorconfig

@@ -0,0 +1,18 @@
+# EditorConfig is awesome: http://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+
+[*.js]
+charset = utf-8
+indent_style = space
+indent_size = 2
+
+[{package.json,.travis.yml}]
+indent_style = space
+indent_size = 2

.eslintrc

@@ -0,0 +1,17 @@
+{
+  "env": {
+    "node": true
+  },
+  "parser": "babel-eslint",
+  "rules": {
+    "comma-spacing": 2,
+    "comma-style": [2, "last"],
+    "one-var": [2, { "initialized": "never" }],
+    "key-spacing": 0,
+    "no-underscore-dangle": 0,
+    "no-unused-vars": [2, { "vars": "all", "args": "none" }],
+    "no-var": 2,
+    "quotes": [2, "single", "avoid-escape"],
+    "strict": 0
+  }
+}

.gitignore

@@ -0,0 +1,2 @@
+node_modules/
+lib/

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 eslint-plugins
+Copyright (c) 2015 Matthew L Smith
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1 +1,54 @@
-# eslint-plugin-lodash
+ESLint-plugin-lodash
+===================
+
+lodash specific linting rules for ESLint
+
+# Installation
+
+Install [ESLint](https://www.github.com/eslint/eslint) either locally or globally.
+
+    npm install eslint
+
+If you installed `ESLint` globally, you have to install lodash plugin globally too. Otherwise, install it locally.
+
+    $ npm install eslint-plugin-lodash
+
+The rules are specifically written to target ES6 JavaScript, so you'll want to
+use the [babel-eslint](https://github.com/babel/babel-eslint) parser.
+
+# Configuration
+
+Add `plugins` section and specify ESLint-plugin-lodash as a plugin.
+
+```json
+{
+  "parser": "babel-eslint",
+  "plugins": [
+    "lodash"
+  ]
+}
+```
+
+Finally, enable all of the rules that you would like to use.
+
+```json
+{
+  "rules": {
+    "lodash/import": 1,
+  }
+}
+```
+
+# List of supported rules
+
+* [import](docs/rules/import.md): Prevent importing the entire lodash library.
+
+## To Do
+
+* Add Contributing Guide, until then PRs welcome!
+
+[Any rule idea is welcome !](https://github.com/eslint-plugins/eslint-plugin-lodash/issues)
+
+# License
+
+ESLint-plugin-lodash is licensed under the [MIT License](LICENSE).

docs/rules/import.md

@@ -0,0 +1,33 @@
+# Enforce that the entire lodash library is not imported
+
+When building browser tools you want to keep the bundles as small as possible.
+You can either take a dependency on the various `lodash.x` modules that exist,
+or you can just have a dependency on the core library and only import what you
+need. This rule will allow you to do so and ensure that the entire library is
+not blindly imported.
+
+## Rule Details
+
+The following patterns are considered warnings:
+
+```js
+import _ from 'lodash';
+```
+
+```js
+import { default as something } from 'lodash';
+```
+
+```js
+import 'lodash';
+```
+
+The following patterns are not considered warnings:
+
+```js
+import find from 'lodash/collection/find';
+```
+
+## When Not To Use It
+
+If you do not care that the entire lodash libary is imported.

package.json

@@ -0,0 +1,35 @@
+{
+  "name": "eslint-plugin-lodash",
+  "version": "0.0.0",
+  "description": "ESLint Plugin for use with the lodash library",
+  "main": "lib/index.js",
+  "scripts": {
+    "test": "npm run lint && mocha && npm run build",
+    "build": "rm -rf lib && babel src --out-dir lib",
+    "lint": "eslint ./"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/eslint-plugins/eslint-plugin-lodash.git"
+  },
+  "author": "Matthew L Smith <[email protected]>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/eslint-plugins/eslint-plugin-lodash/issues"
+  },
+  "homepage": "https://github.com/eslint-plugins/eslint-plugin-lodash#readme",
+  "devDependencies": {
+    "babel": "^5.6.7",
+    "babel-eslint": "^3.1.18",
+    "eslint": "^0.23.0",
+    "eslint-tester": "^0.8.0",
+    "is-my-json-valid": "^2.12.0",
+    "mocha": "^2.2.5"
+  },
+  "keywords": [
+    "eslint-plugin",
+    "eslintplugin",
+    "eslint",
+    "lodash"
+  ]
+}

src/index.js

@@ -0,0 +1,5 @@
+import importRule from './rules/import';
+
+export default {
+  'import': importRule
+};

src/rules/import.js

@@ -0,0 +1,15 @@
+/**
+ * @fileoverview Rule to enforce entire lodash library is not imported
+ * @author Matt Smith
+ * @copyright 2015 Matt Smith. All rights reserved.
+ */
+
+export default function(context) {
+  return {
+    ImportDeclaration: function(node) {
+      if (node.source.value === 'lodash') {
+        context.report(node.source, 'Importing the entire lodash library is not permitted, please import the specific functions you need');
+      }
+    }
+  };
+}

test/mocha.opts

@@ -0,0 +1,2 @@
+--compilers js:babel/register
+--recursive

test/rules/import.Spec.js

@@ -0,0 +1,70 @@
+import EslintTester from 'eslint-tester';
+import eslint from 'eslint';
+
+let tester = new EslintTester(eslint.linter);
+
+tester.addRuleTest('src/rules/import', {
+  valid: [
+    {
+      code: 'import "something"',
+      parser: 'babel-eslint'
+    },
+    {
+      code: 'import something from "something"',
+      parser: 'babel-eslint'
+    },
+    {
+      code: 'import lodash from "something"',
+      parser: 'babel-eslint'
+    },
+    {
+      code: 'import { something } from "something"',
+      parser: 'babel-eslint'
+    },
+    {
+      code: 'import { default as other } from "something"',
+      parser: 'babel-eslint'
+    },
+    {
+      code: 'import find from "lodash/collection/find"',
+      parser: 'babel-eslint'
+    }
+  ],
+  invalid: [
+    {
+      code: 'import "lodash"',
+      parser: 'babel-eslint',
+      errors: [{
+        message: 'Importing the entire lodash library is not permitted, please import the specific functions you need'
+      }]
+    },
+    {
+      code: 'import _ from "lodash"',
+      parser: 'babel-eslint',
+      errors: [{
+        message: 'Importing the entire lodash library is not permitted, please import the specific functions you need'
+      }]
+    },
+    {
+      code: 'import lodash from "lodash"',
+      parser: 'babel-eslint',
+      errors: [{
+        message: 'Importing the entire lodash library is not permitted, please import the specific functions you need'
+      }]
+    },
+    {
+      code: 'import { something } from "lodash"',
+      parser: 'babel-eslint',
+      errors: [{
+        message: 'Importing the entire lodash library is not permitted, please import the specific functions you need'
+      }]
+    },
+    {
+      code: 'import { default as other } from "lodash"',
+      parser: 'babel-eslint',
+      errors: [{
+        message: 'Importing the entire lodash library is not permitted, please import the specific functions you need'
+      }]
+    }
+  ]
+});