Skip to content

Commit

Permalink
feat(angular): add helper function to devkit to add viewProviders to …
Browse files Browse the repository at this point in the history
…a component (#26526)

## Current Behavior

Angular Nx utils have `addProviderToComponent` function to add a
provider to an Angular component, but are missing a function to add
viewProviders.

## Expected Behavior

There should be a function like `addProviderToComponent` to add view
providers to a component.

Co-authored-by: Leosvel Pérez Espinosa <[email protected]>
(cherry picked from commit 15b7e9f)
  • Loading branch information
Olster authored and FrozenPandaz committed Jun 21, 2024
1 parent 42fc597 commit b099cd7
Show file tree
Hide file tree
Showing 3 changed files with 71 additions and 0 deletions.
1 change: 1 addition & 0 deletions packages/angular/src/utils/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ export {
addProviderToAppConfig,
addProviderToComponent,
addProviderToModule,
addViewProviderToComponent,
} from './nx-devkit/ast-utils';

export { addRoute, addProviderToRoute } from './nx-devkit/route-utils';
47 changes: 47 additions & 0 deletions packages/angular/src/utils/nx-devkit/ast-utils.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import {
addImportToPipe,
addProviderToAppConfig,
addProviderToBootstrapApplication,
addViewProviderToComponent,
isStandalone,
} from './ast-utils';
import { createTreeWithEmptyWorkspace } from '@nx/devkit/testing';
Expand Down Expand Up @@ -334,4 +335,50 @@ export const appConfig: ApplicationConfig = {
};"
`);
});

it('should add view provider to a component', () => {
// ARRANGE
const pathToComponent = 'app.component.ts';
const componentOriginal = `import { Component } from '@angular/core';
@Component({
selector: 'app-app',
template: ''
})
export class AppComponent {}
`;
const providerName = 'MyViewProvider';

const tree = createTreeWithEmptyWorkspace({ layout: 'apps-libs' });

tree.write(pathToComponent, componentOriginal);

const tsSourceFile = createSourceFile(
pathToComponent,
componentOriginal,
ScriptTarget.Latest,
true
);

// ACT
addViewProviderToComponent(
tree,
tsSourceFile,
pathToComponent,
providerName
);

// ASSERT
expect(tree.read(pathToComponent, 'utf-8')).toMatchInlineSnapshot(`
"import { Component } from '@angular/core';
@Component({
selector: 'app-app',
template: '',
viewProviders: [MyViewProvider]
})
export class AppComponent {}
"
`);
});
});
23 changes: 23 additions & 0 deletions packages/angular/src/utils/nx-devkit/ast-utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -826,6 +826,29 @@ export function addProviderToComponent(
);
}

/**
* Add a view provider to a Standalone Component
* @param host Virtual Tree
* @param source TS Source File containing the Component
* @param componentPath Path to the Component
* @param symbolName The provider to add
*/
export function addViewProviderToComponent(
host: Tree,
source: ts.SourceFile,
componentPath: string,
symbolName: string
): ts.SourceFile {
return _addSymbolToDecoratorMetadata(
host,
source,
componentPath,
'viewProviders',
symbolName,
'Component'
);
}

export function addDeclarationToModule(
host: Tree,
source: ts.SourceFile,
Expand Down

0 comments on commit b099cd7

Please sign in to comment.