igorsimb / mp-monitor

Django app for scraping Wildberries
1 stars 0 forks source link

improvement(pre-commit): add and run pre-commit #81

Closed igorsimb closed 6 months ago

igorsimb commented 6 months ago

It changes quite a lot of formatting throughout the project.

Summary by CodeRabbit

coderabbitai[bot] commented 6 months ago
Walkthrough ## Walkthrough The recent updates encompass a wide range of improvements across the project, focusing on code readability, consistency, and maintenance. Key changes include updating string literals to use double quotes, reformatting code for better readability, enhancing logging messages, and refining function signatures. Additionally, there's an emphasis on refining the admin interface, updating models and forms, and improving test readability. The introduction of new dependencies in `requirements.txt` suggests enhancements in pre-commit checks, code formatting, and testing capabilities. ## Changes | File Pattern | Change Summary | |---------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `.accounts/admin.py` | Updated string literals to double quotes; Unregistered `EmailAddress`. | | `.accounts/apps.py`, `manage.py`, `mp_monitor/__init__.py`, `mp_monitor/asgi.py`, `mp_monitor/wsgi.py` | Updated string literals to double quotes. | | `.accounts/forms.py` | Included `"password"` in `CustomUserChangeForm` fields. | | `.accounts/models.py` | Reformatted `CustomUser` class's `tenant` field. | | `.commands.md` | Added commands for `pytest-xdist`, `pre-commit`, and `ruff format`. | | `.main/admin.py` | Switched to `@admin.register` decorators for `ItemAdmin` and `PriceAdmin`; Removed `admin.site.register` calls. | | `.main/forms.py` | Removed `ValidationError` import. | | `.main/models.py`, `.main/tasks.py`, `.main/urls.py`, `.main/utils.py`, `.main/views.py` | Various improvements on readability, formatting, and logging. | | `mp_monitor/settings.py` | Removed `USE_L10N` setting. | | `requirements.txt` | Added packages: `cfgv`, `distlib`, `filelock`, `identify`, `nodeenv`, `pre-commit`, `PyYAML`, `ruff`, `virtualenv`. | | `tests/...` | Enhanced readability and formatting in tests for accounts, main forms, models, tasks, templates, urls, and utils. Consistent logging and improved clarity in test method names and error message checks. |

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips ### Chat There are 3 ways to chat with CodeRabbit: - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit-tests for this file.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit tests for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository from git and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit tests.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - The JSON schema for the configuration file is available [here](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json). - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json` ### CodeRabbit Discord Community Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback.