tyson

tyson （打字稿对象符号）?

打字稿作为配置语言

这是什么？

tyson （打字稿对象符号）是打字稿的子集，被选为可作为生成JSON的可嵌入配置语言。您可以将tyson视为JSON +注释 +类型 +使用Typescript语法的基本逻辑。 tyson文件使用.tson扩展名。

目的是使所有主要的编程语言都可以阅读使用本机库在打字稿中编写的配置。也就是说， go程序应该能够使用go库阅读tyson ， rust程序应该能够使用rust库阅读tyson ，依此类推。我们的第一个实施是用纯go编写的，将随后实施rust 。

这是一个示例.tson文件：

 // example.tson
{
  // Single-line comments are supported
  array_field : [ 1 , 2 , 3 ] ,
  boolean_field : true ,
  /* As well as multi-line comments, and multi-line strings.
   *
   * Multi-line strings are TypeScript template literals, so they also support
   * interpolation.
   */
  multi_line_string_field : `
    line 1
    line 2
    line ${ 1 + 2 }
  ` ,
  number_field : 123 ,
  string_field : \'string\' ,
  object_field : {
    // Notice that, unlike JSON, field names can be unquoted if they\'re a valid
    // TypeScript identifier.
    nested_field : \"nested\" ,
  } , // Trailing commas are allowed
}

以上评估以下JSON：

{
    \"array_field\" : [ 1 , 2 , 3 ],
    \"boolean_field\" : true ,
    \"multi_line_string_field\" : \" \\n    line 1 \\n    line 2 \\n    line 3 \\n  \" ,
    \"number_field\" : 123 ,
    \"object_field\" : {
        \"nested_field\" : \" nested \"
    },
    \"string_field\" : \" string \"
}

tyson最初是由Jetify开发的。我们正在使用它作为Devbox的配置语言进行探索。

使用tyson的好处

类型安全：使用TypeScript的类型系统来确保您的配置有效。

 type Config = {
    // This field is required
    required_field : string ;
    // This field is optional
    optional_field ?: number ;
} ;

// When there are multiple expressions in a file, we need to `export default` the one
// that should be evaluated as JSON:
export default {
    optional_field : \'1\' , // Type error: expected number, got string
    rquired_field : \'bar\' , // This typo will be caught by the TypeScript compiler
} satisfies Config ;

可编程：您可以通过编程生成配置。例如，您可以导入和覆盖这样的值：

 import otherConfig from \'./your_other_config.tson\' ;

// Import otherConfig and override some values:
export default {
    ... otherConfig , // Spread operator is supported
    valuesToOverride : \'values1\' ,
} ;

或者，您可以定义功能并在您的配置中使用它们：

 // We can write a function to help us generate configuration:
function person ( first_name : string , last_name : string ) {
    return {
        first_name ,
        last_name ,
        full_name : ` ${ first_name } ${ last_name } ` ,
    } ;
}

export default {
    people : [ person ( \'Alyssa\' , \'Hacker\' ) , person ( \'Ben\' , \'Bitdiddle\' ) ] ,
} ;

NOTER语法：与JSON不同，Dypescript支持评论，尾随逗号和多行字符串，此外还包括类型和功能。与dhall ， cue ， jsonnet或nickel不同的语言不同，如果您已经熟悉打字稿，则不必学习新语言。

编辑支持：由于tyson是打字稿的子集，因此您的编辑器已经支持语法突出显示，格式化和自动完成。只需将编辑器配置为将.tson文件视为打字稿文件即可。

为什么？

几乎所有开发人员工具都需要某种形式的配置。我们认为，理想的配置语言应该是：

• 人类易于读写
• 易于解析和通过机器生成
• 键入安全– 以便易于验证输出
• 可编程– 以便您可以将复杂的配置模式抽象为可重复使用的功能
• 安全– 如果我们想要可编程配置，则其执行不应影响加载它的应用程序。
• 有一个宽容的语法– 没有重大的陷阱，可能导致错误
• 基于广泛使用的标准– 没有人愿意学习一种新语言以配置工具
• 易于迁移到– 已经使用JSON进行配置的工具应该能够逐渐采用新语言，同时保留与现有JSON配置文件的兼容性。

传统上，配置最受欢迎的选择是：JSON，YAML或TOML，但它们都有缺点：

• JSON ：不支持评论，跟踪逗号或多行字符串。
• YAML ：具有模棱两可的语法。例如，令牌no被解释为布尔值，通常在您希望它为字符串的情况下。有关更多示例，请参见https://n*o*yaml.co*m/。
• TOML ：当筑巢多个层次时会变得笨拙。

作为对这些问题的回应，以及缺乏可编程性，已经出现了许多新的配置语言，包括dhall ， cue ， jsonnet和nickel 。这些语言解决了上述几个问题，但它们都要求用户学习新的语法。

以一种有趣的方式，我们喜欢将其称为Tarpit Law，以Turing Tarpit和Greenspun的第十条规则命名：

编程的tarpit定律：“每种支持逻辑，最终都会演变为临时，非正式，错误，缠绕且缓慢地实现Turing-Complete语言的语言。”

这本来应该是嘲讽的：上述许多语言都是明确指定的，而且不是越野车，有些语言甚至没有完整的词……但是，在试图采用它们时，我们仍然发现自己感到沮丧，希望我们不要学习一种新的构想，而是只能使用一种现有的，像打字条的现有语言。

因此，我们问自己，为什么我们不已经使用Typescript作为配置语言？是什么阻止了我们？实际上，在JavaScript生态系统中，大多数工具已经允许用户使用打字稿进行配置。为什么我们不在其他生态系统中做同样的事情？

我们意识到我们的阻滞剂是缺乏用于评估基于打字稿的配置并将其转换为JSON的本地库。我们决定建立tyson来解决这个问题。我们的第一个实现是Pure go中的库，可以评估tyson文件并将其转换为JSON。其他语言的实施将效仿。

命令行工具

tyson配备了一个命令行工具，该工具可用于将tyson文件转换为JSON。要安装它，请运行：

curl -fsSL https://get.j*et*i*fy.com/tyson | bash

要将文件input.tson转换为json，请运行：

 tyson eval input.tson

由此产生的JSON将被打印到Stdout。

下一步

我们将分享tyson作为早期开发人员预览，以在我们巩固规格之前获得社区的反馈。

目前我们提供：

1. 一个可以解析tyson并将其评估给JSON的golang库。它建立在广泛采用的岩石上的esbuild上。
2. 命令行工具，作为单个二进制文件，可以解析并评估tyson文件为JSON。

根据社区的反馈，我们计划补充：

1. tyson的正式规格（一旦我们感到有信心，我们就可以保留向后兼容）。
2. 包括rust在内的其他语言的实现。

相关工作

可以转换为JSON的替代配置语言包括：

• 达尔
• 提示
• jsonnet
• 镍

如果您愿意为您的配置学习新的语法，那么这些替代方案可以提供不同的保证。作为一个例子：

• dhall努力成为一种完全的语言，而不是整理
• CUE具有基于图形统一的类型系统，该系统可以轻松以任何顺序组合值并仍然获得相同的结果，这有时更易于推理。

tyson （Tyson）的主要区别是我们使用打字稿作为基础语言。它使得可以立即开始使用熟悉的语法，并重用对打字稿的现有编辑器（和生态系统）支持。