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

chore(scripts): Add Jetbrains node_modules exclusion script #1507

Merged
merged 3 commits into from
Jan 13, 2019

Conversation

costleya
Copy link
Contributor

@costleya costleya commented Jan 10, 2019

Jetbrains IDEs will index the files in a project to provide intelligent suggestions to users. However, this project uses lerna and has cyclical symlinks inside node_module directories. The IDE will index until it runs out of memory following these links. Given the size of this project, doing the exclusions by hand is infeasable every time one does a git clean. This script will modify the .iml file directly to add the appropriate exclusions.


Pull Request Checklist

  • Testing
    • Unit test added
    • CLI change?: manually run integration tests and paste output as a PR comment
    • cdk-init template change?: coordinated update of integration tests with team
  • Docs
    • jsdocs: All public APIs documented
    • README: README and/or documentation topic updated
  • Title and Description
    • Change type: title prefixed with fix, feat will appear in changelog
    • Title: use lower-case and doesn't end with a period
    • Breaking?: last paragraph: "BREAKING CHANGE: <describe what changed + link for details>"
    • Issues: Indicate issues fixed via: "Fixes #xxx" or "Closes #xxx"
  • Sensitive Modules (requires 2 PR approvers)
    • IAM Policy Document (in @aws-cdk/aws-iam)
    • EC2 Security Groups and ACLs (in @aws-cdk/aws-ec2)
    • Grant APIs (only if not based on official documentation with a reference)

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

Jetbrains IDEs will index the files in a project to provide intelligent suggestions to users. However, this project uses lerna and has cyclical symlinks inside node_module directories. The IDE will index until it runs out of memory following these links. Given the size of this project, doing the exclusions by hand is infeasable every time one does a git clean. This script will modify the .iml file directly to add the appropriate exclusions.
@costleya costleya requested a review from a team as a code owner January 10, 2019 03:10
@eladb
Copy link
Contributor

eladb commented Jan 10, 2019

Add a mention in CONTRIBUTING?

* The JetBrains IDEs exclusion list assumed your iml file was named aws-cdk. It now uses the root directory's name instead.
* IntelliJ stores the iml file at root. The script now accounts for that difference.
* For uncommon setups, the script can take an optional path arguement to opt-out of conventional file discovery, and be explicit.
@costleya costleya changed the title chore(scripts): Add Jetbrains node_modules exclusion script. chore(scripts): Add Jetbrains node_modules exclusion script Jan 11, 2019
@eladb eladb merged commit f02c48a into aws:master Jan 13, 2019
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.

2 participants