New feature : linting

[ericproulx]

This PR adds a linting feature that can activated through Grape.config.lint = true or lint! in a Grape::Api.
Suggested in this comment.

By design, Grape's CI has Grape.config.lint = true, so all specs calling an endpoint are linted.

[dblock]

Should we call it lint! since it's Rack::Lint?

But thinking about it, maybe we need something more generic that allows one to inject middleware here, including potentially the ability to remove Rack::Head?

[ericproulx]

Should we call it lint! since it's Rack::Lint?

But thinking about it, maybe we need something more generic that allows one to inject middleware here, including potentially the ability to remove Rack::Head?

The middleware stack lacks a delete function. I think we should do something like ActionDispatch::MiddlewareStack

[dblock]

Please document this in the README if you want it merged.

That said, also consider not merging this and doing a configurable middleware implementation instead.

[Copilot]

Pull Request Overview

This PR introduces a new linting feature into the Grape framework, allowing endpoints to be linted by default or via a per-endpoint configuration. Key changes include:

• Enabling the global lint configuration in spec_helper and lib/grape.
• Incorporating Rack::Lint middleware in the endpoint stack when linting is enabled.
• Adding a new DSL method lint! to allow per-endpoint lint configuration.

Reviewed Changes

Copilot reviewed 6 out of 7 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
spec/spec_helper.rb	Enables linting globally by setting Grape.config.lint to true.
spec/integration/rails/mounting_spec.rb	Modifies Rails app instantiation and wraps the app with Rack::Lint.
spec/grape/api_spec.rb	Adds tests for the new .lint! behavior and Rack::Lint error handling.
lib/grape/endpoint.rb	Inserts Rack::Lint middleware conditionally and defines a lint? method.
lib/grape/dsl/routing.rb	Introduces lint! in the DSL for endpoint-specific lint enabling.
lib/grape.rb	Sets the default lint configuration to false.

Files not reviewed (1)

• docker/Dockerfile: Language not supported

[ericproulx]

Please document this in the README if you want it merged.

That said, also consider not merging this and doing a configurable middleware implementation instead.

I like the lint! DSL since we can configure our entire CI to use it by default. The configurable middleware seems a good idea but I don't know how we would enforce this in the CI without adding it in every call in every specs. It's already possible to do add Rack::Lint so to by calling:

insert_before Grape::Middleware::Error, Rack::Lint

I think the lint! really ease the whole thing.