Add clangd integration for improved C extension development

st0012 · amomchilov · st0012 · commit 242422fa314d · 2025-05-15T11:23:51.000+01:00
- Added extconf_compile_commands_json for generating and symlinking
  compile_commands.json
- Added .clangd config to point to compilation database

Co-authored-by: Alexander Momchilov &lt;alexander.momchilov@shopify.com&gt;
diff --git a/.clangd b/.clangd
@@ -0,0 +1,2 @@
+CompileFlags:
+    CompilationDatabase: ext/rbs_extension
diff --git a/.gitignore b/.gitignore
@@ -21,3 +21,7 @@ lib/**/*.dll
 doc/
 
 **/*.gem
+
+# For clangd's editor integration
+ext/rbs_extension/compile_commands.json
+ext/rbs_extension/.cache
diff --git a/Gemfile b/Gemfile
@@ -20,6 +20,7 @@ gem "rdoc"
 gem "fileutils"
 gem "raap"
 gem "activesupport", "~> 7.0"
+gem "extconf_compile_commands_json"
 
 group :libs do
   # Libraries required for stdlib test
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -40,6 +40,7 @@ GEM
     diff-lcs (1.6.2)
     digest (3.2.0)
     drb (2.2.1)
+    extconf_compile_commands_json (0.0.7)
     ffi (1.17.2)
     fileutils (1.7.3)
     goodcheck (3.1.0)
@@ -184,6 +185,7 @@ DEPENDENCIES
   csv
   dbm
   digest
+  extconf_compile_commands_json
   fileutils
   goodcheck
   json
diff --git a/ext/rbs_extension/extconf.rb b/ext/rbs_extension/extconf.rb
@@ -25,3 +25,7 @@
 end
 
 create_makefile 'rbs_extension'
+
+require 'extconf_compile_commands_json'
+ExtconfCompileCommandsJson.generate!
+ExtconfCompileCommandsJson.symlink!

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+CompileFlags:`
	`2`	`+ CompilationDatabase: ext/rbs_extension`