helix

helix copied to clipboard

ref: #3164

This PR introduces a new [editor.file-types] config section that will allow custom mappings between the default file type strings and user-defined custom strings. An example:

[editor.file-types]
"rust" = "rs"

will remap the "rust" file type string to "rs" (currently used by the statusline). Glyphs/icons should be supported, if available in the user's font definition.

cc @etienne-k

Meybe this should be under the statusline key? As I understand it, this only affects the rendered output in the statusline. Right?

As I understand it, this only affects the rendered output in the statusline. Right?

Right now that's the case, but it doesn't have to be (see disc).

This key name is confusing: looking just at the toml I would think this makes helix think any .rs files are rust (i.e. the file-types key in languages.toml)

The key name is derived from the default strings ("rust", "typescript", "javascript", etc.) returned from context.doc.language_id(). Is there a better way of doing this map without having to redefine a bunch of language-specific identifiers?

(or are you talking about the editor.file-type key? That's easy to change. Do you have a suggested alternative?

Some possibilities: editor.file-type-indicator, editor.file-type-description)

I mean the editor.file-type key, editor.file-type-indicator seems like a good choice

I kept it plural (file-type-indicators) since you might have more than one defined in this section.

Note that the statusline refers to file-type when it uses this string. I tried making this obvious in the docs.

Just in case anyone wants to try this with nerdfonts, here's a quick file I put together that has all the filetypes I and Helix know about: https://gist.github.com/sbromberger/20ba8b7174ecacad43a10a402446d6fa

These probably won't show up in your browser but if you have nerdfonts and download the file, you should see the glyphs. You should be able to append this file to your config.toml and be good to go.

Here's a version that falls back to use the scope identifier if no LSP is provided. Since Rust has an LSP then rust will stay as rust. Since markdown has no LSP then it will use md as that is its scope ident.

fn render_file_type<F>(context: &mut RenderContext, write: F)
where
    F: Fn(&mut RenderContext, String, Option<Style>) + Copy,
{
    let lsp_language_id = context.doc.language_id().unwrap_or("text");
    let mut lsp_language_fallback = String::from("lsp.");
    lsp_language_fallback.push_str(lsp_language_id);
    let (_, file_ext) = context
        .doc
        .language()
        .unwrap_or(lsp_language_fallback.as_str())
        .rsplit_once('.')
        .expect("Language scope should have ident.ext format");
    let editor_config = context.editor.config();
    let file_type = editor_config
        .file_type_indicators
        .get(file_ext)
        .map(|x| x.as_str())
        .unwrap_or(lsp_language_id);

    write(context, format!(" {} ", file_type), None);
}

Not overly testet but what I did test seemed to work. May serve as a point of discussion, I don't expect the code to be used.

Nice feature BTW :+1:

I think this is ready for review. The bug in language identification is unrelated to this PR but fixing it will definitely make this feature more accurate.