feat: support prettier 1/3

[Anavelyz]

Pull Request description

Prettier is an opinionated code formatter, ensuring that all output code conforms to a consistent style.

Fixes #180

Prettier was added to the project and to the template.

Modified files:

• For the project:

  • .pre-commit-config.yaml
  • .prettierignore
  • .prettierrc.yaml
  • .editorconfig

• For the template:

  • src/scicookie/cookiecutter.json (and it has been reformatted)
  • src/scicookie/{{cookiecutter.project_slug}}/.pre-commit-config.yaml (and it has been reformatted)
  • src/scicookie/hooks/post_gen_project.py
  • tests/smoke/linters.sh

Pull Request checklists

This PR is a:

• bug-fix
• new feature
• maintenance

About this PR:

• it includes tests.
• the tests are executed on CI.
• the tests generate log file(s) (path).
• pre-commit hooks were executed locally.
• this PR requires a project documentation update.

Author's checklist:

• I have reviewed the changes and it contains no misspelling.
• The code is well commented, especially in the parts that contain more complexity.
• New and old tests passed locally.

Reviewer's checklist

• I managed to reproduce the problem locally from the main branch
• I managed to test the new changes locally
• I confirm that the issues mentioned were fixed/resolved

[Anavelyz]

@xmnlab Can you have a look at it, please?

[Saransh-cpp]

Hi @Anavelyz!

It is usually recommended to make all the auto-formatting changes (prettier changes in this case) in a single commit. This commit's hash can then be added to .git-blame-ignore-revs file to ensure that the git blame is preserved. For example, see pybamm's .git-blame-ignore-revs file.

But this is totally up to us, if we want to follow this or not 🙂

[xmnlab]

not sure what happened .. but it shouldn't change indentation from 2 spaces to 4.
maybe you will need to update .editorconfig as well

this is what I am using for astx: https://github.com/arxlang/astx/blob/main/.editorconfig

or just maybe update the prettierc file to define the indentation space directly there.

[Anavelyz]

not sure what happened .. but it shouldn't change indentation from 2 spaces to 4. maybe you will need to update .editorconfig as well

Yes, .editorconfig has 4 spaces set:

scicookie/.editorconfig

Line 7 in 5a6f0b4

indent_size = 4

Excuse me, I did not read the issue carefully. There it was specified

[xmnlab]

Hi @Anavelyz!

It is usually recommended to make all the auto-formatting changes (prettier changes in this case) in a single commit. This commit's hash can then be added to .git-blame-ignore-revs file to ensure that the git blame is preserved. For example, see pybamm's .git-blame-ignore-revs file.

But this is totally up to us, if we want to follow this or not 🙂

thanks @Saransh-cpp to bring that up.

tbh I am not familiar with that .. give me a bit to check that ;)

[xmnlab]

@Saransh-cpp , I think that it makes sense. thank you again for bring that up.

so the workflow would be:

• merge this PR without any change from the prettier
• create a new PR that apply changes from prettier and merge that
• create a new PR for .git-blame-ignore-revs

is that right?

if so ... @Anavelyz, let's do it together ... ping me when you have a free time for that

[Saransh-cpp]

We can do all of this in a single PR (in 3 separate commits) if we "Create a merge commit" instead of "Squash and merge".

If we want to "Squash and merge," then yes, it will require 3 separate PRs.

[xmnlab]

thanks for the answer @Saransh-cpp ! appreciate that

[xmnlab]

lgtm! thanks @Anavelyz

[github-actions]

🎉 This PR is included in version 0.7.0 🎉

The release is available on:

• 0.7.0
• GitHub release

Your semantic-release bot 📦🚀