Skip to content
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.

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

JSII config file #1233

Open
jci-aws opened this issue Aug 9, 2024 · 2 comments
Open

JSII config file #1233

jci-aws opened this issue Aug 9, 2024 · 2 comments
Labels
enhancement New feature or request p2

Comments

@jci-aws
Copy link

jci-aws commented Aug 9, 2024

It would be nice to define JSII configuration in a separate configuration file, instead of cluttering package.json with JSII-specific configuration. Something like .jsii, .jsii.yaml, jsii.config.ts, etc.

All JSII configuration that currently exists in the package.json jsii field should be able to be specified here (including diagnostics). Type-checking the config would also be a nice-to-have here.

@mrgrain
Copy link
Contributor

mrgrain commented Aug 13, 2024

Yeah, I think particular for diagnostics this is quite annoying to be in package.json. With user-provided tsconfigs it's possible to move most of the settings away from it. But notably diagnostics is not supported.

The file can't be named .jsii, that's the name of the jsii assembly file. .jsiirc.json or jsii.config.json would work.

Alternatively, would to you think about a jsii section inside the tsconfig.json file?

@mrgrain mrgrain added enhancement New feature or request p2 labels Aug 13, 2024
@jci-aws
Copy link
Author

jci-aws commented Aug 13, 2024

A jsii section inside tsconfig.json might be a bit confusing, since users may have multiple tsconfig.*.json files. But maybe that can be handled with a flag like jsii --project ./path/to/tsconfig.json, then if that tsconfig.json has a jsii section that configuration can be used.

A separate file is my personal preference tho, I like having a single file where it only contains configuration for a single tool.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request p2
Projects
None yet
Development

No branches or pull requests

2 participants