add compilation flags support

Author: elbywan

README.md

@@ -339,6 +339,17 @@ crystalline:
 
 Each of these projects must contain the `shard.yml`, ideally with the entry point as mentioned above. However, even if no entry point is present, `require`s will still be resolved relative to the project directory rather than the root directory.
 
+### Compilation flags
+
+To use specific compilation flags, you can add a `crystalline/flags` key in the `shard.yml` file:
+
+```yml
+crystalline:
+  flags:
+    - preview_mt
+    - execution_context
+```
+
 ## Features
 
 **Disclaimer: `Crystalline` is not as extensive in terms of features as other

shard.yml

@@ -23,4 +23,8 @@ development_dependencies:
 
 crystal: ">= 0.36.1, < 2.0.0"
 
+crystalline:
+  flags:
+    - preview_mt
+
 license: MIT

src/crystalline/analysis/analysis.cr

@@ -18,24 +18,25 @@ module Crystalline::Analysis
   end
 
   # Compile a target *file_uri*.
-  def self.compile(server : LSP::Server, file_uri : URI, *, lib_path : String? = nil, file_overrides : Hash(String, String)? = nil, ignore_diagnostics = false, wants_doc = false, fail_fast = false, top_level = false)
+  def self.compile(server : LSP::Server, file_uri : URI, *, lib_path : String? = nil, file_overrides : Hash(String, String)? = nil, ignore_diagnostics = false, wants_doc = false, fail_fast = false, top_level = false, compiler_flags : Array(String) = [] of String)
     if file_uri.scheme == "file"
       file = File.new file_uri.decoded_path
       sources = [
         Crystal::Compiler::Source.new(file_uri.decoded_path, file.gets_to_end),
       ]
       file.close
-      self.compile(server, sources, lib_path: lib_path, file_overrides: file_overrides, ignore_diagnostics: ignore_diagnostics, wants_doc: wants_doc, top_level: top_level)
+      self.compile(server, sources, lib_path: lib_path, file_overrides: file_overrides, ignore_diagnostics: ignore_diagnostics, wants_doc: wants_doc, top_level: top_level, compiler_flags: compiler_flags)
     end
   end
 
   # Compile an array of *sources*.
-  def self.compile(server : LSP::Server, sources : Array(Crystal::Compiler::Source), *, lib_path : String? = nil, file_overrides : Hash(String, String)? = nil, ignore_diagnostics = false, wants_doc = false, fail_fast = false, top_level = false)
+  def self.compile(server : LSP::Server, sources : Array(Crystal::Compiler::Source), *, lib_path : String? = nil, file_overrides : Hash(String, String)? = nil, ignore_diagnostics = false, wants_doc = false, fail_fast = false, top_level = false, compiler_flags : Array(String) = [] of String)
     diagnostics = Diagnostics.new
     reply_channel = Channel(Crystal::Compiler::Result | Exception).new
 
     # LSP::Log.info { "sources: #{sources.map(&.filename)}" }
     # LSP::Log.info { "lib_path: #{lib_path}" }
+    LSP::Log.info { "compiler_flags: #{compiler_flags}" }
 
     # Delegate heavy processing to a separate thread.
     spawn_dedicated do
@@ -48,6 +49,7 @@ module Crystalline::Analysis
       compiler.wants_doc = wants_doc
       compiler.stdout = dev_null
       compiler.stderr = dev_null
+      compiler.flags = compiler_flags
 
       if lib_path_override = lib_path
         path = Crystal::CrystalPath.default_path_without_lib.split(Process::PATH_DELIMITER)

src/crystalline/main.cr

@@ -46,7 +46,9 @@ module Crystalline
 
   def self.init(*, input : IO = STDIN, output : IO = STDOUT)
     EnvironmentConfig.run
-    # ::Log.setup(:debug, LSP::Log.backend.not_nil!)
+    {% if flag?(:debug) %}
+      ::Log.setup(:debug, LSP::Log.backend.not_nil!)
+    {% end %}
     server = LSP::Server.new(input, output, SERVER_CAPABILITIES)
     Controller.new(server)
   rescue ex

src/crystalline/project.cr

@@ -7,15 +7,11 @@ class Crystalline::Project
   property dependencies : Set(String) = Set(String).new
   # Determines the project entry point.
   getter? entry_point : URI? do
-    path = Path[root_uri.decoded_path, "shard.yml"]
-    shards_yaml = File.open(path) do |file|
-      YAML.parse(file)
-    end
-    shard_name = shards_yaml["name"].as_s
+    shard_name = shard_yaml["name"].as_s
     # If shard.yml has the `crystalline/main` key, use that.
-    relative_main = shards_yaml.dig?("crystalline", "main").try &.as_s
+    relative_main = shard_yaml.dig?("crystalline", "main").try &.as_s
     # Else if shard.yml has a `targets/[shard name]/main` key, use that.
-    relative_main ||= shards_yaml.dig?("targets", shard_name, "main").try &.as_s
+    relative_main ||= shard_yaml.dig?("targets", shard_name, "main").try &.as_s
     if relative_main && File.exists? Path[root_uri.decoded_path, relative_main]
       main_path = Path[root_uri.decoded_path, relative_main]
       # Add the entry point as a dependency to itself.
@@ -25,6 +21,19 @@ class Crystalline::Project
   rescue e
     nil
   end
+  # Flags to pass to the underlying compiler (-Dpreview_mt, etc).
+  getter flags : Array(String) do
+    (shard_yaml.dig?("crystalline", "flags").try(&.as_a.map(&.as_s)) || [] of String).tap do |flags|
+      LSP::Log.info { "Flags for project #{root_uri}: #{flags}" }
+    end
+  end
+
+  private getter shard_yaml : YAML::Any do
+    path = Path[root_uri.decoded_path, "shard.yml"]
+    shards_yaml = File.open(path) do |file|
+      YAML.parse(file)
+    end
+  end
 
   def initialize(@root_uri)
   end

src/crystalline/workspace.cr

@@ -91,7 +91,7 @@ class Crystalline::Workspace
     return unless target = project.entry_point?
 
     lib_path = project.default_lib_path
-    Analysis.compile(server, target, lib_path: lib_path, ignore_diagnostics: true, wants_doc: false, top_level: true).try { |result|
+    Analysis.compile(server, target, lib_path: lib_path, ignore_diagnostics: true, wants_doc: false, top_level: true, compiler_flags: project.flags).try { |result|
       project.dependencies = result.program.requires
     }
   rescue
@@ -114,7 +114,7 @@ class Crystalline::Workspace
     text_overrides = nil,
     fail_fast = false,
     top_level = false,
-    discard_nil_cached_result = false
+    discard_nil_cached_result = false,
   )
     @projects.each do |project|
       # If the project has less than 1 dependency, it could mean that the last
@@ -185,7 +185,7 @@ class Crystalline::Workspace
         end
 
         lib_path = project.try(&.default_lib_path)
-        result = Analysis.compile(server, sources || target, lib_path: lib_path, file_overrides: file_overrides, ignore_diagnostics: ignore_diagnostics, wants_doc: wants_doc, top_level: top_level)
+        result = Analysis.compile(server, sources || target, lib_path: lib_path, file_overrides: file_overrides, ignore_diagnostics: ignore_diagnostics, wants_doc: wants_doc, top_level: top_level, compiler_flags: project.try(&.flags) || [] of String)
         # Store the result in the cache, unless a client event invalided the previous cache.
         # For instance if a compilation is running, but the user saved the document in the meantime (before completion)
         # then we discard the result because it is already outdated.