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

feat(init-templates): add typesRoot compiler option for typescript templates in the tsconfig.json #3865

Merged
merged 5 commits into from
Sep 2, 2019

Conversation

carlosrfernandez
Copy link
Contributor

Closes #3830

Given a project structure where the cdk (init) generated node_modules has a parent node project with its own node_modules folder with failing typescript code, the CDK will not compile because tsc traverses the directory structure looking for type definitions.

This small change adds the typesRoot compiler option essentially rooting the typescript compiler to look for types under the cdk_root_folder/node_modules/@types.


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

@mergify
Copy link
Contributor

mergify bot commented Aug 29, 2019

Pull Request Checklist

  • Testing
  • Unit test added (prefer to add a new test rather than modify existing tests)
  • CLI change? Re-run/add CLI integration tests
  • Documentation
  • Inline docs: make sure all public APIs are documented (copy & paste from official AWS docs)
  • README: update module README
  • Design: for significant features, follow the design process
  • Title uses the format type(scope): text
  • Type: fix, feat, refactor go into CHANGELOG, chore is hidden
  • Scope: name of the module without the aws- or cdk- prefix or postfix (e.g. s3 instead of aws-s3-deployment)
  • Style: use all lower-case, do not end with a period
  • Description
  • Rationale: describe rationale of change and approach taken
  • Issues: Indicate issues fixed via: fixes #xxx or closes #xxx
  • Breaking?: last paragraph: BREAKING CHANGE: <describe what changed + link for details>
  • Sensitive Modules (requires 2 PR approvers)
  • IAM document library (in @aws-cdk/aws-iam)
  • EC2 security groups and ACLs (in @aws-cdk/aws-ec2)
  • Grant APIs (if not based on official documentation with a reference)

@eladb
Copy link
Contributor

eladb commented Aug 29, 2019

@RomainMuller can you chime in? What do you think?

@RomainMuller
Copy link
Contributor

That sounds fair - the only question is can this have unintended consequences?

@carlosrfernandez
Copy link
Contributor Author

To be honest, I can’t really say if this will have additional side effects.

But depending how you look at it, without having this setting, the side effects are already happening.

It’s a valid concern though...

Copy link
Contributor

@rix0rrr rix0rrr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's give it a shot.

@mergify
Copy link
Contributor

mergify bot commented Sep 2, 2019

Thank you for contributing! Your pull request is now being automatically merged.

@rix0rrr rix0rrr merged commit 2c9bafa into aws:master Sep 2, 2019
@carlosrfernandez carlosrfernandez deleted the feat/init-templates-typescript branch September 2, 2019 12:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Template tsconfig.json should specify typeRoots to avoid potential errors.
4 participants