Introduce Makefile for common dev commands

- Also includes Yard

Author: JPrevost

.gitignore

@@ -33,3 +33,4 @@ yarn-debug.log*
 
 .DS_Store
 .vscode/
+.yardoc

Gemfile

@@ -38,6 +38,7 @@ group :development do
   gem 'rubocop'
   gem 'rubocop-rails'
   gem 'web-console'
+  gem 'yard'
 end
 
 group :test do

Gemfile.lock

@@ -392,6 +392,7 @@ GEM
     websocket-extensions (0.1.5)
     xpath (3.2.0)
       nokogiri (~> 1.8)
+    yard (0.9.37)
     zeitwerk (2.7.3)
 
 PLATFORMS
@@ -443,6 +444,7 @@ DEPENDENCIES
   vcr
   web-console
   webmock
+  yard
 
 RUBY VERSION
    ruby 3.4.7p58

Makefile

@@ -0,0 +1,55 @@
+.PHONY: test
+
+help: # display Makefile commands
+	@awk 'BEGIN { FS = ":.*#"; print "Usage:  make <target>\n\nTargets:" } \
+  /^[-_[:alpha:]]+:.?*#/ { printf "  %-15s%s\n", $$1, $$2 }' $(MAKEFILE_LIST)
+
+#######################
+# Local development commands
+#######################
+
+run: # runs server on localhost
+	bin/rails server
+
+console: # runs console
+	bin/rails console
+
+test: # Run tests
+	bin/rails test
+
+coverage: test # Run tests and open coverage report in default web browser
+	open coverage/index.html
+
+#######################
+# Documentation commands
+#######################
+
+annotate: # update Rails models documentation header
+	bundle exec annotate --models
+
+docserver: # runs local documentation server
+	rm -rf .yardoc # Clears cache as it's sketchy af
+	yard server --reload
+
+#######################
+# Dependency commands
+#######################
+
+install: # Install dependencies
+	bundle install
+
+outdated: # List outdated dependencies
+	bundle outdated
+
+####################################
+# Code quality and safety commands
+####################################
+
+lint:
+	bundle exec rubocop
+
+lint-models:
+	bundle exec rubocop app/models
+
+lint-controllers:
+	bundle exec rubocop app/controllers