class-props-codemod's Introduction

class-props-codemod

Transform old-style assigned static properties to class static properties.

Usage

$ npm install -g jscodeshift
$ jscodeshift PATH_TO_SOURCE --transform PATH_TO_THIS_MODULE

Example

// BEFORE:
class X {
  method1() {}
}
X.foo = 42;

// AFTER:
class X {
  static foo = 42;
  method1() {}
}

Caveats

The transform is very conservative:

If there are any other statements between the class definition and the assigned static properties, then it'll skip that class. Example:
```
  // This class will NOT be transformed
  class X {}
  someOtherStatement;
  X.foo = 42;
```

If any assigned static properties reference the class in the same scope, then it'll skip that class. Example:

  // This class will NOT be transformed
  class X {}
  X.foo = 42;
  X.bar = X.baz();

  // This class WILL BE transformed
  class X {}
  X.foo = 42;
  X.bar = () => X.baz();

If a static property already exists with a name and a value, then it'll skip that class. If the static property exists, but it doesn't have a value, it will get transformed. Example:

  // This class will NOT be transformed
  class X {
    static foo = 43;
  }
  X.foo = 42;

  // This class WILL BE transformed
  class X {
    static foo: number;
  }
  X.foo = 42;

Newly created static properties are added to the class body in the order in which they're found. Either immediately before the first method definition or immediate after the first class property.

class-props-codemod's People

Contributors

Stargazers

Watchers

class-props-codemod's Issues

TypeError: path must be a string

I have noticed the following error while parsing the source code of material-ui:

Processing 1 files...
Spawning 1 workers with 1 files each...
fs.js:263
  binding.open(pathModule._makeLong(path),
          ^

TypeError: path must be a string

This is because of this first error: Skipping path "src/**/**/**/*" which does not exist..
That's not really important. I just thought it would be great to let you know.

Recommend Projects