290 lines
13 KiB
Plaintext
290 lines
13 KiB
Plaintext
"use strict";
|
|
Object.defineProperty(exports, "__esModule", {
|
|
value: true
|
|
});
|
|
0 && (module.exports = {
|
|
getRequiredConfiguration: null,
|
|
writeConfigurationDefaults: null
|
|
});
|
|
function _export(target, all) {
|
|
for(var name in all)Object.defineProperty(target, name, {
|
|
enumerable: true,
|
|
get: all[name]
|
|
});
|
|
}
|
|
_export(exports, {
|
|
getRequiredConfiguration: function() {
|
|
return getRequiredConfiguration;
|
|
},
|
|
writeConfigurationDefaults: function() {
|
|
return writeConfigurationDefaults;
|
|
}
|
|
});
|
|
const _fs = require("fs");
|
|
const _chalk = /*#__PURE__*/ _interop_require_default(require("next/dist/compiled/chalk"));
|
|
const _commentjson = /*#__PURE__*/ _interop_require_wildcard(require("next/dist/compiled/comment-json"));
|
|
const _semver = /*#__PURE__*/ _interop_require_default(require("next/dist/compiled/semver"));
|
|
const _os = /*#__PURE__*/ _interop_require_default(require("os"));
|
|
const _getTypeScriptConfiguration = require("./getTypeScriptConfiguration");
|
|
const _log = /*#__PURE__*/ _interop_require_wildcard(require("../../build/output/log"));
|
|
function _interop_require_default(obj) {
|
|
return obj && obj.__esModule ? obj : {
|
|
default: obj
|
|
};
|
|
}
|
|
function _getRequireWildcardCache(nodeInterop) {
|
|
if (typeof WeakMap !== "function") return null;
|
|
var cacheBabelInterop = new WeakMap();
|
|
var cacheNodeInterop = new WeakMap();
|
|
return (_getRequireWildcardCache = function(nodeInterop) {
|
|
return nodeInterop ? cacheNodeInterop : cacheBabelInterop;
|
|
})(nodeInterop);
|
|
}
|
|
function _interop_require_wildcard(obj, nodeInterop) {
|
|
if (!nodeInterop && obj && obj.__esModule) {
|
|
return obj;
|
|
}
|
|
if (obj === null || typeof obj !== "object" && typeof obj !== "function") {
|
|
return {
|
|
default: obj
|
|
};
|
|
}
|
|
var cache = _getRequireWildcardCache(nodeInterop);
|
|
if (cache && cache.has(obj)) {
|
|
return cache.get(obj);
|
|
}
|
|
var newObj = {};
|
|
var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor;
|
|
for(var key in obj){
|
|
if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) {
|
|
var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null;
|
|
if (desc && (desc.get || desc.set)) {
|
|
Object.defineProperty(newObj, key, desc);
|
|
} else {
|
|
newObj[key] = obj[key];
|
|
}
|
|
}
|
|
}
|
|
newObj.default = obj;
|
|
if (cache) {
|
|
cache.set(obj, newObj);
|
|
}
|
|
return newObj;
|
|
}
|
|
function getDesiredCompilerOptions(ts, userTsConfig) {
|
|
var _userTsConfig_compilerOptions;
|
|
const o = {
|
|
// These are suggested values and will be set when not present in the
|
|
// tsconfig.json
|
|
lib: {
|
|
suggested: [
|
|
"dom",
|
|
"dom.iterable",
|
|
"esnext"
|
|
]
|
|
},
|
|
allowJs: {
|
|
suggested: true
|
|
},
|
|
skipLibCheck: {
|
|
suggested: true
|
|
},
|
|
strict: {
|
|
suggested: false
|
|
},
|
|
..._semver.default.lt(ts.version, "5.0.0") ? {
|
|
forceConsistentCasingInFileNames: {
|
|
suggested: true
|
|
}
|
|
} : undefined,
|
|
noEmit: {
|
|
suggested: true
|
|
},
|
|
..._semver.default.gte(ts.version, "4.4.2") ? {
|
|
incremental: {
|
|
suggested: true
|
|
}
|
|
} : undefined,
|
|
// These values are required and cannot be changed by the user
|
|
// Keep this in sync with the webpack config
|
|
// 'parsedValue' matches the output value from ts.parseJsonConfigFileContent()
|
|
esModuleInterop: {
|
|
value: true,
|
|
reason: "requirement for SWC / babel"
|
|
},
|
|
module: {
|
|
parsedValue: ts.ModuleKind.ESNext,
|
|
// All of these values work:
|
|
parsedValues: [
|
|
ts.ModuleKind.ES2020,
|
|
ts.ModuleKind.ESNext,
|
|
ts.ModuleKind.CommonJS,
|
|
ts.ModuleKind.AMD,
|
|
ts.ModuleKind.NodeNext,
|
|
ts.ModuleKind.Node16
|
|
],
|
|
value: "esnext",
|
|
reason: "for dynamic import() support"
|
|
},
|
|
moduleResolution: {
|
|
// In TypeScript 5.0, `NodeJs` has renamed to `Node10`
|
|
parsedValue: ts.ModuleResolutionKind.Bundler ?? ts.ModuleResolutionKind.NodeNext ?? ts.ModuleResolutionKind.Node10 ?? ts.ModuleResolutionKind.NodeJs,
|
|
// All of these values work:
|
|
parsedValues: [
|
|
ts.ModuleResolutionKind.Node10 ?? ts.ModuleResolutionKind.NodeJs,
|
|
// only newer TypeScript versions have this field, it
|
|
// will be filtered for new versions of TypeScript
|
|
ts.ModuleResolutionKind.Node12,
|
|
ts.ModuleResolutionKind.Node16,
|
|
ts.ModuleResolutionKind.NodeNext,
|
|
ts.ModuleResolutionKind.Bundler
|
|
].filter((val)=>typeof val !== "undefined"),
|
|
value: "node",
|
|
reason: "to match webpack resolution"
|
|
},
|
|
resolveJsonModule: {
|
|
value: true,
|
|
reason: "to match webpack resolution"
|
|
},
|
|
...(userTsConfig == null ? void 0 : (_userTsConfig_compilerOptions = userTsConfig.compilerOptions) == null ? void 0 : _userTsConfig_compilerOptions.verbatimModuleSyntax) === true ? undefined : {
|
|
isolatedModules: {
|
|
value: true,
|
|
reason: "requirement for SWC / Babel"
|
|
}
|
|
},
|
|
jsx: {
|
|
parsedValue: ts.JsxEmit.Preserve,
|
|
value: "preserve",
|
|
reason: "next.js implements its own optimized jsx transform"
|
|
}
|
|
};
|
|
return o;
|
|
}
|
|
function getRequiredConfiguration(ts) {
|
|
const res = {};
|
|
const desiredCompilerOptions = getDesiredCompilerOptions(ts);
|
|
for (const optionKey of Object.keys(desiredCompilerOptions)){
|
|
const ev = desiredCompilerOptions[optionKey];
|
|
if (!("value" in ev)) {
|
|
continue;
|
|
}
|
|
res[optionKey] = ev.parsedValue ?? ev.value;
|
|
}
|
|
return res;
|
|
}
|
|
async function writeConfigurationDefaults(ts, tsConfigPath, isFirstTimeSetup, isAppDirEnabled, distDir, hasPagesDir) {
|
|
if (isFirstTimeSetup) {
|
|
await _fs.promises.writeFile(tsConfigPath, "{}" + _os.default.EOL);
|
|
}
|
|
const { options: tsOptions, raw: rawConfig } = await (0, _getTypeScriptConfiguration.getTypeScriptConfiguration)(ts, tsConfigPath, true);
|
|
const userTsConfigContent = await _fs.promises.readFile(tsConfigPath, {
|
|
encoding: "utf8"
|
|
});
|
|
const userTsConfig = _commentjson.parse(userTsConfigContent);
|
|
if (userTsConfig.compilerOptions == null && !("extends" in rawConfig)) {
|
|
userTsConfig.compilerOptions = {};
|
|
isFirstTimeSetup = true;
|
|
}
|
|
const desiredCompilerOptions = getDesiredCompilerOptions(ts, userTsConfig);
|
|
const suggestedActions = [];
|
|
const requiredActions = [];
|
|
for (const optionKey of Object.keys(desiredCompilerOptions)){
|
|
const check = desiredCompilerOptions[optionKey];
|
|
if ("suggested" in check) {
|
|
if (!(optionKey in tsOptions)) {
|
|
if (!userTsConfig.compilerOptions) {
|
|
userTsConfig.compilerOptions = {};
|
|
}
|
|
userTsConfig.compilerOptions[optionKey] = check.suggested;
|
|
suggestedActions.push(_chalk.default.cyan(optionKey) + " was set to " + _chalk.default.bold(check.suggested));
|
|
}
|
|
} else if ("value" in check) {
|
|
var _check_parsedValues;
|
|
const ev = tsOptions[optionKey];
|
|
if (!("parsedValues" in check ? (_check_parsedValues = check.parsedValues) == null ? void 0 : _check_parsedValues.includes(ev) : "parsedValue" in check ? check.parsedValue === ev : check.value === ev)) {
|
|
if (!userTsConfig.compilerOptions) {
|
|
userTsConfig.compilerOptions = {};
|
|
}
|
|
userTsConfig.compilerOptions[optionKey] = check.value;
|
|
requiredActions.push(_chalk.default.cyan(optionKey) + " was set to " + _chalk.default.bold(check.value) + ` (${check.reason})`);
|
|
}
|
|
} else {
|
|
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
const _ = check;
|
|
}
|
|
}
|
|
const nextAppTypes = `${distDir}/types/**/*.ts`;
|
|
if (!("include" in rawConfig)) {
|
|
userTsConfig.include = isAppDirEnabled ? [
|
|
"next-env.d.ts",
|
|
nextAppTypes,
|
|
"**/*.ts",
|
|
"**/*.tsx"
|
|
] : [
|
|
"next-env.d.ts",
|
|
"**/*.ts",
|
|
"**/*.tsx"
|
|
];
|
|
suggestedActions.push(_chalk.default.cyan("include") + " was set to " + _chalk.default.bold(isAppDirEnabled ? `['next-env.d.ts', '${nextAppTypes}', '**/*.ts', '**/*.tsx']` : `['next-env.d.ts', '**/*.ts', '**/*.tsx']`));
|
|
} else if (isAppDirEnabled && !rawConfig.include.includes(nextAppTypes)) {
|
|
userTsConfig.include.push(nextAppTypes);
|
|
suggestedActions.push(_chalk.default.cyan("include") + " was updated to add " + _chalk.default.bold(`'${nextAppTypes}'`));
|
|
}
|
|
// Enable the Next.js typescript plugin.
|
|
if (isAppDirEnabled) {
|
|
// Check if the config or the resolved config has the plugin already.
|
|
const plugins = [
|
|
...Array.isArray(tsOptions.plugins) ? tsOptions.plugins : [],
|
|
...userTsConfig.compilerOptions && Array.isArray(userTsConfig.compilerOptions.plugins) ? userTsConfig.compilerOptions.plugins : []
|
|
];
|
|
const hasNextPlugin = plugins.some(({ name })=>name === "next");
|
|
// If the TS config extends on another config, we can't add the `plugin` field
|
|
// because that will override the parent config's plugins.
|
|
// Instead we have to show a message to the user to add the plugin manually.
|
|
if (!userTsConfig.compilerOptions || plugins.length && !hasNextPlugin && "extends" in rawConfig && (!rawConfig.compilerOptions || !rawConfig.compilerOptions.plugins)) {
|
|
_log.info(`\nYour ${_chalk.default.bold("tsconfig.json")} extends another configuration, which means we cannot add the Next.js TypeScript plugin automatically. To improve your development experience, we recommend adding the Next.js plugin (\`${_chalk.default.cyan('"plugins": [{ "name": "next" }]')}\`) manually to your TypeScript configuration. Learn more: https://nextjs.org/docs/app/building-your-application/configuring/typescript#the-typescript-plugin\n`);
|
|
} else if (!hasNextPlugin) {
|
|
if (!("plugins" in userTsConfig.compilerOptions)) {
|
|
userTsConfig.compilerOptions.plugins = [];
|
|
}
|
|
userTsConfig.compilerOptions.plugins.push({
|
|
name: "next"
|
|
});
|
|
suggestedActions.push(_chalk.default.cyan("plugins") + " was updated to add " + _chalk.default.bold(`{ name: 'next' }`));
|
|
}
|
|
// If `strict` is set to `false` or `strictNullChecks` is set to `false`,
|
|
// then set `strictNullChecks` to `true`.
|
|
if (hasPagesDir && isAppDirEnabled && userTsConfig.compilerOptions && !userTsConfig.compilerOptions.strict && !("strictNullChecks" in userTsConfig.compilerOptions)) {
|
|
userTsConfig.compilerOptions.strictNullChecks = true;
|
|
suggestedActions.push(_chalk.default.cyan("strictNullChecks") + " was set to " + _chalk.default.bold(`true`));
|
|
}
|
|
}
|
|
if (!("exclude" in rawConfig)) {
|
|
userTsConfig.exclude = [
|
|
"node_modules"
|
|
];
|
|
suggestedActions.push(_chalk.default.cyan("exclude") + " was set to " + _chalk.default.bold(`['node_modules']`));
|
|
}
|
|
if (suggestedActions.length < 1 && requiredActions.length < 1) {
|
|
return;
|
|
}
|
|
await _fs.promises.writeFile(tsConfigPath, _commentjson.stringify(userTsConfig, null, 2) + _os.default.EOL);
|
|
_log.info("");
|
|
if (isFirstTimeSetup) {
|
|
_log.info(`We detected TypeScript in your project and created a ${_chalk.default.cyan("tsconfig.json")} file for you.`);
|
|
return;
|
|
}
|
|
_log.info(`We detected TypeScript in your project and reconfigured your ${_chalk.default.cyan("tsconfig.json")} file for you. Strict-mode is set to ${_chalk.default.cyan("false")} by default.`);
|
|
if (suggestedActions.length) {
|
|
_log.info(`The following suggested values were added to your ${_chalk.default.cyan("tsconfig.json")}. These values ${_chalk.default.cyan("can be changed")} to fit your project's needs:\n`);
|
|
suggestedActions.forEach((action)=>_log.info(`\t- ${action}`));
|
|
_log.info("");
|
|
}
|
|
if (requiredActions.length) {
|
|
_log.info(`The following ${_chalk.default.white("mandatory changes")} were made to your ${_chalk.default.cyan("tsconfig.json")}:\n`);
|
|
requiredActions.forEach((action)=>_log.info(`\t- ${action}`));
|
|
_log.info("");
|
|
}
|
|
}
|
|
|
|
//# sourceMappingURL=writeConfigurationDefaults.js.map |