diff --git a/.gitignore b/.gitignore index bea7290ec..d44e5cfde 100644 --- a/.gitignore +++ b/.gitignore @@ -103,3 +103,6 @@ dump.rdb # pry configuration file .pryrc + +# generated yarddoc +doc/ \ No newline at end of file diff --git a/.solargraph.yml b/.solargraph.yml new file mode 100644 index 000000000..397304276 --- /dev/null +++ b/.solargraph.yml @@ -0,0 +1,23 @@ +--- +include: +- "**/*.rb" +exclude: +- spec/**/* +- test/**/* +- vendor/**/* +- ".bundle/**/*" +require: [] +domains: [] +reporters: +- rubocop +- require_not_found +formatter: + rubocop: + cops: safe + except: [] + only: [] + extra_args: [] +require_paths: [] +plugins: + - solargraph-rails +max_files: 5000 diff --git a/Gemfile b/Gemfile index 6070196e2..7add981bf 100644 --- a/Gemfile +++ b/Gemfile @@ -125,7 +125,11 @@ group :development do gem "listen", "~> 3.7", require: false # Helps 'listen' to file system modifications events (also used by other gems like guard) gem "memory_profiler", "~> 1.0", require: false # Memory profiling routines for Ruby 2.3+ gem "solargraph", "~> 0.44", require: false # For LSP support (such as symbol renaming, documentation lookup) + gem "solargraph-rails", "~> 0.3.1", require: false # For LSP support with Rails gem "web-console", "~> 4.2" # Rails Console on the Browser + gem "yard", "~> 0.9" # Documentation format + gem "yard-activerecord", "~> 0.0" + gem "yard-activesupport-concern", "~> 0.0" end group :development, :test do diff --git a/Gemfile.lock b/Gemfile.lock index 7120467ae..211c95f5a 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -330,8 +330,6 @@ GEM globalid (1.0.0) activesupport (>= 5.0) google-protobuf (3.19.4) - google-protobuf (3.19.4-x86_64-darwin) - google-protobuf (3.19.4-x86_64-linux) guard (2.18.0) formatador (>= 0.2.4) listen (>= 2.7, < 4.0) @@ -493,12 +491,6 @@ GEM nokogiri (1.13.3) mini_portile2 (~> 2.8.0) racc (~> 1.4) - nokogiri (1.13.3-arm64-darwin) - racc (~> 1.4) - nokogiri (1.13.3-x86_64-darwin) - racc (~> 1.4) - nokogiri (1.13.3-x86_64-linux) - racc (~> 1.4) notiffany (0.1.3) nenv (~> 0.1) shellany (~> 0.0) @@ -793,6 +785,9 @@ GEM thor (~> 1.0) tilt (~> 2.0) yard (~> 0.9, >= 0.9.24) + solargraph-rails (0.3.1) + activesupport + solargraph (>= 0.41.1) sprockets (4.0.3) concurrent-ruby (~> 1.0) rack (> 1, < 3) @@ -881,6 +876,10 @@ GEM nokogiri (~> 1.8) yard (0.9.27) webrick (~> 1.7.0) + yard-activerecord (0.0.16) + yard (>= 0.8.3) + yard-activesupport-concern (0.0.1) + yard (>= 0.8) zeitwerk (2.5.4) zonebie (0.6.1) @@ -1018,6 +1017,7 @@ DEPENDENCIES simplecov (~> 0.21.2) slack-notifier (~> 2.4) solargraph (~> 0.44) + solargraph-rails (~> 0.3.1) sprockets (~> 4.0) staccato (~> 0.5) stackprof (~> 0.2) @@ -1039,6 +1039,9 @@ DEPENDENCIES webmock (~> 3.14) webpacker (~> 5.4.3) with_model (~> 2.1.6) + yard (~> 0.9) + yard-activerecord (~> 0.0) + yard-activesupport-concern (~> 0.0) zonebie (~> 0.6.1) RUBY VERSION diff --git a/vendor/cache/solargraph-rails-0.3.1.gem b/vendor/cache/solargraph-rails-0.3.1.gem new file mode 100644 index 000000000..6f047a6d0 Binary files /dev/null and b/vendor/cache/solargraph-rails-0.3.1.gem differ diff --git a/vendor/cache/yard-activerecord-0.0.16.gem b/vendor/cache/yard-activerecord-0.0.16.gem new file mode 100644 index 000000000..78becc42d Binary files /dev/null and b/vendor/cache/yard-activerecord-0.0.16.gem differ diff --git a/vendor/cache/yard-activesupport-concern-0.0.1.gem b/vendor/cache/yard-activesupport-concern-0.0.1.gem new file mode 100644 index 000000000..1857f7146 Binary files /dev/null and b/vendor/cache/yard-activesupport-concern-0.0.1.gem differ