lit - 现代的文学编程工具

文学编程 是一种旨在提高程序可理解性的编写方式。所有文学编程的程序都由叙述性文本和特殊的文学结构组成，就像你现在阅读的这段文字一样。

lit 就是一个针对这一编程范式的现代工具。它不仅能生成计算机能理解的源代码，还能自动生成易于理解的文档。

记住 —— “程序首先是给人看的，其次才是机器。” —— Harold Abelson 和 Gerald Jay Sussman（《 Structure and Interpretation of Computer Programs》）

强大特性概览

• 所有叙事部分可以采用Markdown或纯文本格式
• 支持所有编程语言
• 通过缩进来定义文学结构
• 可以监控文件或目录变化，自动重新编译

示例

下面是一个来自examples/目录的helloWorld.hs.lit示例文件：

这是Haskell Hello World程序的概述。
我们使用 * 定义主要宏，从这里开始，其他所有代码或宏都将被定义。
    << * >>=
    << 一个简单的注释 >>

接着，我们定义前面提到的宏，
首先是一个无关紧要的注释！
    << 一个简单的注释 >>=
    -- 这是一个Hello World的Haskell程序

最后，我们需要打印出"Hello, World!"
    << 打印字符串 >>=
    main = putStr "Hello, World!"

运行命令 lit -c helloWorld.hs.lit 即可生成源代码文件helloWorld.hs：

-- 这是一个Hello World的Haskell程序
main = putStr "Hello, World!"

语法简述

lit有两个有效的构造：宏定义 << ... >>= 和宏引用 << ... >>。相同或更靠右的缩进行都是宏定义的一部分，宏定义可以包含宏引用。宏定义扩展是通过在文本文档中后续使用相同的名称来实现的。

当lit试图从文学文件生成源代码时，会将每个宏引用替换为其对应的宏定义。按照约定，必须包含根宏定义 << * >>= 来生成源代码。

安装与使用

首先安装Haskell平台，然后运行以下命令：

cabal install lit

使用lit的命令选项包括：

Usage: lit OPTIONS... FILES...

  -h  --html          生成HTML
  -m  --markdown      生成Markdown
  -c  --code          根据文件扩展名生成代码
  -n  --number        添加注解到生成的代码中，注明源lit文件和行号
      --css=FILE      指定HTML生成的CSS文件
      --docs-dir=DIR  生成文档的目录
      --code-dir=DIR  生成代码的目录
  -w  --watch         监听文件变化，自动运行lit
  -v  --version       输出版本信息
      --help          显示帮助

开发与贡献

从最新的源码构建lit：

git clone https://github.com/cdosborn/lit.git;
cd lit;
cabal sandbox init;
scripts/build.sh;

如果您发现了bug，请提交问题，附上输入的lit文件和失败的输出。如果愿意，欢迎直接发起包含修复的pull请求！

探索代码库，阅读在线文档，修改src/*.lit 文件，然后运行 ./build.sh，它已经非常文档化，并且能够处理重建和测试过程。

结语

lit 提供了一种崭新的、增强代码可读性的编程方式，无论您是开发者还是写作者，这个工具都能极大地提升您的工作效率和代码质量。试试看，你会发现更多惊喜！