Use StandardRB for linting & formatting

Simple, minimal config, effective

Fixes #101

Author: brettchalupa

.github/workflows/tests.yml

@@ -18,5 +18,7 @@ jobs:
         with:
           ruby-version: ${{ matrix.ruby-version }}
           bundler-cache: true
+      - name: Run StandardRB
+        run: bundle exec rake standard
       - name: Run test suite
         run: bundle exec rake

.rubocop.yml

@@ -8,10 +8,28 @@ For fixes and small additions, follow the steps below to get developing and cont
 2. Run the `bin/setup` script to install development dependencies
 3. Work on a branch
 4. Make changes
-5. Ensure tests pass by running `bin/rake`
+5. Ensure tests and code style checks pass by running `bin/rake` (runs both StandardRB and tests)
 6. Commit your changes, this project follows [the Conventional Commits spec](https://www.conventionalcommits.org/en/v1.0.0/)
 7. Open up a pull request
 
+## Code Style
+
+This project uses [StandardRB](https://github.com/standardrb/standard) for Ruby code style. StandardRB is an opinionated, zero-configuration linter and formatter.
+
+Before committing your changes, make sure your code passes StandardRB:
+
+```console
+bundle exec rake standard
+```
+
+To automatically fix most style issues:
+
+```console
+bundle exec rake standard:fix
+```
+
+The default `bin/rake` command runs both StandardRB checks and the test suite, so you can verify everything at once.
+
 ## Finding Issues
 
 - Good First Issue — If you're new to the project or Ruby, check out the ["good first issue" tag](https://github.com/brettchalupa/graphql-docs/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22). They're smaller, approachable issues if you're just getting started.

CONTRIBUTING.md

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in graphql-docs.gemspec
 gemspec

Gemfile

@@ -498,6 +498,30 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 `bin/rake test` to run the tests. You can also run `bin/console` for
 an interactive prompt that will allow you to experiment.
 
+### Code Style
+
+This project uses [StandardRB](https://github.com/standardrb/standard) for Ruby code style enforcement. StandardRB is a zero-configuration formatter and linter based on RuboCop.
+
+To check your code style:
+
+```console
+bundle exec rake standard
+```
+
+To automatically fix style issues:
+
+```console
+bundle exec rake standard:fix
+```
+
+The default rake task runs both StandardRB and the test suite:
+
+```console
+bundle exec rake
+```
+
+StandardRB checks are also run in CI, so make sure your code passes before opening a pull request.
+
 ### Releasing a new version of the gem
 
 1. Update CHANGELOG.md

README.md

@@ -1,116 +1,114 @@
 # frozen_string_literal: true
 
-require 'bundler/gem_tasks'
-require 'rake/testtask'
+require "bundler/gem_tasks"
+require "rake/testtask"
 
-require 'rubocop/rake_task'
-
-RuboCop::RakeTask.new(:rubocop)
+require "standard/rake"
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.libs << 'lib'
+  t.libs << "test"
+  t.libs << "lib"
   t.warning = false
-  t.test_files = FileList['test/**/*_test.rb']
+  t.test_files = FileList["test/**/*_test.rb"]
 end
 
-task default: :test
+task default: [:standard, :test]
 
-desc 'Invoke HTML-Proofer'
+desc "Invoke HTML-Proofer"
 task :html_proofer do
   Rake::Task[:generate_sample]
-  require 'html-proofer'
-  output_dir = File.join(File.dirname(__FILE__), 'output')
+  require "html-proofer"
+  output_dir = File.join(File.dirname(__FILE__), "output")
 
-  proofer_options = { disable_external: true, assume_extension: true }
+  proofer_options = {disable_external: true, assume_extension: true}
   HTMLProofer.check_directory(output_dir, proofer_options).run
 end
 
-desc 'Set up a console'
+desc "Set up a console"
 task :console do
-  require 'graphql-docs'
+  require "graphql-docs"
 
   def reload!
     files = $LOADED_FEATURES.select { |feat| feat =~ %r{/graphql-docs/} }
     files.each { |file| load file }
   end
 
-  require 'irb'
+  require "irb"
   ARGV.clear
   IRB.start
 end
 
 namespace :yard do
-  desc 'Generate YARD documentation'
+  desc "Generate YARD documentation"
   task :doc do
-    sh 'bundle exec yard doc'
+    sh "bundle exec yard doc"
   end
 
-  desc 'Run YARD documentation server'
+  desc "Run YARD documentation server"
   task :server do
     puts "Starting YARD server at http://localhost:8808"
     puts "Press Ctrl+C to stop"
-    sh 'bundle exec yard server --reload --bind 0.0.0.0 --port 8808'
+    sh "bundle exec yard server --reload --bind 0.0.0.0 --port 8808"
   end
 end
 
 # Alias for convenience
-desc 'Generate YARD documentation'
-task yard: 'yard:doc'
+desc "Generate YARD documentation"
+task yard: "yard:doc"
 
 namespace :sample do
-  desc 'Generate the sample documentation'
+  desc "Generate the sample documentation"
   task :generate do
-    require 'graphql-docs'
+    require "graphql-docs"
 
     options = {}
     options[:delete_output] = true
-    options[:base_url] = ENV.fetch('GQL_DOCS_BASE_URL', '')
-    options[:filename] = File.join(File.dirname(__FILE__), 'test', 'graphql-docs', 'fixtures', 'gh-schema.graphql')
+    options[:base_url] = ENV.fetch("GQL_DOCS_BASE_URL", "")
+    options[:filename] = File.join(File.dirname(__FILE__), "test", "graphql-docs", "fixtures", "gh-schema.graphql")
 
     puts "Generating sample docs"
     GraphQLDocs.build(options)
   end
 
-  desc 'Generate the documentation and run a web server'
+  desc "Generate the documentation and run a web server"
   task serve: [:generate] do
-    require 'webrick'
-    PORT = "5050"
-    puts "Navigate to http://localhost:#{PORT} to view the sample docs"
-    server = WEBrick::HTTPServer.new Port: PORT
-    server.mount '/', WEBrick::HTTPServlet::FileHandler, 'output'
-    trap('INT') { server.stop }
+    require "webrick"
+    port = "5050"
+    puts "Navigate to http://localhost:#{port} to view the sample docs"
+    server = WEBrick::HTTPServer.new Port: port
+    server.mount "/", WEBrick::HTTPServlet::FileHandler, "output"
+    trap("INT") { server.stop }
     server.start
   end
   task server: :serve
 
-  desc 'Run the sample docs as a Rack application (dynamic, on-demand generation)'
+  desc "Run the sample docs as a Rack application (dynamic, on-demand generation)"
   task :rack do
-    require 'rack'
-    require 'graphql-docs'
+    require "rack"
+    require "graphql-docs"
 
-    schema_path = File.join(File.dirname(__FILE__), 'test', 'graphql-docs', 'fixtures', 'gh-schema.graphql')
+    schema_path = File.join(File.dirname(__FILE__), "test", "graphql-docs", "fixtures", "gh-schema.graphql")
     schema = File.read(schema_path)
 
-    app = GraphQLDocs::App.new(
+    GraphQLDocs::App.new(
       schema: schema,
       options: {
-        base_url: '',
+        base_url: "",
         use_default_styles: true,
         cache: true
       }
     )
 
-    PORT = ENV.fetch('PORT', '9292')
+    port = ENV.fetch("PORT", "9292")
     puts "Starting Rack server in dynamic mode (on-demand generation)"
-    puts "Navigate to http://localhost:#{PORT} to view the sample docs"
+    puts "Navigate to http://localhost:#{port} to view the sample docs"
     puts "Press Ctrl+C to stop"
     puts ""
     puts "NOTE: This serves documentation dynamically - pages are generated on request"
     puts "      Compare with 'rake sample:serve' which serves pre-generated static files"
     puts ""
 
     # Use rackup for Rack 3.x compatibility
-    sh "rackup config.ru -p #{PORT}"
+    sh "rackup config.ru -p #{port}"
   end
 end

Rakefile

@@ -8,10 +8,10 @@
 # Run with: rackup config.ru
 # Or with specific port: rackup config.ru -p 9292
 
-require_relative 'lib/graphql-docs'
+require_relative "lib/graphql-docs"
 
 # Load the sample GraphQL schema
-schema_path = File.join(__dir__, 'test', 'graphql-docs', 'fixtures', 'gh-schema.graphql')
+schema_path = File.join(__dir__, "test", "graphql-docs", "fixtures", "gh-schema.graphql")
 
 unless File.exist?(schema_path)
   puts "Error: Sample schema not found at #{schema_path}"
@@ -25,7 +25,7 @@ schema = File.read(schema_path)
 app = GraphQLDocs::App.new(
   schema: schema,
   options: {
-    base_url: '',
+    base_url: "",
     use_default_styles: true,
     cache: true
   }
@@ -35,7 +35,7 @@ app = GraphQLDocs::App.new(
 use Rack::CommonLogger
 
 # Add reloader for development (optional, requires 'rack' gem)
-if ENV['RACK_ENV'] != 'production'
+if ENV["RACK_ENV"] != "production"
   puts "Running in development mode"
   puts "Visit http://localhost:9292 to view the documentation"
   puts "Press Ctrl+C to stop the server"

config.ru

@@ -10,17 +10,17 @@ OptionParser.new do |parser|
   parser.program_name = NAME
   parser.banner = <<~EOS
 
-  Generate GraphQL docs from the passed in schema file.
+    Generate GraphQL docs from the passed in schema file.
 
-  Usage: graphql-docs SCHEMA
+    Usage: graphql-docs SCHEMA
 
-  The only required argument is the path to the schema file to generate the site from.
+    The only required argument is the path to the schema file to generate the site from.
 
-  Examples:
-    $ graphql-docs schema.graphql
-    $ graphql-docs schema.graphql -o _docs
+    Examples:
+      $ graphql-docs schema.graphql
+      $ graphql-docs schema.graphql -o _docs
 
-  Options:
+    Options:
   EOS
 
   parser.version = GraphQLDocs::VERSION
@@ -51,7 +51,7 @@ verbose = opts.delete(:verbose)
 
 puts("Generating site with the following options: #{opts}") if verbose
 
-opts.transform_keys! { |k| k.to_s.gsub("-", "_").to_sym }
+opts.transform_keys! { |k| k.to_s.tr("-", "_").to_sym }
 GraphQLDocs.build(opts)
 
-puts("Site successfully generated in: #{opts[:output_dir] || 'output' }") if verbose
+puts("Site successfully generated in: #{opts[:output_dir] || "output"}") if verbose