Skip to content

[code-infra] Move next config to ESM #40869

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Janpot merged 7 commits into from
Feb 8, 2024
Merged

[code-infra] Move next config to ESM #40869

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
84ccb28
Move next config to ESM
Janpot Jan 31, 2024
9e5f9df
fixes
Janpot Jan 31, 2024
9ee0194
Merge branch 'heads/upstream/master' into next-config-mjs
Janpot Feb 7, 2024
d1940d0
Update pnpm-lock.yaml
Janpot Feb 7, 2024
45d9d18
Merge branch 'heads/upstream/master' into next-config-mjs
Janpot Feb 7, 2024
4c58db0
Merge branch 'heads/upstream/master' into next-config-mjs
Janpot Feb 8, 2024
f0731ea
ewr
Janpot Feb 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .eslintrc.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -465,7 +465,7 @@ module.exports = {
},
},
{
files: ['scripts/**/*.mjs', 'packages/**/*.mjs'],
files: ['**/*.mjs'],
rules: {
'import/extensions': ['error', 'ignorePackages'],
},
Expand Down
26 changes: 17 additions & 9 deletions docs/next.config.js → docs/next.config.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,34 @@
// @ts-check
const path = require('path');
import * as path from 'path';
import * as url from 'url';
import * as fs from 'fs';
// @ts-ignore
const { BundleAnalyzerPlugin } = require('webpack-bundle-analyzer');
const pkg = require('../package.json');
const withDocsInfra = require('./nextConfigDocsInfra');
const { findPages } = require('./src/modules/utils/find');
const {
import { BundleAnalyzerPlugin } from 'webpack-bundle-analyzer';
import { createRequire } from 'module';
import withDocsInfra from './nextConfigDocsInfra.js';
import { findPages } from './src/modules/utils/find.mjs';
Comment on lines +8 to +9
Copy link
Member

@oliviertassinari oliviertassinari Feb 6, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm curious about this. Why add the extensions?

Edit: oh lol really? https://nodejs.org/api/esm.html#mandatory-file-extensions

Mandatory file extensions

Copy link
Member Author

@Janpot Janpot Feb 7, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

node.js follows the native browser implementation in its resolver for esm, full paths mandatory. I guess it guarantees predictable amount of io access during module loading? It's more important on the web.
I think I saw somewhere that they're porting the classic node resolver to esm, but it's still experimental.

import {
LANGUAGES,
LANGUAGES_SSR,
LANGUAGES_IGNORE_PAGES,
LANGUAGES_IN_PROGRESS,
} = require('./config');
} from './config.js';

const workspaceRoot = path.join(__dirname, '../');
const currentDirectory = url.fileURLToPath(new URL('.', import.meta.url));
const require = createRequire(import.meta.url);

const workspaceRoot = path.join(currentDirectory, '../');

const l10nPRInNetlify = /^l10n_/.test(process.env.HEAD || '') && process.env.NETLIFY === 'true';
const vercelDeploy = Boolean(process.env.VERCEL);
const isDeployPreview = Boolean(process.env.PULL_REQUEST_ID);
// For crowdin PRs we want to build all locales for testing.
const buildOnlyEnglishLocale = isDeployPreview && !l10nPRInNetlify && !vercelDeploy;

module.exports = withDocsInfra({
const pkgContent = fs.readFileSync(path.resolve(workspaceRoot, 'package.json'), 'utf8');
const pkg = JSON.parse(pkgContent);

export default withDocsInfra({
webpack: (config, options) => {
const plugins = config.plugins.slice();

Expand Down
16 changes: 8 additions & 8 deletions docs/src/modules/utils/find.js → docs/src/modules/utils/find.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
const fs = require('fs');
const path = require('path');
import * as fs from 'fs';
import * as url from 'url';
import * as path from 'path';

const currentDirectory = url.fileURLToPath(new URL('.', import.meta.url));

const pageRegex = /(\.js|\.tsx)$/;
const blackList = ['/.eslintrc', '/_document', '/_app'];
Expand All @@ -19,9 +22,10 @@ const blackList = ['/.eslintrc', '/_document', '/_app'];
* @param {NextJSPage[]} pages
* @returns {NextJSPage[]}
*/
function findPages(
// eslint-disable-next-line import/prefer-default-export
export function findPages(
options = {},
directory = path.resolve(__dirname, '../../../pages'),
directory = path.resolve(currentDirectory, '../../../pages'),
pages = [],
) {
fs.readdirSync(directory).forEach((item) => {
Expand Down Expand Up @@ -80,7 +84,3 @@ function findPages(

return pages;
}

module.exports = {
findPages,
};
2 changes: 1 addition & 1 deletion docs/tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"extends": "../tsconfig.json",
"include": ["next-env.d.ts", "types", "src", "pages", "data", "next.config.js"],
"include": ["next-env.d.ts", "types", "src", "pages", "data", "next.config.mjs"],
"compilerOptions": {
"allowJs": true,
"isolatedModules": true,
Expand Down