使用 arara 和 latexindent 自动缩进子文件不起作用

Question

这种行为可能看起来像是一个错误，但实际上是预料之中的。file变量被标准化为仅保存文件名，并且任何现有路径都被删除。做出这一决定是因为一些与 TeX 相关的工具在不在所提供文件的同一级别调用时会出现问题。为了解决这个问题，版本 4.0 提供了另一个名为的变量reference，它保存了所提供文件的完整规范路径，从根文件系统到端点。

从这个意义上来说，有两种方法可以使规则发挥作用：

第一种方法是最明显的，即在规则上下文file中用替换reference。对于latexindent，新规则将如下所示：

!config
identifier: indent
name: Indent
authors:
- Chris Hughes
- Paulo Cereda
commands:
- name: The latexindent.pl script
  command: >
    @{
        return getCommand('latexindent', silent, trace, screenlog,
               settings, cruft, overwrite, output, reference,
               modifylinebreaks, replacement, options, logfile);
    }
arguments:
- identifier: silent
  flag: >
    @{
        isTrue(parameters.silent, '-s')
    }
- identifier: overwrite
  flag: >
    @{
        isTrue(parameters.overwrite, '-w')
    }
- identifier: trace
  flag: >
    @{
      if ([ 'default', 'complete' ].contains(parameters.trace)) {
          return isTrue(parameters.trace == 'default', '-t', '-tt');
      }
      else {
          throwError('You provided an invalid value for trace.');
      }
    }
- identifier: screenlog
  flag: >
    @{
        isTrue(parameters.screenlog, '-sl')
    }
- identifier: modifylinebreaks
  flag: >
    @{
        isTrue(parameters.modifylinebreaks, '-m')
    }
- identifier: settings
  flag: >
    @{
      check = parameters.containsKey('where');
      location = check ? parameters.where : '';
      if ([ 'local', 'onlydefault' ].contains(parameters.settings)) {
          return isTrue(parameters.settings == 'local', isTrue(check,
                 '-l='.concat(location), '-l'), '-d');
      }
      else {
          throwError('You provided an invalid value for settings.');
      }
    }
- identifier: cruft
  flag: >
    @{
        '-c='.concat(parameters.cruft)
    }
- identifier: logfile
  flag: >
    @{
        [ '-g', parameters.logfile ]
    }
- identifier: output
  flag: >
    @{
        [ '-o', parameters.output ]
    }
- identifier: where
  flag: >
    @{
      check = parameters.containsKey('settings');
      setting = check ? parameters.settings : '';
      if (setting != 'local') {
          throwError('This key requires a local setting.');
      }
    }
- identifier: replacement
  flag: >
    @{
      opts = [ 'full' : '-r', 'noverb' : '-rv', 'noindent' : '-rr' ];
      if (opts.keySet().contains(parameters.replacement)) {
          return opts[parameters.replacement];
      }
      else {
          throwError('You provided an invalid value for replacement.');
      }
    }

- identifier: options
  flag: >
    @{
        if (isList(parameters.options)) {
            return parameters.options;
        }
        else {
            throwError('I was expecting a list of options.');
        }
    }

第二种方法涉及添加一个额外的directory选项以涵盖此类情况。这有点复杂，但我们（团队）实际上正在考虑这种方法，以便为所有引擎和其他 TeX 相关工具提供此类支持。这样做的原因是我们希望施加一定的限制，使其arara只能处理主文件层次结构下的文件，以此来减轻文件系统中的滥用。在修订版 2 中，我们添加了一个新的辅助方法以实现此支持。新规则将是：

!config
identifier: indent
name: Indent
authors:
- Chris Hughes
- Paulo Cereda
commands:
- name: The latexindent.pl script
  command: >
    @{
        if (isEmpty(directory)) {
            return getCommand('latexindent', silent, trace, screenlog,
                   settings, cruft, overwrite, output, file,
                   modifylinebreaks, replacement, options, logfile);
        }
        else {
            return getCommandWithWorkingDirectory(directory,
                   'latexindent', silent, trace, screenlog,
                   settings, cruft, overwrite, output, file,
                   modifylinebreaks, replacement, options, logfile);
        }
    }
arguments:
- identifier: silent
  flag: >
    @{
        isTrue(parameters.silent, '-s')
    }
- identifier: overwrite
  flag: >
    @{
        isTrue(parameters.overwrite, '-w')
    }
- identifier: trace
  flag: >
    @{
      if ([ 'default', 'complete' ].contains(parameters.trace)) {
          return isTrue(parameters.trace == 'default', '-t', '-tt');
      }
      else {
          throwError('You provided an invalid value for trace.');
      }
    }
- identifier: screenlog
  flag: >
    @{
        isTrue(parameters.screenlog, '-sl')
    }
- identifier: modifylinebreaks
  flag: >
    @{
        isTrue(parameters.modifylinebreaks, '-m')
    }
- identifier: settings
  flag: >
    @{
      check = parameters.containsKey('where');
      location = check ? parameters.where : '';
      if ([ 'local', 'onlydefault' ].contains(parameters.settings)) {
          return isTrue(parameters.settings == 'local', isTrue(check,
                 '-l='.concat(location), '-l'), '-d');
      }
      else {
          throwError('You provided an invalid value for settings.');
      }
    }
- identifier: cruft
  flag: >
    @{
        '-c='.concat(parameters.cruft)
    }
- identifier: logfile
  flag: >
    @{
        [ '-g', parameters.logfile ]
    }
- identifier: output
  flag: >
    @{
        [ '-o', parameters.output ]
    }
- identifier: where
  flag: >
    @{
      check = parameters.containsKey('settings');
      setting = check ? parameters.settings : '';
      if (setting != 'local') {
          throwError('This key requires a local setting.');
      }
    }
- identifier: replacement
  flag: >
    @{
      opts = [ 'full' : '-r', 'noverb' : '-rv', 'noindent' : '-rr' ];
      if (opts.keySet().contains(parameters.replacement)) {
          return opts[parameters.replacement];
      }
      else {
          throwError('You provided an invalid value for replacement.');
      }
    }

- identifier: options
  flag: >
    @{
        if (isList(parameters.options)) {
            return parameters.options;
        }
        else {
            throwError('I was expecting a list of options.');
        }
    }
- identifier: directory
  flag: >
    @{
        entry = toFile(parameters.directory);
        if (entry.isFile()) {
            throwError('I was expecting a directory.');
        }
        else {
            if (!isSubdirectory(entry)) {
                throwError('Only subdirectories are allowed.');
            }
            else {
                return entry;
            }
        }
    }

这是我们正在讨论目录支持的未决问题。对我们来说，这个问题已经基本解决了，现在我们需要更新规则包（以及相应的用户手册条目）以反映这一点。

顺便说一句，如上所述，新的辅助方法仅从修订版 2 开始可用，因此在旧版本中运行它（即使是 4.0 系列）也会报告错误。确保arara使用 TeX 发行版管理器至少更新到修订版 2，这样方法 #2 中的上述规则将具有预期的行为。您可以在运行该工具时通过查看标题来检查修订版：arara 4.0 (revision 2)。

_{笔记：截至 2019 年 9 月 16 日，arara4.0 的修订版 2 已成功提交给 CTAN 并由其处理，因此它将在几个小时后在 CTAN 镜像中可用。}

Answer 1