extconf_compile_commands_json 0.0.1 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c4119e56b170eeb8c7754f47f7735f14f9e2110aec9a55d2627d2be4b96e24d
-  data.tar.gz: 8db262a1e1ceba1e9246fa88914c2cd44b5e36a1b0b80e4ef83be7d159d51f72
+  metadata.gz: 92e4b4fbb8bb8e86e7039716f5ea508d2384890760e5eac2b4e0aa2d4e7acc5a
+  data.tar.gz: a9a7564118dba73159f3888a84cc1d5177561480005584b6a538e5ee7d2ec207
 SHA512:
-  metadata.gz: af7263343f4e56f58c8c49cd40b74bec3865b3bbea54fe32c730f69fd90decb0fbfd6cea29fb373bd319c34099a95c1df22cea09bd1e75132860636adc579f0c
-  data.tar.gz: f547795042f887afd413b52e39310bcd0b3dfe106729c90bb3583ca6b8d8771eb4c8a31b81aac8beaa9592d026e5801d8ad755c05d130a78f24878c01446102a
+  metadata.gz: 549e9d2def77550934c972edca5c86d0edab4211d5175099f312d6319eaf9ce03aba745863a8097e7d64d3825f4e509596a49798e653a44e23b020e7abcf492f
+  data.tar.gz: 6ae64693bf58886d3670d3bc7032520d0db565d4eeabb7ae90ab376deb357db0e4cd330619cec29dad0d192b6223e5b4f2623c3b201934cbc84b6b1b207c1b95

data/lib/extconf_compile_commands_json/autoload.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# Requiring this file will patch MkMf to auto-magically generate compile_commands.json.
+# Handy to add to a RUBYOPT env var or such, so you can work on a project not using
+# this gem but benefit from it yourself, without having to modify the existing build
+# scripts.
+
+require "mkmf"
+# the require_relative looks stupid, but it ensures that you can load this patch
+# simply by running adding -r/path/to/autoload.rb to your Ruby invocation without
+# needing to muck about with $LOAD_PATH or Bundler.
+require_relative "../extconf_compile_commands_json"
+
+module ExtconfCompileCommandsJson
+  module AutoloadPatch
+    def create_makefile(*args)
+      super
+      ExtconfCompileCommandsJson.generate!
+      ExtconfCompileCommandsJson.symlink!
+    end
+  end
+end
+
+MakeMakefile.prepend ExtconfCompileCommandsJson::AutoloadPatch
+# We have to patch the toplevel binding directly as well, because requiring
+# mkmf includes it into main straight away. So, prepending to MakeMakefile
+# will be ignored if someone calls "create_makefile" in their extconf.rb
+prepend ExtconfCompileCommandsJson::AutoloadPatch

data/lib/extconf_compile_commands_json.rb

@@ -3,9 +3,10 @@
 require "mkmf"
 require "shellwords"
 require "json"
+require "fileutils"
 
 module ExtconfCompileCommandsJson
-  def self.generate_compile_commands_json
+  def self.generate!
     mkmf_cflags = []
     # Start by expanding what's in our magic variables
     [$INCFLAGS, $CPPFLAGS, $CFLAGS, $COUTFLAGS].each do |v|
@@ -41,4 +42,17 @@ module ExtconfCompileCommandsJson
     end
     File.write("compile_commands.json", compile_commands.to_json)
   end
+
+  # generate will put the compile_commands.json in the same folder as the
+  # compiled output (and Makefile); symlink will create a symlink in the
+  # same folder as the extconf.rb, so that clangd can find it.
+  def self.symlink!
+    # This is the same check mkmf does for deciding whether to spew errors onto your
+    # terminal, so I figure it'll do for spewing symlinks into your directory too.
+    return unless !$extmk && (/\A(extconf|makefile).rb\z/ =~ File.basename($0))
+    extconf_dir = File.dirname $0
+    compile_commands_file = File.realpath("./compile_commands.json")
+    return unless File.exist? compile_commands_file
+    FileUtils.ln_sf compile_commands_file, File.join(extconf_dir, "compile_commands.json")
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: extconf_compile_commands_json
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.4
 platform: ruby
 authors:
 - KJ Tsanaktsidis
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-03 00:00:00.000000000 Z
+date: 2022-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: standard
@@ -34,6 +34,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/extconf_compile_commands_json.rb
+- lib/extconf_compile_commands_json/autoload.rb
 homepage: https://github.com/KJTsanaktsidis/extconf_compile_commands_json
 licenses:
 - MIT