tj-pre-commit / graphene-django-precommit-hook

Pre-commit hook for graphene-django schema generator

graphene-django-precommit-hook

pre-commit hook to generate your graphql schema for graphene-django.

As a pre-commit hook

See pre-commit for instructions

Sample basic .pre-commit-config.yaml

-   repo: https://github.com/tj-pre-commit/graphene-django-precommit-hook
    rev: v2.0.0
    hooks:
      - id: graphene-django-hook
        stages: [commit]

Sample complex .pre-commit-config.yaml

-   repo: https://github.com/tj-pre-commit/graphene-django-precommit-hook
    rev: v2.0.0
    hooks:
      - id: graphene-django-hook
        stages: [commit]
        args: [
          '--settings',
          'project.settings'. # Defaults to: DJANGO_SETTINGS_MODULE
          '--indent',
          '4' # See https://docs.graphene-python.org/projects/django/en/latest/introspection/
          '--out',
          'path/to/schema.graphql',
          '--schema',
          'module.path.to.schema',
          '--verbosity', # OR '-v'
          '2', # Set the verbosity level {0,1,2,3}
        ]