Implement codemod transform which replaces enum usage with string literal #1639
Conversation
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
🦋 Changeset detectedLatest commit: a67d809 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Dogdriip
changed the title
Codecov ReportAll modified lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1639 +/- ##
=======================================
Coverage 87.23% 87.23%
=======================================
Files 281 281
Lines 3900 3900
Branches 820 820
=======================================
Hits 3402 3402
Misses 424 424
Partials 74 74 ☔ View full report in Codecov by Sentry. |
Dogdriip
changed the title
sungik-choi
reviewed
Sep 21, 2023
Dogdriip
commented
Sep 26, 2023
Comment on lines
10
to
36
| sourceFile.forEachDescendant((node) => { | ||
| if (node.isKind(SyntaxKind.PropertyAccessExpression)) { | ||
| const firstIdentifier = node.getFirstChildByKind(SyntaxKind.Identifier) | ||
| const lastIdentifier = node.getLastChildByKind(SyntaxKind.Identifier) | ||
|
|
||
| if (firstIdentifier && lastIdentifier) { | ||
| const declarationSymbol = firstIdentifier.getSymbol() | ||
| const memberValueDeclaration = lastIdentifier.getSymbol()?.getValueDeclaration() | ||
|
|
||
| if (Node.isEnumMember(memberValueDeclaration)) { | ||
| const enumName = declarationSymbol?.getName() | ||
| const enumMemberValue = memberValueDeclaration.getInitializer()?.getText() | ||
|
|
||
| if (enumName && enumMemberValue && targetEnums.includes(enumName)) { | ||
| const ancestor = node.getFirstAncestor() | ||
| if (ancestor?.isKind(SyntaxKind.JsxExpression)) { | ||
| ancestor.replaceWithText(`'${enumMemberValue.slice(1, -1)}'`) | ||
| } else { | ||
| node.replaceWithText(`'${enumMemberValue.slice(1, -1)}'`) | ||
| } | ||
|
|
||
| enumNames.push(enumName) | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }) |
There was a problem hiding this comment.
PropertyAccessExpression을 찾아 첫 identifier와 마지막 identifier를 찾습니다.
- ex)
Enum1.A.B.C->Enum1,C
- 첫 identifier의 symbol과 마지막 identifier의 valueDeclaration을 봅니다.
- 각각 enum 이름과 enum member 이름이 됩니다.
enumMemberValue.slice(1, -1)으로 값을 대체합니다.
- enum member 이름에 single quote가 있어, 앞뒤 글자를 자릅니다 (
'green-alt'식으로 되어있음) - JSX에 사용되는 경우 중괄호까지 replace해야 하므로 ancestor를 건드립니다.
기존에 작성했던 |
sungik-choi
reviewed
Sep 26, 2023
There was a problem hiding this comment.
👍 README도 업데이트해주시면 감사하겠습니다~!
(Ref: https://nextjs.org/docs/app/building-your-application/upgrading/codemods)
packages/bezier-codemod/src/transforms/common/enum-member-to-string-literal.ts
Outdated
Show resolved
Hide resolved
packages/bezier-codemod/src/transforms/progress-bar-string-literal-variants.ts
Outdated
Show resolved
Hide resolved
yangwooseong
approved these changes
Sep 26, 2023
sungik-choi
approved these changes
Sep 26, 2023
sungik-choi
approved these changes
Sep 27, 2023
This was referenced Sep 27, 2023
sungik-choi
pushed a commit
that referenced
this pull request
Sep 27, 2023
This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated. # Releases ## @channel.io/[email protected] ### Minor Changes - Implement codemod transform which replaces enum usage with string literal ([#1639](#1639)) by @Dogdriip Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
This was referenced Dec 15, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Self Checklist
Related Issue
ProgressBarSize,ProgressBarVariantstring literal type and deprecate enum #1595Summary
ProgressBarSize,ProgressBarVariantstring literal type and deprecate enum #1595 에서ProgressBar의 Size, Variant에 대해 string literal을 사용하고 enum을 deprecate함에 따라, enum 사용을 이에 대응하는 string literal로 변경하는 codemod를 작성합니다.Details
transforms/progress-bar-string-literal-variants.tsEnumTransforms: Record<string, Record<string, string>>형식으로 작성합니다.ProgressBarVariantProgressBarSizeBreaking change? (Yes/No)
References