Comments (16)
Hey @adamjstewart
I can take care of this.
I assume that formatting should be run on all files, not just some specific folder ? Also to clarify, this job should be implemented in style.yaml CI ?
from torchgeo.
Yes that will be most convenient. I will review then available packages and will let you know which ones I would suggest.
from torchgeo.
Seen yes, but haven't had time to review in detail yet. Apologies for the wait...
from torchgeo.
Yes, all *.yaml
and *.yml
files.
Yes, .github/workflows/style.yaml
.
It would be preferable to use something available on PyPI so we can explicitly list it as a dependency and install it with pip. Maybe you can review the options and propose which tool is best and why before actually making any code changes?
from torchgeo.
From what I have searched Google (unofficial) yamlfmt if well recommended but it's written in Go
and it's not in PyPI, it is similar with Prettier that can cover not only YAML but many other formats as well but it needs different package managers like NPM, Yarn etc.
In this case I would decide on yamlfix. It's available on PyPI, have good and clear documentation can be simply configured in pyproject.toml
if additional options are needed. Is maintained and updated since few years so it doesn't look like dead project.
from torchgeo.
yamlfmt's dependency on go and prettier's dependency on npm are unideal.
yamlfix appears to be somewhat dead: lyz-code/yamlfix#272
What about pretty-yaml? Are there any other alternatives we can consider?
from torchgeo.
True, sorry I haven't noticed that.
Pretty-yaml is very simple and seams to not support going thru all the directories in search for *.yaml
, *.yml
files. On top of that it's replacing true
with yes
and false
with no
so it doesn't suet our needs.
I will be keep on searching and will let you know as soon as I find something.
from torchgeo.
In YAML, true
== yes
: https://yaml.org/type/bool.html
I personally prefer true
, but I do want to ensure that all Booleans follow the same pattern. I'm surprised pretty-yaml didn't follow the canonical definition here.
from torchgeo.
Yes I noticed that here in code is used true
and false
so this along with inability to use it recursively disqualifies pretty-yaml as a potential package to use.
I did search since last comment and I could not find anything that could be used. Packages either do not support CLI, or are dead projects that haven't been touched for at lest a year or more.
Prettier is dominating in this field.
Then I think in this case we could use yamlfix even tho at the moment maintainer since 5 months is too busy, he says that eventually will comeback to project. It supports going through files recursively, can be easily configured, have quite few options and well written documentation. I can test if it wont throw any unsolved errors while running on torchgeo code.
There is also yamllint but this is only a linter, it would only prompt user where the errors are but it wont fix them on it self.
from torchgeo.
Let me think about this. It might not be horrible to use a go/npm package since it's only used by developers, not users. I'm also curious how many files would be changed if we used something like prettier. We do need something for JSON files too for .ipynb files...
from torchgeo.
When it's a part of CI it don't make much of a difference to us, it's just matter of using actions/setup-node@v4
or actions/setup-go@v5
instead of actions/setup-python@v5
. On the other hand Prettier could be also used as pre-commit hook but then of course node would had to be installed with Prettier as dependency.
It's possible that initially it could slightly change all the files since it's very opinionated, as it's devs say "Prettier is not a kitchen-sink code formatter that attempts to print your code in any way you wish. It is opinionated.". But still it have some options that can be always adjusted. If JSON files also would had to be handled then Prettier is a best choice.
from torchgeo.
I'm fine with opinionated, that's the whole point of a formatter/linter.
from torchgeo.
What is the final decision on that matter ? Will we use Prettier ?
from torchgeo.
I think prettier is probably best. Can you open a PR that uses prettier to see what the changes look like?
from torchgeo.
This is how it looks like while it was run without any additional options with just npx prettier . --write
from torchgeo.
Have you seen changes in PR #2018 ?
from torchgeo.
Related Issues (20)
- Use ruff
- Add Inference Example HOT 1
- Switch coverage providers? HOT 1
- Auto download fails for FireRisk HOT 11
- Anomaly with RandomGrayScale tests HOT 2
- Change documentation theme HOT 1
- CDL: cannot redownload additional years HOT 20
- Overrideable resample property for IntersectionDataset
- UnionDataset of two IntersectionDataset fails HOT 2
- RandomBatchGeoSampler produces nan or nodata values HOT 6
- Check if bbox of intersection is valid HOT 4
- Git clone and pip install results in 'Successfully installed UNKNOWN-0.0.0' HOT 10
- class_weights cannot be passed via config file as a tensor is expected HOT 5
- README.md benchmark dataset code HOT 17
- AgriFieldNet missing filename glob HOT 3
- CLI script for test HOT 2
- PatternNet download link is broken HOT 2
- VHR10 plot fails for negative split HOT 1
- VHR10 uses 'masks' as data_key, not 'mask'
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 torchgeo.