npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

vile-rubycritic

v0.3.0

Published

Lint your Ruby code, identify similar methods, and calculate code churn.

Downloads

15

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

brentlintnerbrentlintner

Keywords

vilerubycriticflogflayreekruby

Readme

vile-rubycritic Circle CI Build status score-badge coverage-badge dependency-badge

A Vile plugin for linting your Ruby code, identifying similar methods, and calculating code churn (via RubyCritic).

Requirements

Installation

Currently, you need to have rubycritic installed manually.

Example:

npm i -D vile vile-rubycritic
gem install rubycritic

Note: A good strategy is to use Bundler.

Config

Example:

rubycritic:
  allow:
    - app
    - spec
  config:
    rating: "A"

Any source control related properites like churn will be ignored if you are not using anything like Git.

Ignore

Since rubycritic honours your .reek configuration, you should be able to use that to ignore files.

However, it appears that ignoring files is not wholistically supported, so a solution for now is to specify whitelist paths:

rubycritic:
  allow:
    - app
    - lib

Gotchas

If you see something like this:

error worker Error: ENOENT: no such file or directory, open './tmp/rubycritic/report.json'

...and you are using the slim-lint plugin, see here for some workarounds.

If nothing helps, feel free to open an issue!

Vile Types Generated

  • vile.DUPE
  • vile.CHURN
  • vile.COMP
  • vile.MAIN

Versioning

This project uses Semver.

Licensing

This project is licensed under the MPL-2.0 license.

Any contributions made to this project are made under the current license.

Contributions

Current list of Contributors.

Any contributions are welcome and appreciated!

All you need to do is submit a Pull Request.

  1. Please consider tests and code quality before submitting.
  2. Please try to keep commits clean, atomic and well explained (for others).

Issues

Current issue tracker is on GitHub.

Even if you are uncomfortable with code, an issue or question is welcome.

Code Of Conduct

By participating in this project you agree to our Code of Conduct.

Maintainers

Architecture

This project is currently written in TypeScript.

RubyCritic provides a JSON CLI output that is currently used until a more ideal IPC option is implemented.

  • bin houses any shell based scripts
  • src typescript src
  • lib generated js library

Developing

cd vile-rubycritic
npm install
gem install rubycritic
npm run dev
npm test