ruby / rbs

Type Signature for Ruby

Other

1.91k stars 201 forks source link

Introduce rubocop-on-rbs #1899

Open ksss opened 2 weeks ago

ksss commented 2 weeks ago

I propose to introduce rubocop-on-rbs.

This is a lint tool for RBS file.

This tool automates trivial indentation and style remarks during review.

Examples of remarks from RuboCop

Departments

This PR enables RBS/Layout and RBS/Lint departments.

RBS/Layout provides feedback on indentation and spacing, which does not affect the semantics of RBS at all.
RBS/Lint points out important issues such as syntax errors and unused type variables.

See also all documentation. https://github.com/ksss/rubocop-on-rbs/blob/main/docs/modules/ROOT/pages/cops.adoc

This introduction does not use RBS/Style cops. RBS/Style will be discussed and introduced one by one later.

Notice

I'm not sure that running the RuboCop task on both head and 3.3 in CI. Probably for the purpose of running rubycw with head.