Rework: removed language specific file size in favor of global config

This sets a default maximum size of 150mb to trigger syntax highlighting
while allowing the user to specify an editor setting
  `syntax-max-file-size` to change the value of the maximum size
it will also notify the user once a file is opened if the limit is
exceeded.

Author: xEgoist

book/src/configuration.md

@@ -57,6 +57,7 @@ on unix operating systems.
 | `rulers` | List of column positions at which to display the rulers. Can be overridden by language specific `rulers` in `languages.toml` file. | `[]` |
 | `bufferline` | Renders a line at the top of the editor displaying open buffers. Can be `always`, `never` or `multiple` (only shown if more than one buffer is in use) | `never` |
 | `color-modes` | Whether to color the mode indicator with different colors depending on the mode itself | `false` |
+| `syntax-max-file-size` | Specify the maximum file size in bytes to enable syntax highlighting | `150000000` |
 
 ### `[editor.statusline]` Section
 

book/src/languages.md

@@ -62,7 +62,6 @@ These configuration keys are available:
 | `grammar`             | The tree-sitter grammar to use (defaults to the value of `name`) |
 | `formatter`           | The formatter for the language, it will take precedence over the lsp when defined. The formatter must be able to take the original file as input from stdin and write the formatted file to stdout |
 | `max-line-length`     | Maximum line length. Used for the `:reflow` command           |
-| `hl-max-size`         | Maximum file size in bytes for syntax highlighting            |
 
 ### File-type detection and the `file-types` key
 

helix-core/src/syntax.rs

@@ -122,8 +122,7 @@ pub struct LanguageConfiguration {
     #[serde(default, skip_serializing, deserialize_with = "deserialize_auto_pairs")]
     pub auto_pairs: Option<AutoPairs>,
 
-    pub rulers: Option<Vec<u16>>,   // if set, override editor's rulers
-    pub hl_max_size: Option<usize>, // maximum file size in bytes for highlighting
+    pub rulers: Option<Vec<u16>>, // if set, override editor's rulers
 }
 
 #[derive(Debug, PartialEq, Eq, Hash)]
@@ -551,7 +550,6 @@ pub struct Loader {
     language_config_ids_by_extension: HashMap<String, usize>, // Vec<usize>
     language_config_ids_by_suffix: HashMap<String, usize>,
     language_config_ids_by_shebang: HashMap<String, usize>,
-
     scopes: ArcSwap<Vec<String>>,
 }
 

helix-term/src/application.rs

@@ -176,7 +176,7 @@ impl Application {
                 &config.editor
             })),
         );
-
+        let mut enable_syntax_highlighting = true;
         let keys = Box::new(Map::new(Arc::clone(&config), |config: &Config| {
             &config.keys
         }));
@@ -223,11 +223,18 @@ impl Application {
                         // opened last is focused on.
                         let view_id = editor.tree.focus;
                         let doc = doc_mut!(editor, &doc_id);
+                        enable_syntax_highlighting = doc.enable_syntax_highlighting;
                         let pos = Selection::point(pos_at_coords(doc.text().slice(..), pos, true));
                         doc.set_selection(view_id, pos);
                     }
                 }
-                editor.set_status(format!("Loaded {} files.", nr_of_files));
+                if !enable_syntax_highlighting {
+                    editor.set_error(format!(
+                        "Warning: Syntax highlighting is disabled due to exceeding the size limit"
+                    ));
+                } else {
+                    editor.set_status(format!("Loaded {} files.", nr_of_files));
+                }
                 // align the view to center after all files are loaded,
                 // does not affect views without pos since it is at the top
                 let (view, doc) = current!(editor);

helix-term/src/ui/picker.rs

@@ -150,7 +150,7 @@ impl<T: Item> FilePicker<T> {
                     (size, _) if size > MAX_FILE_SIZE_FOR_PREVIEW => CachedPreview::LargeFile,
                     _ => {
                         // TODO: enable syntax highlighting; blocked by async rendering
-                        Document::open(path, None, None)
+                        Document::open(path, None, None, 0)
                             .map(|doc| CachedPreview::Document(Box::new(doc)))
                             .unwrap_or(CachedPreview::NotFound)
                     }

helix-view/src/document.rs

@@ -133,6 +133,7 @@ pub struct Document {
 
     diagnostics: Vec<Diagnostic>,
     language_server: Option<Arc<helix_lsp::Client>>,
+    pub enable_syntax_highlighting: bool,
 }
 
 use std::{fmt, mem};
@@ -371,6 +372,7 @@ impl Document {
             last_saved_revision: 0,
             modified_since_accessed: false,
             language_server: None,
+            enable_syntax_highlighting: true,
         }
     }
 
@@ -381,6 +383,7 @@ impl Document {
         path: &Path,
         encoding: Option<&'static encoding::Encoding>,
         config_loader: Option<Arc<syntax::Loader>>,
+        file_size_limit: usize,
     ) -> Result<Self, Error> {
         // Open the file if it exists, otherwise assume it is a new file (and thus empty).
         let (rope, encoding) = if path.exists() {
@@ -397,6 +400,9 @@ impl Document {
         // set the path and try detecting the language
         doc.set_path(Some(path))?;
         if let Some(loader) = config_loader {
+            if doc.text().len_bytes() > file_size_limit {
+                doc.enable_syntax_highlighting = false;
+            }
             doc.detect_language(loader);
         }
 
@@ -681,17 +687,12 @@ impl Document {
         loader: Option<Arc<helix_core::syntax::Loader>>,
     ) {
         if let (Some(language_config), Some(loader)) = (language_config, loader) {
-            if let Some(max_size) = language_config.hl_max_size {
-                if self.text.len_bytes() > max_size {
-                    self.syntax = None;
-                    self.language = Some(language_config);
-                    return;
+            if self.enable_syntax_highlighting {
+                if let Some(highlight_config) = language_config.highlight_config(&loader.scopes()) {
+                    let syntax = Syntax::new(&self.text, highlight_config, loader);
+                    self.syntax = Some(syntax);
                 }
             }
-            if let Some(highlight_config) = language_config.highlight_config(&loader.scopes()) {
-                let syntax = Syntax::new(&self.text, highlight_config, loader);
-                self.syntax = Some(syntax);
-            }
 
             self.language = Some(language_config);
         } else {

helix-view/src/editor.rs

@@ -174,6 +174,8 @@ pub struct Config {
     pub indent_guides: IndentGuidesConfig,
     /// Whether to color modes with different colors. Defaults to `false`.
     pub color_modes: bool,
+    /// Maximum file size to trigger syntax highlighting
+    pub syntax_max_file_size: usize,
 }
 
 #[derive(Debug, Default, Clone, PartialEq, Eq, Serialize, Deserialize)]
@@ -615,6 +617,7 @@ impl Default for Config {
             bufferline: BufferLine::default(),
             indent_guides: IndentGuidesConfig::default(),
             color_modes: false,
+            syntax_max_file_size: 150000000,
         }
     }
 }
@@ -1098,8 +1101,12 @@ impl Editor {
         let id = if let Some(id) = id {
             id
         } else {
-            let mut doc = Document::open(&path, None, Some(self.syn_loader.clone()))?;
-
+            let mut doc = Document::open(
+                &path,
+                None,
+                Some(self.syn_loader.clone()),
+                self.config().syntax_max_file_size,
+            )?;
             let _ = Self::launch_language_server(&mut self.language_servers, &mut doc);
 
             self.new_document(doc)