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

Support styleguides #424

Open
lucaferranti opened this issue Sep 4, 2024 · 1 comment · May be fixed by #440
Open

Support styleguides #424

lucaferranti opened this issue Sep 4, 2024 · 1 comment · May be fixed by #440
Assignees
Labels
template: add Addition suggestion, i.e., a new file or option
Milestone

Comments

@lucaferranti
Copy link
Contributor

lucaferranti commented Sep 4, 2024

Description

It would be nice to have a question like

> Would you like to follow any particular styleguide?
- SciML style
- blue style
- YAS style
- None

If the user selects a styleguide, then the corresponding badge should be added to the README.md and the .JuliaFormatter.toml should have a line

style = "$STYLENAME"

Maybe one thing worth pointing out is that all three styles above choose a formatting of 4, hence not sure how the choice should play with the question about indentation. I think a .JuliaFormatter.toml file like

style = "sciml"
indentation = 2

is valid and indentation would overwrite the value dictated by style (haven't checked), hence I guess there's no harm in keeping the indentation question if one wants

Validation and testing

It would need to verify the badge is inserted and .JuliaFormatter has the approrpriate style entry in the generated package.

Motivation

As those styleguides are popular (at least scimlstyle and blue, not sure about yas) several package developers may want to follow those and add the badge to the readme. This is also a feature of PkgTemplates.jl hence it would fit nicely under #353

Target audience

No response

Can you help?

Yes, I can open a PR. This way I can also guineapig the instructions in https://abelsiqueira.com/BestieTemplate.jl/stable/91-developer/#Additions-to-the-templates to check if they're clear :D

@abelsiqueira
Copy link
Collaborator

I like the idea. Feel free to open a PR. It should fit inside the copier/code-quality.yml file, I think.

@abelsiqueira abelsiqueira added the template: add Addition suggestion, i.e., a new file or option label Sep 5, 2024
@lucaferranti lucaferranti linked a pull request Sep 5, 2024 that will close this issue
5 tasks
@abelsiqueira abelsiqueira added this to the 0.11.0 milestone Sep 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
template: add Addition suggestion, i.e., a new file or option
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants