Typescript：强制执行灵活的字符串要求 - 所有下划线分隔的文件名格式

Question

可以定义一个 TypeScript 类型（我使用的是 4.7），它允许字符串是以下任何一种：

XXX_YY_ZZZ.pdf
ABCD_GG_JJ_PPPP.pdf
VV_XX.pdf
ABCD.pdf

本质上是尝试制作如下界面的键：

export interface FileChecks {
    [key: string]: (string|RegExp)[];
}

符合已知格式，即特定文件命名格式（所有大写下划线以扩展名分隔）。

我见过一些例子，其中字符串可以被限制为类似的东西：

1234-5678-9012
3456-4566-8798

这让我想知道是否可以采取进一步措施。

Answer 1

TypeScript 中没有特定类型可以按您想要的方式工作。 也就是说，您最终将无法编写

const good: ValidFile = "ABC_DEF.pdf"; // okay
const bad: ValidFile = "ABC_DeF.pdf"; // error!

TypeScript 当前不具有正则表达式验证的字符串类型，如microsoft/TypeScript#41160中所述，因此没有类似type ValidFile = /^[A-Z_]*\.pdf$/;的类型。 你可以写。

从概念上讲，您可以将该类型想象为符合您的规则的可能字符串文字类型的联合，但 TypeScript 联合只能容纳数万个成员，而您需要……让我们看看……无限数字，因为你的字符串的长度是无限的。 即使您可以将最大长度限制为 32 个字符，这仍然比 TypeScript 可以表示的可能性更多。

所以这是不可能直接的。

---

我们可以创建一个充当约束的通用类型，而不是尝试编写特定类型。 也就是说，我们编写ValidFile<T>而不是ValidFile ，它采用候选字符串文字类型T ； 如果T有效，则ValidFile<T>将仅评估为T 。 否则它将评估为某种有效的字符串文字类型，该类型在某种程度上“接近” T 。 然后你可以做像T extends ValidFile<T>这样的检查。 为了防止有人不得不写const good: ValidFile<"ABC_DEF.pdf"> = "ABC_DEF.pdf" ，我们将制作一个通用帮助器 function 这样你就可以写const good = validFile("ABC_DEF.pdf"); .

所以当我们完成后，而不是

const good: ValidFile = "ABC_DEF.pdf"; // okay
const bad: ValidFile = "ABC_DeF.pdf"; // error!

你将会拥有

const good = validFile("ABC_DEF.pdf"); // okay
const bad = validFile("ABC_DeF.pdf"); // error! 

如果你眯着眼睛看，这很相似。

---

好的，开始了。 首先让我们创建一个文件名前缀（扩展名之前的部分）中允许的字符的并集：

type AllowedChars = "A" | "B" | "C" | "D" | "E" | "F" | "G" | "H" |
  "I" | "J" | "K" | "L" | "M" | "N" | "O" | "P" | "Q" | "R" | "S" |
  "T" | "U" | "V" | "W" | "X" | "Y" | "Z" | "_";

然后我们可以编写一个通用的ValidFilePrefix<T>来验证前缀：

type ValidFilePrefix<T extends string, A extends string = ""> =
  T extends `${infer F}${infer R}` ?
  ValidFilePrefix<R, `${A}${F extends AllowedChars ? F : "A"}`> :
  A

这种尾递归条件类型使用模板文字类型逐个字符地解析T 。 每个允许的字符保持不变，而每个无效字符都转换为"A" 。 所以ValidFilePrefix<"PqR">将是"PAR" 。

然后我们像这样处理".pdf"后缀：

type ValidFile<T extends string> =
  `${ValidFilePrefix<T extends `${infer F}.pdf` ? F : T>}.pdf`;

在这里，如果字符串末尾存在".pdf" ，我们将其删除，对结果求值ValidatePrefix ，然后将".pdf"添加回末尾。 所以ValidFile<"PqR.pdf">将是"PAR.pdf" ，而ValidFile<"PQR">将是"PQR.pdf" 。

现在这里是validFile() ：

const validFile = <T extends string>(
  x: T extends ValidFile<T> ? T : ValidFile<T>
) => x;

它使用条件类型来帮助推理； T extends ValidFile<T>? T: ValidFile<T> T extends ValidFile<T>? T: ValidFile<T>会将T推断为作为x传递的任何内容，然后无论如何都会计算为ValidFile<T> 。 最好写成const validFile = <T extends ValidFile<T>>(x: T) => x; 但是编译器抱怨这是一个循环约束。 所以条件类型是一种解决方法。

---

让我们试试看：

const good = validFile("ABC_DEF.pdf");
const bad = validFile("ABC_DeF.pdf"); // error! 
// Argument of type '"ABC_DeF.pdf"' is not assignable to 
// parameter of type '"ABC_DAF.pdf"'.

看起来挺好的。 接受有效文件名，拒绝无效文件名。 此外，错误消息应该有望给出一些错误的指示。 它建议您应该编写"ABC_DAF.pdf"而不是"ABC_DeF.pdf" 。 可能有更智能的ValidFile版本，例如，建议"ABC_DEF.pdf" ，方法是在放弃之前检查无效字符的大写并建议"A" ，但我不会在这上面花任何额外的时间这里。

游乐场代码链接