Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

RFC: Re-expose the GraphQLSP TS plugin at gql.tada/ts-plugin #75

Closed
kitten opened this issue Feb 24, 2024 · 1 comment · Fixed by #62
Closed

RFC: Re-expose the GraphQLSP TS plugin at gql.tada/ts-plugin #75

kitten opened this issue Feb 24, 2024 · 1 comment · Fixed by #62
Labels
future 🔮 An enhancement or feature proposal that will be addressed after the next release

Comments

@kitten
Copy link
Member

kitten commented Feb 24, 2024

Summary

Currently, the Installation steps of gql.tada include installing @0no-co/graphqlsp and the explanations for how gql.tada functions differentiates between the two packages.

It may be a small detail, but this often forces us to refer to this project as gql.tada, by its package name, in the documentation, and to the TS LSP plugin as @0no-co/graphqlsp, which hinders being able to describe how this project functions in short and succinct ways.

Instead, we'd love to be able to automatically instally @0no-co/graphqlsp and not expose users to having to understand the internal workings of this structure.

Proposed Solution

We'd like @0no-co/graphqlsp to be re-exported as gql.tada/lsp (or a similar import).
This would mean that, in the future, the tsconfig.json changes would look as follows:

{
  "compilerOptions": {
    "strict": true,
    "plugins": [
      {
        "name": "gql.tada/lsp",
        "schema": "./schema.graphql",
        "tadaOutputLocation": "./src/graphql-env.d.ts"
      }
    ]
  }
}

No additional packages would be installed as @0no-co/graphqlsp would become a dependency of gql.tada and would be automatically installed.

This previously wasn't possible as TypeScript would block sub-paths from loading as a TS plugin, but will be enabled once this commit is released: microsoft/TypeScript@ef091bf

Requirements

  • Re-export @0no-co/graphqlsp as gql.tada/lsp using the existing build pipeline
@kitten kitten added the future 🔮 An enhancement or feature proposal that will be addressed after the next release label Feb 24, 2024
@kitten
Copy link
Member Author

kitten commented Apr 26, 2024

With 5.5 being in beta this is now unblocked: microsoft/TypeScript@ef091bf

@kitten kitten changed the title RFC: Re-expose the GraphQLSP TS plugin at gql.tada/lsp RFC: Re-expose the GraphQLSP TS plugin at gql.tada/ts-plugin Apr 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
future 🔮 An enhancement or feature proposal that will be addressed after the next release
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant