Skip to content

fix(@angular/cli): only load autocompletion in interactive shells #34401

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.

Sign up for GitHub

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
clydin merged 2 commits into from
Oct 20, 2026
+21 −52
Merged

fix(@angular/cli): only load autocompletion in interactive shells #34401

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
10949d0
fix(@angular/cli): only load autocompletion in interactive shells
clydin Oct 19, 2026
521fb0e
fixup! fix(@angular/cli): only load autocompletion in interactive shells
clydin Oct 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion packages/angular/cli/src/commands/completion/long-description.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,9 @@ more control over exactly where this configuration lives, you can manually set i
shell run at startup:

```bash
source <(ng completion script)
if [[ $- == *i* ]]; then
source <(ng completion script)
fi
Comment thread
clydin marked this conversation as resolved.
```

This is equivalent to what `ng completion` will automatically set up, and gives power users more
Expand Down
2 changes: 1 addition & 1 deletion packages/angular/cli/src/utilities/completion.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,7 @@ export async function initializeAutocomplete(): Promise<string> {
try {
await fs.appendFile(
rcFile,
'\n\n# Load Angular CLI autocompletion.\nsource <(ng completion script)\n',
'\n\n# Load Angular CLI autocompletion for interactive shells.\nif [[ $- == *i* ]]; then\n source <(ng completion script)\nfi\n',
);
} catch (err) {
assertIsError(err);
Expand Down
67 changes: 17 additions & 50 deletions tests/e2e/tests/commands/completion/completion.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,13 @@ import {

const testRegistry = getGlobalVariable('package-registry');

const AUTOCOMPLETION_SNIPPET = `
# Load Angular CLI autocompletion for interactive shells.
if [[ $- == *i* ]]; then
source <(ng completion script)
fi
`.trim();
Comment thread
clydin marked this conversation as resolved.

export default async function () {
// Windows Cmd and Powershell do not support autocompletion. Run a different set of tests to
// confirm autocompletion fails gracefully.
Expand All @@ -33,11 +40,7 @@ export default async function () {
);

const rcContents = await fs.readFile(path.join(home, '.bashrc'), 'utf-8');
const expected = `
# Load Angular CLI autocompletion.
source <(ng completion script)
`.trim();
if (!rcContents.includes(expected)) {
if (!rcContents.includes(AUTOCOMPLETION_SNIPPET)) {
throw new Error(`~/.bashrc does not contain autocompletion script. Contents:\n${rcContents}`);
}
});
Expand All @@ -55,11 +58,7 @@ source <(ng completion script)
);

const rcContents = await fs.readFile(path.join(home, '.zshrc'), 'utf-8');
const expected = `
# Load Angular CLI autocompletion.
source <(ng completion script)
`.trim();
if (!rcContents.includes(expected)) {
if (!rcContents.includes(AUTOCOMPLETION_SNIPPET)) {
throw new Error(`~/.zshrc does not contain autocompletion script. Contents:\n${rcContents}`);
}
});
Expand All @@ -79,11 +78,7 @@ source <(ng completion script)
);

const rcContents = await fs.readFile(bashrc, 'utf-8');
const expected = `# Other commands...

# Load Angular CLI autocompletion.
source <(ng completion script)
`;
const expected = `# Other commands...\n\n${AUTOCOMPLETION_SNIPPET}\n`;
if (rcContents !== expected) {
throw new Error(`~/.bashrc does not match expectation. Contents:\n${rcContents}`);
}
Expand All @@ -104,11 +99,7 @@ source <(ng completion script)
);

const rcContents = await fs.readFile(bashProfile, 'utf-8');
const expected = `# Other commands...

# Load Angular CLI autocompletion.
source <(ng completion script)
`;
const expected = `# Other commands...\n\n${AUTOCOMPLETION_SNIPPET}\n`;
if (rcContents !== expected) {
throw new Error(`~/.bash_profile does not match expectation. Contents:\n${rcContents}`);
}
Expand All @@ -129,11 +120,7 @@ source <(ng completion script)
);

const rcContents = await fs.readFile(profile, 'utf-8');
const expected = `# Other commands...

# Load Angular CLI autocompletion.
source <(ng completion script)
`;
const expected = `# Other commands...\n\n${AUTOCOMPLETION_SNIPPET}\n`;
if (rcContents !== expected) {
throw new Error(`~/.profile does not match expectation. Contents:\n${rcContents}`);
}
Expand All @@ -159,11 +146,7 @@ source <(ng completion script)
);

const bashrcContents = await fs.readFile(bashrc, 'utf-8');
const bashrcExpected = `# \`.bashrc\` commands...

# Load Angular CLI autocompletion.
source <(ng completion script)
`;
const bashrcExpected = `# \`.bashrc\` commands...\n\n${AUTOCOMPLETION_SNIPPET}\n`;
if (bashrcContents !== bashrcExpected) {
throw new Error(`~/.bashrc does not match expectation. Contents:\n${bashrcContents}`);
}
Expand Down Expand Up @@ -194,11 +177,7 @@ source <(ng completion script)
);

const rcContents = await fs.readFile(zshrc, 'utf-8');
const expected = `# Other commands...

# Load Angular CLI autocompletion.
source <(ng completion script)
`;
const expected = `# Other commands...\n\n${AUTOCOMPLETION_SNIPPET}\n`;
if (rcContents !== expected) {
throw new Error(`~/.zshrc does not match expectation. Contents:\n${rcContents}`);
}
Expand All @@ -219,11 +198,7 @@ source <(ng completion script)
);

const rcContents = await fs.readFile(zshProfile, 'utf-8');
const expected = `# Other commands...

# Load Angular CLI autocompletion.
source <(ng completion script)
`;
const expected = `# Other commands...\n\n${AUTOCOMPLETION_SNIPPET}\n`;
if (rcContents !== expected) {
throw new Error(`~/.zsh_profile does not match expectation. Contents:\n${rcContents}`);
}
Expand All @@ -244,11 +219,7 @@ source <(ng completion script)
);

const rcContents = await fs.readFile(profile, 'utf-8');
const expected = `# Other commands...

# Load Angular CLI autocompletion.
source <(ng completion script)
`;
const expected = `# Other commands...\n\n${AUTOCOMPLETION_SNIPPET}\n`;
if (rcContents !== expected) {
throw new Error(`~/.profile does not match expectation. Contents:\n${rcContents}`);
}
Expand All @@ -274,11 +245,7 @@ source <(ng completion script)
);

const zshrcContents = await fs.readFile(zshrc, 'utf-8');
const zshrcExpected = `# \`.zshrc\` commands...

# Load Angular CLI autocompletion.
source <(ng completion script)
`;
const zshrcExpected = `# \`.zshrc\` commands...\n\n${AUTOCOMPLETION_SNIPPET}\n`;
if (zshrcContents !== zshrcExpected) {
throw new Error(`~/.zshrc does not match expectation. Contents:\n${zshrcContents}`);
}
Expand Down
Loading