Skip to content

Document release version of every tsconfig option #3310

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
jakebailey merged 1 commit into from
Jan 26, 2025
Merged

Document release version of every tsconfig option #3310

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
106 changes: 89 additions & 17 deletions packages/tsconfig-reference/scripts/tsconfigRules.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ export const recommended = [
"exactOptionalPropertyTypes",
];

type RootProperties = "files" | "extends" | "include" | "exclude";
type RootProperties = "files" | "extends" | "include" | "exclude" | "references";
type WatchProperties =
| "force"
| "watchFile"
Expand Down Expand Up @@ -310,18 +310,40 @@ function formatAllowedValues(type: CommandLineOption["type"]) {
}

export const releaseToConfigsMap: { [key: string]: AnOption[] } = {
"5.7": ["rewriteRelativeImportExtensions"],
"5.6": ["strictBuiltinIteratorReturn", "noUncheckedSideEffectImports"],
"5.5": ["isolatedDeclarations", "noCheck"],
"5.0": [
"allowArbitraryExtensions",
"allowImportingTsExtensions",
"customConditions",
"resolvePackageJsonExports",
"resolvePackageJsonImports",
"verbatimModuleSyntax",
],
"4.7": ["moduleDetection", "moduleSuffixes"],
"4.5": ["preserveValueImports"],
"4.4": ["exactOptionalPropertyTypes", "useUnknownInCatchVariables"],
"4.3": ["noImplicitOverride"],
"4.2": ["noPropertyAccessFromIndexSignature", "explainFiles"],
"4.1": ["jsxImportSource", "noUncheckedIndexedAccess", "disableFilenameBasedTypeAcquisition"],
"4.2": [
"noPropertyAccessFromIndexSignature",
"explainFiles",
"excludeDirectories",
"excludeFiles",
],
"4.1": [
"generateTrace",
"jsxImportSource",
"noUncheckedIndexedAccess",
"disableFilenameBasedTypeAcquisition",
],
"4.0": ["jsxFragmentFactory", "disableReferencedProjectLoad"],
"3.8": [
"assumeChangesOnlyAffectDirectDependencies",
"importsNotUsedAsValues",
"disableSolutionSearching",
"fallbackPolling",
"synchronousWatchDirectory",
"watchDirectory",
"watchFile",
],
Expand All @@ -333,38 +355,88 @@ export const releaseToConfigsMap: { [key: string]: AnOption[] } = {
"3.5": ["allowUmdGlobalAccess"],
"3.4": ["incremental", "tsBuildInfoFile"],
"3.2": ["strictBindCallApply", "showConfig"],
"3.0": ["composite", "build"],
"2.9": ["keyofStringsOnly", "declarationMap"],
"2.8": ["emitDeclarationOnly"],
"3.0": ["composite", "references"],
"2.9": ["declarationMap", "keyofStringsOnly", "resolveJsonModule"],
"2.8": ["emitDeclarationOnly", "preserveWatchOutput"],
"2.7": ["strictPropertyInitialization", "esModuleInterop"],
"2.6": ["strictFunctionTypes"],
"2.4": ["noStrictGenericChecks"],
"2.5": ["noStrictGenericChecks", "preserveSymlinks"],
"2.3": ["strict", "downlevelIteration", "init", "checkJs"],
"2.2": ["jsx"],
"2.1": ["extends", "alwaysStrict"],
"2.2": ["jsxFactory", "plugins"],
"2.1": ["extends", "alwaysStrict", "importHelpers"],
"2.0": [
"baseUrl",
"declarationDir",
"skipLibCheck",
"noUnusedLocals",
"noUnusedParameters",
"disableSizeLimit",
"exclude",
"extendedDiagnostics",
"include",
"lib",
"strictNullChecks",
"listEmittedFiles",
"maxNodeModuleJsDepth",
"noImplicitThis",
"noUnusedLocals",
"noUnusedParameters",
"paths",
"rootDirs",
"skipLibCheck",
"strictNullChecks",
"traceResolution",
"include",
"types",
"typeRoots",
],
"1.8": [
"allowJs",
"allowSyntheticDefaultImports",
"allowUnreachableCode",
"allowUnusedLabels",
"forceConsistentCasingInFileNames",
"noImplicitReturns",
"noImplicitUseStrict",
"noFallthroughCasesInSwitch",
"pretty",
"reactNamespace",
],
"1.6": [
"jsx",
"moduleResolution",
"outFile",
"skipDefaultLibCheck",
"suppressExcessPropertyErrors",
],
"1.5": [
"emitDecoratorMetadata",
"experimentalDecorators",
"files",
"inlineSourceMap",
"inlineSources",
"isolatedModules",
"listFiles",
"newLine",
"noEmit",
"noEmitHelpers",
"rootDir",
"stripInternal",
],
"1.4": ["noEmitOnError", "preserveConstEnums", "suppressImplicitAnyIndexErrors"],
"1.0": [
"charset",
"declaration",
"diagnostics",
"emitBOM",
"mapRoot",
"module",
"noErrorTruncation",
"noImplicitAny",
"noLib",
"noResolve",
"out",
"outDir",
"removeComments",
"sourceMap",
"sourceRoot",
"target",
],
"1.5": ["inlineSourceMap", "noEmitHelpers", "newLine", "inlineSources", "rootDir"],
"1.4": ["noEmitOnError"],
"1.0": ["declaration", "target", "module", "outFile"],
};

export const additionalOptionDescriptors: Record<string, { categoryCode: number }> = {
Expand Down
Loading