Skip to content

Commit 2371801

Browse files
RulaKhaledRulaKhaled
committed
docs(react-router): Add note for Windows users to set env var
1 parent e82155a commit 2371801

File tree

3 files changed

+78
-41
lines changed

3 files changed

+78
-41
lines changed

‎docs/platforms/javascript/guides/react-router/index.mdx‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -308,6 +308,8 @@ export const handleError: HandleErrorFunction = (error, { request }) => {
308308
Since React Router is running in ESM mode, you need to use the `--import` command line options to load our server-side instrumentation module before the application starts.
309309
Update the `start` and `dev` script to include the instrumentation file:
310310

311+
<WindowsNodeEnvSetup nodeOption="--import ./instrument.server.mjs" />
312+
311313
```json {filename: package.json}
312314
"scripts": {
313315
"dev": "NODE_OPTIONS='--import ./instrument.server.mjs' react-router dev",

‎src/components/WindowsNodeEnvSetup.tsx‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
import { Alert } from './alert';
2+
import { CodeBlock } from './codeBlock';
3+
import { CodeTabs } from './codeTabs';
4+
5+
export function WindowsNodeEnvSetup({ nodeOption }: { nodeOption: string }) {
6+
return (
7+
<Alert>
8+
<p>
9+
If you're on Windows, set <code>NODE_OPTIONS</code> environment variable before
10+
running your app.
11+
</p>
12+
<CodeTabs>
13+
<CodeBlock language="cmd">
14+
<pre>
15+
<code>set NODE_OPTIONS={nodeOption}</code>
16+
</pre>
17+
</CodeBlock>
18+
<CodeBlock language="powershell">
19+
<pre>
20+
<code>$env:NODE_OPTIONS="{nodeOption}"</code>
21+
</pre>
22+
</CodeBlock>
23+
</CodeTabs>
24+
<p className="pt-3">
25+
Read more about{' '}
26+
<a href="https://learn.microsoft.com/en-us/windows/win32/procthread/environment-variables">
27+
environment variables
28+
</a>
29+
.
30+
</p>
31+
</Alert>
32+
);
33+
}

‎src/mdxComponents.ts‎

Lines changed: 43 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,49 @@
1-
import {Alert} from './components/alert';
2-
import {Arcade} from './components/arcade';
3-
import {Break} from './components/break';
4-
import {Card} from './components/card';
5-
import {CliChecksumTable} from './components/cliChecksumTable';
6-
import {CodeBlock} from './components/codeBlock';
7-
import {CodeTabs} from './components/codeTabs';
8-
import {CommunitySupportedPlatforms} from './components/communitySupportedPlatforms';
9-
import {ConfigKey} from './components/configKey';
10-
import {ConfigValue} from './components/configValue';
11-
import {CreateGitHubAppForm} from './components/createGitHubAppForm';
12-
import {DefinitionList} from './components/definitionList';
13-
import {DevDocsCardGrid} from './components/devDocsCardGrid';
1+
import { Alert } from './components/alert';
2+
import { Arcade } from './components/arcade';
3+
import { Break } from './components/break';
4+
import { Card } from './components/card';
5+
import { CliChecksumTable } from './components/cliChecksumTable';
6+
import { CodeBlock } from './components/codeBlock';
7+
import { CodeTabs } from './components/codeTabs';
8+
import { CommunitySupportedPlatforms } from './components/communitySupportedPlatforms';
9+
import { ConfigKey } from './components/configKey';
10+
import { ConfigValue } from './components/configValue';
11+
import { CreateGitHubAppForm } from './components/createGitHubAppForm';
12+
import { DefinitionList } from './components/definitionList';
13+
import { DevDocsCardGrid } from './components/devDocsCardGrid';
1414
import DocImage from './components/docImage';
15-
import {Expandable} from './components/expandable';
16-
import {GuideGrid} from './components/guideGrid';
17-
import {JsBundleList} from './components/jsBundleList';
18-
import {LambdaLayerDetail} from './components/lambdaLayerDetail';
19-
import {LinkWithPlatformIcon} from './components/linkWithPlatformIcon';
20-
import {OnboardingOption, OnboardingOptionButtons} from './components/onboarding';
21-
import {OrgAuthTokenNote} from './components/orgAuthTokenNote';
22-
import {PageGrid} from './components/pageGrid';
23-
import {ParamTable} from './components/paramTable';
24-
import {PiiFields} from './components/piiFields';
25-
import {PlatformCategorySection} from './components/platformCategorySection';
26-
import {PlatformFilter} from './components/platformFilter';
27-
import {PlatformGrid} from './components/platformGrid';
28-
import {PlatformIdentifier} from './components/platformIdentifier';
29-
import {PlatformLink} from './components/platformLink';
30-
import {PlatformLinkWithLogo} from './components/platformLinkWithLogo';
31-
import {PlatformOrGuideName} from './components/platformOrGuideName';
32-
import {PlatformSdkPackageName} from './components/platformSdkPackageName';
33-
import {PlatformSection} from './components/platformSection';
34-
import {RelayMetrics} from './components/relayMetrics';
35-
import {SandboxLink} from './components/sandboxLink';
36-
import {SdkApi} from './components/sdkApi';
37-
import {SdkOption} from './components/sdkOption';
38-
import {SignInNote} from './components/signInNote';
39-
import {SmartLink} from './components/smartLink';
40-
import {TableOfContents} from './components/tableOfContents';
41-
import {VimeoEmbed} from './components/video';
15+
import { Expandable } from './components/expandable';
16+
import { GuideGrid } from './components/guideGrid';
17+
import { JsBundleList } from './components/jsBundleList';
18+
import { LambdaLayerDetail } from './components/lambdaLayerDetail';
19+
import { LinkWithPlatformIcon } from './components/linkWithPlatformIcon';
20+
import { OnboardingOption, OnboardingOptionButtons } from './components/onboarding';
21+
import { OrgAuthTokenNote } from './components/orgAuthTokenNote';
22+
import { PageGrid } from './components/pageGrid';
23+
import { ParamTable } from './components/paramTable';
24+
import { PiiFields } from './components/piiFields';
25+
import { PlatformCategorySection } from './components/platformCategorySection';
26+
import { PlatformFilter } from './components/platformFilter';
27+
import { PlatformGrid } from './components/platformGrid';
28+
import { PlatformIdentifier } from './components/platformIdentifier';
29+
import { PlatformLink } from './components/platformLink';
30+
import { PlatformLinkWithLogo } from './components/platformLinkWithLogo';
31+
import { PlatformOrGuideName } from './components/platformOrGuideName';
32+
import { PlatformSdkPackageName } from './components/platformSdkPackageName';
33+
import { PlatformSection } from './components/platformSection';
34+
import { RelayMetrics } from './components/relayMetrics';
35+
import { SandboxLink } from './components/sandboxLink';
36+
import { SdkApi } from './components/sdkApi';
37+
import { SdkOption } from './components/sdkOption';
38+
import { SignInNote } from './components/signInNote';
39+
import { SmartLink } from './components/smartLink';
40+
import { TableOfContents } from './components/tableOfContents';
41+
import { VimeoEmbed } from './components/video';
42+
import { WindowsNodeEnvSetup } from './components/WindowsNodeEnvSetup';
4243

4344
export function mdxComponents(
4445
dynamicComponents: any = {},
45-
wrapper: any = ({children}) => children
46+
wrapper: any = ({ children }) => children
4647
) {
4748
return {
4849
Alert,
@@ -86,6 +87,7 @@ export function mdxComponents(
8687
SandboxLink,
8788
SignInNote,
8889
VimeoEmbed,
90+
WindowsNodeEnvSetup,
8991
a: SmartLink,
9092
img: DocImage,
9193
...dynamicComponents,

0 commit comments

Comments
 (0)