mirror of
https://github.com/ghostty-org/ghostty.git
synced 2025-08-02 14:57:31 +03:00
build: move Vim plugin file generation into a separate Step
This commit is contained in:
Gregory Anders
113
build.zig
113
build.zig
@ -13,7 +13,7 @@ const LibtoolStep = @import("src/build/LibtoolStep.zig");
|
|||||||
const LipoStep = @import("src/build/LipoStep.zig");
|
const LipoStep = @import("src/build/LipoStep.zig");
|
||||||
const XCFrameworkStep = @import("src/build/XCFrameworkStep.zig");
|
const XCFrameworkStep = @import("src/build/XCFrameworkStep.zig");
|
||||||
const Version = @import("src/build/Version.zig");
|
const Version = @import("src/build/Version.zig");
|
||||||
const Config = @import("src/config/Config.zig");
|
const VimStep = @import("src/build/VimStep.zig");
|
||||||
|
|
||||||
// Do a comptime Zig version requirement. The required Zig version is
|
// Do a comptime Zig version requirement. The required Zig version is
|
||||||
// somewhat arbitrary: it is meant to be a version that we feel works well,
|
// somewhat arbitrary: it is meant to be a version that we feel works well,
|
||||||
@ -404,111 +404,12 @@ pub fn build(b: *std.Build) !void {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Vim plugin
|
// Vim plugin
|
||||||
{
|
const vim_step = VimStep.create(b);
|
||||||
const wf = b.addWriteFiles();
|
b.installDirectory(.{
|
||||||
|
.source_dir = vim_step.getDirectory(),
|
||||||
// syntax/ghostty.vim
|
.install_dir = .prefix,
|
||||||
{
|
.install_subdir = "share/vim/vimfiles",
|
||||||
var buf = std.ArrayList(u8).init(b.allocator);
|
});
|
||||||
defer buf.deinit();
|
|
||||||
|
|
||||||
const writer = buf.writer();
|
|
||||||
try writer.print(
|
|
||||||
\\" Vim syntax file
|
|
||||||
\\" Language: Ghostty config file
|
|
||||||
\\" Maintainer: Ghostty <https://github.com/mitchellh/ghostty>
|
|
||||||
\\"
|
|
||||||
\\" THIS FILE IS AUTO-GENERATED
|
|
||||||
\\
|
|
||||||
\\if exists('b:current_syntax')
|
|
||||||
\\ finish
|
|
||||||
\\endif
|
|
||||||
\\
|
|
||||||
\\let b:current_syntax = 'ghostty'
|
|
||||||
\\
|
|
||||||
\\let s:cpo_save = &cpo
|
|
||||||
\\set cpo&vim
|
|
||||||
\\
|
|
||||||
\\
|
|
||||||
, .{});
|
|
||||||
|
|
||||||
const config_fields = @typeInfo(Config).Struct.fields;
|
|
||||||
var keywords = try std.ArrayList([]const u8).initCapacity(b.allocator, config_fields.len);
|
|
||||||
defer keywords.deinit();
|
|
||||||
|
|
||||||
inline for (config_fields) |field| {
|
|
||||||
// Ignore fields which begin with _
|
|
||||||
if (field.name[0] != '_') {
|
|
||||||
keywords.appendAssumeCapacity(field.name);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
try writer.print(
|
|
||||||
\\syn keyword ghosttyConfigKeyword
|
|
||||||
\\ \ {s}
|
|
||||||
\\
|
|
||||||
\\syn match ghosttyConfigComment /#.*/ contains=@Spell
|
|
||||||
\\
|
|
||||||
\\hi def link ghosttyConfigComment Comment
|
|
||||||
\\hi def link ghosttyConfigKeyword Keyword
|
|
||||||
\\
|
|
||||||
\\let &cpo = s:cpo_save
|
|
||||||
\\unlet s:cpo_save
|
|
||||||
\\
|
|
||||||
, .{
|
|
||||||
try std.mem.join(b.allocator, "\n\t\\ ", keywords.items),
|
|
||||||
});
|
|
||||||
|
|
||||||
_ = wf.add("syntax/ghostty.vim", buf.items);
|
|
||||||
}
|
|
||||||
|
|
||||||
// ftdetect/ghostty.vim
|
|
||||||
{
|
|
||||||
_ = wf.add(
|
|
||||||
"ftdetect/ghostty.vim",
|
|
||||||
"au BufRead,BufNewFile */.config/ghostty/config set ft=ghostty\n",
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
// ftplugin/ghostty.vim
|
|
||||||
{
|
|
||||||
var buf = std.ArrayList(u8).init(b.allocator);
|
|
||||||
defer buf.deinit();
|
|
||||||
|
|
||||||
const writer = buf.writer();
|
|
||||||
try writer.writeAll(
|
|
||||||
\\" Vim filetype plugin file
|
|
||||||
\\" Language: Ghostty config file
|
|
||||||
\\" Maintainer: Ghostty <https://github.com/mitchellh/ghostty>
|
|
||||||
\\"
|
|
||||||
\\" THIS FILE IS AUTO-GENERATED
|
|
||||||
\\
|
|
||||||
\\if exists('b:did_ftplugin')
|
|
||||||
\\ finish
|
|
||||||
\\endif
|
|
||||||
\\let b:did_ftplugin = 1
|
|
||||||
\\
|
|
||||||
\\setlocal commentstring=#%s
|
|
||||||
\\setlocal iskeyword+=-
|
|
||||||
\\
|
|
||||||
\\" Use syntax keywords for completion
|
|
||||||
\\setlocal omnifunc=syntaxcomplete#Complete
|
|
||||||
\\
|
|
||||||
\\let b:undo_ftplugin = 'setl cms< isk< ofu<'
|
|
||||||
\\
|
|
||||||
);
|
|
||||||
|
|
||||||
_ = wf.add("ftplugin/ghostty.vim", buf.items);
|
|
||||||
}
|
|
||||||
|
|
||||||
const install_vim_plugin = b.addInstallDirectory(.{
|
|
||||||
.source_dir = wf.getDirectory(),
|
|
||||||
.install_dir = .prefix,
|
|
||||||
.install_subdir = "share/vim/vimfiles",
|
|
||||||
});
|
|
||||||
install_vim_plugin.step.dependOn(&wf.step);
|
|
||||||
b.getInstallStep().dependOn(&install_vim_plugin.step);
|
|
||||||
}
|
|
||||||
|
|
||||||
// App (Linux)
|
// App (Linux)
|
||||||
if (target.isLinux()) {
|
if (target.isLinux()) {
|
||||||
|
|||||||
143
src/build/VimStep.zig
Normal file
143
src/build/VimStep.zig
Normal file
@ -0,0 +1,143 @@
|
|||||||
|
//! A Zig build step that generates Vim plugin files for Ghostty's configuration
|
||||||
|
//! file.
|
||||||
|
|
||||||
|
const VimStep = @This();
|
||||||
|
|
||||||
|
const std = @import("std");
|
||||||
|
const Step = std.Build.Step;
|
||||||
|
|
||||||
|
const Config = @import("../config/Config.zig");
|
||||||
|
|
||||||
|
step: *Step,
|
||||||
|
|
||||||
|
// The build step that generates the file contents
|
||||||
|
generate_step: Step,
|
||||||
|
|
||||||
|
pub fn create(b: *std.Build) *VimStep {
|
||||||
|
const self = b.allocator.create(VimStep) catch @panic("OOM");
|
||||||
|
|
||||||
|
const write_file = Step.WriteFile.create(b);
|
||||||
|
|
||||||
|
self.* = .{
|
||||||
|
.step = &write_file.step,
|
||||||
|
.generate_step = Step.init(.{
|
||||||
|
.id = .custom,
|
||||||
|
.name = "generate Vim plugin files",
|
||||||
|
.owner = b,
|
||||||
|
.makeFn = make,
|
||||||
|
}),
|
||||||
|
};
|
||||||
|
|
||||||
|
write_file.step.dependOn(&self.generate_step);
|
||||||
|
|
||||||
|
return self;
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn getDirectory(self: *VimStep) std.Build.LazyPath {
|
||||||
|
const wf = @fieldParentPtr(Step.WriteFile, "step", self.step);
|
||||||
|
return wf.getDirectory();
|
||||||
|
}
|
||||||
|
|
||||||
|
fn make(step: *Step, prog_node: *std.Progress.Node) !void {
|
||||||
|
_ = prog_node;
|
||||||
|
const self = @fieldParentPtr(VimStep, "generate_step", step);
|
||||||
|
const wf = @fieldParentPtr(Step.WriteFile, "step", self.step);
|
||||||
|
const b = step.owner;
|
||||||
|
|
||||||
|
// syntax/ghostty.vim
|
||||||
|
{
|
||||||
|
var buf = std.ArrayList(u8).init(b.allocator);
|
||||||
|
defer buf.deinit();
|
||||||
|
|
||||||
|
const writer = buf.writer();
|
||||||
|
try writer.print(
|
||||||
|
\\" Vim syntax file
|
||||||
|
\\" Language: Ghostty config file
|
||||||
|
\\" Maintainer: Ghostty <https://github.com/mitchellh/ghostty>
|
||||||
|
\\"
|
||||||
|
\\" THIS FILE IS AUTO-GENERATED
|
||||||
|
\\
|
||||||
|
\\if exists('b:current_syntax')
|
||||||
|
\\ finish
|
||||||
|
\\endif
|
||||||
|
\\
|
||||||
|
\\let b:current_syntax = 'ghostty'
|
||||||
|
\\
|
||||||
|
\\let s:cpo_save = &cpo
|
||||||
|
\\set cpo&vim
|
||||||
|
\\
|
||||||
|
\\
|
||||||
|
, .{});
|
||||||
|
|
||||||
|
const config_fields = @typeInfo(Config).Struct.fields;
|
||||||
|
var keywords = try std.ArrayList([]const u8).initCapacity(
|
||||||
|
b.allocator,
|
||||||
|
config_fields.len,
|
||||||
|
);
|
||||||
|
defer keywords.deinit();
|
||||||
|
|
||||||
|
inline for (config_fields) |field| {
|
||||||
|
// Ignore fields which begin with _
|
||||||
|
if (field.name[0] != '_') {
|
||||||
|
keywords.appendAssumeCapacity(field.name);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
try writer.print(
|
||||||
|
\\syn keyword ghosttyConfigKeyword
|
||||||
|
\\ \ {s}
|
||||||
|
\\
|
||||||
|
\\syn match ghosttyConfigComment /#.*/ contains=@Spell
|
||||||
|
\\
|
||||||
|
\\hi def link ghosttyConfigComment Comment
|
||||||
|
\\hi def link ghosttyConfigKeyword Keyword
|
||||||
|
\\
|
||||||
|
\\let &cpo = s:cpo_save
|
||||||
|
\\unlet s:cpo_save
|
||||||
|
\\
|
||||||
|
, .{
|
||||||
|
try std.mem.join(b.allocator, "\n\t\\ ", keywords.items),
|
||||||
|
});
|
||||||
|
|
||||||
|
_ = wf.add("syntax/ghostty.vim", buf.items);
|
||||||
|
}
|
||||||
|
|
||||||
|
// ftdetect/ghostty.vim
|
||||||
|
{
|
||||||
|
_ = wf.add(
|
||||||
|
"ftdetect/ghostty.vim",
|
||||||
|
"au BufRead,BufNewFile */.config/ghostty/config set ft=ghostty\n",
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// ftplugin/ghostty.vim
|
||||||
|
{
|
||||||
|
var buf = std.ArrayList(u8).init(b.allocator);
|
||||||
|
defer buf.deinit();
|
||||||
|
|
||||||
|
const writer = buf.writer();
|
||||||
|
try writer.writeAll(
|
||||||
|
\\" Vim filetype plugin file
|
||||||
|
\\" Language: Ghostty config file
|
||||||
|
\\" Maintainer: Ghostty <https://github.com/mitchellh/ghostty>
|
||||||
|
\\"
|
||||||
|
\\" THIS FILE IS AUTO-GENERATED
|
||||||
|
\\
|
||||||
|
\\if exists('b:did_ftplugin')
|
||||||
|
\\ finish
|
||||||
|
\\endif
|
||||||
|
\\let b:did_ftplugin = 1
|
||||||
|
\\
|
||||||
|
\\setlocal commentstring=#%s
|
||||||
|
\\setlocal iskeyword+=-
|
||||||
|
\\
|
||||||
|
\\" Use syntax keywords for completion
|
||||||
|
\\setlocal omnifunc=syntaxcomplete#Complete
|
||||||
|
\\
|
||||||
|
\\let b:undo_ftplugin = 'setl cms< isk< ofu<'
|
||||||
|
\\
|
||||||
|
);
|
||||||
|
|
||||||
|
_ = wf.add("ftplugin/ghostty.vim", buf.items);
|
||||||
|
}
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user