Skip to content

Commit 94d7450

Browse files
chore: Enable Alex documentation linting for error pages (#26526)
1 parent ccf189f commit 94d7450

9 files changed

+19
-8
lines changed

.alexignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
11
CODE_OF_CONDUCT.md
22
docs/
3-
errors/
43
examples/

.alexrc

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"allow": [
3+
"dead",
4+
"executed",
5+
"executes",
6+
"failed",
7+
"failure",
8+
"hook",
9+
"host-hostess",
10+
"invalid"
11+
]
12+
}

errors/api-routes-static-export.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
An `exportPathMap` path was matched to an API route. Statically exporting a Next.js application via `next export` disables API routes.
66

7-
This command is meant for static-only hosts, and is not necessary to make your application static. Pages in your application without server-side data dependencies will be automatically statically exported by `next build`, including pages powered by `getStaticProps`
7+
This command is meant for a static-only setup, and is not necessary to make your application static. Pages in your application without server-side data dependencies will be automatically statically exported by `next build`, including pages powered by `getStaticProps`
88

99
#### Possible Ways to Fix It
1010

errors/can-not-output-to-public.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
Either you set `distDir` to `public` in your `next.config.js` or during `next export` you tried to export to the `public` directory.
66

7-
This is not allowed due to `public` being a special folder in Next.js used to serve static assets.
7+
This is not allowed because `public` is used by Next.js to serve static assets.
88

99
#### Possible Ways to Fix It
1010

errors/can-not-output-to-static.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
Either you set `distDir` to `static` in your `next.config.js` or during `next export` you tried to export to the `static` directory.
66

7-
This is not allowed due to `static` being a special folder in Next.js used to serve static assets.
7+
This is not allowed because `static` is used by Next.js to serve static assets.
88

99
#### Possible Ways to Fix It
1010

errors/future-webpack5-moved-to-webpack5.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The `future.webpack5` option has been moved to `webpack5` in `next.config.js`.
88

99
If you had the value `true` you can remove the option as webpack 5 is now the default for all Next.js apps unless opted out.
1010

11-
If you had he value `false` you can update `next.config.js`:
11+
If you had the value `false` you can update `next.config.js`:
1212

1313
Change `future.webpack5` to `webpack5`.
1414

errors/next-start-serverless.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ Next.js can only handle running a server when the `target` is set to `server` (t
66

77
#### Possible Ways to Fix It
88

9-
Use a different handler than `next start` when testing a serverless **production** build, otherwise just use `next dev`.
9+
Use a different handler than `next start` when testing a serverless **production** build, otherwise use `next dev`.

errors/prefetch-true-deprecated.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,4 @@ These requests have low-priority and yield to fetch() or XHR requests. Next.js w
1818

1919
The prefetch attribute is no longer needed, when set to true, example: `prefetch={true}`, remove the property.
2020

21-
Prefetching can be disabled with `prefetch={false}`.
21+
Prefetching can be turned off with `prefetch={false}`.

errors/static-dir-deprecated.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The reason we want to support a `public` directory instead is to not require the
88

99
#### Possible Ways to Fix It
1010

11-
You can move your `static` directory inside of the `public` directory and all URLs will remain the same as they were before.
11+
You can move your `static` directory inside of the `public` directory and all URLs will stay the same as they were before.
1212

1313
**Before**
1414

0 commit comments

Comments
 (0)