Skip to content

API Proposal: Code Formatting, Prettier #1517

@acao

Description

@acao

Currently:

We aren't using prettier, instead a lightweight custom solution that has issues, and is not configurable.

Proposed

  • Use prettier for graphql, json, yaml, etc.
  • make it fully configurable by users
  • make it available via command palette, right click context menu, and key commands
  • allow formatting on paste, format range, etc
  • asynchronously imports prettier standalone/graphql parser (500kb minified!)
  • offload computationally expensive work to the webworker process, to increase scalability for large operations or variables.

RFC In Progress

A basic example of formatting graphql with monaco using key shortcuts, context menu and command palette

This PR implements all of the above using monaco and a new language service class: acao#17

It performs the prettier parsing and formatting entirely in the monaco language service webworker thread, and integrates cleanly with monaco's built in formatting provider capabilities. Thus why format on paste, etc is built in! hooray monaco

Todo

  • Document monaco-graphql formatting configuration API
  • allow a formattingConfiguration prop to pass to new monaco-graphql API
  • document how to use new GraphiQL editorConfig prop to enable formatOnPaste
  • expose API to programatically format operation (for an eventual button)

Originally, we were going to make this a plugin, however, the formatting is already so tightly integrated with monaco, and we asynchronously load prettier on the first format run so, it's not as daunting as it had seemed before. 500kb is a LOT to consider. prettier/standalone sounds small, but check it out on bundle phobia

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions