XAMPPRocky/tokei

# Tokei ([時計](https://en.wiktionary.org/wiki/%E6%99%82%E8%A8%88)) [](https://github.com/XAMPPRocky/tokei/actions?query=workflow%3A%22Mean+Bean+CI%22) [](https://github.com/XAMPPRocky/tokei/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) [](https://docs.rs/tokei/)    ) [](https://deps.rs/repo/github/XAMPPRocky/tokei) [](https://repology.org/project/tokei/versions) Tokei 是一个显示代码统计信息的程序。Tokei 会按语言分组显示文件数量、这些文件中的总行数以及代码、注释和空白的行数。 ## 示例 ``` ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ Language Files Lines Code Comments Blanks ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ BASH 4 49 30 10 9 JSON 1 1332 1332 0 0 Shell 1 49 38 1 10 TOML 2 77 64 4 9 ─────────────────────────────────────────────────────────────────────────────── Markdown 5 1355 0 1074 281 |- JSON 1 41 41 0 0 |- Rust 2 53 42 6 5 |- Shell 1 22 18 0 4 (Total) 1471 101 1080 290 ─────────────────────────────────────────────────────────────────────────────── Rust 19 3416 2840 116 460 |- Markdown 12 351 5 295 51 (Total) 3767 2845 411 511 ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ Total 32 6745 4410 1506 829 ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ ``` ## [API 文档](https://docs.rs/tokei) ## 目录 - [功能特性](#features) - [安装](#installation) - [包管理器](#package-managers) - [手动安装](#manual) - [配置](#configuration) - [如何使用 Tokei](#how-to-use-tokei) - [选项](#options) - [支持的语言](#supported-languages) - [更新日志](CHANGELOG.md) - [常见问题](#common-issues) - [权威源](#canonical-source) - [版权与许可](#copyright-and-license) ## 功能特性 - Tokei **非常快**，能够在几秒钟内计算数百万行代码。 查看 [11.0.0 版本](https://github.com/XAMPPRocky/tokei/releases/v11.0.0) 以了解 Tokei 的速度如何与其他工具进行比较。 - Tokei **准确**，Tokei 能正确处理多行注释， 嵌套注释，并且不会将字符串中的注释计入。提供准确的代码统计。 - Tokei 支持范围广泛的语言，支持超过 **150** 种语言， 及其各种扩展名。 - Tokei 可以以多种格式 (**CBOR**、**JSON**、**YAML**) 输出， 从而可以轻松地存储和重用 Tokei 的输出。这些也可以在 tokei 中重用，将上一次运行的统计信息与另一组统计信息结合。 - Tokei 可在 **Mac**、**Linux** 和 **Windows** 上使用。有关如何在你所用的平台上获取 Tokei 的信息，请参阅[安装说明](#installation)。 - Tokei 也是一个**库**，允许你轻松地将其与其他项目集成。 - Tokei 带有彩色和无彩色模式。将环境变量 NO_COLOR 设置为 1， 它将以黑白方式显示。 ## 安装 ### 包管理器 #### Unix ``` # Alpine Linux (自 3.13 起) apk add tokei # Arch Linux pacman -S tokei # Cargo cargo install tokei # Conda conda install -c conda-forge tokei # Fedora sudo dnf install tokei # FreeBSD pkg install tokei # NetBSD pkgin install tokei # Nix/NixOS nix-env -i tokei # OpenSUSE sudo zypper install tokei # Void Linux sudo xbps-install tokei ``` #### macOS ``` # Homebrew brew install tokei # MacPorts sudo port selfupdate sudo port install tokei ``` #### Windows ``` # Winget winget install XAMPPRocky.tokei # Scoop scoop install tokei ``` ### 手动安装 #### 下载 你可以在 [发布版块](https://github.com/XAMPPRocky/tokei/releases) 下载预编译的二进制文件。 #### 构建 你也可以从源代码构建并安装（需要最新的稳定版 [Rust] 编译器）。 ``` cargo install --git https://github.com/XAMPPRocky/tokei.git tokei ``` ## 配置 Tokei 有一个 [配置] 文件，允许你更改默认行为。 该文件可以命名为 `tokei.toml` 或 `.tokeirc`。目前 tokei 会在三个不同的位置查找此文件：当前目录、你的主目录以及你的配置目录。 ## 如何使用 Tokei #### 基本用法 这是使用 tokei 的基本方法。它将报告 `./foo` 及其所有子文件夹中的代码情况。 ``` $ tokei ./foo ``` #### 多个文件夹 要让 tokei 在同一次调用中报告多个文件夹的情况，只需将所有你希望 tokei 检查的文件夹添加进来即可。 ``` $ tokei ./foo ./bar ./baz ``` #### 排除文件夹 Tokei 会遵循所有的 `.gitignore` 和 `.ignore` 文件，并且你可以使用 `--exclude` 选项来排除任何额外的文件。`--exclude` 标志的语义与 `.gitignore` 相同。 ``` $ tokei ./foo --exclude *.rs ``` 要排除的路径也可以列在 `.tokeignore` 文件中，使用与 .gitignore 文件相同的 [语法](https://git-scm.com/docs/gitignore)。 #### 对输出进行排序 默认情况下，tokei 按语言名称的字母顺序排序，但使用 `--sort` 选项，tokei 也可以按任何列进行排序。 `blanks, code, comments, lines` ``` $ tokei ./foo --sort code ``` #### 输出文件统计信息 默认情况下，tokei 仅输出语言的汇总，而使用 `--files` 标志，tokei 还可以输出单个文件的统计信息。 ``` $ tokei ./foo --files ``` #### 输出为不同格式 Tokei 通常输出为适合终端阅读的、友好的人类可读格式。 此外，还可以使用 `--output` 选项以各种其他格式输出，这对于将数据导入其他程序更为有用。 **注意：** 此版本的 tokei 在编译时未包含任何序列化格式，要启用序列化功能，请使用 features 标志重新安装 tokei。 ``` ALL: cargo install tokei --features all CBOR: cargo install tokei --features cbor YAML: cargo install tokei --features yaml ``` **目前支持的格式** - JSON `--output json` - YAML `--output yaml` - CBOR `--output cbor` ``` $ tokei ./foo --output json ``` #### 读入已存储的格式 Tokei 还可以接收之前结果中输出的格式，并将其添加到当前运行中。Tokei 可以接受一个文件路径、作为选项值传入的格式，或者从标准输入 读取。 ``` $ tokei ./foo --input ./stats.json ``` ## 选项 ``` USAGE: tokei [FLAGS] [OPTIONS] [--] [input]... FLAGS: -f, --files Will print out statistics on individual files. -h, --help Prints help information --hidden Count hidden files. -l, --languages Prints out supported languages and their extensions. --no-ignore Don't respect ignore files (.gitignore, .ignore, etc.). This implies --no-ignore-parent, --no-ignore-dot, and --no-ignore-vcs. --no-ignore-dot Don't respect .ignore and .tokeignore files, including those in parent directories. --no-ignore-parent Don't respect ignore files (.gitignore, .ignore, etc.) in parent directories. --no-ignore-vcs Don't respect VCS ignore files (.gitignore, .hgignore, etc.), including those in parent directories. -V, --version Prints version information -v, --verbose Set log output level: 1: to show unknown file extensions, 2: reserved for future debugging, 3: enable file level trace. Not recommended on multiple files OPTIONS: -c, --columns Sets a strict column width of the output, only available for terminal output. -e, --exclude ... Ignore all files & directories matching the pattern. -i, --input Gives statistics from a previous tokei run. Can be given a file path, or "stdin" to read from stdin. -o, --output

Outputs Tokei in a specific format. Compile with additional features for more format support. [possible values: cbor, json, yaml] -s, --sort Sort languages based on column [possible values: files, lines, blanks, code, comments] -t, --type Filters output by language type, separated by a comma. i.e. -t=Rust,Markdown ARGS: ... The path(s) to the file or directory to be counted. ``` ## Docker 化版本 Tokei 提供了一个基于 `alpine` 的小型 Docker 镜像，可通过 [earthly](https://github.com/earthly/earthly) 构建： ``` earthly +docker ``` 构建完成后，可以通过以下命令运行镜像： ``` docker run --rm -v /path/to/analyze:/src tokei . ``` 或者，直接分析当前文件夹： ``` docker run --rm -v $(pwd):/src tokei . ``` ## 支持的语言 如果你希望将某种语言添加到 tokei 中，请随时提交拉取请求。语言定义在 [`languages.json`](./languages.json) 中，你可以在我们的 [CONTRIBUTING.md](./CONTRIBUTING.md) 中阅读如何添加和测试你的语言。 ``` Abap ActionScript Ada Agda Alex Alloy APL Asn1 Asp AspNet Assembly AssemblyGAS ATS Autoconf AutoHotKey Automake AWK Bash Batch Bazel Bean Bicep Bitbake BQN BrightScript C C3 Cabal Cassius Ceylon CHeader Cil Clojure ClojureC ClojureScript CMake Cobol CoffeeScript Cogent ColdFusion ColdFusionScript Coq Cpp CppHeader Crystal CSharp CShell Css Cuda CUE Cython D D2 DAML Dart DeviceTree Dhall Dockerfile DotNetResource DreamMaker Dust Ebuild EdgeDB Edn Elisp Elixir Elm Elvish EmacsDevEnv Emojicode Erlang Factor FEN Fish FlatBuffers ForgeConfig Forth FortranLegacy FortranModern FreeMarker FSharp Fstar GDB GdScript GdShader Gherkin Gleam Glsl Go Graphql Groovy Gwion Hamlet Handlebars Happy Hare Haskell Haxe Hcl Hex Hex0 Hex1 Hex2 HiCAD hledger Hlsl HolyC Html Hy Idris Ini IntelHex Isabelle Jai Janet Java JavaScript Jq Json Jsx Julia Julius Just KakouneScript KaemFile Koka Kotlin Lean Less Lingua Franca LinkerScript Liquid Lisp LLVM Logtalk Lua Lucius M1Assembly Madlang Max Makefile Markdown Mdx Meson Mint Mlatu ModuleDef MonkeyC MoonScript MsBuild Mustache Nim Nix NotQuitePerl NuGetConfig Nushell ObjectiveC ObjectiveCpp OCaml Odin OpenSCAD OpenQASM Org Oz Pascal Perl Perl6 Pest Phix Php Po Poke Polly Pony PostCss PowerShell Processing Prolog Protobuf PRQL PSL PureScript Pyret Python Qcl Qml R Racket Rakefile Razor Renpy ReStructuredText RON RPMSpecfile Ruby RubyHtml Rust Sass Scala Scheme Scons Sh ShaderLab Slang Sml Solidity SpecmanE Spice Sql SRecode Stata Stratego Svelte Svg Swift Swig SystemVerilog Slint Tact Tcl Templ Tex Text Thrift Toml Tsx Twig TypeScript UMPL UnrealDeveloperMarkdown UnrealPlugin UnrealProject UnrealScript UnrealShader UnrealShaderHeader UrWeb UrWebProject Vala VB6 VBScript Velocity Verilog VerilogArgsFile Vhdl VimScript VisualBasic VisualStudioProject VisualStudioSolution Vue WebAssembly Wolfram Xaml XcodeConfig Xml XSL Xtend Yaml ZenCode Zig ZoKrates Zsh ``` ## 常见问题 ### Tokei 提示我有大量的 D 代码，但我确信没有 D 代码！ 这可能是由于 `gcc` 生成了 `.d` 文件。在 D 语言开发者决定使用不同的文件扩展名之前，你随时可以使用 `-e --exclude` 标志排除 `.d` 文件，就像这样 ``` $ tokei . -e *.d ``` ## 权威源 此代码库的权威源托管在 [GitHub](https://github.com/XAMPPRocky/tokei)。如果你有 GitHub 账户， 请在那里提交 issue 和拉取请求。 ## 相关工具 - [tokei-pie](https://github.com/laixintao/tokei-pie)：将 tokei 的输出渲染为交互式旭日图。 ## 版权与许可 (C) 版权所有 2015，XAMPPRocky 及贡献者 请参阅 [图表](https://github.com/XAMPPRocky/tokei/graphs/contributors) 获取完整的贡献者列表。 Tokei 根据 MIT 许可证和 Apache 许可证 (版本 2.0) 的双重条款进行分发。 有关更多信息，请参阅 [LICENCE-APACHE](./LICENCE-APACHE) 和 [LICENCE-MIT](./LICENCE-MIT)。

标签：CLI, Homebrew安装, Rust, SOC Prime, Tokei, WiFi技术, 二进制发布, 云安全监控, 代码分析, 代码统计, 代码行数, 凭证管理, 可视化界面, 开发工具, 开发效率, 开源工具, 统计工具, 编程语言分析, 网络可观测性, 网络流量审计, 请求拦截, 通知系统, 静态分析