VSCode Front Matter 文件前缀占位符功能详解

在内容管理系统和文档编写过程中，文件命名规范化是一个常见需求。VSCode Front Matter 插件最新版本引入了一项重要功能：支持在文件前缀模板中使用占位符。这项改进为用户提供了更灵活的文件命名控制能力。

功能背景

传统文件前缀通常是静态字符串，限制了文件命名的动态性。新版本通过引入占位符支持，使得文件前缀可以包含动态生成的标识符，如唯一ID、序列号或日期等。

技术实现

要实现动态文件前缀，需要进行两项配置：

1. 文件前缀配置：在插件设置中指定使用占位符作为前缀

{
  "frontMatter.content.pageFolders": [{
    "title": "文章",
    "path": "[[workspace]]/content/prefixes/",
    "filePrefix": "{{indexNr}}"
  }]
}

2. 自定义占位符脚本：编写生成逻辑的JavaScript模块

{
  "frontMatter.content.placeholders": [{
    "id": "indexNr",
    "script": "./scripts/indexNr.mjs",
    "command": "~/.nvm/versions/node/v18.17.1/bin/node"
  }]
}

脚本开发示例

动态生成序列号的脚本示例：

import { PlaceholderScript } from "@frontmatter/extensibility";
import { readdir } from "fs/promises";

(async () => {
  const { filePath } = PlaceholderScript.getArguments();
  
  if (!filePath) {
    PlaceholderScript.done(`000`);
    return;
  }

  const files = await readdir(filePath);
  const nextNum = files ? files.length + 1 : 1;
  
  // 生成三位数序号，不足补零
  PlaceholderScript.done(nextNum.toString().padStart(3, `0`));
})();

应用场景

1. 自动编号：为系列文章生成连续的编号前缀
2. 日期标记：使用当前日期作为文件前缀
3. 分类标识：结合内容类型生成特定前缀
4. 唯一标识：生成UUID或其他唯一字符串

最佳实践

1. 脚本应考虑异常情况，提供默认返回值
2. 对于频繁使用的占位符，可以创建共享脚本库
3. 复杂的生成逻辑应该进行单元测试
4. 考虑性能影响，避免在脚本中执行耗时操作

这项功能显著提升了VSCode Front Matter在内容管理方面的灵活性，特别适合需要规范化文件命名的大型文档项目。通过自定义脚本，用户可以实现几乎任何复杂度的命名逻辑，满足各种业务场景需求。