IssueRaiser

Allow tsconfig.yaml in addition to tsconfig.json

## Search Terms yaml tsconfig format ## Suggestion I suggest allowing the `tsconfig.json` file to be replaced with `tsconfig.yaml`. This would be implemented by simply converting the yaml to json and passing it to whatever method currently interprets the contents of `tsconfig.json`. Additionally, I would propose that the presence of both a `tsconfig.json` and a `tsconfig.yaml` file in the root of a project is an error. ## Use Cases Like #30400 (which I found originally), I'd like to add comments to my project config. Also, yaml is just a nicer format for something intended to be edited by a human. I have created this simply because #30400 (which called for adding `tsconfig.js`) was closed for reasons which do not apply to yaml. So I thought there should be an open issue. You can always close it for other reasons, right? ## Examples following the [example in the handbook](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html) ``` % cat example.json { "compilerOptions": { "module": "commonjs", "noImplicitAny": true, "removeComments": true, "preserveConstEnums": true, "sourceMap": true }, "files": [ "core.ts", "sys.ts", "types.ts", "scanner.ts", "parser.ts", "utilities.ts", "binder.ts", "checker.ts", "emitter.ts", "program.ts", "commandLineParser.ts", "tsc.ts", "diagnosticInformationMap.generated.ts" ] } % cat example.yaml compilerOptions: module: commonjs noImplicitAny: true

Posted by dradetsky on Aug 13, 2020, 12:27 AM

Tags

Related issues

Raise real-world problems, find people facing the same issue, and discuss solutions.3,000 issues0 comments

github (Other)

Allow tsconfig.yaml in addition to tsconfig.json

dradetskyAug 13, 2020, 12:27 AM

## Search Terms yaml tsconfig format ## Suggestion I suggest allowing the `tsconfig.json` file to be replaced with `tsconfig.yaml`. This would be implemented by simply converting the yaml to json and passing it to whatever method currently interprets the contents of `tsconfig.json`. Additionally, I would propose that the presence of both a `tsconfig.json` and a `tsconfig.yaml` file in the root of a project is an error. ## Use Cases Like #30400 (which I found originally), I'd like to add comments to my project config. Also, yaml is just a nicer format for something intended to be edited by a human. I have created this simply because #30400 (which called for adding `tsconfig.js`) was closed for reasons which do not apply to yaml. So I thought there should be an open issue. You can always close it for other reasons, right? ## Examples following the [example in the handbook](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html) ``` % cat example.json { "compilerOptions": { "module": "commonjs", "noImplicitAny": true, "removeComments": true, "preserveConstEnums": true, "sourceMap": true }, "files": [ "core.ts", "sys.ts", "types.ts", "scanner.ts", "parser.ts", "utilities.ts", "binder.ts", "checker.ts", "emitter.ts", "program.ts", "commandLineParser.ts", "tsc.ts", "diagnosticInformationMap.generated.ts" ] } % cat example.yaml compilerOptions: module: commonjs noImplicitAny: true

Comments (0)

No comments yet. Start the discussion.

Comment on this issue