https://github.com/psu-libraries/niftany

Combining "nittany" and "nifty" into one, super-nice gem that lints all our code at once.
https://github.com/psu-libraries/niftany

ruby

Last synced: about 1 year ago
JSON representation

Combining "nittany" and "nifty" into one, super-nice gem that lints all our code at once.

• Host: GitHub
• URL: https://github.com/psu-libraries/niftany
• Owner: psu-libraries
• License: mit
• Created: 2018-03-23T15:10:02.000Z (over 8 years ago)
• Default Branch: main
• Last Pushed: 2025-02-20T17:28:57.000Z (over 1 year ago)
• Last Synced: 2025-03-29T01:34:11.871Z (about 1 year ago)
• Topics: ruby
• Language: Ruby
• Homepage:
• Size: 50.8 KB
• Stars: 2
• Watchers: 8
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# Niftany

A portmanteau of Penn State's _nittany_ lion, and _nifty_, meaning fashionable and stylish.

Niftany combines different linters such as Rubocop, erb-lint, scss-lint and others,

manging their different versions and configurations in one gem.

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'niftany'

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install niftany

## Usage

To run all the linters at once:

    $ bundle exec niftany

Setup and run each linter accordingly:

### Rubocop

In your local `.rubocop.yml` file, add:

    inherit_gem:

      niftany: niftany_rubocop.yml

Then run:

    $ bundle exec rubocop -a

### erb-lint

Copy `niftany_erblint.yml` to `.erb-lint.yml` in your local repo and run:

    $ bundle exec erblint --lint-all --autocorrect

### scss-lint

Copy `niftany_scsslint.yml` to `.scss-lint.yml` in your local repo and run:

    $ bundle exec scss-lint