Custom code style

[krlmlr]

For graph literals.

#673 contains the logic that was used in a one-off run. It would be nice to have the code styled on a regular basis, e.g., in a pre-commit hook.

[maelle]

In the PR, there are two scripts defining the same function normalize_igraph_arrows().

[maelle]

I'd suggest:

• creating a package holding the custom style (like https://github.com/ropensci-review-tools/spaceout)
• referencing it in the contributing guide. Regular contributors would install and run it locally.
• creating and tweaking a PR command workflow https://github.com/r-lib/actions/blob/473c68190595b311a74f208fba61a8d8c0d4c247/examples/pr-commands.yaml#L51

Does that sound good @krlmlr?

[krlmlr]

Can that be a function in the igraph package too? (Not sure a whole new repo is justified here.)

[maelle]

I suppose it could, but I find it cleaner this way. https://github.com/igraph/igraph.r2cdocs is a separate package for instance.

If it is a function in the igraph package, could we export it? Styling graphs might be relevant for igraph users too.

[krlmlr]

Yeah, let's start with a separate package. Merging is easier than tearing apart.

We have infrastructure to run styler on every PR, need to understand how to make it work with that new package or style guide. No PR command workflow needed.

[maelle]

@krlmlr are all these snaps correct? https://github.com/igraph/igraph.style/blob/main/tests/testthat/_snaps/igraph-style.md

In the PR you had linked to, I think all versions of normalize_igraph_arrows() were the same but they contained leftover browser().

[krlmlr]

• Needs a space before the RHS: A +-+ B etc.
• Also: A -+ B:C

[maelle]

Right, so does it mean you had used other code in your PR? I'm confused.

[maelle]

oh maybe the functions aren't the same (I had tried to compare them with version control, maybe I pasted the wrong one 🫠 )

[maelle]

RHS problem fixed but did the styling of styler::style_text("A - +B:C", style = igraph_style) ever work?

[krlmlr]

Might not have worked ever, or styler changed in the meantime.

[maelle]

Do you still remember enough about the code to fix {igraph.style} yourself or should I try?

[krlmlr]

I don't have the capacity to deal with that at the moment.

[krlmlr]

Seems to work now. Next steps:

• Run locally on the package, PR
• Decide on a level of quality (strict, scope)
• Configure GHA to run automatically

I can help with the third step.