Missing simple examples for new users

I have never used jscodeshift, but have identified it as being potentially useful for a couple of simple use cases.

For example, I would like to change an object literal in code.

Before:

// Some code ...

const someObj = {
  x: {
    foo: 3
  }
};

// Some more code ...

After:

// Some code ...

const someObj = {
  x: {
    foo: 4,
    bar: '5'
  }
};

// Some more code ...

But there are no examples of changing values. In general, this repo is very thin on examples. Google and Stackoverflow don’t seem to point to any relevant information. None of the linked examples are helpful. jscodeshift-helper doesn’t help. Every example I have found so far is for complex use cases rather than something simple like changing the literal value of something.

[davidmccabe]

Another beginner here. There aren’t even examples of how to build new AST nodes. The readme points to the definitions of the AST builders, but it’s not at all transparent how to figure out what you actually need to do based on these definitions. To the fields represent positional arguments? Properties in an object? Who knows?

[danieldelcore]

Hey all, I’ve been working on a project called CodeshiftCommunity 🚚, based on jscodeshift, which is provides some docs/guides/recipes for creating codemods. It’s still early days for the project as a whole, but at the very least these docs should be helpful to folks like me that had no idea where to get started 😄

Feedback welcome!

Guides

• Your first codemod
• Understanding ASTs
• Prompting for human input
• When not to codemod

Recipes Practical examples for common operations

• Working with imports
• Working with react + JSX

The long-term plan is to be a place where people can learn how to write codemods, publish in a way that’s similar to DefinitelyTyped and consume them via cli.