Merge pull request #3077 from pydanny/fix/linting-gh-actions

Author: browniebroke

requirements.txt

@@ -8,6 +8,7 @@ black==20.8b1
 isort==5.8.0
 flake8==3.9.0
 flake8-isort==4.0.0
+pre-commit==2.10.1
 
 # Testing
 # ------------------------------------------------------------------------------

tests/test_bare.sh

@@ -27,5 +27,11 @@ sudo utility/install_os_dependencies.sh install
 # Install Python deps
 pip install -r requirements/local.txt
 
+# Lint by running pre-commit on all files
+# Needs a git repo to find the project root
+git init
+git add .
+pre-commit run --show-diff-on-failure -a
+
 # run the project's tests
 pytest

tests/test_docker.sh

@@ -17,12 +17,16 @@ cd .cache/docker
 cookiecutter ../../ --no-input --overwrite-if-exists use_docker=y $@
 cd my_awesome_project
 
+# Lint by running pre-commit on all files
+# Needs a git repo to find the project root
+# We don't have git inside Docker, so run it outside
+git init
+git add .
+pre-commit run --show-diff-on-failure -a
+
 # run the project's type checks
 docker-compose -f local.yml run django mypy my_awesome_project
 
-# Run black with --check option
-docker-compose -f local.yml run django black --check --diff  --exclude 'migrations' ./
-
 # run the project's tests
 docker-compose -f local.yml run django pytest
 

{{cookiecutter.project_slug}}/.envs/.local/.django

@@ -14,4 +14,4 @@ REDIS_URL=redis://redis:6379/0
 # Flower
 CELERY_FLOWER_USER=!!!SET CELERY_FLOWER_USER!!!
 CELERY_FLOWER_PASSWORD=!!!SET CELERY_FLOWER_PASSWORD!!!
-{% endif %}
+{%- endif %}

{{cookiecutter.project_slug}}/.pre-commit-config.yaml

@@ -26,4 +26,3 @@ repos:
       - id: flake8
         args: ['--config=setup.cfg']
         additional_dependencies: [flake8-isort]
-

{{cookiecutter.project_slug}}/.pylintrc

@@ -1,5 +1,5 @@
 [MASTER]
-load-plugins=pylint_django{% if cookiecutter.use_celery == "y" %}, pylint_celery {% endif %}
+load-plugins=pylint_django{% if cookiecutter.use_celery == "y" %}, pylint_celery{% endif %}
 
 [FORMAT]
 max-line-length=120

{{cookiecutter.project_slug}}/LICENSE

@@ -7,7 +7,7 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-{% elif cookiecutter.open_source_license == 'BSD' %}
+{%- elif cookiecutter.open_source_license == 'BSD' %}
 Copyright (c) {% now 'utc', '%Y' %}, {{ cookiecutter.author_name }}
 All rights reserved.
 
@@ -35,7 +35,7 @@ DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
 OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 OF THE POSSIBILITY OF SUCH DAMAGE.
-{% elif cookiecutter.open_source_license == 'GPLv3' %}
+{%- elif cookiecutter.open_source_license == 'GPLv3' %}
 Copyright (c) {% now 'utc', '%Y' %}, {{ cookiecutter.author_name }}
 
 This program is free software: you can redistribute it and/or modify
@@ -50,7 +50,7 @@ GNU General Public License for more details.
 
 You should have received a copy of the GNU General Public License
 along with this program. If not, see <http://www.gnu.org/licenses/>.
-{% elif cookiecutter.open_source_license == 'Apache Software License 2.0' %}
+{%- elif cookiecutter.open_source_license == 'Apache Software License 2.0' %}
 
                                  Apache License
                            Version 2.0, January 2004
@@ -242,4 +242,4 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
-{% endif %}
+{%- endif %}

{{cookiecutter.project_slug}}/Procfile

@@ -1,10 +1,10 @@
 release: python manage.py migrate
-{% if cookiecutter.use_async == "y" -%}
+{%- if cookiecutter.use_async == "y" -%}
 web: gunicorn config.asgi:application -k uvicorn.workers.UvicornWorker
 {%- else  %}
 web: gunicorn config.wsgi:application
 {%- endif %}
-{% if cookiecutter.use_celery == "y" -%}
+{%- if cookiecutter.use_celery == "y" -%}
 worker: celery worker --app=config.celery_app --loglevel=info
 beat: celery beat --app=config.celery_app --loglevel=info
 {%- endif %}

{{cookiecutter.project_slug}}/README.rst

@@ -9,10 +9,10 @@
 .. image:: https://img.shields.io/badge/code%20style-black-000000.svg
      :target: https://github.com/ambv/black
      :alt: Black code style
-{% if cookiecutter.open_source_license != "Not open source" %}
+{%- if cookiecutter.open_source_license != "Not open source" %}
 
 :License: {{cookiecutter.open_source_license}}
-{% endif %}
+{%- endif %}
 
 Settings
 --------
@@ -67,7 +67,7 @@ Moved to `Live reloading and SASS compilation`_.
 
 .. _`Live reloading and SASS compilation`: http://cookiecutter-django.readthedocs.io/en/latest/live-reloading-and-sass-compilation.html
 
-{% if cookiecutter.use_celery == "y" %}
+{%- if cookiecutter.use_celery == "y" %}
 
 Celery
 ^^^^^^
@@ -83,19 +83,21 @@ To run a celery worker:
 
 Please note: For Celery's import magic to work, it is important *where* the celery commands are run. If you are in the same folder with *manage.py*, you should be right.
 
-{% endif %}
-{% if cookiecutter.use_mailhog == "y" %}
+{%- endif %}
+{%- if cookiecutter.use_mailhog == "y" %}
 
 Email Server
 ^^^^^^^^^^^^
-{% if cookiecutter.use_docker == 'y' %}
+{%- if cookiecutter.use_docker == 'y' %}
+
 In development, it is often nice to be able to see emails that are being sent from your application. For that reason local SMTP server `MailHog`_ with a web interface is available as docker container.
 
 Container mailhog will start automatically when you will run all docker containers.
 Please check `cookiecutter-django Docker documentation`_ for more details how to start all containers.
 
 With MailHog running, to view messages that are sent by your application, open your browser and go to ``http://127.0.0.1:8025``
-{% else %}
+{%- else %}
+
 In development, it is often nice to be able to see emails that are being sent from your application. If you choose to use `MailHog`_ when generating the project a local SMTP server with a web interface will be available.
 
 #. `Download the latest MailHog release`_ for your OS.
@@ -117,10 +119,10 @@ In development, it is often nice to be able to see emails that are being sent fr
 Now you have your own mail server running locally, ready to receive whatever you send it.
 
 .. _`Download the latest MailHog release`: https://github.com/mailhog/MailHog/releases
-{% endif %}
+{%- endif %}
 .. _mailhog: https://github.com/mailhog/MailHog
-{% endif %}
-{% if cookiecutter.use_sentry == "y" %}
+{%- endif %}
+{%- if cookiecutter.use_sentry == "y" %}
 
 Sentry
 ^^^^^^
@@ -129,32 +131,31 @@ Sentry is an error logging aggregator service. You can sign up for a free accoun
 The system is setup with reasonable defaults, including 404 logging and integration with the WSGI application.
 
 You must set the DSN url in production.
-{% endif %}
+{%- endif %}
 
 Deployment
 ----------
 
 The following details how to deploy this application.
-{% if cookiecutter.use_heroku.lower() == "y" %}
+{%- if cookiecutter.use_heroku.lower() == "y" %}
 
 Heroku
 ^^^^^^
 
 See detailed `cookiecutter-django Heroku documentation`_.
 
 .. _`cookiecutter-django Heroku documentation`: http://cookiecutter-django.readthedocs.io/en/latest/deployment-on-heroku.html
-{% endif %}
-{% if cookiecutter.use_docker.lower() == "y" %}
+{%- endif %}
+{%- if cookiecutter.use_docker.lower() == "y" %}
 
 Docker
 ^^^^^^
 
 See detailed `cookiecutter-django Docker documentation`_.
 
 .. _`cookiecutter-django Docker documentation`: http://cookiecutter-django.readthedocs.io/en/latest/deployment-with-docker.html
-{% endif %}
-
-{% if cookiecutter.custom_bootstrap_compilation == "y" %}
+{%- endif %}
+{%- if cookiecutter.custom_bootstrap_compilation == "y" %}
 Custom Bootstrap Compilation
 ^^^^^^
 
@@ -163,11 +164,11 @@ Bootstrap v4 is installed using npm and customised by tweaking your variables in
 
 You can find a list of available variables `in the bootstrap source`_, or get explanations on them in the `Bootstrap docs`_.
 
-{% if cookiecutter.js_task_runner == 'Gulp' %}
+{%- if cookiecutter.js_task_runner == 'Gulp' %}
 Bootstrap's javascript as well as its dependencies is concatenated into a single file: ``static/js/vendors.js``.
-{% endif %}
+{%- endif %}
 
 .. _in the bootstrap source: https://github.com/twbs/bootstrap/blob/v4-dev/scss/_variables.scss
 .. _Bootstrap docs: https://getbootstrap.com/docs/4.1/getting-started/theming/
 
-{% endif %}
+{%- endif %}

{{cookiecutter.project_slug}}/compose/local/django/start

@@ -10,4 +10,4 @@ python manage.py migrate
 uvicorn config.asgi:application --host 0.0.0.0 --reload
 {%- else %}
 python manage.py runserver_plus 0.0.0.0:8000
-{% endif %}
+{%- endif %}