1
1
Fork
You've already forked ecformat
0

Include licenses #24

Manually merged
BaumiCoder merged 17 commits from chore/9-licenses into main 2025年10月04日 11:19:26 +02:00

Resolves #9

User perspective

With the license command you can now, see the license information of ecformat and all its libraries / dependencies. See the CLI help (e.g., with ecformat help license) for available options.

Developer perspective

The license information are now collected automatically with cargo-about. This cargo plugin is automatically installed and excuted via the build.rs. The created markdown file is included at compile time. Therefore, no extra license file needs to be distributed.

Resolves #9 ### User perspective With the `license` command you can now, see the license information of ecformat and all its libraries / dependencies. See the CLI help (e.g., with `ecformat help license`) for available options. ### Developer perspective The license information are now collected automatically with `cargo-about`. This cargo plugin is automatically installed and excuted via the `build.rs`. The created markdown file is included at compile time. Therefore, no extra license file needs to be distributed. 
Basic config to run cargo about generate sucessfully.
Markdown is more readable for humans and there are crates to
print markdown formatted into a terminal.
This ensures the included about.md always exist at compile time
and makes the separate hook unnecessary.
https://users.rust-lang.org/t/get-cargo-package-name-in-build-rs/13340 
This also introduce uniform error handling for all commands.
A more suitable name as the Pagination option is more than a print.
Furthermore, order the options from complex to simple.
Some licenses were only used in removed dependencies, but I only
updated the list in the deny.toml.
Count the lines of the quite big about text only if necessary.
Author
Owner
Copy link

The include_str!(...) calls uses fixed file paths with / (i.e., Unix-like paths). Therefore, I tested it on Windows 11, but there was no problem with this. So no need to handle these paths differently on Windows.

The `include_str!(...)` calls uses fixed file paths with `/` (i.e., Unix-like paths). Therefore, I tested it on Windows 11, but there was no problem with this. So no need to handle these paths differently on Windows.
BaumiCoder manually merged commit cf9663f2fd into main 2025年10月04日 11:19:26 +02:00
Sign in to join this conversation.
No reviewers
Labels
Clear labels
Compat/Breaking
Breaking change that won't be backward compatible
EditorConfig
0.17.2
 Issues to support version 0.17.2 of the EditorConfig specification
Kind
Bug
 Something is not working
Kind
Chore
 Some tasks maintainig tasks
Kind
Documentation
 Documentation changes
Kind
Enhancement
 Improve existing functionality
Kind
Feature
 New functionality
Kind
Testing
 Issue or pull request related to testing
Packaging
About packaging the project for some platform
Priority
Critical
 The priority is critical
Priority
High
 The priority is high
Priority
Low
 The priority is low
Priority
Medium
 The priority is medium
Reviewed
Confirmed
 Issue has been confirmed
Reviewed
Duplicate
 This issue or pull request already exists
Reviewed
Invalid
 Invalid issue
Reviewed
Won't Fix
 This issue won't be fixed
Status
Abandoned
 Somebody has started to work on this but abandoned work
Status
Blocked
 Something is blocking this issue or pull request
Status
Need More Info
 Feedback is required to reproduce issue or to continue work
WIP
Work in progress (Assignee is working on this issue)
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
BaumiCoder/ecformat!24
Reference in a new issue
BaumiCoder/ecformat
No description provided.
Delete branch "chore/9-licenses"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?