Benface/Nextra #319

benface · 2023-03-16T22:18:45Z

Some proposed changes to accompany my review of #301...

github-actions · 2023-03-16T22:22:02Z

📦 Next.js Bundle Analysis

This analysis was generated by the next.js bundle analysis action 🤖

⚠️ Global Bundle Size Increased

Page	Size (compressed)
`global`	`1.39 MB` (🟡 +16 B)

Details

The global bundle is the javascript bundle that loads alongside every page. It is in its own category because its impact is much higher - an increase to its size means that every page on your website loads slower, and a decrease means every page loads faster.

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

If you want further insight into what is behind the changes, give @next/bundle-analyzer a try!

One Page Changed Size

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

Page	Size (compressed)	First Load	% of Budget (`350 KB`)
`/[locale]`	`2.08 KB`	1.39 MB	406.22% (+/- <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.

saihaj · 2023-03-17T01:56:02Z

@benface if you can rebase from nextra branch and just have your change commits cause right now the diff is noise cause of the changes from main which were not synced yet

… `.env`)

benface · 2023-03-17T02:03:39Z

@saihaj – I had intentionally merged main into my branch, but I guess that's problematic, especially with squashing commits. I just did like you said. Better now?

saihaj · 2023-03-17T02:04:50Z

@saihaj – I had intentionally merged main into my branch, but I guess that's problematic, especially with squashing commits. I just did like you said. Better now?

yeah now we can easily go through commits!

dimaMachina · 2023-03-17T02:05:50Z

website/components/EditPageLink.tsx

-      href={`https://github.com/graphprotocol/docs/blob/main/pages/${pagePath}`}
+      href={`https://github.com/graphprotocol/docs/blob/main/website/${pagePath}`}


nice catch for edit on github, forget to test it

saihaj · 2023-03-17T02:06:18Z

website/tsconfig.json

-  "compilerOptions": {
-    "baseUrl": ".",
-    "paths": {
-      "@/*": ["*"]


I think this was nice :)

I agree, if you find a way to make it pass pnpm lint, let's put it back!

dimaMachina · 2023-03-17T02:06:24Z

website/next.config.mjs

-import { getNavItems } from '@/navigation'
+import { getNavItems } from '${'../'.repeat(routeSegments.length - 1)}navigation'


why did you remove @ alias in tsconfig? seems it worked well?

It didn't! Try running pnpm lint in your branch.

I think ESlint config has a way to pick aliases 🤔

Oh yeah Prettier fails which prevents tsc from even running... try pnpm lint:fix

We should probably replace the &&s with ; so each command runs regardless of the result of the previous one.

to fix you can replace the below in package.json

-"typecheck": "tsc --noEmit", +"typecheck": "pnpm --filter @graphprotocol/docs typecheck",

Ohhh, thank you @B2o5T! Done in a0717fa, and then I reverted removing the alias in e8baaf6.

By the way, there are still 4 ESLint warnings:

Those are weird, I don't really understand why TypeScript thinks they are any.

I will take a look tomorrow!

This reverts commit 7a9ad6e.

dimaMachina · 2023-03-17T20:02:10Z

package.json

+    "lint": "eslint . --ext .js,.jsx,.ts,.tsx,.mjs; pnpm prettier:check; pnpm typecheck",
+    "lint:fix": "eslint . --fix --ext .js,.jsx,.ts,.tsx,.mjs; pnpm prettier; pnpm typecheck",


@benface we should use && instead, otherwise, it's not fails if some command fails, e.g. eslint --max-warnings 0

Ah yeah, oops. I guess I just find it annoying that if e.g. Prettier fails, the TS errors are not even shown. Maybe Prettier should be last?

yes, I guess the following commands typecheck -> eslint -> prettier will be better

Co-authored-by: Dimitri POSTOLOV <[email protected]>

benface requested a review from a team as a code owner March 16, 2023 22:18

benface mentioned this pull request Mar 16, 2023

The Graph Docs x Nextra #301

Merged

benface added 7 commits March 16, 2023 21:59

Run pnpm lint in PR CI/CD

1c18407

Fix Prettier check

977689d

Fix lint by getting rid of alias imports

7a9ad6e

Fix search by moving .env to website package

6dcfd41

Fix “Edit page” link as pagePath now includes pages/

66271c0

Shouldn’t need to repeat default value of SITE_URL (it’s already in…

ee25bef

… `.env`)

Don’t use inset for better Safari support (unrelated to Nextra)

8c22460

benface force-pushed the benface/nextra branch from 9b2a4ad to 8c22460 Compare March 17, 2023 02:01

dimaMachina reviewed Mar 17, 2023

View reviewed changes

saihaj reviewed Mar 17, 2023

View reviewed changes

dimaMachina reviewed Mar 17, 2023

View reviewed changes

dimaMachina approved these changes Mar 17, 2023

View reviewed changes

saihaj approved these changes Mar 17, 2023

View reviewed changes

saihaj mentioned this pull request Mar 17, 2023

bring back path aliases #320

Closed

benface added 2 commits March 16, 2023 22:18

Update lint, lint:fix, and typecheck scripts

a0717fa

Revert "Fix lint by getting rid of alias imports"

e8baaf6

This reverts commit 7a9ad6e.

dimaMachina reviewed Mar 17, 2023

View reviewed changes

fix eslint warnings

82c66e5

dimaMachina merged commit 3c9d8cc into nextra Mar 17, 2023

dimaMachina deleted the benface/nextra branch March 17, 2023 20:40

dimaMachina added a commit that referenced this pull request Mar 17, 2023

Benface/Nextra (#319)

b165011

Co-authored-by: Dimitri POSTOLOV <[email protected]>

dimaMachina mentioned this pull request Mar 28, 2023

use Nextra's _meta.js for declaring sidebar titles and order #314

Merged

2 tasks

		href={`https://github.com/graphprotocol/docs/blob/main/pages/${pagePath}`}
		href={`https://github.com/graphprotocol/docs/blob/main/website/${pagePath}`}

		import { getNavItems } from '@/navigation'
		import { getNavItems } from '${'../'.repeat(routeSegments.length - 1)}navigation'

		"lint": "eslint . --ext .js,.jsx,.ts,.tsx,.mjs; pnpm prettier:check; pnpm typecheck",
		"lint:fix": "eslint . --fix --ext .js,.jsx,.ts,.tsx,.mjs; pnpm prettier; pnpm typecheck",

Benface/Nextra #319

Benface/Nextra #319

Uh oh!

Conversation

benface commented Mar 16, 2023

Uh oh!

github-actions bot commented Mar 16, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📦 Next.js Bundle Analysis

⚠️ Global Bundle Size Increased

One Page Changed Size

Uh oh!

saihaj commented Mar 17, 2023

Uh oh!

benface commented Mar 17, 2023

Uh oh!

saihaj commented Mar 17, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

github-actions bot commented Mar 16, 2023 •

edited

Loading