Research
Security News
Quasar RAT Disguised as an npm Package for Detecting Vulnerabilities in Ethereum Smart Contracts
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.
@0no-co/graphqlsp
Advanced tools
TypeScript LSP plugin that finds GraphQL documents in your code and provides hints and auto-generates types.
This is a TypeScript LSP Plugin that will recognise documents in your TypeScript code and help you out with hover-information, diagnostics and auto-complete.
Note that this plugin does not do syntax highlighting, for that you still need something like the VSCode/... plugin
npm install -D @0no-co/graphqlsp
Go to your tsconfig.json
and add
{
"compilerOptions": {
"plugins": [
{
"name": "@0no-co/graphqlsp",
"schema": "./schema.graphql"
}
]
}
}
now restart your TS-server and you should be good to go, ensure you are using the workspace version of TypeScript. In VSCode you can do so by clicking the bottom right when on a TypeScript file or adding a file like this.
If you are using VSCode ensure that your editor is using the Workspace Version of TypeScript this can be done by manually selecting it or adding a
.vscode/config.json
with the contents of
{ "typescript.tsdk": "node_modules/typescript/lib", "typescript.enablePromptUseWorkspaceTsdk": true }
Required
schema
allows you to specify a url, .json
or .graphql
file as your schema. If you need to specify headers for your introspection
you can opt into the object notation i.e. { "schema": { "url": "x", "headers": { "Authorization": "y" } }}
Optional
template
add an additional template to the defaults gql
and graphql
templateIsCallExpression
this tells our client that you are using graphql('doc')
(default: true)
when using false
it will look for tagged template literalsshouldCheckForColocatedFragments
when turned on, this will scan your imports to find
unused fragments and provide a message notifying you about them (only works with call-expressions, default: true)trackFieldUsage
this only works with the client-preset, when turned on it will warn you about
unused fields within the same file. (only works with call-expressions, default: true)tadaOutputLocation
when using gql.tada
this can be convenient as it automatically generates
an introspection.ts
file for you, just give it the directory to output to and you're doneCurrently the tracking unused fields feature has a few caveats with regards to tracking, first and foremost it will only track the result and the accessed properties in the same file to encourage fragment co-location.
Secondly, we don't track mutations/subscriptions as some folks will add additional fields to properly support normalised cache updates.
When we use a useQuery
that supports TypedDocumentNode
it will automatically pick up the typings
from the query
you provide it. However for fragments this could become a bit more troublesome, the
minimal way of providing typings for a fragment would be the following:
import { TypedDocumentNode } from '@graphql-typed-document-node/core';
export const PokemonFields = gql`
fragment pokemonFields on Pokemon {
id
name
}
` as typeof import('./Pokemon.generated').PokemonFieldsFragmentDoc;
export const Pokemon = props => {
const pokemon = useFragment(props.pokemon, PokemonFields);
};
export function useFragment<Type>(
data: any,
_fragment: TypedDocumentNode<Type>
): Type {
return data;
}
This is mainly needed in cases where this isn't supported out of the box and mainly serves as a way for you to case your types.
Run pnpm i
at the root. Open packages/example
by running code packages/example
or if you want to leverage
breakpoints do it with the TSS_DEBUG_BRK=9559
prefix. When you make changes in packages/graphqlsp
all you need
to do is run pnpm i
in your other editor and restart the TypeScript server
for the changes to apply.
Ensure that both instances of your editor are using the Workspace Version of TypeScript
FAQs
TypeScript LSP plugin that finds GraphQL documents in your code and provides hints and auto-generates types.
We found that @0no-co/graphqlsp demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.
Security News
Research
A supply chain attack on Rspack's npm packages injected cryptomining malware, potentially impacting thousands of developers.
Research
Security News
Socket researchers discovered a malware campaign on npm delivering the Skuld infostealer via typosquatted packages, exposing sensitive data.