[Release] v1.2.1

Author: ptkdev

.gitignore

@@ -1,6 +1,6 @@
 ######################################################################################
 # License:        MIT - http://opensource.org/licenses/MIT                           #
-# Author:         Patryk Rzucidlo (@ptkdev) <support@ptkdev.io> https://ptkdev.it    #
+# Author:         Patryk Rzucidło (@ptkdev) <support@ptkdev.io> https://ptkdev.it    #
 # Original:       octocat - https://github.com/octocat                               #
 # Latest version: https://github.com/ptkdev/dotfiles                                 #
 ######################################################################################

AUTHORS.md

@@ -1,4 +1,4 @@
-# Patryk Rzucidlo (@ptkdev) support@ptkdev.io
+# Patryk Rzucidło (@ptkdev) support@ptkdev.io
 [![https://ptkdev.it](https://ptkdev.it/img/ptkdev_patryk_rzucidlo_avatar_150.png)](https://ptkdev.it)
 
 `Lead Developer - May 27, 2018`

CHANGELOG.md

@@ -1,6 +1,6 @@
 # v1.2.0 (October 08, 2018)
 
-* Feature: eslint --fix param, auto replace camelCase to snake_case
+* Feature: eslint --fix parameter, auto replace camelCase to snake_case
 
 
 # v1.1.0 (October 01, 2018)

INSTALL.md

@@ -1,5 +1,5 @@
 #### Setup
-1. Install eslint: `npm install eslint --save`
+1. Install eslint: `npm install eslint --save-dev`
 2. Install snakecasejs plugin: `npm install eslint-plugin-snakecasejs --save-dev`
 3. Create `.eslintrc.json` file with:
 ```

ISSUE_TEMPLATE.md

@@ -33,6 +33,6 @@ much detail as possible.
 2. ...
 3. ...
 
-### Screenshots (Optional)
+### Screenshot (Optional)
 
 If the error is graphical in nature it is helpful to provide a screenshot. 

LICENSE

@@ -5,7 +5,7 @@ Copyright (c) 2018 Patryk Rzucidło
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+to use, copy, modify, merge, publish, distribute, sub-license, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 

README.md

@@ -2,23 +2,23 @@
 
 # ESLint Plugin snakecasejs
 
-[![](https://img.shields.io/badge/license-MIT-brightgreen.svg)](#) [![](https://img.shields.io/badge/powered%20by-eslint-46aef7.svg)](https://www.npmjs.com/package/eslint) [![](https://img.shields.io/badge/version-v1.2.0-lightgrey.svg)](https://github.com/ptkdev/eslint-plugin-snakecasejs/releases) [![](https://img.shields.io/badge/chat%20on-slack-orange.svg)](http://slack.ptkdev.io) [![](https://img.shields.io/badge/chat%20on-discord-7289da.svg)](http://discord.ptkdev.io) [![](https://img.shields.io/badge/blog-medium-2AE176.svg)](http://blog.ptkdev.io) [![](https://img.shields.io/badge/twitter-ptkdevio-2AA3EF.svg)](https://twitter.com/ptkdevio)
+[![](https://img.shields.io/badge/license-MIT-brightgreen.svg)](#) [![](https://img.shields.io/badge/powered%20by-eslint-46aef7.svg)](https://www.npmjs.com/package/eslint) [![](https://img.shields.io/badge/version-v1.2.1-lightgrey.svg)](https://github.com/ptkdev/eslint-plugin-snakecasejs/releases) [![](https://img.shields.io/badge/chat%20on-slack-orange.svg)](http://slack.ptkdev.io) [![](https://img.shields.io/badge/chat%20on-discord-7289da.svg)](http://discord.ptkdev.io) [![](https://img.shields.io/badge/blog-medium-2AE176.svg)](http://blog.ptkdev.io) [![](https://img.shields.io/badge/twitter-ptkdevio-2AA3EF.svg)](https://twitter.com/ptkdevio)
 
 [![](https://img.shields.io/badge/donate-patreon-F87668.svg)](http://patreon.ptkdev.io) [![](https://img.shields.io/badge/donate-paypal-46AFE0.svg)](http://paypal.ptkdev.io) [![](https://img.shields.io/badge/buy%20me-coffee-4B788C.svg)](http://coffee.ptkdev.io) [![](https://img.shields.io/badge/help-support@ptkdev.io-fbbc05.svg)](mailto:support@ptkdev.io)
 
 ## What does it do
-This is to enforce a style of snake_case in your project, rather than just disabling camelcase.
+This is to enforce a style of snake_case in your project, rather than just disabling camelCase.
 
 ## Features
 * [✓] Easy to use
 * [✓] MIT License
 * [✓] Compatible with latest version of ESLint
 * [✓] Compatible with CamelCase (Class name or similar)
 * [✓] Compatible with --fix (convert automatically camelCase to snake_case)
-* [✓] Whitelist array for methods or variables with camelCase syntax from other libraries/npm package.
+* [✓] White list array for methods or variables with camelCase syntax from other libraries/npm package.
 
 ## Fast setup
-1. Install eslint: `npm install eslint --save`
+1. Install eslint: `npm install eslint --save-dev`
 2. Install snakecasejs plugin: `npm install eslint-plugin-snakecasejs --save-dev`
 3. Create `.eslintrc.json` file with:
 ```
@@ -41,10 +41,13 @@ NOTE: switch `error` to `warn` if you don't need snake_case as mandatory rules.
 For advanced configuration see [INSTALL.md](https://github.com/ptkdev/eslint-plugin-snakecasejs/blob/master/INSTALL.md).
 
 ## --fix
-This eslint param fix simple rules of linter and with this plugin convert all camelCase variables or function name to snake_case. --fix support whitelist. Run this command in your project dir:
+This eslint parameter fix simple rules of linter and with this plugin convert all camelCase variables or function name to snake_case. 
+Fix command support whitelist. Run this command in your project directory:
 - `eslint ./ --cache --ignore-pattern .gitignore --fix`
 
-## Whitelist
+**WARNING:** You need install eslint globally for this feature: `npm install eslint -g`
+
+## White list
 Ignore words, variables, methods, class name without snake_case syntax. Add rules: `"snakecasejs/whitelist": []` with array of variables or method with camelCase that you can not convert to snake_case (external library naming convention). 
 
 Plugin ignore check on this words. Example: `"snakecasejs/whitelist": ["externalPath","setNumber"]`

package.json

@@ -1,9 +1,9 @@
 {
   "name": "eslint-plugin-snakecasejs",
   "description": "Eslint plugin to enforce a style of snake_case in your project, rather than just disabling camelCase.",
-  "version": "1.2.0-3",
+  "version": "1.2.1",
   "main": "plugin.js",
-  "author": "Patryk Rzucidlo [@ptkdev] <support@ptkdev.io> (https://ptkdev.it)",
+  "author": "Patryk Rzucidło [@ptkdev] <support@ptkdev.io> (https://ptkdev.it)",
   "author_original": "David Buchan-Swanson <david.buchanswanson@gmail.com>",
   "license": "MIT",
   "homepage": "https://ptkdev.io",
@@ -43,6 +43,7 @@
     "node": ">=7.6.0"
   },
   "devDependencies": {
-    "pre-commit": "^1.2.2"
+    "eslint": "latest",
+    "pre-commit": "latest"
   }
 }

plugin.js

@@ -1,9 +1,9 @@
 /**
  * ESLint: snakecasejs
  * =====================
- * This is to enforce a style of snake_case in your project, rather than just disabling camelcase.
+ * This is to enforce a style of snake_case in your project, rather than just disabling camelCase.
  *
- * @author:     Patryk Rzucidlo [@ptkdev] <support@ptkdev.io> (https://ptkdev.it)
+ * @author:     Patryk Rzucidło [@ptkdev] <support@ptkdev.io> (https://ptkdev.it)
  * @original:   David Buchan-Swanson <david.buchanswanson@gmail.com>
  * @license:    This code and contributions have 'MIT License'
  *
@@ -18,7 +18,7 @@ try {
 /**
  * Whitelist exist?
  * =====================
- * Set empry array if whitelist is undefined in eslintrc
+ * Set empty array if whitelist is undefined in eslintrc
  *
  */
 if (typeof eslintrc.rules["snakecasejs/whitelist"] == "undefined") {
@@ -28,7 +28,7 @@ if (typeof eslintrc.rules["snakecasejs/whitelist"] == "undefined") {
 /**
  * Detect var and function
  * =====================
- * Filter code, find funcrions name and variables
+ * Filter code, find functions name and variables
  *
  */
 function filter(node) {
@@ -72,7 +72,7 @@ module.exports = {
                                     identifier: node.name,
                                 },
 
-                                // --fix eslint param: detect camelCase and convert in snake_case
+                                // --fix eslint parameter: detect camelCase and convert in snake_case
                                 fix(fixer) {
                                     return fixer.replaceText(node, node.name.split(/(?=[A-Z])/).join("_").toLowerCase());
                                 }

test.js

@@ -1,9 +1,9 @@
 /**
  * snakecasejs
  * =====================
- * This is to enforce a style of snake_case in your project, rather than just disabling camelcase.
+ * This is to enforce a style of snake_case in your project, rather than just disabling camelCase.
  *
- * @author:     Patryk Rzucidlo [@ptkdev] <support@ptkdev.io> (https://ptkdev.it)
+ * @author:     Patryk Rzucidło [@ptkdev] <support@ptkdev.io> (https://ptkdev.it)
  * @original:   David Buchan-Swanson <david.buchanswanson@gmail.com>
  * @license:    This code and contributions have 'MIT License'
  *