10000 upgrate documentation website to next 14 (#1975) · immutable-js/immutable-js@b118ffb · GitHub
[go: up one dir, main page]
Skip to content

Commit b118ffb

Browse files
jdeniaujdeniau
authored
upgrate documentation website to next 14 (#1975)
* upgrate to next 12 * next 13 * migrate links * next 14 * deactivate eslint for documentation once again * Fix title warning. See vercel/next.js#38256
1 parent 7f9ba58 commit b118ffb

File tree

11 files changed

+676
-3726
lines changed

11 files changed

+676
-3726
lines changed

‎package-lock.json

Lines changed: 633 additions & 3682 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@
7373
"build:prepare": "./resources/prepare-dist.sh",
7474
"build:stats": "node ./resources/dist-stats.mjs",
7575
"unit-test": "jest",
76-
"website:build": "cd website && next build && next-sitemap && next export",
76+
"website:build": "cd website && next build && next-sitemap",
7777
"website:dev": "cd website && next dev",
7878
"check-git-clean": "./resources/check-git-clean.sh",
7979
"benchmark": "node ./resources/benchmark.js",
@@ -94,7 +94,7 @@
9494
"dtslint": "^4.2.1",
9595
"eslint": "^8.56.0",
9696
"eslint-config-airbnb": "^19.0.4",
97-
"eslint-config-next": "^14.0.0",
97+
"eslint-config-next": "^14.1.0",
9898
"eslint-config-prettier": "^9.1.0",
9999
"eslint-plugin-import": "^2.29.1",
100100
"eslint-plugin-jsx-a11y": "^6.8.0",
@@ -107,12 +107,12 @@
107107
"make-synchronous": "0.1.1",
108108
"marked": "2.1.2",
109109
"microtime": "3.0.0",
110-
"next": "11.0.1",
110+
"next": "^14.1.0",
111111
"next-sitemap": "1.6.124",
112112
"npm-run-all": "4.1.5",
113113
"prettier": "2.3.2",
114-
"react": "17.0.2",
115-
"react-dom": "17.0.2",
114+
"react": "^18.2.0",
115+
"react-dom": "^18.2.0",
116116
"rimraf": "2.7.1",
117117
"rollup": "2.52.3",
118118
"rollup-plugin-buble": "0.19.8",

‎website/next-env.d.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
/// <reference types="next" />
2-
/// <reference types="next/types/global" />
32
/// <reference types="next/image-types/global" />
3+
4+
// NOTE: This file should not be edited
5+
// see https://nextjs.org/docs/basic-features/typescript for more information.

‎website/next.config.js

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
module.exports = {
22
reactStrictMode: true,
33
trailingSlash: true,
4+
output: 'export',
45

5-
// as next eslint config does not work with eslint 8.
6-
// TODO Waiting for nextjs upgrade to reactive this
6+
// Issues while upgrading from next 11 to 12.
7+
// Possibly related to typescript parser missing ?
8+
// TODO Waiting the migration from tslint to eslint to reactivate this
79
eslint: {
810
ignoreDuringBuilds: true,
911
},

‎website/src/Defs.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -214,8 +214,8 @@ export function TypeDef({ type, prefix }: { type: Type; prefix?: number }) {
214214
'type',
215215
<>
216216
{type.url ? (
217-
<Link href={type.url}>
218-
<a className="t typeName">{type.name}</a>
217+
<Link href={type.url} className="t typeName">
218+
{type.name}
219219
</Link>
220220
) : (
221221
<span className="t typeName">{type.name}</span>

‎website/src/Header.tsx

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -88,13 +88,11 @@ export function Header({
8888

8989
export function HeaderLogoLink() {
9090
return (
91-
<Link href="/">
92-
<a className="miniLogo">
93-
<SVGSet>
94-
<Logo color="#FC4349" />
95-
<Logo color="#2C3E50" inline />
96-
</SVGSet>
97-
</a>
91+
<Link href="/" className="miniLogo">
92+
<SVGSet>
93+
<Logo color="#FC4349" />
94+
<Logo color="#2C3E50" inline />
95+
</SVGSet>
9896
</Link>
9997
);
10098
}
@@ -166,7 +164,7 @@ function DocsDropdown({
166164
`}</style>
167165
<div>
168166
<Link href={`/docs/${currentVersion || versions[0]}`}>
169-
<a>Docs{currentVersion && ` (${currentVersion})`}</a>
167+
Docs{currentVersion && ` (${currentVersion})`}
170168
</Link>
171169
</div>
172170
<ul>

‎website/src/MemberDoc.tsx

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,7 @@ export function MemberDoc({ member }: { member: MemberDefinition }) {
3636
<h4 className="infoHeader">Inherited from</h4>
3737
<code>
3838
<Link href={member.inherited.url}>
39-
<a>
40-
{member.inherited.interface}#{member.inherited.label}
41-
</a>
39+
{member.inherited.interface}#{member.inherited.label}
4240
</Link>
4341
</code>
4442
</section>
@@ -48,9 +46,7 @@ export function MemberDoc({ member }: { member: MemberDefinition }) {
4846
<h4 className="infoHeader">Overrides</h4>
4947
<code>
5048
<Link href={member.overrides.url}>
51-
<a>
52-
{member.overrides.interface}#{member.overrides.label}
53-
</a>
49+
{member.overrides.interface}#{member.overrides.label}
5450
</Link>
5551
</code>
5652
</section>

‎website/src/Sidebar.tsx

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -40,24 +40,24 @@ function Links({
4040
isActive ? 'sideBar__Link--active' : ''
4141
}`}
4242
>
43-
<Link href={link.url}>
43+
<Link
44+
href={link.url}
45+
onClick={e => {
46+
if (isCurrent) {
47+
e.preventDefault();
48+
setIsForcedClosed(!isForcedClosed);
49+
}
50+
}}
51+
>
4452
{/* eslint-disable-next-line jsx-a11y/click-events-have-key-events, jsx-a11y/anchor-is-valid */}
45-
<a
46-
onClick={e => {
47-
if (isCurrent) {
48-
e.preventDefault();
49-
setIsForcedClosed(!isForcedClosed);
50-
}
51-
}}
52-
>
53-
{link.label}
54-
{isActive && (focus?.interface || focus?.functions) && (
55-
<>
56-
{' '}
57-
<ArrowDown isActive={isActive} />
58-
</>
59-
)}
60-
</a>
53+
54+
{link.label}
55+
{isActive && (focus?.interface || focus?.functions) && (
56+
<>
57+
{' '}
58+
<ArrowDown isActive={isActive} />
59+
</>
60+
)}
6161
</Link>
6262
</div>
6363

‎website/src/pages/docs/[version]/[type].tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ export default function TypeDocPage({
6060
return (
6161
<div>
6262
<Head>
63-
<title>{def.qualifiedName} — Immutable.js</title>
63+
<title>{`${def.qualifiedName} — Immutable.js`}</title>
6464
<link rel="icon" type="image/png" href="/favicon.png" />
6565
</Head>
6666
<ImmutableConsole version={version} />

‎website/src/pages/docs/[version]/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ export default function OverviewDocPage({
6060
return (
6161
<div>
6262
<Head>
63-
<title>Documentation {version} — Immutable.js</title>
63+
<title>{`Documentation ${version} — Immutable.js`}</title>
6464
</Head>
6565
<ImmutableConsole version={version} />
6666
<DocHeader versions={versions} currentVersion={version} />

0 commit comments

Comments
 (0)
0