Floskell 开源项目使用教程

Floskell 开源项目使用教程

floskellFloskell is a flexible Haskell source code pretty printer.项目地址:https://gitcode.com/gh_mirrors/fl/floskell

1. 项目的目录结构及介绍

Floskell 项目的目录结构如下：

floskell/
├── github/
│   └── workflows/
├── contrib/
├── scripts/
├── src/
├── styles/
├── ghci/
├── .gitignore
├── BENCHMARK.md
├── CHANGELOG.md
├── CONFIGURATION.md
├── LICENSE.md
├── README.md
├── Setup.hs
├── TEST.md
├── floskell.cabal
├── floskell.json
├── stack-haskell-src-exts-1.19.yaml
├── stack-haskell-src-exts-1.20.yaml
├── stack-haskell-src-exts-1.21.yaml
└── stack.yaml

目录介绍

• github/workflows/: 包含 GitHub Actions 的工作流配置文件。
• contrib/: 包含项目的贡献文件。
• scripts/: 包含项目的脚本文件。
• src/: 包含项目的源代码文件。
• styles/: 包含项目的样式文件。
• ghci/: 包含 GHCi 的配置文件。
• .gitignore: Git 忽略文件配置。
• BENCHMARK.md: 基准测试文档。
• CHANGELOG.md: 变更日志文档。
• CONFIGURATION.md: 配置文档。
• LICENSE.md: 许可证文档。
• README.md: 项目介绍文档。
• Setup.hs: 项目设置文件。
• TEST.md: 测试文档。
• floskell.cabal: Cabal 构建配置文件。
• floskell.json: 项目配置文件。
• stack-haskell-src-exts-1.19.yaml, stack-haskell-src-exts-1.20.yaml, stack-haskell-src-exts-1.21.yaml: Stack 构建配置文件。
• stack.yaml: Stack 构建配置文件。

2. 项目的启动文件介绍

Floskell 项目的启动文件是 Setup.hs。这个文件用于配置和构建项目。它通常包含项目的初始化逻辑和构建步骤。

3. 项目的配置文件介绍

Floskell 项目的配置文件是 floskell.json。这个文件用于配置 Floskell 的格式化选项和样式。以下是配置文件的一些关键部分：

{
  "appStyle": "cramer",
  "appLanguage": "Haskell2010",
  "appExtensions": ["Extension1", "Extension2"],
  "appFixities": ["Fixity1", "Fixity2"]
}

配置文件字段介绍

• appStyle: 指定格式化样式，例如 cramer。
• appLanguage: 指定 Haskell 语言版本，例如 Haskell2010。
• appExtensions: 指定启用的 Haskell 扩展列表。
• appFixities: 指定运算符的优先级和结合性。

通过编辑 floskell.json 文件，可以自定义 Floskell 的格式化行为。

floskellFloskell is a flexible Haskell source code pretty printer.项目地址:https://gitcode.com/gh_mirrors/fl/floskell