able_git_hooks 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: edc627c31da0c20e26a37d02937483614ff2467d2b103b5a677804dde8ce9e46
-  data.tar.gz: 3cdbf9533b3fd89c50b867adda4581e51fa1b720a3dd5248d9179f93d9644e81
+  metadata.gz: 2c2cfb7a8cf9f20c9239f1fa90bd5b8186be514321d7f9f0fc12ff5fc1786fd4
+  data.tar.gz: fc41fa34ca1a4732b10f70bc3b7a212fedb832dfd03e5c6279742e9775e156ba
 SHA512:
-  metadata.gz: de0cf62b06fd7649fbad4c5da0e4115b8a942b175c9d3e9ceff34239f0ecbaea7f609f81dff660a2e26ff8d8600b24e7f937bcdc67b7b3f6a9c756e4b2a391e1
-  data.tar.gz: 156c269792873441ed1cf3ea38b400befd8f5cc28a07c2b1b692fc0c23b01d38e1764080769d2cdb8465a9198ab517e1217be6db6c6426c44c0583b921eeab10
+  metadata.gz: 4012768541ad36d72dba19328eb85ef199f40c38e42e5cd2209e260fc0cfcab3503001d7d46c4ac2372016bb6390312df91ea4ac8245041a10125c9d264029a8
+  data.tar.gz: fd916bca9d07e150bebb6f3029058b629e39c416aeca772f44e0df26b9b9d82e6ce1f7e398c7a9df272a1b1b5156769e28ccab58789fc96b2165a79c3f67d1fd

data/.rubocop.yml

@@ -0,0 +1,117 @@
+---
+AllCops:
+  DisabledByDefault: true
+  Exclude:
+    - bin/**/*
+    - node_modules/**/*
+    - db/migrate/*
+    - db/schema.rb
+  TargetRubyVersion: 2.5
+Layout/AccessModifierIndentation:
+  EnforcedStyle: indent
+Layout/BlockAlignment:
+  EnforcedStyleAlignWith: either
+Layout/DefEndAlignment:
+  EnforcedStyleAlignWith: start_of_line
+Layout/DotPosition:
+  EnforcedStyle: leading
+Layout/EmptyComment:
+  Enabled: true
+Layout/EmptyLineBetweenDefs:
+  Enabled: true
+  NumberOfEmptyLines: 1
+Layout/EmptyLinesAroundBlockBody:
+  EnforcedStyle: no_empty_lines
+Layout/EmptyLinesAroundClassBody:
+  EnforcedStyle: no_empty_lines
+Layout/EmptyLinesAroundModuleBody:
+  EnforcedStyle: no_empty_lines
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: start_of_line
+Layout/ExtraSpacing:
+  AllowForAlignment: true
+Layout/IndentArray:
+  EnforcedStyle: consistent
+Layout/IndentHash:
+  EnforcedStyle: consistent
+Layout/IndentationConsistency:
+  EnforcedStyle: normal
+Layout/IndentationWidth:
+  Width: 2
+Layout/SpaceAroundBlockParameters:
+  EnforcedStyleInsidePipes: no_space
+Layout/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: space
+Layout/SpaceAroundOperators:
+  Enabled: true
+Layout/SpaceBeforeBlockBraces:
+  EnforcedStyle: space
+Layout/SpaceInLambdaLiteral:
+  EnforcedStyle: require_no_space
+Layout/SpaceInsideBlockBraces:
+  EnforcedStyle: space
+  EnforcedStyleForEmptyBraces: no_space
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: space
+  EnforcedStyleForEmptyBraces: no_space
+Layout/SpaceInsideReferenceBrackets:
+  EnforcedStyle: no_space
+Layout/SpaceInsideStringInterpolation:
+  EnforcedStyle: no_space
+Layout/Tab:
+  Enabled: true
+Layout/TrailingWhitespace:
+  Enabled: true
+Lint/SafeNavigationChain:
+  Enabled: true
+Lint/ShadowedArgument:
+  Enabled: true
+Lint/UnusedBlockArgument:
+  Enabled: true
+Lint/UnusedMethodArgument:
+  Enabled: true
+Naming/VariableName:
+  EnforcedStyle: snake_case
+Rails/LexicallyScopedActionFilter:
+  Include:
+    - app/controllers/**/*.rb
+Rails/TimeZone:
+  EnforcedStyle: flexible
+Rails/UnknownEnv:
+  Environments:
+    - development
+    - test
+    - production
+Style/BlockDelimiters:
+  EnforcedStyle: line_count_based
+Style/BracesAroundHashParameters:
+  EnforcedStyle: no_braces
+Style/EmptyElse:
+  EnforcedStyle: both
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+Style/HashSyntax:
+  EnforcedStyle: ruby19_no_mixed_keys
+Style/MethodDefParentheses:
+  EnforcedStyle: require_parentheses
+Style/NumericLiterals:
+  MinDigits: 5
+  Strict: false
+Style/RedundantReturn:
+  Enabled: true
+Style/Semicolon:
+  Enabled: true
+Style/SingleLineMethods:
+  Enabled: true
+Style/StabbyLambdaParentheses:
+  EnforcedStyle: require_parentheses
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: single_quotes
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: no_comma
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: no_comma
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: no_comma

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    able_git_hooks (0.11.0)
+    able_git_hooks (0.12.0)
       railties (~> 5.2, >= 5.2.0)
       rubocop (~> 0.57.2, >= 0.57.2)
 
@@ -40,7 +40,7 @@ GEM
     method_source (0.9.0)
     mini_portile2 (2.3.0)
     minitest (5.11.3)
-    nokogiri (1.8.3)
+    nokogiri (1.8.4)
       mini_portile2 (~> 2.3.0)
     parallel (1.12.1)
     parser (2.5.1.0)

data/README.md

@@ -24,3 +24,10 @@ And then execute:
 Execute the generator command to copy the files:
 
     $ bundle exec rails generate able_git_hooks:install
+
+
+For the ESLint default configuration you'll need to install
+
+- eslint-plugin-import
+- eslint-plugin-react
+- eslint-plugin-prettier

data/lib/able_git_hooks/generators/install_generator.rb

@@ -4,6 +4,9 @@ module AbleGitHooks
       desc "Install git hook files"
       source_root File.expand_path("../templates", __FILE__)
 
+      class_option :with_stylelint, type: :boolean, default: false, description: "Include the default configuration for stylelint"
+
+
       def install_git_hooks
         copy_file "_do_hook", ".git/hooks/_do_hook"
         chmod ".git/hooks/_do_hook", 0755
@@ -22,6 +25,32 @@ module AbleGitHooks
       def copy_rubocop_defaults
         template "rubocop.yml", "config/rubocop.yml"
       end
+
+      def install_eslint_hooks
+        copy_file "eslint-check.js", "hooks/pre-commit/eslint-check.js"
+        chmod "hooks/pre-commit/eslint-check.js", 0755
+      end
+
+      def copy_eslint_defaults
+        copy_file "eslintrc.json", ".eslintrc.json"
+      end
+
+      def copy_prettier_defaults
+        copy_file "prettierrc", ".prettierrc"
+      end
+
+      def install_stylelint_hooks
+        if options["with_stylelint"]
+          copy_file "stylelint-check.js", "hooks/pre-commit/stylelint-check.js"
+          chmod "hooks/pre-commit/stylelint-check.js", 0755
+        end
+      end
+
+      def copy_stylelint_defaults
+        if options["with_stylelint"]
+          copy_file "stylelintrc", ".stylelintrc"
+        end
+      end
     end
   end
 end

data/lib/able_git_hooks/generators/templates/_do_hook

@@ -14,5 +14,5 @@ declare -r hookdir="hooks/$ARG0"
 
 for hook in "$hookdir"/*; do
   echo "executing hook: ${hook}"
-  exec "${hook}"
+  eval "${hook}"
 done

data/lib/able_git_hooks/generators/templates/eslint-check.js

@@ -0,0 +1,76 @@
+#!/usr/bin/env node
+
+"use strict";
+
+/***
+ * Description:
+ *    Run prettier on the files are they are staged to be commit. Exit successfully
+ * only if the file would be left unchanged by prettier.
+ *
+ * Steps:
+ *
+ *  1. List the sources files that are to be committed.
+ *  2. Use git show :<path> to print the staged file to stdout.
+ *  3. Pipe stdout to `prettier.check`.
+ *
+ ***/
+
+const { promisify } = require("util");
+let { exec } = require("child_process");
+exec = promisify(exec);
+const ESLintCLIEngine = require("eslint").CLIEngine;
+const cli = new ESLintCLIEngine({});
+const formatter = cli.getFormatter();
+
+
+const getStagedFiles =
+  "git diff --staged --name-only -z --diff-filter=ACMR";
+
+const onlyJSFiles = filenames => {
+  return filenames.filter(
+    file => file.endsWith(".js") || file.endsWith(".jsx"),
+  );
+};
+
+const splitFileNames = ret => {
+  const fileNames = ret.stdout.substring(0, ret.stdout.length - 1);
+  return fileNames.split("\u0000");
+};
+
+function and(x, y) {
+  return x && y;
+}
+
+const reduceWithAnd = xs => {
+  return xs.reduce(and, true);
+};
+
+const exit = success => {
+  if (success) {
+    process.exit(0);
+  } else {
+    process.exit(1);
+  }
+};
+
+function lintFile(filepath) {
+  return exec(`git show :${filepath}`).then(ret => {
+    const report = cli.executeOnText(ret.stdout, filepath);
+    if (report.errorCount > 0 || report.warningCount > 0) {
+      const errorResults = ESLintCLIEngine.getErrorResults(report.results);
+      console.log(formatter(errorResults));
+    }
+    return report.errorCount === 0 && report.warningCount === 0;
+  });
+}
+
+function lintFiles(filepaths) {
+  return Promise.all(filepaths.map(lintFile));
+}
+
+exec(getStagedFiles)
+  .then(splitFileNames)
+  .then(onlyJSFiles)
+  .then(lintFiles)
+  .then(reduceWithAnd)
+  .then(exit);

data/lib/able_git_hooks/generators/templates/eslintrc.json

@@ -0,0 +1,33 @@
+{
+  "parserOptions": {
+    "ecmaVersion": 6,
+    "sourceType": "module",
+    "ecmaFeatures": {
+      "jsx": true
+    }
+  },
+  plugins: ["import", "react", "prettier"],
+  "rules": {
+    "no-dupe-keys": "error",
+    "no-undef": "error",
+    "no-unreachable": "error",
+    "no-unused-vars": ["error", { argsIgnorePattern: "^_" }],
+    "no-useless-constructor": "error",
+    "no-var": "error",
+    "no-duplicate-imports": "error",
+    "no-duplicate-case": "error",
+    "no-console": "error",
+    "no-debugger": "error",
+    "import/no-unresolved": "error",
+    "import/default": "error",
+    "react/jsx-no-undef": "error",
+    "react/jsx-uses-vars": 1,
+    "react/jsx-uses-react": "error",
+    "react/react-in-jsx-scope": "error",
+    "react/no-string-refs": "error",
+    "react/prop-types": ["error", { skipUndeclared: true }],
+    "react/forbid-prop-types": "error",
+    "react/prefer-stateless-function": "error",
+    "prettier/prettier": "error"
+  }
+}

data/lib/able_git_hooks/generators/templates/prettierrc

@@ -0,0 +1,3 @@
+{
+  "trailingComma": "all"
+}

data/lib/able_git_hooks/generators/templates/rubocop.rb

@@ -4,6 +4,9 @@ require "rubocop"
 require "shellwords"
 
 staged_files = `git diff -z --staged --name-only --diff-filter=ACM`.split("\u0000")
+
+exit 0 if staged_files.empty?
+
 config_store = RuboCop::ConfigStore.new
 target_files = RuboCop::TargetFinder.new(config_store).find(staged_files)
 

data/lib/able_git_hooks/generators/templates/stylelint-check.js

@@ -0,0 +1,70 @@
+#!/usr/bin/env node
+
+'use strict';
+
+/***
+ * Description:
+ *   Run stylelint against the staged version of style files. If any errors are
+ * found by stylelint, print them to standard output and return with a non-zero
+ * exit code. Otherwise return successfully.
+***/
+
+const { promisify } = require('util');
+let { exec } = require('child_process');
+exec = promisify(exec);
+const stylelint = require('stylelint');
+
+
+const getStagedFiles =
+  "git diff --staged --name-only -z --diff-filter=ACMR";
+
+const onlyJSFiles = filenames => {
+  return filenames.filter(
+    file => file.endsWith(".js") || file.endsWith(".jsx"),
+  );
+};
+
+const splitFileNames = ret => {
+  const fileNames = ret.stdout.substring(0, ret.stdout.length - 1);
+  return fileNames.split("\u0000");
+};
+
+function and(x, y) {
+  return x && y;
+}
+
+const reduceWithAnd = xs => {
+  return xs.reduce(and, true);
+};
+
+const exit = success => {
+  if (success) {
+    process.exit(0);
+  } else {
+    process.exit(1);
+  }
+};
+
+function lintFile(filepath) {
+  return exec(`git show :${filepath}`)
+    .then(ret => stylelint.lint({ code: ret.stdout, codeFilename: filepath, formatter: 'verbose' }))
+    .then(result => {
+      if (!result.errored) {
+        return true;
+      } else {
+        console.log(result.output);
+        return false;
+      }
+    });
+}
+
+function lintFiles(filepaths) {
+  return Promise.all(filepaths.map(lintFile));
+}
+
+exec(getStagedFiles)
+  .then(splitFileNames)
+  .then(onlyStyleFiles)
+  .then(lintFiles)
+  .then(reduceWithAnd)
+  .then(exit);

data/lib/able_git_hooks/generators/templates/stylelintrc

@@ -0,0 +1,15 @@
+{
+  "processors": ["stylelint-processor-styled-components"],
+  "extends": [
+    "stylelint-config-standard",
+    "stylelint-config-styled-components"
+  ],
+  "syntax": "scss",
+  "plugins": ["stylelint-order"],
+  "rules": {
+    "order/properties-alphabetical-order": true,
+    "block-opening-brace-space-after": null,
+    "block-closing-brace-space-before": null,
+    "color-hex-case": "lower"
+  }
+}

data/lib/able_git_hooks/version.rb

@@ -1,3 +1,3 @@
 module AbleGitHooks
-  VERSION = "0.11.0"
+  VERSION = "0.12.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: able_git_hooks
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Mario Rodas
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-02 00:00:00.000000000 Z
+date: 2018-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -102,6 +102,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -113,8 +114,13 @@ files:
 - lib/able_git_hooks.rb
 - lib/able_git_hooks/generators/install_generator.rb
 - lib/able_git_hooks/generators/templates/_do_hook
+- lib/able_git_hooks/generators/templates/eslint-check.js
+- lib/able_git_hooks/generators/templates/eslintrc.json
+- lib/able_git_hooks/generators/templates/prettierrc
 - lib/able_git_hooks/generators/templates/rubocop.rb
 - lib/able_git_hooks/generators/templates/rubocop.yml
+- lib/able_git_hooks/generators/templates/stylelint-check.js
+- lib/able_git_hooks/generators/templates/stylelintrc
 - lib/able_git_hooks/railtie.rb
 - lib/able_git_hooks/version.rb
 homepage: http://able.co
@@ -137,7 +143,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Creates an extensible git hooks system on rails projects