Skip to content

Latest commit

 

History

History
93 lines (74 loc) · 2.92 KB

README.md

File metadata and controls

93 lines (74 loc) · 2.92 KB
Raw

Maintainability Test Coverage Build Status

BdLint

This is a developer tool designed to provide a consistant format for the Brad's Deals code base. It also adds checks for common issues like leaving debugging declarations in the code.The linter cover the following.

  • Javascript ES5 & ES6 support
  • JSON
  • Ruby & Ruby on Rails
  • SCSS & CSS
  • YAML

Installation

Add this line to your application's Gemfile:

group :development do
  gem 'bd_lint'
end

And then execute:

$ bundle

Application Setup

Add this snippet to the apps ./Rakefile If the app is NOT rails

begin
  require "bd_lint/rake_tasks"
rescue LoadError
  puts "BD Lint Not Loaded"
end

Install/Update bd lint config:

$ bundle exec rake bd_lint:setup:app

Local Developer Setup

Install pre-commit on your local copy of the application

$ bundle exec rake bd_lint:setup:local

Bundle Audit Issues

If you are trying to merge or push a change out and temporarily ignore bundle audit, you can disable it by performing the following steps.

  1. Vist your Travis builds Repository
  2. Click More options / Settings
  3. Go to the Environment Variables section
  4. Add DISABLE_BUNDLE_AUDIT with a value of true
  5. Re-run your travis build
  6. After your build completes successfully remove the variable from Travis

Note

If you are merging a pull requests and deploying to staging wait until after your code is deployed before removing the variable from Travis.

If a gem has an open CVE with no viable long term fix and we need to ignore it without skipping all gems set the BUNDLE_AUDIT_IGNORE as a comma delimited value of CVE's

  1. Vist your Travis builds Repository
  2. Click More options / Settings
  3. Go to the Environment Variables section
  4. Add BUNDLE_AUDIT_IGNORE with a comma delimited list of CVE's
  5. Re-run your travis build

Additional Commands

Evaluate Changes Manually

If you wish to run checks without commiting you can run the following

$ bundle exec rake bd_lint:check

If you are using RVM and your install is not working

The command ensures checks will run on RMV

$ bundle exec rake bd_lint:rvm_check

Check an application for known security vulnerabilities in its Gems by running the following

$ bundle exec rake bd_lint:audit

Contributing

If you wish to contribute create a separate branch and submit a pull request to the master branch.

License

The gem is available as open source under the terms of the MIT License.