aerogear/create-graphql

Refactor to support plugin like babel

Open

#59 opened on Feb 6, 2017

View on GitHub
 (9 comments) (1 reaction) (0 assignees)JavaScript (440 stars) (51 forks)batch import
enhancementhelp wantednew feature

Description

Babel plugin object example:

type PluginObject = {
  pre?: Function;
  post?: Function;
  manipulateOptions?: Function;

  visitor: ?{
    [key: string]: Function | {
      enter?: Function | Array<Function>;
      exit?: Function | Array<Function>;
    }
  };
};

each babel plugin returns an object like this.

we should think in CreateGraphQL PluginObject as well.

  • Separate mongoose schema to a plugin;
  • Separate relay templates to a plugin (figure out how to best do this);
  • Create boilerplate projects for Create-GraphQL plugins;
  • Handle plugins property on .graphqlrc.

Contributor guide

Tech stack
javascriptgraphqlnodejs
Domain
cliapibackend
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
over 1 week
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Familiarity with GraphQLJavaScript/Node.js experienceUnderstanding of plugin architecture
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35
Research direction
Examine the existing codebase in /src to understand current architecture. Review the babel plugin pattern as a reference. The issue's checklist outlines separate tasks: separating mongoose schema, relay templates, creating boilerplate projects, and handling plugins property in .graphqlrc. Look at linked issues or comments for any prior design discussions.