villesau / optional-chaining-codemod Goto Github PK

Codemod to migrate from Lodash get and logical and expressions to optional chaining

License: MIT License

JavaScript 92.52% TypeScript 7.48%

codemod codemods jscodeshift optional-chaining es7 es6 javascript transform

optional-chaining-codemod's Introduction

Optional chaining codemod

This is a codemod to migrate different types of lodash get calls and a && a.b kind of expressions to use optional chaining and nullish coalescing instead.

Following babel plugins are required to transpile optional chaining and nullish coalescing:

What it does?

a && a.b becomes a?.b
_.get(foo, 'a.b') and _.get(foo, ['a', 'b']) becomes foo?.a?.b
_.get(foo, 'a.b', defaultValue) becomes foo?.a?.b ?? defaultValue

You can check out the __textfixtures__ folder to see full list of supported transformations.

Why should I migrate to use optional chaining?

When using static type checkers like Flow or Typescript, optional chaining provides much better type safety than lodash get. Optional chaining is standard Javascript feature.
It also has a neater syntax than chaining && expressions one after another.

Install

$ yarn global add optional-chaining-codemod

$ npm install -g optional-chaining-codemod

Usage

$ optional-chaining-codemod ./**/*.js --ignore-pattern="**/node_modules/**"

with flow parser:

$ optional-chaining-codemod ./**/*.js --ignore-pattern="**/node_modules/**" --parser=flow

with typescript parser:

$ optional-chaining-codemod ./**/*.ts --ignore-pattern="**/node_modules/**" --parser=ts

with typescript+react parser:

$ optional-chaining-codemod ./**/*.tsx --parser=tsx

The CLI is the same as in jscodeshift except you can omit the transform file.

Alternatively, you can run the codemod using jscodeshift as follows:

$ yarn global add jscodeshift
$ yarn add optional-chaining-codemod
$ jscodeshift -t node_modules/optional-chaining-codemod/transform.js --ignore-pattern="**/node_modules/**" ./**/*.js

flags

This codemod has two flags:

--skipVariables to skip variables passed to lodash get
--skipTemplateStrings to skip template strings passed to lodash get

Especially the first case is risky as the variable might actually be something like var bar = "a.b.c" and produce from _.get(foo, bar) following: foo?[bar] although lodash would treat it like foo?.a?.b?.c".

Contributing

Contributions are more than welcome! One area of improvement could be e.g better CLI or finding out new areas to migrate to use optional chaining.

optional-chaining-codemod's People

Contributors

Stargazers

Watchers

Forkers

devjv derekstavis benmonro daveisfera fauxfaux shaharkazaz xyy94813 pezmc piyushimraw connorjclark adrienj lautis

optional-chaining-codemod's Issues

array syntax

looks like i might have found an edge case for you:

     get(foo, 'bar[0]["60"]')

is transforming to

      foo?.bar?.0]["60"

how to run against typescript codebase?

congrats on this codemod

how to run against typscript codebase?

Doesn't handle passing array reference as path

This example

import { get } from 'lodash';

const obj = { a: { b: { c: { d: 1 }}}};
const path = ['a','b','c','d'];

get(obj, path);

Turns into:

const obj = { a: { b: { c: { d: 1 }}}};
const path = ['a','b','c','d'];

obj?.[path];

Which is incorrect, obv. Will try to do a follow-up PR to tackle this issue.

another edge case

input

const id = correlations && correlations.id;

output

const { id } = correlations;

expected output

const id = correlations?.id;

Doesn't handle curried versions of `get()` and `getOr()`

One last big thanks for the awesome codemod!

Curried versions of get() and getOr() cause an error:

TypeError: Cannot read property 'type' of undefined
    at skip (/Users/dlj/projects/optional-chaining-codemod/transform.js:82:35)
    at NodePath.<anonymous> (/Users/dlj/projects/optional-chaining-codemod/transform.js:133:9)
    at NodePath.<anonymous> (/usr/local/lib/node_modules/jscodeshift/src/collections/Node.js:142:47)
    at /usr/local/lib/node_modules/jscodeshift/src/Collection.js:75:36
    at Array.forEach (<anonymous>)
    at Collection.forEach (/usr/local/lib/node_modules/jscodeshift/src/Collection.js:74:18)
    at Collection.replaceWith (/usr/local/lib/node_modules/jscodeshift/src/collections/Node.js:140:17)
    at Collection.replaceWith (/usr/local/lib/node_modules/jscodeshift/src/Collection.js:413:43)
    at mangleLodashGets (/Users/dlj/projects/optional-chaining-codemod/transform.js:132:8)
    at module.exports (/Users/dlj/projects/optional-chaining-codemod/transform.js:313:3)

But they could be turned into fat arrow functions using the existing logic, like the following:
get('value') to v => v?.value
getOr(default, 'value') to v => v?.value ?? default

`some.object && some.object.fn()` and `this.object && this.object.value` not handled

I used this tool on a large codebase, and came across some cases that were missed. Here's
everything I found:

GoogleChrome/lighthouse#13503 (comment)
(link to code at particular commit)
https://github.com/GoogleChrome/lighthouse/tree/11a6a030f3e29910be6dc1166f17e085c17da6da

I believe the following specific examples show every unique case missed.

Does not transform:

const hasMetricError = lhr.categories.performance && lhr.categories.performance.auditRefs
  .some(audit => Boolean(audit.group === 'metrics' && lhr.audits[audit.id].errorMessage));

But it will transform this:

const hasMetricError = lhr.categories.performance && lhr.categories.performance.auditRefs;

Perhaps function calls are not handled?

Does not transform:

this.json.audits['script-treemap-data'] && this.json.audits['script-treemap-data'].details

this.json.audits.blah && this.json.audits.blah.details

Perhaps this. is not handled?

Could further reduce `.length > 0` checks

Thanks once again for this saaaaweeeet codemod!

This line of code item && item.props && item.props.data && item.props.data.length > 0 is reduced to two statementsitem?.props?.data && item.props.data.length > 0 but it could be reduced to a single statement item?.props?.data?.length > 0

`b && b[0]` -> `b?.[0]` makes me nauseous

b && b[0] currently gets transformed to b?.[0].

Personally, I'm not ready for this monster. ?.[. Just look at it.

Could this specific transform be made optional, please?

Support lodash/fp?

Hi, thanks for making this!

The get function from lodash/fp flips the arguments. Would it be possible to support this?

https://github.com/lodash/lodash/wiki/FP-Guide

`import * as _ from "lodash"` not handled

The "recommended" way to import lodash in TS is import * as _ from "lodash";, the import _ from "lodash"; is Kinda Legacy(tm). The tool does not support this style.

If you change the import in typescript.input.ts, the import and the calls on it are ignored:

  ● lodash get to optional chaining › flags › typescript › transform › transforms correctly using "typescript" data

    expect(received).toEqual(expected) // deep equality

    - Expected
    + Received

    + import * as _ from "lodash";
    +
    - const foo1  = bar?.a?.b?.c;
    + const foo1  = _.get(bar, "a.b.c");
      const foo2  = bar?.a?.b?.c;
...
      const foo9  = bar?.a?.[foo5]?.c ?? "what";
      const foo10 = bar?.a?.[foo5]?.c ?? barr;
    - const foo11 = bar?.a?.[foo5];
    + const foo11 = _.get(bar, `a.${foo5}`);
    - const foo12 = bar?.a?.[foo5]?.smthng;
...

can we also handle `idx` calls?

input:

const value = idx(obj, _ => _.a.b.c)

output:

const value = obj?.a?.b?.c

Handling `just-safe-get`

It would be great if it could also handle https://www.npmjs.com/package/just-safe-get

nested w/ array elements

found Another use case. :)

input:

foo && foo[0] && foo[0].bar

output:

foo?.[0] && foo[0].bar

expected:

foo?.[0]?.bar

not sure what to title this one :)

pretty sure this one is a bug though:

input

foo[bar] && foo[bar].baz

output

foo[bar]?.[baz]

expected

foo[bar]?.baz

Doesn't put "invalid" names in string

Thanks for this awesome codemod!

While running on our code, we noticed that it doesn't handle names that need to be made strings correctly. For example, get(['value', 'something-else'], data) is changed to data?.value?.something-else when it should be data?.value?.['something-else']

Wrong result with `BinaryExpression` when migrate Lodash `get` calls

Test Case:

_.get(object, 'property', 0) + 1
_.get(object, 'property', 0) > 1

Now:

object?.property ?? 0 + 1
object?.property ?? 0 > 1

Except:
(object?.property ?? 0) + 1
(object?.property ?? 0) > 1

Doesn't handle getOr from lodash/fp

get with an argument for the default from lodash is handled, but not getOr from lodash/fp

kudos

I would like to file an issue giving you Kudos. Bless you for making this codemod. no really. this is so good. bless your heart!

dashes use case

get(foo, "bar.data-thing-a-mabob");

transforms into this which is invalid:

 foo?.bar?.data-thing-a-mabob;

should be transformed to

foo?.bar?.["data-thing-a-mabob"]

Doesn't reduce `getOr(false, ...)` correctly

Thanks again for this awesome codemod!

getOr(false, 'value', data) is kind of silly, but it's reduced to data?.value ?? false when it should just be data?.value since it will already be falsy and eslint doesn't like ?? false

bug on edge case

input

const padding = (info.padding && info.padding[info.level]) || '';

output

const padding = info.padding?.info.level || '';

it should be:

const padding = info.padding?[info.level] || '';

Transformation error (did not recognize object of type "ChainExpression")

Seems the codemod does not support running on code that already utilizes optional chaining.

lighthouse-core/computed/metrics/timing-summary.js Transformation error (did not recognize object of type "ChainExpression")
Error: did not recognize object of type "ChainExpression"
    at Object.getFieldNames (/Users/cjamcl/.npm/_npx/42135/lib/node_modules/optional-chaining-codemod/node_modules/ast-types/lib/types.js:661:19)
    at visitChildren (/Users/cjamcl/.npm/_npx/42135/lib/node_modules/optional-chaining-codemod/node_modules/ast-types/lib/path-visitor.js:186:36)
    at Visitor.PVp.visitWithoutReset (/Users/cjamcl/.npm/_npx/42135/lib/node_modules/optional-chaining-codemod/node_modules/ast-types/lib/path-visitor.js:168:20)
    at visitChildren (/Users/cjamcl/.npm/_npx/42135/lib/node_modules/optional-chaining-codemod/node_modules/ast-types/lib/path-visitor.js:205:25)
    at Visitor.PVp.visitWithoutReset (/Users/cjamcl/.npm/_npx/42135/lib/node_modules/optional-chaining-codemod/node_modules/ast-types/lib/path-visitor.js:168:20)
    at NodePath.each (/Users/cjamcl/.npm/_npx/42135/lib/node_modules/optional-chaining-codemod/node_modules/ast-types/lib/path.js:89:26)
    at visitChildren (/Users/cjamcl/.npm/_npx/42135/lib/node_modules/optional-chaining-codemod/node_modules/ast-types/lib/path-visitor.js:180:18)
    at Visitor.PVp.visitWithoutReset (/Users/cjamcl/.npm/_npx/42135/lib/node_modules/optional-chaining-codemod/node_modules/ast-types/lib/path-visitor.js:168:20)
    at visitChildren (/Users/cjamcl/.npm/_npx/42135/lib/node_modules/optional-chaining-codemod/node_modules/ast-types/lib/path-visitor.js:205:25)
    at Visitor.PVp.visitWithoutReset (/Users/cjamcl/.npm/_npx/42135/lib/node_modules/optional-chaining-codemod/node_modules/ast-types/lib/path-visitor.js:168:20)

I believe it was resolved here: benjamn/ast-types#383

Add support of custom babel rules

Hi, thank you for your package. It's great and helps us a lot to migrate our codebase to modern JS style.

In our code we use custom babel plugins, such as @babel/plugin-proposal-decorators
When I apply your tool to our code base, I receive erros, like

SyntaxError: This experimental syntax requires enabling one of the following parser plugin(s): 'decorators-legacy, decorators' (11:0)

How I can fix them?
Thanks!

.prettierrc missing?

Please commit your .prettierrc, or upgrade prettier to 2.0, with the sane defaults (which the codebase is formatted using), e.g. trailing-comma.

villesau / optional-chaining-codemod Goto Github PK

optional-chaining-codemod's Introduction

Optional chaining codemod

What it does?

Why should I migrate to use optional chaining?

Install

Usage

flags

Contributing

optional-chaining-codemod's People

Contributors

Stargazers

Watchers

Forkers

optional-chaining-codemod's Issues

Recommend Projects

Recommend Topics

Recommend Org