Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

文档覆盖检查 CI? #32

Open
1 of 2 tasks
255doesnotexist opened this issue Oct 16, 2024 · 4 comments
Open
1 of 2 tasks

文档覆盖检查 CI? #32

255doesnotexist opened this issue Oct 16, 2024 · 4 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Milestone

Comments

@255doesnotexist
Copy link
Owner

255doesnotexist commented Oct 16, 2024

暂定 Tarpaulin 实现。

  • code coverage
  • docs coverage
@255doesnotexist 255doesnotexist added the enhancement New feature or request label Oct 16, 2024
@255doesnotexist 255doesnotexist self-assigned this Oct 16, 2024
@aisuneko
Copy link
Collaborator

aisuneko commented Oct 16, 2024

好像 code coverage 的前提是要有测试?等我写个unit test先 (#29)
docs coverage 倒是可以先做

@aisuneko aisuneko added the documentation Improvements or additions to documentation label Oct 16, 2024
@aisuneko aisuneko self-assigned this Oct 16, 2024
@255doesnotexist

This comment was marked as duplicate.

@aisuneko
Copy link
Collaborator

aisuneko commented Oct 23, 2024

@255doesnotexist code coverage 有一个问题:lintestor 是一个 binary project, api 并不对测试模块可见 ( https://doc.rust-lang.org/book/ch11-03-test-organization.html

@aisuneko
Copy link
Collaborator

docs coverage 实现有了(但是需要 nightly toolchain):

RUSTDOCFLAGS="-Z unstable-options --show-coverage" cargo doc --no-deps
+-------------------------------------+------------+------------+------------+------------+
| File                                | Documented | Percentage |   Examples | Percentage |
+-------------------------------------+------------+------------+------------+------------+
| src/aggregator.rs                   |          3 |     100.0% |          0 |       0.0% |
| src/config/connection_config.rs     |          1 |      14.3% |          0 |       0.0% |
| src/config/distro_config.rs         |          1 |      10.0% |          0 |       0.0% |
| src/config/mod.rs                   |          0 |       0.0% |          0 |       0.0% |
| src/main.rs                         |          8 |     100.0% |          0 |       0.0% |
| src/markdown_report.rs              |          2 |     100.0% |          0 |       0.0% |
| src/test_runner/local.rs            |          1 |      33.3% |          0 |       0.0% |
| src/test_runner/mod.rs              |          2 |      66.7% |          0 |       0.0% |
| src/test_runner/remote.rs           |          3 |      33.3% |          0 |       0.0% |
| src/testenv_manager.rs              |          6 |      66.7% |          0 |       0.0% |
| src/testscript_manager.rs           |          8 |      80.0% |          5 |     100.0% |
| src/utils.rs                        |         29 |      96.7% |          0 |       0.0% |
+-------------------------------------+------------+------------+------------+------------+
| Total                               |         64 |      67.4% |          5 |      83.3% |
+-------------------------------------+------------+------------+------------+------------+

@aisuneko aisuneko added this to the 1.0 release milestone Oct 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants