Comments (2)
While searching for tools like this one, while it seems impressive/interesting, I have noticed a lack of CLI docs/examples, or at least they're not as easily visible as other projects make them such as on the README.
There's a reason for this. The tool is currently not stable, features could be added and changed, which means I would have to update the documentation.
Personally, I'm looking for a CLI that allows me to break analysis down further by filtering to file types/extensions
This program currently doesn't do that.
I can raise a separate issue as a feature request for that if it interests you.
Please do. I would like you to specify how exactly it should work:
- Do you only filter files? What about directories?
- What is the syntax?
Keep in mind that I do not compromise performance to add new features (I accept compromise in binary size), so the feature would have to wait.
from parallel-disk-usage.
There's a reason for this. The tool is currently not stable, features could be added and changed, which means I would have to update the documentation.
That's understandable. It does make me reluctant to trying it out and providing feedback though. I image other users may feel similar, it's not a huge amount of friction but it's there.
I don't mind if documentation for commands isn't updated and in sync all the time, especially when the lack of a stable API is communicated clearly. It's still valuable for getting a quick overview of what to expect.
Assuming your executable can output such so that there is some easy way to know how to use the CLI, you could print that output to a txt/md document with builds in CI or locally and commit that with a link on the README. More thorough documentation / examples could come later.
Keep in mind that I do not compromise performance to add new features
Do you see supporting an option to filter files by extension as a performance problem when filtering isn't used? I would have imagined any filtering logic wouldn't be run. I'm not familiar with the internals, but I envisioned the feature as opting in to check the file name or path against some condition, eg a regex pattern or list of extensions depending on how flexible you would allow it.
Performance degrading only when using such a feature is a non-issue in the sense that it has 0/no performance when the feature itself doesn't exist. I'd rather have access to a feature and accept the performance hit than not have the ability to do such in the first place, so long as it doesn't negatively impact anyone not using the feature.
I'll open an issue for the feature request (done. Up to you if leaving this documentation issue open is useful.
from parallel-disk-usage.
Related Issues (20)
- Lots of errors on runtime on macOS by default HOT 4
- Add 'arm64-darwin' build and publish to Homebrew and MacPorts HOT 4
- Fix the benchmark CI
- Print JSON representation of `data_tree::Reflection`
- Visualize from JSON representation of `data_tree::Reflection`
- Create cargo features to make `clap` and CLI parts of the library optional
- BTRFS filesystem du support HOT 1
- Customize the alignment of the bars
- 1500K should be shown as 1.5M
- Show incorrect size for files stored on cloud with link on local disk HOT 7
- Integration tests
- Improve documentation
- Add schema version to JSON
- Add pdu version to JSON HOT 6
- Preserve root paths HOT 1
- Can you Ignore duplicate inodes? HOT 1
- Feature Request: Filter files by file extension or regex HOT 3
- Dependency Dashboard
- exclude path option HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from parallel-disk-usage.