forked from nodejs/nodejs.org
-
Notifications
You must be signed in to change notification settings - Fork 1
/
next.constants.mjs
137 lines (123 loc) · 5.08 KB
/
next.constants.mjs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
'use strict';
/**
* This is used to verify if the current Website is running on a Development Environment
*/
export const IS_DEVELOPMENT = process.env.NODE_ENV === 'development';
/**
* This is used for telling Next.js if the Website is deployed on Vercel
*
* Can be used for conditionally enabling features that we know are Vercel only
*
* @see https://vercel.com/docs/concepts/projects/environment-variables/system-environment-variables#framework-environment-variables
*/
export const VERCEL_ENV = process.env.NEXT_PUBLIC_VERCEL_ENV || undefined;
/**
* This is used for defining a default time of when `next-data` and other dynamically generated
* but static-enabled pages should be regenerated.
*
* Note that this is a custom Environment Variable that can be defined by us when necessary
*/
export const VERCEL_REVALIDATE = Number(
process.env.NEXT_PUBLIC_VERCEL_REVALIDATE_TIME || 300
);
/**
* This is used for telling Next.js to to a Static Export Build of the Website
*
* This is used for static/without a Node.js server hosting, such as on our
* legacy Website Build Environment on Node.js's DigitalOcean Droplet.
*
* Note that this is a manual Environment Variable defined by us during `npm run deploy`
*/
export const ENABLE_STATIC_EXPORT =
process.env.NEXT_PUBLIC_STATIC_EXPORT === 'true' ||
process.env.NEXT_PUBLIC_STATIC_EXPORT === true;
/**
* This is used for enabling the New Website Redesign Layouts
*
* Note that this is a manual Environment Variable defined by us if necessary.
*/
export const ENABLE_WEBSITE_REDESIGN =
process.env.NEXT_PUBLIC_ENABLE_REDESIGN === 'true' ||
process.env.NEXT_PUBLIC_ENABLE_REDESIGN === true;
/**
* This is used for any place that requires the full canonical URL path for the Node.js Website (and its deployment), such as for example, the Node.js RSS Feed.
*
* This variable can either come from the Vercel Deployment as `NEXT_PUBLIC_VERCEL_URL` or from the `NEXT_PUBLIC_BASE_URL` Environment Variable that is manually defined
* by us if necessary. Otherwise it will fallback to the default Node.js Website URL.
*
* @see https://vercel.com/docs/concepts/projects/environment-variables/system-environment-variables#framework-environment-variables
*/
export const BASE_URL = process.env.NEXT_PUBLIC_BASE_URL
? process.env.NEXT_PUBLIC_BASE_URL
: process.env.NEXT_PUBLIC_VERCEL_URL
? `https://${process.env.NEXT_PUBLIC_VERCEL_URL}`
: 'https://nodejs.org';
/**
* This is used for any place that requires the Node.js distribution URL (which by default is nodejs.org/dist)
*
* Note that this is a custom Environment Variable that can be defined by us when necessary
*/
export const DIST_URL =
process.env.NEXT_PUBLIC_DIST_URL || 'https://nodejs.org/dist/';
/**
* This is used for any place that requires the Node.js API Docs URL (which by default is nodejs.org/docs)
*
* Note that this is a custom Environment Variable that can be defined by us when necessary
*/
export const DOCS_URL =
process.env.NEXT_PUBLIC_DOCS_URL || 'https://nodejs.org/docs/';
/**
* Supports a manual override of the base path of the Website
*
* This is useful when running the deployment on a subdirectory
* of a domain, such as when hosted on GitHub Pages.
*
* Note that this is a custom Environment Variable that can be defined by us when necessary
*/
export const BASE_PATH = process.env.NEXT_PUBLIC_BASE_PATH || '';
/**
* This is used for fetching static next-data through the /en/next-data/ endpoint
*
* Note this is assumes that the Node.js Website is either running within Vercel Environment
* or running locally (either production or development) mode
*
* Note this variable can be overridden via a manual Environment Variable defined by us if necessary.
*/
export const NEXT_DATA_URL = process.env.NEXT_PUBLIC_DATA_URL
? process.env.NEXT_PUBLIC_DATA_URL
: VERCEL_ENV
? `${BASE_URL}${BASE_PATH}/en/next-data/`
: `http://localhost:3000/en/next-data/`;
/**
* This ReGeX is used to remove the `index.md(x)` suffix of a name and to remove
* the `.md(x)` extensions of a filename.
*
* This RegEx is used to transform the file system pathnames into acceptable
* Route Segments for Next.js Dynamic Routes on `pages/[...path].tsx`
*/
export const MD_EXTENSION_REGEX = /((\/)?(index))?\.mdx?$/i;
/**
* This defines how many blog posts each pagination page should have
*
* @todo: update the value when moving to website redesign
*/
export const BLOG_POSTS_PER_PAGE = ENABLE_WEBSITE_REDESIGN ? 6 : 20;
/**
* The `localStorage` key to store the theme choice of `next-themes`
*
* This is what allows us to store user preference for theming
*/
export const THEME_STORAGE_KEY = 'theme';
/***
* This is a list of all external links that are used on website sitemap.
* @see https://github.com/nodejs/nodejs.org/issues/5813 for more context
*/
export const EXTERNAL_LINKS_SITEMAP = [
'https://terms-of-use.openjsf.org/',
'https://privacy-policy.openjsf.org/',
'https://bylaws.openjsf.org/',
'https://code-of-conduct.openjsf.org/',
'https://trademark-policy.openjsf.org/',
'https://trademark-list.openjsf.org/',
'https://www.linuxfoundation.org/cookies',
];