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

docs: describe how to configure CommonJS modules #37331

Closed
wants to merge 1 commit into from

Conversation

aikithoughts
Copy link
Contributor

In version 10, we have a new option for the angular.json file,
allowedCommonJsDependencies, so users can opt in to support
CommonJS modules.

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • angular.io application / infrastructure changes
  • Other... Please describe:

What is the current behavior?

Current documentation does not describe how to configure the angular.json file to support CommonJS modules.

Issue Number: N/A

What is the new behavior?

Add section that describes how to configure the angular.json file to support CommonJS modules.

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

@mary-poppins
Copy link

You can preview d480de2 at https://pr37331-d480de2.ngbuilds.io/.

Copy link
Contributor Author

@aikithoughts aikithoughts left a comment

Choose a reason for hiding this comment

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

Feedback incorporated. Thank you!

aio/content/guide/build.md Show resolved Hide resolved
@mary-poppins
Copy link

You can preview aa6f505 at https://pr37331-aa6f505.ngbuilds.io/.

@mary-poppins
Copy link

You can preview 9a8e59c at https://pr37331-9a8e59c.ngbuilds.io/.

Copy link
Contributor Author

@aikithoughts aikithoughts left a comment

Choose a reason for hiding this comment

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

Thanks for the feedback!

aio/content/guide/build.md Outdated Show resolved Hide resolved
@alan-agius4 alan-agius4 added the target: patch This PR is targeted for the next patch release label Jun 9, 2020
Copy link
Contributor

@alan-agius4 alan-agius4 left a comment

Choose a reason for hiding this comment

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

2 small nits

  • Can we changes {@a commonjs } to {@a commonjs-dependencies }
  • Can you fixup your commits please?

@alan-agius4 alan-agius4 added the action: cleanup The PR is in need of cleanup, either due to needing a rebase or in response to comments from reviews label Jun 9, 2020
@aikithoughts aikithoughts added effort2: days risk: low and removed action: cleanup The PR is in need of cleanup, either due to needing a rebase or in response to comments from reviews labels Jun 9, 2020
@ngbot ngbot bot modified the milestones: needsTriage, Backlog Jun 9, 2020
@aikithoughts aikithoughts added this to In Review in docs Jun 9, 2020
@aikithoughts aikithoughts added the action: merge The PR is ready for merge by the caretaker label Jun 9, 2020
@mary-poppins
Copy link

You can preview d6e7954 at https://pr37331-d6e7954.ngbuilds.io/.

Copy link
Contributor

@IgorMinar IgorMinar left a comment

Choose a reason for hiding this comment

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

LGTM after the suggested tweaks, but I would also consider adding language around our intention to turn off the commonjs support in the future and making it an opt-in instead.

aio/content/guide/build.md Outdated Show resolved Hide resolved
aio/content/guide/build.md Outdated Show resolved Hide resolved
aio/content/guide/build.md Outdated Show resolved Hide resolved
@IgorMinar IgorMinar added the action: cleanup The PR is in need of cleanup, either due to needing a rebase or in response to comments from reviews label Jun 10, 2020
Copy link
Contributor

@ajitsinghkaler ajitsinghkaler left a comment

Choose a reason for hiding this comment

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

you can checkout https://angular.io/guide/docs-style-guide#markdown-and-html if you have any doubts

aio/content/guide/build.md Show resolved Hide resolved
aio/content/guide/build.md Show resolved Hide resolved
Copy link
Contributor

@IgorMinar IgorMinar left a comment

Choose a reason for hiding this comment

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

Adding more suggestions

aio/content/guide/build.md Outdated Show resolved Hide resolved
@mary-poppins
Copy link

You can preview 12db3ac at https://pr37331-12db3ac.ngbuilds.io/.

@aikithoughts aikithoughts removed the action: cleanup The PR is in need of cleanup, either due to needing a rebase or in response to comments from reviews label Jun 11, 2020
In version 10, we have a new option for the `angular.json` file,
`allowedCommonJsDependencies`, so users can opt in to support
CommonJS modules.
mhevery pushed a commit that referenced this pull request Jun 15, 2020
In version 10, we have a new option for the `angular.json` file,
`allowedCommonJsDependencies`, so users can opt in to support
CommonJS modules.

PR Close #37331
@mhevery mhevery closed this in adc9d5c Jun 15, 2020
ngwattcos pushed a commit to ngwattcos/angular that referenced this pull request Jun 25, 2020
In version 10, we have a new option for the `angular.json` file,
`allowedCommonJsDependencies`, so users can opt in to support
CommonJS modules.

PR Close angular#37331
@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 Jul 16, 2020
profanis pushed a commit to profanis/angular that referenced this pull request Sep 5, 2020
In version 10, we have a new option for the `angular.json` file,
`allowedCommonJsDependencies`, so users can opt in to support
CommonJS modules.

PR Close angular#37331
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
action: merge The PR is ready for merge by the caretaker cla: yes effort2: days risk: low target: patch This PR is targeted for the next patch release type: bug/fix
Projects
docs
In Review
Development

Successfully merging this pull request may close these issues.

None yet

8 participants