Skip to content

docs(@angular/cli): Adds developer documentation and Intellij setup. #16152

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

Merged
merged 3 commits into from
Nov 14, 2019

Conversation

dgp1130
Copy link
Collaborator

@dgp1130 dgp1130 commented Nov 11, 2019

I wrote down my understanding of the best ways to build/run/test/debug this repository. I also included some configs for Intellij to work a little bit better "out of the box".

I tried to get VSCode to work as well, however the debugger there was having trouble loading source maps, so I'll need to come back to that later.

Changes include:

  • Updated README with instructions for new developers.
  • Updated .gitignore for Intellij and VSCode.
  • Added Intellij config files.
  • Added nodemon as a dev dependency, which is needed for watch executions but wasn't listed.
  • Removed an extraneous debugger; statement which I kept hitting.
  • Added support for negated .gitignore expressions in the build tool, as my changes to that file were causing build errors.

@dgp1130 dgp1130 requested a review from clydin November 11, 2019 22:14
@dgp1130 dgp1130 self-assigned this Nov 11, 2019
Copy link
Member

@clydin clydin left a comment

Choose a reason for hiding this comment

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

Can you split this into several commits? Probably three:

  1. The README updates
  2. git ignore improvements
  3. IntelliJ setup

The last may need some discussion with the team as I believe there were previous concerns with adding IDE specific configuration into the repositories.

…ellij configurations.

This also changes the local build script to allow negated .gitignore expressions to support these changes.
This should enable using Intellij IDEA/WebStorm to create the project, run it, and start a debugger. I did my best to make sure my personal configuration didn't leak in, someone else will have to confirm that this works reasonably for them too.
@dgp1130 dgp1130 force-pushed the dev-docs branch 2 times, most recently from 9f982fd to 46de409 Compare November 12, 2019 20:06
@dgp1130
Copy link
Collaborator Author

dgp1130 commented Nov 12, 2019

I split up the commits and moved my README edits to scripts/templates/readme.ejs, which I didn't see before.

@dgp1130 dgp1130 added the target: major This PR is targeted for the next major release label Nov 12, 2019
I wrote down my understanding of the best ways to build/run/test/debug this repository.

A couple other random things included here:
* Removed an extraneous `debugger;` statement which I kept hitting.
* Removed the `watch` scripts which are no longer used and don't need to be supported.
* Removed `yarn test-cli-e2e`, as it alters the $PATH and can use the wrong `ng` instance.
@dgp1130
Copy link
Collaborator Author

dgp1130 commented Nov 14, 2019

Do you think we need to discuss the IntelliJ configs with the team or should I just merge this?

@clydin clydin added the needs: discussion On the agenda for team meeting to determine next steps label Nov 14, 2019
@clydin
Copy link
Member

clydin commented Nov 14, 2019

To be safe, added the discussion label for tomorrow's triage meeting.

@filipesilva filipesilva removed the needs: discussion On the agenda for team meeting to determine next steps label Nov 14, 2019
@dgp1130 dgp1130 merged commit 1aac244 into angular:master Nov 14, 2019
@dgp1130
Copy link
Collaborator Author

dgp1130 commented Nov 14, 2019

Concerns in the meeting were able not forcing personal configuration settings (such as themeing) directly in the repo. IntelliJ doesn't really put personal settings like that in these files. The settings will be picked up by default, but users should be able to change and modify them as they wish independently from the setting stored in source control.

@dgp1130 dgp1130 deleted the dev-docs branch November 14, 2019 19:14
ahasall added a commit to ahasall/angular-cli that referenced this pull request Nov 18, 2019
Intellij and Webstorm unfortunately don't the use the exact same
configuration system.For example, Intellij treats every project as
`JAVA_MODULE` but Webstorm doesn't recognize the `JAVA_MODULE`.
Therefore, I think that the modules.xml and iml should be left
out from version control.

refs angular#16152
ahasall added a commit to ahasall/angular-cli that referenced this pull request Nov 18, 2019
Intellij and Webstorm unfortunately don't the use the exact same
configuration system. For example, Intellij treats every project as
`JAVA_MODULE` but Webstorm doesn't recognize the `JAVA_MODULE`.
Therefore, I think that the modules.xml and iml should be left
out from version control.

refs angular#16152
ahasall added a commit to ahasall/angular-cli that referenced this pull request Nov 18, 2019
Intellij and Webstorm unfortunately don't the use the exact same
configuration system. For example, Intellij treats every project as
`JAVA_MODULE` but Webstorm doesn't recognize the `JAVA_MODULE`.
Therefore, I think that the modules.xml and iml should be left
out from version control.

refs angular#16152
ahasall added a commit to ahasall/angular-cli that referenced this pull request Nov 19, 2019
Intellij and Webstorm unfortunately don't the use the exact same
configuration system. For example, Intellij treats every project as
`JAVA_MODULE` but Webstorm doesn't recognize the `JAVA_MODULE`.
Therefore, I think that the modules.xml and iml should be left
out from version control.

refs angular#16152
ahasall added a commit to ahasall/angular-cli that referenced this pull request Nov 19, 2019
Intellij and Webstorm unfortunately don't the use the exact same
configuration system. For example, Intellij treats every project as
`JAVA_MODULE` but Webstorm doesn't recognize the `JAVA_MODULE`.
Let's use `WEB_MODULE` as it's recognized by both IDEs.

refs angular#16152
dgp1130 pushed a commit that referenced this pull request Nov 19, 2019
Intellij and Webstorm unfortunately don't the use the exact same
configuration system. For example, Intellij treats every project as
`JAVA_MODULE` but Webstorm doesn't recognize the `JAVA_MODULE`.
Let's use `WEB_MODULE` as it's recognized by both IDEs.

refs #16152
@angular-automatic-lock-bot
Copy link

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators Dec 15, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
target: major This PR is targeted for the next major release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants