mirror of
https://github.com/NotAShelf/nvf.git
synced 2026-01-02 00:55:54 +00:00
Removed builderTemplate implementation in favour of an inline approach
This commit is contained in:
isaacST08
parent
4d80eeb006
commit
0da99e05ae
6 changed files with 400 additions and 625 deletions
|
|
@ -1,66 +0,0 @@
|
|||
# This function acts as a template for creating new builders.
|
||||
# It enforces providing all the parameters required for creating
|
||||
# a new builder for it to be able to work in the existing code.
|
||||
#
|
||||
# The first layer requirements are as follows:
|
||||
{
|
||||
# This is the name of the builder, it will only be used internally and
|
||||
# should match the <name>.nix file that the builder is implemented in.
|
||||
name,
|
||||
#
|
||||
# Module attribute set. This is the attribute set that the module that is
|
||||
# defining a builder is passed as its input.
|
||||
moduleInheritancePackage,
|
||||
#
|
||||
# These are the standard options for the builder just like creating any
|
||||
# other module. Some options are required and are described below but
|
||||
# it will also accept any other options that are provided to it.
|
||||
options,
|
||||
#
|
||||
# These are the command line arguments that will accompany the executable
|
||||
# when the build command is called.
|
||||
# This is a function that will take in the cfg of its own builder.
|
||||
# i.e. will be called as "args cfg.build.builders.${name}"
|
||||
args,
|
||||
...
|
||||
}: let
|
||||
# Inherit the necessary variables available to any module.
|
||||
inherit (moduleInheritancePackage) lib config;
|
||||
#
|
||||
# Inherit other useful functions.
|
||||
inherit (lib.modules) mkIf;
|
||||
#
|
||||
# Set the cfg variable
|
||||
cfg = config.vim.languages.tex;
|
||||
in {
|
||||
# These are the options for the builder. It will accept any options
|
||||
# provided to it but some options are mandatory:
|
||||
options.vim.languages.tex.build.builders.${name} = ({
|
||||
# The enable option. This one is self explanatory.
|
||||
enable,
|
||||
#
|
||||
# This is the package option for the builder.
|
||||
package,
|
||||
#
|
||||
# This is the executable that will be used to call the builder.
|
||||
# It, along with package will result in:
|
||||
# "<package_path>/bin/<executable>"
|
||||
executable,
|
||||
#
|
||||
# Any other options provided are accepted.
|
||||
...
|
||||
} @ opts:
|
||||
opts)
|
||||
options;
|
||||
|
||||
# Check that the language and this builder have been enabled
|
||||
# before making any config.
|
||||
config = mkIf (cfg.enable && cfg.build.builders.${name}.enable) {
|
||||
vim.languages.tex.build.builder = {
|
||||
inherit name;
|
||||
package = cfg.build.builders.${name}.package;
|
||||
executable = cfg.build.builders.${name}.executable;
|
||||
args = args cfg.build.builders.${name};
|
||||
};
|
||||
};
|
||||
}
|
||||
|
|
@ -1,57 +1,53 @@
|
|||
# TODO: I need testing.
|
||||
{
|
||||
pkgs,
|
||||
config,
|
||||
lib,
|
||||
pkgs,
|
||||
...
|
||||
} @ moduleInheritancePackage: let
|
||||
}: let
|
||||
# The name of the builder
|
||||
name = "latexmk";
|
||||
|
||||
# The builder template
|
||||
template = import ./builderTemplate.nix;
|
||||
|
||||
inherit (lib.modules) mkIf;
|
||||
inherit (lib.nvim.config) mkBool;
|
||||
inherit (lib.options) mkOption mkEnableOption;
|
||||
inherit (lib.types) bool package str;
|
||||
in (
|
||||
template {
|
||||
inherit name moduleInheritancePackage;
|
||||
inherit (lib.types) package str;
|
||||
|
||||
options = {
|
||||
enable = mkEnableOption "Whether to enable Tex Compilation Via latexmk";
|
||||
texCfg = config.vim.languages.tex;
|
||||
cfg = texCfg.build.builders.${name};
|
||||
in {
|
||||
options.vim.languages.tex.build.builders.${name} = {
|
||||
enable = mkEnableOption "Whether to enable Tex Compilation Via latexmk";
|
||||
|
||||
package = mkOption {
|
||||
type = package;
|
||||
default = pkgs.texlive.withPackages (ps: [ps.latexmk]);
|
||||
description = "latexmk package";
|
||||
};
|
||||
|
||||
executable = mkOption {
|
||||
type = str;
|
||||
default = "latexmk";
|
||||
description = "The executable name from the build package that will be used to build/compile the tex.";
|
||||
};
|
||||
|
||||
# Flag options
|
||||
pdfOutput = mkOption {
|
||||
type = bool;
|
||||
default = true;
|
||||
example = false;
|
||||
description = "Insure the output file is a pdf.";
|
||||
};
|
||||
package = mkOption {
|
||||
type = package;
|
||||
default = pkgs.texlive.withPackages (ps: [ps.latexmk]);
|
||||
description = "latexmk package";
|
||||
};
|
||||
|
||||
args = builderCfg: (
|
||||
# Flags
|
||||
(
|
||||
if builderCfg.pdfOutput
|
||||
then ["-pdf"]
|
||||
else []
|
||||
)
|
||||
# Base args
|
||||
++ [
|
||||
"-quiet"
|
||||
"%f"
|
||||
]
|
||||
);
|
||||
}
|
||||
)
|
||||
executable = mkOption {
|
||||
type = str;
|
||||
default = "latexmk";
|
||||
description = "The executable name from the build package that will be used to build/compile the tex.";
|
||||
};
|
||||
|
||||
# Flag options
|
||||
pdfOutput = mkBool true "Insure the output file is a pdf.";
|
||||
};
|
||||
|
||||
config = mkIf (texCfg.enable && cfg.enable) {
|
||||
vim.languages.tex.build.builder = {
|
||||
inherit name;
|
||||
inherit (cfg) package executable;
|
||||
args = (
|
||||
# Flags
|
||||
(lib.lists.optional cfg.pdfOutput "-pdf")
|
||||
# Base args
|
||||
++ [
|
||||
"-quiet"
|
||||
"%f"
|
||||
]
|
||||
);
|
||||
};
|
||||
};
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,203 +1,161 @@
|
|||
{
|
||||
config,
|
||||
pkgs,
|
||||
lib,
|
||||
pkgs,
|
||||
...
|
||||
} @ moduleInheritancePackage: let
|
||||
}: let
|
||||
# The name of the builder
|
||||
name = "tectonic";
|
||||
|
||||
# The builder template
|
||||
template = import ./builderTemplate.nix;
|
||||
|
||||
inherit (lib.options) mkOption mkEnableOption;
|
||||
inherit (lib.types) enum ints listOf package str;
|
||||
inherit (builtins) concatLists elem map toString match;
|
||||
inherit (lib.modules) mkIf;
|
||||
inherit (lib.nvim.config) mkBool;
|
||||
inherit (builtins) concatLists elem map toString;
|
||||
inherit (lib.options) mkOption mkEnableOption;
|
||||
inherit (lib.strings) toLower optionalString stringAsChars;
|
||||
inherit (lib.types) enum ints listOf package str;
|
||||
|
||||
cfg = config.vim.languages.tex;
|
||||
in (
|
||||
template {
|
||||
inherit name moduleInheritancePackage;
|
||||
texCfg = config.vim.languages.tex;
|
||||
cfg = texCfg.build.builders.${name};
|
||||
in {
|
||||
options.vim.languages.tex.build.builders.${name} = {
|
||||
enable = mkEnableOption "Whether to enable Tex Compilation Via Tectonic";
|
||||
|
||||
options = {
|
||||
enable = mkEnableOption "Whether to enable Tex Compilation Via Tectonic";
|
||||
|
||||
package = mkOption {
|
||||
type = package;
|
||||
default = pkgs.tectonic;
|
||||
description = "tectonic package";
|
||||
};
|
||||
|
||||
executable = mkOption {
|
||||
type = str;
|
||||
default = "tectonic";
|
||||
description = "The executable name from the build package that will be used to build/compile the tex.";
|
||||
};
|
||||
|
||||
# -- Flags --
|
||||
keepIntermediates = mkBool false ''
|
||||
Keep the intermediate files generated during processing.
|
||||
|
||||
If texlab is reporting build errors when there shouldn't be, disable this option.
|
||||
'';
|
||||
keepLogs = mkBool true ''
|
||||
Keep the log files generated during processing.
|
||||
|
||||
Without the keepLogs flag, texlab won't be able to report compilation warnings.
|
||||
'';
|
||||
onlyCached = mkBool false "Use only resource files cached locally";
|
||||
synctex = mkBool true "Generate SyncTeX data";
|
||||
untrustedInput = mkBool false "Input is untrusted -- disable all known-insecure features";
|
||||
|
||||
# -- Options --
|
||||
reruns = mkOption {
|
||||
type = ints.unsigned;
|
||||
default = 0;
|
||||
example = 2;
|
||||
description = ''
|
||||
Rerun the TeX engine exactly this many times after the first.
|
||||
|
||||
Setting this value to 0 will disable setting this option.
|
||||
'';
|
||||
};
|
||||
|
||||
bundle = mkOption {
|
||||
type = str;
|
||||
default = "";
|
||||
description = "Use this directory or Zip-format bundle file to find resource files instead of the default";
|
||||
};
|
||||
|
||||
webBundle = mkOption {
|
||||
type = str;
|
||||
default = "";
|
||||
description = "Use this URL to find resource files instead of the default";
|
||||
};
|
||||
|
||||
outfmt = mkOption {
|
||||
type = enum [
|
||||
"pdf"
|
||||
"html"
|
||||
"xdv"
|
||||
"aux"
|
||||
"fmt"
|
||||
""
|
||||
];
|
||||
default = "";
|
||||
description = "The kind of output to generate";
|
||||
};
|
||||
|
||||
hidePaths = mkOption {
|
||||
type = listOf str;
|
||||
default = [];
|
||||
example = [
|
||||
"./secrets.tex"
|
||||
"./passwords.tex"
|
||||
];
|
||||
description = "Tell the engine that no file at <hide_path> exists, if it tries to read it.";
|
||||
};
|
||||
|
||||
format = mkOption {
|
||||
type = str;
|
||||
default = "";
|
||||
description = "The name of the \"format\" file used to initialize the TeX engine";
|
||||
};
|
||||
|
||||
color = mkOption {
|
||||
type = enum [
|
||||
"always"
|
||||
"auto"
|
||||
"never"
|
||||
""
|
||||
];
|
||||
default = "";
|
||||
example = "always";
|
||||
description = "Enable/disable colorful log output";
|
||||
};
|
||||
|
||||
extraOptions = {
|
||||
type = listOf str;
|
||||
default = [];
|
||||
description = ''
|
||||
Add extra command line options to include in the tectonic build command.
|
||||
Extra options added here will not overwrite the options set in as nvf options.
|
||||
'';
|
||||
};
|
||||
package = mkOption {
|
||||
type = package;
|
||||
default = pkgs.tectonic;
|
||||
description = "tectonic package";
|
||||
};
|
||||
|
||||
args = builderCfg: (
|
||||
# Base args
|
||||
[
|
||||
"-X"
|
||||
"compile"
|
||||
"%f"
|
||||
]
|
||||
# Flags
|
||||
++ (
|
||||
if builderCfg.keepIntermediates
|
||||
then ["--keep-intermediates"]
|
||||
else []
|
||||
)
|
||||
++ (
|
||||
if builderCfg.keepLogs
|
||||
then ["--keep-logs"]
|
||||
else []
|
||||
)
|
||||
++ (
|
||||
if builderCfg.onlyCached
|
||||
then ["--only-cached"]
|
||||
else []
|
||||
)
|
||||
++ (
|
||||
if builderCfg.synctex
|
||||
then ["--synctex"]
|
||||
else []
|
||||
)
|
||||
++ (
|
||||
if builderCfg.untrustedInput
|
||||
then ["--untrusted"]
|
||||
else []
|
||||
)
|
||||
# Options
|
||||
++ (
|
||||
if builderCfg.reruns > 0
|
||||
then ["--reruns" "${toString builderCfg.reruns}"]
|
||||
else []
|
||||
)
|
||||
++ (
|
||||
if builderCfg.bundle != ""
|
||||
then ["--bundle" "${toString builderCfg.bundle}"]
|
||||
else []
|
||||
)
|
||||
++ (
|
||||
if builderCfg.webBundle != ""
|
||||
then ["--web-bundle" "${toString builderCfg.webBundle}"]
|
||||
else []
|
||||
)
|
||||
++ (
|
||||
if builderCfg.outfmt != ""
|
||||
then ["--outfmt" "${toString builderCfg.outfmt}"]
|
||||
else []
|
||||
)
|
||||
++ (concatLists (map (x: ["--hide" x]) builderCfg.hidePaths))
|
||||
++ (
|
||||
if builderCfg.format != ""
|
||||
then ["--format" "${toString builderCfg.format}"]
|
||||
else []
|
||||
)
|
||||
++ (
|
||||
if builderCfg.color != ""
|
||||
then ["--color" "${toString builderCfg.color}"]
|
||||
else []
|
||||
)
|
||||
# Still options but these are not defined by builder specific options but
|
||||
# instead synchronize options between the global build options and builder
|
||||
# specific options
|
||||
++ (
|
||||
if !(elem cfg.build.pdfDirectory ["." ""])
|
||||
then ["--outdir" "${cfg.build.pdfDirectory}"]
|
||||
else []
|
||||
)
|
||||
);
|
||||
}
|
||||
)
|
||||
executable = mkOption {
|
||||
type = str;
|
||||
default = "tectonic";
|
||||
description = "The executable name from the build package that will be used to build/compile the tex.";
|
||||
};
|
||||
|
||||
# -- Flags --
|
||||
keepIntermediates = mkBool false ''
|
||||
Keep the intermediate files generated during processing.
|
||||
|
||||
If texlab is reporting build errors when there shouldn't be, disable this option.
|
||||
'';
|
||||
keepLogs = mkBool true ''
|
||||
Keep the log files generated during processing.
|
||||
|
||||
Without the keepLogs flag, texlab won't be able to report compilation warnings.
|
||||
'';
|
||||
onlyCached = mkBool false "Use only resource files cached locally";
|
||||
synctex = mkBool true "Generate SyncTeX data";
|
||||
untrustedInput = mkBool false "Input is untrusted -- disable all known-insecure features";
|
||||
|
||||
# -- Options --
|
||||
reruns = mkOption {
|
||||
type = ints.unsigned;
|
||||
default = 0;
|
||||
example = 2;
|
||||
description = ''
|
||||
Rerun the TeX engine exactly this many times after the first.
|
||||
|
||||
Setting this value to 0 will disable setting this option.
|
||||
'';
|
||||
};
|
||||
|
||||
bundle = mkOption {
|
||||
type = str;
|
||||
default = "";
|
||||
description = "Use this directory or Zip-format bundle file to find resource files instead of the default";
|
||||
};
|
||||
|
||||
webBundle = mkOption {
|
||||
type = str;
|
||||
default = "";
|
||||
description = "Use this URL to find resource files instead of the default";
|
||||
};
|
||||
|
||||
outfmt = mkOption {
|
||||
type = enum [
|
||||
"pdf"
|
||||
"html"
|
||||
"xdv"
|
||||
"aux"
|
||||
"fmt"
|
||||
""
|
||||
];
|
||||
default = "";
|
||||
description = "The kind of output to generate";
|
||||
};
|
||||
|
||||
hidePaths = mkOption {
|
||||
type = listOf str;
|
||||
default = [];
|
||||
example = [
|
||||
"./secrets.tex"
|
||||
"./passwords.tex"
|
||||
];
|
||||
description = "Tell the engine that no file at <hide_path> exists, if it tries to read it.";
|
||||
};
|
||||
|
||||
format = mkOption {
|
||||
type = str;
|
||||
default = "";
|
||||
description = "The name of the \"format\" file used to initialize the TeX engine";
|
||||
};
|
||||
|
||||
color = mkOption {
|
||||
type = enum [
|
||||
"always"
|
||||
"auto"
|
||||
"never"
|
||||
""
|
||||
];
|
||||
default = "";
|
||||
example = "always";
|
||||
description = "Enable/disable colorful log output";
|
||||
};
|
||||
|
||||
extraOptions = {
|
||||
type = listOf str;
|
||||
default = [];
|
||||
description = ''
|
||||
Add extra command line options to include in the tectonic build command.
|
||||
Extra options added here will not overwrite the options set in as nvf options.
|
||||
'';
|
||||
};
|
||||
};
|
||||
|
||||
config = mkIf (texCfg.enable && cfg.enable) {
|
||||
vim.languages.tex.build.builder = {
|
||||
inherit name;
|
||||
inherit (cfg) package executable;
|
||||
args = let
|
||||
inherit (lib.lists) optional optionals;
|
||||
snakeCaseToKebabCase = str: stringAsChars (x: "${optionalString ((match "[A-Z]" x) != null) "-"}${toLower x}") str;
|
||||
generateOptionFlag = option: (optionals (cfg.${option} != "") ["--${snakeCaseToKebabCase option}" "${toString cfg.${option}}"]);
|
||||
in (
|
||||
# Base args
|
||||
[
|
||||
"-X"
|
||||
"compile"
|
||||
"%f"
|
||||
]
|
||||
# Flags
|
||||
++ (optional cfg.keepIntermediates "--keep-intermediates")
|
||||
++ (optional cfg.keepLogs "--keep-logs")
|
||||
++ (optional cfg.onlyCached "--only-cached")
|
||||
++ (optional cfg.synctex "--synctex")
|
||||
++ (optional cfg.untrustedInput "--untrusted")
|
||||
# Options
|
||||
++ (optionals (cfg.reruns > 0) ["--reruns" "${toString cfg.reruns}"])
|
||||
++ (generateOptionFlag "bundle")
|
||||
++ (generateOptionFlag "webBundle")
|
||||
++ (generateOptionFlag "outfmt")
|
||||
++ (concatLists (map (x: ["--hide" x]) cfg.hidePaths))
|
||||
++ (generateOptionFlag "format")
|
||||
++ (generateOptionFlag "color")
|
||||
# Still options but these are not defined by builder specific options but
|
||||
# instead synchronize options between the global build options and builder
|
||||
# specific options.
|
||||
++ (optionals (!(elem texCfg.build.pdfDirectory ["." ""])) ["--outdir" "${texCfg.build.pdfDirectory}"])
|
||||
);
|
||||
};
|
||||
};
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue