2017 © Pedro Peláez
 

silverstripe-vendormodule silverstripe-phpstorm-graphql

Helper to allow PHPStorm GraphQL lookups

image

twohill/silverstripe-phpstorm-graphql

Helper to allow PHPStorm GraphQL lookups

  • Thursday, April 26, 2018
  • by twohill
  • Repository
  • 1 Watchers
  • 1 Stars
  • 0 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 0 Forks
  • 0 Open issues
  • 1 Versions
  • 0 % Grown

The README.md

SilverStripe-PhpStorm-GraphQL helper

This module allows you to use JS GraphQL within your SilverStripe project., (*1)

It does this by providing another authenticator that lets JS GraphQL query the schema without logging in. There might be a better way of going about this - I'm all ears!, (*2)

To provide some sort of security, by default we restrict to queries from localhost, with the user-agent "JS GraphQL", and only in dev mode., (*3)

Requirements

  • silverstripe-graphql
  • PhpStorm
  • JS GraphQL

Installation

Install the JS GraphQL plugin Install this helper, (*4)

composer require twohill/silverstripe-phpstorm-graphql

Create a graphql.config.json with the following details (update the URL as required), (*5)

{
  "schema": {
    "request": {
      "url": "http://localhost/graphql",
      "method": "POST",
      "postIntrospectionQuery": true,
      "options": {
        "headers": {
          "user-agent": "JS GraphQL",
          "Origin": "localhost"
        }
      }
    }
  },
  "endpoints": [
    {
      "name": "Default (http://localhost/graphql)",
      "url": "http://localhost/graphql",
      "options": {
        "headers": {
          "user-agent": "JS GraphQL",
          "Origin": "localhost"
        }
      }
    }
  ]
}

Edit some GraphQL and see some lovely schema completion :), (*6)

License

See License, (*7)

Example configuration (optional)

If you want to override any of the security settings you can do so via yaml., (*8)


Twohill\PhpStormGraphQL\PhpStormDevAuthenticator: allowed_ips: - '127.0.0.1' allowed_useragent: 'JS GraphQL' allowed_environment: 'dev'

Maintainers

Bugtracker

Bugs are tracked in the issues section of this repository. Before submitting an issue please read over existing issues to ensure yours is unique., (*9)

If the issue does look like a new bug:, (*10)

  • Create a new issue
  • Describe the steps required to reproduce your issue, and the expected outcome. Unit tests, screenshots and screencasts can help here.
  • Describe your environment as detailed as possible: SilverStripe version, Browser, PHP version, Operating System, any installed SilverStripe modules.

Please report security issues to the module maintainers directly. Please don't file security issues in the bugtracker., (*11)

Development and contribution

If you would like to make contributions to the module please ensure you raise a pull request and discuss with the module maintainers., (*12)

The Versions

26/04 2018

dev-master

9999999-dev https://github.com/twohill/silverstripe-phpstorm-graphql

Helper to allow PHPStorm GraphQL lookups

  Sources   Download

BSD-3-Clause

The Requires

 

by Al Twohill

silverstripe phpstorm graphql