Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add transform for v9 migration #29

Merged
merged 8 commits into from
Jun 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 73 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ Where:

`path` - Files or directory to transform.


For more information on jscodeshift, check their official [docs](https://github.com/facebook/jscodeshift).

## Transforms
Expand All @@ -49,3 +48,76 @@ module.exports = {
create: function(context) { ... }
};
```

### v9-rule-migration

Transform that migrates an ESLint rule definition from the old Rule API:

```javascript
module.exports = {
create(context) {
return {
Program(node) {
const sourceCode = context.getSourceCode();
const cwd = context.getCwd();
const filename = context.getFilename();
const physicalFilename = context.getPhysicalFilename();
const sourceCodeText = context.getSource();
const sourceLines = context.getSourceLines();
const allComments = context.getAllComments();
const nodeByRangeIndex = context.getNodeByRangeIndex();
const commentsBefore = context.getCommentsBefore(node);
const commentsAfter = context.getCommentsAfter(node);
const commentsInside = context.getCommentsInside(node);
const jsDocComment = context.getJSDocComment();
const firstToken = context.getFirstToken(node);
const firstTokens = context.getFirstTokens(node);
const lastToken = context.getLastToken(node);
const lastTokens = context.getLastTokens(node);
const tokenAfter = context.getTokenAfter(node);
const tokenBefore = context.getTokenBefore(node);
const tokenByRangeStart = context.getTokenByRangeStart(node);
const getTokens = context.getTokens(node);
const tokensAfter = context.getTokensAfter(node);
const tokensBefore = context.getTokensBefore(node);
const tokensBetween = context.getTokensBetween(node);
const parserServices = context.parserServices;
},
};
},
};
```

to the new [Rule API introduced in ESLint 9.0.0](https://eslint.org/blog/2023/09/preparing-custom-rules-eslint-v9/):

```javascript
module.exports = {
create(context) {
const sourceCode = context.sourceCode ?? context.getSourceCode();
return {
Program(node) {
const sourceCodeText = sourceCode.getText();
const sourceLines = sourceCode.getLines();
const allComments = sourceCode.getAllComments();
const nodeByRangeIndex = sourceCode.getNodeByRangeIndex();
const commentsBefore = sourceCode.getCommentsBefore(nodeOrToken);
const commentsAfter = sourceCode.getCommentsAfter(nodeOrToken);
const commentsInside = sourceCode.getCommentsInside(nodeOrToken);
const jsDocComment = sourceCode.getJSDocComment();
const firstToken = sourceCode.getFirstToken(node);
const firstTokens = sourceCode.getFirstTokens(node);
const lastToken = sourceCode.getLastToken(node);
const lastTokens = sourceCode.getLastTokens(node);
const tokenAfter = sourceCode.getTokenAfter(node);
const tokenBefore = sourceCode.getTokenBefore(node);
const tokenByRangeStart = sourceCode.getTokenByRangeStart(node);
const getTokens = sourceCode.getTokens(node);
const tokensAfter = sourceCode.getTokensAfter(node);
const tokensBefore = sourceCode.getTokensBefore(node);
const tokensBetween = sourceCode.getTokensBetween(node);
const parserServices = sourceCode.parserServices;
},
};
},
};
```
Loading