Skip to content
This repository was archived by the owner on Jan 13, 2024. It is now read-only.

Commit 2f1157a

Browse files
System233System233
committed
Remove comments from tsconfig.json generated by 'tsc --init'
1 parent 08d6df0 commit 2f1157a

File tree

12 files changed

+105
-1211
lines changed

12 files changed

+105
-1211
lines changed

‎src/compiler/commandLineParser.ts

Lines changed: 11 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -2667,10 +2667,6 @@ export function generateTSConfig(options: CompilerOptions, fileNames: readonly s
26672667
const compilerOptionsMap = getSerializedCompilerOption(options);
26682668
return writeConfigurations();
26692669

2670-
function makePadding(paddingLength: number): string {
2671-
return Array(paddingLength + 1).join(" ");
2672-
}
2673-
26742670
function isAllowedOptionForOutput({ category, name, isCommandLineOnly }: CommandLineOption): boolean {
26752671
// Skip options which do not have a category or have categories which are more niche
26762672
const categoriesToSkip = [Diagnostics.Command_line_Options, Diagnostics.Editor_Support, Diagnostics.Compiler_Diagnostics, Diagnostics.Backwards_Compatibility, Diagnostics.Watch_and_Build_Modes, Diagnostics.Output_Formatting];
@@ -2697,57 +2693,19 @@ export function generateTSConfig(options: CompilerOptions, fileNames: readonly s
26972693
}
26982694
}
26992695

2700-
// Serialize all options and their descriptions
2701-
let marginLength = 0;
2702-
let seenKnownKeys = 0;
2703-
const entries: { value: string; description?: string; }[] = [];
2704-
categorizedOptions.forEach((options, category) => {
2705-
if (entries.length !== 0) {
2706-
entries.push({ value: "" });
2707-
}
2708-
entries.push({ value: `/* ${getLocaleSpecificMessage(category)} */` });
2709-
for (const option of options) {
2710-
let optionName;
2711-
if (compilerOptionsMap.has(option.name)) {
2712-
optionName = `"${option.name}": ${JSON.stringify(compilerOptionsMap.get(option.name))}${(seenKnownKeys += 1) === compilerOptionsMap.size ? "" : ","}`;
2713-
}
2714-
else {
2715-
optionName = `// "${option.name}": ${JSON.stringify(getDefaultValueForOption(option))},`;
2716-
}
2717-
entries.push({
2718-
value: optionName,
2719-
description: `/* ${option.description && getLocaleSpecificMessage(option.description) || option.name} */`,
2720-
});
2721-
marginLength = Math.max(optionName.length, marginLength);
2722-
}
2723-
});
2724-
2725-
// Write the output
2726-
const tab = makePadding(2);
2727-
const result: string[] = [];
2728-
result.push(`{`);
2729-
result.push(`${tab}"compilerOptions": {`);
2730-
result.push(`${tab}${tab}/* ${getLocaleSpecificMessage(Diagnostics.Visit_https_Colon_Slash_Slashaka_ms_Slashtsconfig_to_read_more_about_this_file)} */`);
2731-
result.push("");
2732-
// Print out each row, aligning all the descriptions on the same column.
2733-
for (const entry of entries) {
2734-
const { value, description = "" } = entry;
2735-
result.push(value && `${tab}${tab}${value}${description && (makePadding(marginLength - value.length + 2) + description)}`);
2736-
}
2696+
// Serialize all options
2697+
const tsconfig: Partial<TSConfig> = {};
2698+
tsconfig.compilerOptions = {
2699+
...optionMapToObject(compilerOptionsMap),
2700+
};
27372701
if (fileNames.length) {
2738-
result.push(`${tab}},`);
2739-
result.push(`${tab}"files": [`);
2740-
for (let i = 0; i < fileNames.length; i++) {
2741-
result.push(`${tab}${tab}${JSON.stringify(fileNames[i])}${i === fileNames.length - 1 ? "" : ","}`);
2742-
}
2743-
result.push(`${tab}]`);
2744-
}
2745-
else {
2746-
result.push(`${tab}}`);
2702+
tsconfig.files = fileNames;
27472703
}
2748-
result.push(`}`);
2749-
2750-
return result.join(newLine) + newLine;
2704+
const message = `/* ${getLocaleSpecificMessage(Diagnostics.Visit_https_Colon_Slash_Slashaka_ms_Slashtsconfig_to_read_more_about_this_file)} */`;
2705+
return [
2706+
message,
2707+
JSON.stringify(tsconfig, undefined, 2),
2708+
].join(newLine) + newLine;
27512709
}
27522710
}
27532711

‎tests/baselines/reference/config/initTSConfig/Default initialized TSConfig/tsconfig.json

Lines changed: 7 additions & 105 deletions
Original file line numberDiff line numberDiff line change
@@ -1,109 +1,11 @@
1+
/* Visit https://aka.ms/tsconfig to read more about this file */
12
{
23
"compilerOptions": {
3-
/* Visit https://aka.ms/tsconfig to read more about this file */
4-
5-
/* Projects */
6-
// "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
7-
// "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
8-
// "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */
9-
// "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */
10-
// "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
11-
// "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */
12-
13-
/* Language and Environment */
14-
"target": "es2016", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
15-
// "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
16-
// "jsx": "preserve", /* Specify what JSX code is generated. */
17-
// "experimentalDecorators": true, /* Enable experimental support for legacy experimental decorators. */
18-
// "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
19-
// "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
20-
// "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
21-
// "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
22-
// "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
23-
// "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
24-
// "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */
25-
// "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */
26-
27-
/* Modules */
28-
"module": "commonjs", /* Specify what module code is generated. */
29-
// "rootDir": "./", /* Specify the root folder within your source files. */
30-
// "moduleResolution": "node10", /* Specify how TypeScript looks up a file from a given module specifier. */
31-
// "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
32-
// "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
33-
// "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
34-
// "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */
35-
// "types": [], /* Specify type package names to be included without being referenced in a source file. */
36-
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
37-
// "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */
38-
// "allowImportingTsExtensions": true, /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
39-
// "resolvePackageJsonExports": true, /* Use the package.json 'exports' field when resolving package imports. */
40-
// "resolvePackageJsonImports": true, /* Use the package.json 'imports' field when resolving imports. */
41-
// "customConditions": [], /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
42-
// "resolveJsonModule": true, /* Enable importing .json files. */
43-
// "allowArbitraryExtensions": true, /* Enable importing files with any extension, provided a declaration file is present. */
44-
// "noResolve": true, /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
45-
46-
/* JavaScript Support */
47-
// "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
48-
// "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
49-
// "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
50-
51-
/* Emit */
52-
// "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
53-
// "declarationMap": true, /* Create sourcemaps for d.ts files. */
54-
// "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
55-
// "sourceMap": true, /* Create source map files for emitted JavaScript files. */
56-
// "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
57-
// "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
58-
// "outDir": "./", /* Specify an output folder for all emitted files. */
59-
// "removeComments": true, /* Disable emitting comments. */
60-
// "noEmit": true, /* Disable emitting files from a compilation. */
61-
// "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
62-
// "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */
63-
// "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
64-
// "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
65-
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
66-
// "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
67-
// "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
68-
// "newLine": "crlf", /* Set the newline character for emitting files. */
69-
// "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
70-
// "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */
71-
// "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
72-
// "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */
73-
// "declarationDir": "./", /* Specify the output directory for generated declaration files. */
74-
// "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
75-
76-
/* Interop Constraints */
77-
// "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
78-
// "verbatimModuleSyntax": true, /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
79-
// "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
80-
"esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
81-
// "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
82-
"forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */
83-
84-
/* Type Checking */
85-
"strict": true, /* Enable all strict type-checking options. */
86-
// "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */
87-
// "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */
88-
// "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
89-
// "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
90-
// "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
91-
// "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */
92-
// "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */
93-
// "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
94-
// "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */
95-
// "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */
96-
// "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
97-
// "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
98-
// "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
99-
// "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */
100-
// "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
101-
// "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */
102-
// "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
103-
// "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */
104-
105-
/* Completeness */
106-
// "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
107-
"skipLibCheck": true /* Skip type checking all .d.ts files. */
4+
"module": "commonjs",
5+
"target": "es2016",
6+
"strict": true,
7+
"esModuleInterop": true,
8+
"forceConsistentCasingInFileNames": true,
9+
"skipLibCheck": true
10810
}
10911
}

0 commit comments

Comments
 (0)