Skip to content

docs: add Angular CLI autocompletion doc #23146

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 1 commit into from
May 18, 2022

Conversation

dgp1130
Copy link
Collaborator

@dgp1130 dgp1130 commented May 17, 2022

Spin off from angular/angular#45995.

This explains how to set up autocompletion with the Angular CLI:

  1. Via the automated prompt on first execution.
  2. Via ng completion.
  3. Manually via appending source <(ng completion script) to the user's ~/.bashrc file.

It also specifically calls out supported and unsupported platforms as well as the requirement for a global install of the Angular CLI.

The demo /generated/images/guide/cli/completion.gif needs to be merged to the angular/angular repository. angular/angular#45995 will submit that image so it can be used from this doc.

@mgechev, not sure if you want anyone from the docs team to take an edit pass on this?

/cc @twerske, @alan-agius4

@dgp1130 dgp1130 added the target: rc This PR is targeted for the next release-candidate label May 17, 2022
@dgp1130 dgp1130 added this to the v14 milestone May 17, 2022
@dgp1130 dgp1130 requested a review from clydin May 17, 2022 00:45
alan-agius4
alan-agius4 previously approved these changes May 17, 2022
@mgechev
Copy link
Member

mgechev commented May 17, 2022

@dgp1130, just shared a link with Bob and will forward to our editor as well.

Copy link

@TMDavisGoogle TMDavisGoogle left a comment

Choose a reason for hiding this comment

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

Light edits (punctuation, rewording for clarity) made.

This explains how to set up autocompletion with the Angular CLI:

1. Via the automated prompt on first execution.
2. Via `ng completion`.
3. Manually via appending `source <(ng completion script)` to the user's `~/.bashrc` file.

It also specifically calls out supported and unsupported platforms as well as the requirement for a global install of the Angular CLI.
@dgp1130
Copy link
Collaborator Author

dgp1130 commented May 17, 2022

@TMDavisGoogle, thanks! Applied all your suggestions.

@dgp1130 dgp1130 requested a review from TMDavisGoogle May 17, 2022 21:45
Copy link

@TMDavisGoogle TMDavisGoogle left a comment

Choose a reason for hiding this comment

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

LGTM.

@clydin clydin removed their request for review May 18, 2022 13:34
@dgp1130 dgp1130 added the action: merge The PR is ready for merge by the caretaker label May 18, 2022
@clydin clydin merged commit f6b52e4 into angular:main May 18, 2022
@dgp1130 dgp1130 deleted the autocompletion-doc branch May 18, 2022 18:24
dgp1130 added a commit to dgp1130/angular that referenced this pull request May 20, 2022
The CLI autocompletion doc added in angular/angular-cli#23146 includes a demo GIF, but AIO currently has no infrastructure to pull assets like images from the CLI repository, so this demo needs to be stored directly in AIO on this repository.
alxhub pushed a commit to angular/angular that referenced this pull request May 23, 2022
The CLI autocompletion doc added in angular/angular-cli#23146 includes a demo GIF, but AIO currently has no infrastructure to pull assets like images from the CLI repository, so this demo needs to be stored directly in AIO on this repository.

PR Close #45995
alxhub pushed a commit to angular/angular that referenced this pull request May 23, 2022
The CLI autocompletion doc added in angular/angular-cli#23146 includes a demo GIF, but AIO currently has no infrastructure to pull assets like images from the CLI repository, so this demo needs to be stored directly in AIO on this repository.

PR Close #45995
@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 Jun 18, 2022
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 target: rc This PR is targeted for the next release-candidate
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants