Skip to content

Conversation

@Jackenmen
Copy link
Member

@Jackenmen Jackenmen commented Mar 15, 2021

Type

  • Bugfix
  • Enhancement
  • New feature

Description of the changes

List of changes to be completed...

Notes:

  • make stylediff reports diffs separately
    • Previously I wrote a tool for running both tools on the files and showing the combined diff
      but I think it's just an unnecessary maintenance burden. Here's a link in case someone is
      interested in this work though:
      563b94a
    • I was also considering removing make stylediff completely since it was primarily added for
      use in CI but it isn't much of a burden to at least keep it in this form and it might be
      useful for some people's workflows. pre-commit usage should, however, be preferred.

TODO:

  • re-enable flake8 for tests/ after figuring out a proper way to minimize the issues with the imports
  • Incorporate pylint too? Maybe it would be better as separate PR once pylint 2.7.3 gets released; TBD
  • Add a new recipe to Makefile that creates a new venv and auto-installs pre-commit as part of it
    • basically make newenv + pre-commit install combined
    • alternatively, we could just print a message in make newenv after it finishes everything else
  • add the following commits from ISort, various new checks, problem matchers and more - reformat #4894 once it's merged:
    • "Address issues from flake8"
    • "Reformat with Black 22.1.0"
    • "Reformat with isort 5.10.1"
    • "Remove trailing whitespace"
    • "Make files end with one empty line"
    • "Reformat JSON files with pretty-format-json hook"

Things that I have considered but ended up not doing:

  • a Makefile recipe that calls pre-commit run --all-files
    • note: this would have been a single recipe and it would not be the same as reformat, stylecheck, or stylediff as not all hooks are able to automatically reformat the files
    • I think that there isn't much use for this, pre-commit works better as
      an installed pre-commit hook, it already runs in CI, and it isn't particularly
      hard for people to run pre-commit run --all-files if that's their preferred workflow
  • auto-install pre-commit as part of newenv recipe in Makefile
    • it is not a good idea to force this workflow on people

The reformatting needed by this PR is done in #4894 and that PR should be merged before this one.

Link to problem matcher preview: 6378fdf (can also be seen on the "Files changes" page in "Unchanged files with check annotations" section)

Fixes #3882, fixes #4698

Blocked by #4894 (the one that actually does the reformatting)

@Jackenmen Jackenmen added Type: Enhancement Something meant to enhance existing Red features. Type: Fix Category: CI This is related to repository's CI configuration. Category: Meta This is related to the repository maintenance. labels Mar 15, 2021
@github-actions github-actions bot added Category: Cogs - Admin This is related to the Admin cog. Category: Cogs - Alias This is related to the Alias cog. Category: Cogs - Audio This is related to the Audio cog. Category: Core - API - Bank This is related to the core Bank API. Category: Cogs - Bank (historical) This is related to the Bank cog. Category: Bot Core Category: Cogs - Cleanup This is related to the Cleanup cog. Category: Core - API - Config This is related to the `redbot.core.config` module and `redbot.core.drivers` package. Category: Cogs - CustomCommands This is related to the CustomCommands cog. Category: Cogs - Dev This is related to the Dev cog. Category: Docs - Other This is related to documentation that doesn't have its dedicated label. Category: Cogs - Downloader This is related to the Downloader cog. Category: Cogs - Economy This is related to the Economy cog. Category: Cogs - Filter This is related to the Filter cog. Category: Cogs - General This is related to the General cog. Category: Core - Help This is related to our help command and/or HelpFormatter API. Category: Core - i18n This is related to the i18n core API or locale files. Category: Cogs - Image This is related to the Image cog. Category: Cogs - Mod This is related to the Mod cog. Category: Core - Modlog This is related to the core Modlog API. Category: Cogs - Modlog This is related to the Modlog cog. Category: Cogs - Mutes This is related to the Mutes cog. Category: Cogs - Permissions This is related to the Permissions cog. Category: Cogs - Reports This is related to the Reports cog. Category: Core - RPC/ZMQ Related to provided (provisional) API for implementing RPC in cogs Category: Cogs - Streams This is related to the Streams cog. labels Mar 15, 2021
@Jackenmen Jackenmen force-pushed the V3/linter_stuff branch 2 times, most recently from 4349da1 to 194c012 Compare March 22, 2022 17:45
@Jackenmen Jackenmen force-pushed the V3/linter_stuff branch 2 times, most recently from c0220c4 to 1d38466 Compare September 13, 2022 02:35
@Flame442 Flame442 modified the milestones: 3.5.0, 3.5.1 Apr 13, 2023
@Jackenmen Jackenmen modified the milestones: 3.5.6, 3.5.7 Mar 18, 2024
@Jackenmen Jackenmen modified the milestones: 3.5.9, 3.5.10 Apr 20, 2024
@Jackenmen Jackenmen modified the milestones: 3.5.14, 3.5.x Dec 24, 2024
@Jackenmen Jackenmen removed the Blocked By: Other PR Blocked by another PR. label Mar 22, 2025
@github-actions github-actions bot added the Category: Docs - Other This is related to documentation that doesn't have its dedicated label. label Mar 22, 2025
@Jackenmen Jackenmen added the Blocked By: Other PR Blocked by another PR. label Mar 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Blocked By: Other PR Blocked by another PR. Category: CI This is related to repository's CI configuration. Category: Docs - Other This is related to documentation that doesn't have its dedicated label. Category: Meta This is related to the repository maintenance. Type: Bug Unexpected behavior, result, or exception. In case of PRs, it is a fix for the foregoing. Type: Enhancement Something meant to enhance existing Red features.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add Problem Matchers to our GitHub Actions workflows Add iSort linting

3 participants