Skip to content

ensure graphql codeblocks in markdown doesn't contain syntax errors #357

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

Open
wants to merge 4 commits into
base: lint-code-blocks2
Choose a base branch
from

Conversation

dimaMachina
Copy link
Contributor

@dimaMachina dimaMachina commented Apr 26, 2023

fixes #349

@dimaMachina dimaMachina requested a review from a team as a code owner April 26, 2023 16:04
foos(first: 100, subgraphError: allow) {
id
}
{
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added { to make it query

```graphql
```text
Copy link
Contributor Author

@dimaMachina dimaMachina Apr 26, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added text to ignore syntax error reported by GraphQL-ESLint parser

Comment on lines +572 to +573
```text
Type IndexingRule {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure which language it's so I marked type with Type as in codeblock on line 632

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is assemblyscript?

```graphql
```text
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

to ignore syntax errors

```graphql
import { execute } from "your-favorite-graphql-client"
```ts
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

incorrect lang

@github-actions
Copy link

📦 Next.js Bundle Analysis for @graphprotocol/docs

This analysis was generated by the Next.js Bundle Analysis action. 🤖

Four Pages Changed Size

The following pages changed size from the code in this PR compared to its base branch:

Page Size (compressed) First Load % of Budget (350 KB)
/en/developing/creating-a-subgraph 24.78 KB 615.8 KB 175.94% (+/- <0.01%)
/en/network/indexing 20.67 KB 611.69 KB 174.77% (🟢 -0.01%)
/en/querying/querying-best-practices 9.77 KB 600.79 KB 171.66% (+/- <0.01%)
/en/release-notes/graphql-validations-migration-guide 9.1 KB 600.12 KB 171.46% (+/- <0.01%)
Details

Only the gzipped size is provided here based on an expert tip.

First Load is the size of the global bundle plus the bundle for the individual page. If a user were to show up to your website and land on a given page, the first load size represents the amount of javascript that user would need to download. If next/link is used, subsequent page loads would only need to download that page's bundle (the number in the "Size" column), since the global bundle has already been downloaded.

Any third party scripts you have added directly to your app using the <script> tag are not accounted for in this analysis

The "Budget %" column shows what percentage of your performance budget the First Load total takes up. For example, if your budget was 100kb, and a given page's first load size was 10kb, it would be 10% of your budget. You can also see how much this has increased or decreased compared to the base branch of your PR. If this percentage has increased by 20% or more, there will be a red status indicator applied, indicating that special attention should be given to this. If you see "+/- <0.01%" it means that there was a change in bundle size, but it is a trivial enough amount that it can be ignored.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants