-
-
Notifications
You must be signed in to change notification settings - Fork 2k
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
feat(store): add createFeatureSelector migration #3214
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
import { Tree } from '@angular-devkit/schematics'; | ||
import { | ||
SchematicTestRunner, | ||
UnitTestTree, | ||
} from '@angular-devkit/schematics/testing'; | ||
import * as path from 'path'; | ||
|
||
describe('Store Migration 13_0_0 beta', () => { | ||
const collectionPath = path.join(__dirname, '../migration.json'); | ||
const pkgName = 'store'; | ||
|
||
it(`should replace createFeatureSelector usages with 2 generics`, async () => { | ||
const contents = ` | ||
import {createFeatureSelector} from '@ngrx/store' | ||
|
||
// untouched | ||
const featureSelector1 = createFeatureSelector('feature1'); | ||
const featureSelector2 = createFeatureSelector<Feature>(feature2); | ||
const featureSelector3 = createFeatureSelector<State,Feature,SomethingElse>(feature3); | ||
const featureSelector4 = createFeatureSelector<fromFeat.State>('feature4'); | ||
|
||
// modified | ||
const featureSelector5 = createFeatureSelector<State, Feature>('feature5'); | ||
const featureSelector6 = createFeatureSelector<State,Feature>(feature6); | ||
const featureSelector7 = createFeatureSelector<fromRoot.State, fromFeat.State>('feature7'); | ||
`; | ||
|
||
const expected = ` | ||
import {createFeatureSelector} from '@ngrx/store' | ||
|
||
// untouched | ||
const featureSelector1 = createFeatureSelector('feature1'); | ||
const featureSelector2 = createFeatureSelector<Feature>(feature2); | ||
const featureSelector3 = createFeatureSelector<State,Feature,SomethingElse>(feature3); | ||
const featureSelector4 = createFeatureSelector<fromFeat.State>('feature4'); | ||
|
||
// modified | ||
const featureSelector5 = createFeatureSelector< Feature>('feature5'); | ||
const featureSelector6 = createFeatureSelector<Feature>(feature6); | ||
const featureSelector7 = createFeatureSelector< fromFeat.State>('feature7'); | ||
`; | ||
|
||
const appTree = new UnitTestTree(Tree.empty()); | ||
appTree.create('./fixture.ts', contents); | ||
const runner = new SchematicTestRunner('schematics', collectionPath); | ||
|
||
const newTree = await runner | ||
.runSchematicAsync(`ngrx-${pkgName}-migration-13-beta`, {}, appTree) | ||
.toPromise(); | ||
const file = newTree.readContent('fixture.ts'); | ||
|
||
expect(file).toBe(expected); | ||
}); | ||
}); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
import * as ts from 'typescript'; | ||
import { Rule, chain, Tree } from '@angular-devkit/schematics'; | ||
import { | ||
visitTSSourceFiles, | ||
RemoveChange, | ||
commitChanges, | ||
} from '../../schematics-core'; | ||
|
||
function updateCreateFeatureSelectorGenerics(): Rule { | ||
return (tree: Tree) => { | ||
visitTSSourceFiles(tree, (sourceFile) => { | ||
const runMigration = sourceFile.statements | ||
.filter(ts.isImportDeclaration) | ||
.filter( | ||
(importDeclaration) => | ||
importDeclaration.moduleSpecifier.getText(sourceFile) === | ||
"'@ngrx/store'" || | ||
importDeclaration.moduleSpecifier.getText(sourceFile) === | ||
'"@ngrx/store"' | ||
) | ||
.some((importDeclaration) => { | ||
return importDeclaration.importClause?.namedBindings | ||
?.getText(sourceFile) | ||
.includes('createFeatureSelector'); | ||
}); | ||
|
||
if (!runMigration) return; | ||
|
||
const changes: RemoveChange[] = []; | ||
ts.forEachChild(sourceFile, crawl); | ||
return commitChanges(tree, sourceFile.fileName, changes); | ||
|
||
function crawl(node: ts.Node) { | ||
ts.forEachChild(node, crawl); | ||
|
||
if (!ts.isCallExpression(node)) return; | ||
if (node.typeArguments?.length !== 2) return; | ||
if (!ts.isIdentifier(node.expression)) return; | ||
if (node.expression.text !== 'createFeatureSelector') return; | ||
|
||
changes.push( | ||
new RemoveChange( | ||
sourceFile.fileName, | ||
node.typeArguments[0].pos, | ||
node.typeArguments[1].pos | ||
) | ||
); | ||
} | ||
}); | ||
}; | ||
} | ||
|
||
export default function (): Rule { | ||
return chain([updateCreateFeatureSelectorGenerics()]); | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Based on the previous migration names:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yea... 😅
The name doesn't really matter (it's only important to run the schematic in the test).
I was thinking it would make more sense to follow the versions, instead of creating an own counter.