chef / chef/cookstyle

Evaluate and implement additional helpers

Open
#321 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Helpers Type: Design Proposal
Dominant language
Ruby
Stars
112
Forks
69
Avg merge
5d 19h
Merged PRs (30d)
13

Description

Motivation

Specification

Foodcritic shipped with a large number of helpers that allowed users to get quick access to cookbook information without having to dig into xpath. Rubocop is inherently easier than Foodcritic and ships with about 100 built in helpers for the AST, but these aren't Chef specific. We should perform some basic gap analysis to determine where we might want to implement helpers. In particular there's some repetition in the node mappers that could be bubbled up to a helper. This sort of thing has been done in other rubocop plugins like rspec-ruubocop.

Downstream Impact

We'd refactor some rules with cookstyle already, but that should be transparent to the user.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing node mappers and the helper capabilities described for Foodcritic and RuboCop. Perform the requested gap analysis, identify repeated Chef-specific operations that could become helpers, and confirm that any rule refactoring remains transparent to users.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.