feat: add a navigateTo -> navigate codemod #7532
Merged
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
Note: this makes an assumption that we support ESM in the absence of any require or import statements... we _have_ to make an assumption though, so this seems like at least a decent fallback
DSchau
commented
Aug 22, 2018
| @@ -32,14 +32,18 @@ function addEsmImport(j, root, tag) { | |||
| return // already exists | |||
|
|
|||
| if (!existingImport.length) { | |||
| const first = root.find(j.Program).get('body', 0) | |||
There was a problem hiding this comment.
We may not actually need this because there will likely be a import React from 'react'; or const React = require('react'); as the first line, correct? If that's the case, I can tweak this a bit and just use insertAfter
| @@ -119,7 +123,12 @@ module.exports = (file, api, options) => { | |||
| let tag = tags.get(0) | |||
|
|
|||
| const useImportSyntax = | |||
| root.find(j.ImportDeclaration, { importKind: `value` }).length > 0 | |||
| root.find(j.ImportDeclaration, { importKind: `value` }).length > 0 || | |||
| root.find(j.VariableDeclarator, { | |||
There was a problem hiding this comment.
This is an assumption. If there isn't any import or require statement, we have to make a decision here. I think we should prefer esm, but I'd rather not make any assumption--thus see above where I think we'll always have at least one import/require statement in the file
m-allanson
approved these changes
Sep 3, 2018
There was a problem hiding this comment.
Thanks @DSchau, this looks great 👍 How do you feel about merging it in so people can try it out?
| import React from "react" | ||
| import { navigate } from 'gatsby'; | ||
|
|
||
| // Don't use navigate with an onClick btw :-) |
Merged
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
This PR adds a (probably at least somewhat naive) codemod for migrating from navigateTo to navigate. I think there's still more to do here, but this should at least be a good start.
Additionally, I fixed the commented out test in the other, existing codemod.
Consider this kind of a WIP, I want to write a few more tests before I'd be comfortable with other people actually using this thing.