1. OpenREM Avatar OpenREM
  2. OpenREM
  3. OpenREM
  4. Issues

Tidy up code formatting with black

Issue #841 resolved
Ed McDonagh created an issue

Proposal: use black to improve formatting to PEP8 conventions

Comments (50)

  8. Ed McDonagh reporter

    Thanks @David Platten . Finally managed to reduce the number of code style issues on Codacy rather than increasing them, but that was partly by just disabling more of the pylint checks! I am confident that it is a good discipline to use, but I am wondering now about ditching Codacy and setting up an alternative instead, rather than just fighting pylint all the time. Flake8 appears to be the linter tool to use, but it isn’t an option in Codacy.

    I’ll have a look at how the new reports functions work in bitbucket: https://support.atlassian.com/bitbucket-cloud/docs/code-insights/, possibly with the Flake8 reports being part of the pipeline then being analysed by sonarcloud and the report coming into the PR. Or something.

    And I think unless @Luuk or anyone else has a better idea or reasonable objection, I think I’ll merge the code in sooner rather than later so we can have a cleaner base to finish off the version 1 release with.

  9. Luuk

    Seems to me like a very good idea to unify code formatting and I can’t think of any reasonable objection.

  11. Ed McDonagh reporter

    I need to think about that. It changes the code, so might be a surprise if it happened after the code is committed. And I’m not sure how that would work.

    There might be something that can be done with pre-commit hooks, not sure.

    Maybe just a pre-merge check (manually)?

  28. Ed McDonagh reporter

    soundcloud-scan now works, but sonarcloud-quality-gate fails on memor error. Seeing if splitting them makes a difference (and works). Refs #841

    → <<cset 89733f89a24a>>

  46. Ed McDonagh reporter

    Merged in issue841testblack (pull request #377)

    Refs #841 but doesn't fix it because I need to add some developer docs for black.

    Runs flake8 report first, then creates code quality report for everything, then runs a quality gate check before finally running the django tests. Quality gate is currently set at a low bar for now. Not sure which of code quality or django tests are more likely to fail - whichever it is should go first to save pipeline minutes!

    → <<cset ff50f63ebadc>>

  51. Log in to comment
Assignee
Type
proposal
Priority
minor
Status
resolved
Component
–
Milestone
1.0.0
Votes
0
Watchers
1
Jira: the preferred issue tracker for Bitbucket. Join the team!