codemod 0.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +201 -0
- package/README.md +264 -0
- package/codemod +167 -0
- package/package.json +38 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright 2023 Codemod, Inc.
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,264 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<a href="https://codemod.com">
|
|
3
|
+
<picture>
|
|
4
|
+
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/codemod/codemod/main/apps/docs/images/intro/codemod-docs-hero-dark.jpg">
|
|
5
|
+
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/codemod/codemod/main/apps/docs/images/intro/codemod-docs-hero-light.jpg">
|
|
6
|
+
<img alt="Codemod CLI" src="https://raw.githubusercontent.com/codemod/codemod/main/apps/docs/images/intro/codemod-docs-hero-light.jpg">
|
|
7
|
+
</picture>
|
|
8
|
+
</a>
|
|
9
|
+
|
|
10
|
+
<p align="center">
|
|
11
|
+
<br />
|
|
12
|
+
<a href="https://go.codemod.com/app">Platform</a>
|
|
13
|
+
·
|
|
14
|
+
<a href="https://go.codemod.com/community">Community</a>
|
|
15
|
+
·
|
|
16
|
+
<a href="https://docs.codemod.com">Docs</a>
|
|
17
|
+
</p>
|
|
18
|
+
</p>
|
|
19
|
+
|
|
20
|
+
# Codemod CLI
|
|
21
|
+
|
|
22
|
+
[](https://go.codemod.com/community)
|
|
23
|
+
[](https://github.com/codemod/codemod/blob/main/LICENSE)
|
|
24
|
+
[](https://www.npmjs.com/package/codemod)
|
|
25
|
+
|
|
26
|
+
**Codemod CLI** is an open-source command-line tool for building, testing, and running **codemod packages**—automated code transformations that help teams modernize codebases, upgrade frameworks, and refactor at scale.
|
|
27
|
+
|
|
28
|
+
Whether you're an individual developer tackling tech debt, an OSS maintainer shipping upgrade paths, or a platform team coordinating migrations across hundreds of services, Codemod CLI gives you the tools to automate repetitive code changes reliably.
|
|
29
|
+
|
|
30
|
+
## Installation
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
npm install -g codemod@latest
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
Or use via `npx` without installation:
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
npx codemod@latest <command>
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
## Quick Start
|
|
43
|
+
|
|
44
|
+
```bash
|
|
45
|
+
# 1. Create a codemod package
|
|
46
|
+
npx codemod init my-codemod
|
|
47
|
+
cd my-codemod
|
|
48
|
+
|
|
49
|
+
# You can create codemod packages with the help of AI using Codemod MCP or Studio
|
|
50
|
+
|
|
51
|
+
# 2. Run it locally
|
|
52
|
+
npx codemod workflow run -w ./example-codemod -t /abs/path/to/repo
|
|
53
|
+
|
|
54
|
+
# 3. Publish to registry
|
|
55
|
+
npx codemod login
|
|
56
|
+
npx codemod publish
|
|
57
|
+
|
|
58
|
+
# 4. Run from registry
|
|
59
|
+
npx codemod @your-org/example-codemod
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
## What are Codemod Packages?
|
|
63
|
+
|
|
64
|
+
**Codemod packages** are portable, reusable code transformation units that can range from simple find-and-replace operations to complex, multi-step migration workflows. Each package includes:
|
|
65
|
+
|
|
66
|
+
- **Transformation logic** – Written in JavaScript/TypeScript (jssg), YAML ast-grep rules, or shell scripts
|
|
67
|
+
- **Workflow definition** – Orchestrates steps, handles dependencies, and manages execution
|
|
68
|
+
- **Package manifest** – Defines metadata, target languages, and publishing configuration
|
|
69
|
+
|
|
70
|
+
Packages are **fully portable**: run them locally during development, in CI/CD pipelines, or share them via the [Codemod Registry](https://go.codemod.com/registry) for your team or the community.
|
|
71
|
+
|
|
72
|
+
## Why Codemod CLI?
|
|
73
|
+
|
|
74
|
+
- **🎯 Built for Automation** – Scaffold, test, and publish codemod packages from your terminal
|
|
75
|
+
- **📦 Registry Integration** – Share codemods via the [Codemod Registry](https://go.codemod.com/registry) or run community packages instantly
|
|
76
|
+
- **⚡ Powerful Engines** – Leverage ast-grep (YAML + jssg) for fast, accurate AST-based transformations
|
|
77
|
+
- **🤖 AI-Powered Creation** – Use [Codemod MCP](https://go.codemod.com/mcp-docs) in your IDE or [Codemod Studio](https://go.codemod.com/studio-docs) to build codemods with AI assistance
|
|
78
|
+
- **🧪 Built-in Testing** – Validate codemods with snapshot testing before running on production code
|
|
79
|
+
- **🔧 Flexible Runtime** – Run directly on your machine or in Docker/Podman containers
|
|
80
|
+
|
|
81
|
+
## Core Concepts
|
|
82
|
+
|
|
83
|
+
### Codemod Packages
|
|
84
|
+
|
|
85
|
+
A **codemod package** is a directory containing:
|
|
86
|
+
|
|
87
|
+
- `codemod.yaml` – Package metadata (name, version, description, target languages)
|
|
88
|
+
- `workflow.yaml` – Workflow steps and orchestration logic
|
|
89
|
+
- `scripts/` – JavaScript/TypeScript codemods (jssg)
|
|
90
|
+
- `rules/` – YAML ast-grep rule files
|
|
91
|
+
|
|
92
|
+
Packages can be as simple as a single transformation or as complex as multi-step migration workflows combining JavaScript codemods, YAML rules, shell scripts, and AI-assisted steps.
|
|
93
|
+
|
|
94
|
+
[Learn more about codemod packages →](https://docs.codemod.com/cli/packages)
|
|
95
|
+
|
|
96
|
+
### jssg (JavaScript ast-grep)
|
|
97
|
+
|
|
98
|
+
**jssg** enables you to write codemods in JavaScript/TypeScript that transform code in **any language** supported by ast-grep (JavaScript, TypeScript, Python, Rust, Go, Java, C++, and more).
|
|
99
|
+
|
|
100
|
+
```typescript
|
|
101
|
+
// Example: Replace console.log with logger.info
|
|
102
|
+
import type { Transform } from "codemod:ast-grep";
|
|
103
|
+
import type TSX from "codemod:ast-grep/langs/tsx";
|
|
104
|
+
|
|
105
|
+
const transform: Transform<TSX> = (root) => {
|
|
106
|
+
const rootNode = root.root();
|
|
107
|
+
|
|
108
|
+
// Find all console.log calls
|
|
109
|
+
const consoleCalls = rootNode.findAll({
|
|
110
|
+
rule: { pattern: "console.log($$$ARGS)" }
|
|
111
|
+
});
|
|
112
|
+
|
|
113
|
+
if (consoleCalls.length === 0) {
|
|
114
|
+
return null; // No changes needed
|
|
115
|
+
}
|
|
116
|
+
|
|
117
|
+
// Create edits
|
|
118
|
+
const edits = consoleCalls.map((node) => {
|
|
119
|
+
const args = node.getMatch('ARGS')?.text() || '';
|
|
120
|
+
return node.replace(`logger.info(${args})`);
|
|
121
|
+
});
|
|
122
|
+
|
|
123
|
+
return rootNode.commitEdits(edits);
|
|
124
|
+
};
|
|
125
|
+
|
|
126
|
+
export default transform;
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
jssg combines the power of AST transformations with the flexibility of JavaScript, making complex transformations intuitive and testable.
|
|
130
|
+
|
|
131
|
+
[Learn more about jssg →](https://docs.codemod.com/jssg)
|
|
132
|
+
|
|
133
|
+
### Workflow Orchestration
|
|
134
|
+
|
|
135
|
+
Workflows define how your codemod package runs. They can orchestrate multiple steps, handle dependencies, manage state, and even include manual approval gates:
|
|
136
|
+
|
|
137
|
+
```yaml
|
|
138
|
+
version: "1"
|
|
139
|
+
nodes:
|
|
140
|
+
- id: transform
|
|
141
|
+
name: Update API Calls
|
|
142
|
+
type: automatic
|
|
143
|
+
steps:
|
|
144
|
+
- name: "Run jssg codemod"
|
|
145
|
+
js-ast-grep:
|
|
146
|
+
js_file: "scripts/update-api.ts"
|
|
147
|
+
language: "typescript"
|
|
148
|
+
include:
|
|
149
|
+
- "**/*.ts"
|
|
150
|
+
- "**/*.tsx"
|
|
151
|
+
|
|
152
|
+
- name: "Format code"
|
|
153
|
+
run: npx prettier --write "**/*.{ts,tsx}"
|
|
154
|
+
|
|
155
|
+
- name: "Run tests"
|
|
156
|
+
run: npm test
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
[Learn more about workflows →](https://docs.codemod.com/cli/packages/building-workflows)
|
|
160
|
+
|
|
161
|
+
## CLI Commands
|
|
162
|
+
|
|
163
|
+
### Package Management
|
|
164
|
+
|
|
165
|
+
| Command | Description |
|
|
166
|
+
|---------|-------------|
|
|
167
|
+
| `npx codemod init [path]` | Create a new codemod package with interactive setup |
|
|
168
|
+
| `npx codemod publish [path]` | Publish package to the Codemod Registry |
|
|
169
|
+
| `npx codemod login` | Authenticate with the registry (browser or API key) |
|
|
170
|
+
| `npx codemod logout` | Logout from registry |
|
|
171
|
+
| `npx codemod whoami` | Show current authentication status |
|
|
172
|
+
| `npx codemod search [query]` | Search for packages in the registry |
|
|
173
|
+
| `npx codemod unpublish <package>` | Remove a package from the registry |
|
|
174
|
+
|
|
175
|
+
### Workflow Commands
|
|
176
|
+
|
|
177
|
+
| Command | Description |
|
|
178
|
+
|---------|-------------|
|
|
179
|
+
| `npx codemod workflow run -w <path>` | Run a codemod workflow on your codebase |
|
|
180
|
+
| `npx codemod workflow validate -w <path>` | Validate workflow syntax and structure |
|
|
181
|
+
| `npx codemod workflow resume -i <id>` | Resume a paused workflow |
|
|
182
|
+
| `npx codemod workflow status -i <id>` | Show workflow execution status |
|
|
183
|
+
| `npx codemod workflow list` | List recent workflow runs |
|
|
184
|
+
| `npx codemod workflow cancel -i <id>` | Cancel a running workflow |
|
|
185
|
+
|
|
186
|
+
### jssg Commands
|
|
187
|
+
|
|
188
|
+
| Command | Description |
|
|
189
|
+
|---------|-------------|
|
|
190
|
+
| `npx codemod jssg run <file> <target> --language <lang>` | Run a jssg codemod directly |
|
|
191
|
+
| `npx codemod jssg test <file> --language <lang>` | Test jssg codemod with fixtures |
|
|
192
|
+
|
|
193
|
+
### Cache Management
|
|
194
|
+
|
|
195
|
+
| Command | Description |
|
|
196
|
+
|---------|-------------|
|
|
197
|
+
| `npx codemod cache info` | Show cache statistics |
|
|
198
|
+
| `npx codemod cache list` | List all cached packages |
|
|
199
|
+
| `npx codemod cache clear [package]` | Clear cache for package or all |
|
|
200
|
+
| `npx codemod cache prune` | Remove old or unused cache entries |
|
|
201
|
+
|
|
202
|
+
**For detailed options and examples, see the [full CLI reference →](https://docs.codemod.com/cli/cli-reference)**
|
|
203
|
+
|
|
204
|
+
## Ecosystem & Platform
|
|
205
|
+
|
|
206
|
+
The Codemod CLI is part of a larger ecosystem designed to help teams modernize code at scale:
|
|
207
|
+
|
|
208
|
+
### Open-Source Tools
|
|
209
|
+
|
|
210
|
+
- **[Codemod CLI](https://docs.codemod.com/cli)** (this package) – Build, test, and run codemod packages
|
|
211
|
+
- **[Codemod MCP](https://go.codemod.com/mcp-docs)** – Build codemods with AI assistance in your IDE
|
|
212
|
+
- **[Public Registry](https://go.codemod.com/registry)** – Discover and share community codemods
|
|
213
|
+
|
|
214
|
+
### Enterprise Platform Features
|
|
215
|
+
|
|
216
|
+
For teams coordinating migrations across multiple repositories:
|
|
217
|
+
|
|
218
|
+
- **[Codemod Studio](https://go.codemod.com/studio)** – AI-powered web interface for creating codemods
|
|
219
|
+
- **[Campaigns](https://docs.codemod.com/migrations)** – Multi-repo orchestration with progress tracking
|
|
220
|
+
- **[Insights](https://docs.codemod.com/insights)** – Analytics dashboards for measuring migration impact
|
|
221
|
+
- **Private Registry** – Secure, organization-scoped codemod packages
|
|
222
|
+
|
|
223
|
+
[Learn more about the platform →](https://app.codemod.com)
|
|
224
|
+
|
|
225
|
+
## Resources
|
|
226
|
+
|
|
227
|
+
### Documentation
|
|
228
|
+
- **[Full Documentation](https://docs.codemod.com)** – Comprehensive guides and tutorials
|
|
229
|
+
- **[CLI Reference](https://docs.codemod.com/cli/cli-reference)** – Detailed command documentation
|
|
230
|
+
- **[Codemod Packages](https://docs.codemod.com/cli/packages)** – Learn more about codemod packages and workflows
|
|
231
|
+
- **[jssg Documentation](https://docs.codemod.com/jssg)** – JavaScript ast-grep reference
|
|
232
|
+
|
|
233
|
+
### Get Help
|
|
234
|
+
- **[Slack Community](https://go.codemod.com/community)** – Ask questions and share codemods
|
|
235
|
+
- **[GitHub Discussions](https://github.com/codemod/codemod/discussions)** – Long-form Q&A
|
|
236
|
+
- **[GitHub Issues](https://github.com/codemod/codemod/issues)** – Report bugs or request features
|
|
237
|
+
|
|
238
|
+
### Explore
|
|
239
|
+
- **[Codemod Registry](https://go.codemod.com/registry)** – Browse community codemods
|
|
240
|
+
- **[Codemod Studio](https://go.codemod.com/studio)** – Try creating codemods with AI
|
|
241
|
+
- **[Example Codemods](https://github.com/codemod/codemod/tree/main/test-codemods)** – Reference implementations
|
|
242
|
+
|
|
243
|
+
## Contributing
|
|
244
|
+
|
|
245
|
+
Contributions are welcome! Help make codemod automation better for everyone.
|
|
246
|
+
|
|
247
|
+
**Ways to contribute:**
|
|
248
|
+
- 🐛 Report bugs via [GitHub Issues](https://github.com/codemod/codemod/issues)
|
|
249
|
+
- 💡 Suggest features on [Feedback Board](https://feedback.codemod.com)
|
|
250
|
+
- 📝 Improve documentation
|
|
251
|
+
- 🔧 Submit pull requests
|
|
252
|
+
- 🌟 Star the repo and spread the word
|
|
253
|
+
|
|
254
|
+
Read our [Contributing Guide](https://github.com/codemod/codemod/blob/main/CONTRIBUTING.md) and [Code of Conduct](https://github.com/codemod/codemod/blob/main/CODE_OF_CONDUCT.md).
|
|
255
|
+
|
|
256
|
+
## License
|
|
257
|
+
|
|
258
|
+
MIT License - see [LICENSE](https://github.com/codemod/codemod/blob/main/LICENSE) for details.
|
|
259
|
+
|
|
260
|
+
---
|
|
261
|
+
|
|
262
|
+
<p align="center">
|
|
263
|
+
<strong>Built with ❤️ by <a href="https://codemod.com">Codemod</a> and the <a href="https://github.com/codemod/codemod/graphs/contributors">open-source community</a></strong>
|
|
264
|
+
</p>
|
package/codemod
ADDED
|
@@ -0,0 +1,167 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
|
|
3
|
+
const { spawn } = require("node:child_process");
|
|
4
|
+
const fs = require("fs");
|
|
5
|
+
const path = require("path");
|
|
6
|
+
|
|
7
|
+
const binaryName = process.platform === "win32" ? "codemod.exe" : "codemod";
|
|
8
|
+
|
|
9
|
+
function detectPackageName() {
|
|
10
|
+
const { platform, arch } = process;
|
|
11
|
+
|
|
12
|
+
switch (platform) {
|
|
13
|
+
case "darwin":
|
|
14
|
+
if (arch === "arm64") {
|
|
15
|
+
return "@codemod.com/cli-darwin-arm64";
|
|
16
|
+
}
|
|
17
|
+
if (arch === "x64") {
|
|
18
|
+
return "@codemod.com/cli-darwin-x64";
|
|
19
|
+
}
|
|
20
|
+
break;
|
|
21
|
+
case "linux": {
|
|
22
|
+
const { family, MUSL } = require("detect-libc");
|
|
23
|
+
const libcSuffix =
|
|
24
|
+
family === MUSL ? "musl" : arch === "arm" ? "gnueabihf" : "gnu";
|
|
25
|
+
if (arch === "x64") {
|
|
26
|
+
return `@codemod.com/cli-linux-x64-${libcSuffix}`;
|
|
27
|
+
}
|
|
28
|
+
if (arch === "arm64") {
|
|
29
|
+
return `@codemod.com/cli-linux-arm64-${libcSuffix}`;
|
|
30
|
+
}
|
|
31
|
+
break;
|
|
32
|
+
}
|
|
33
|
+
case "win32":
|
|
34
|
+
if (arch === "x64") {
|
|
35
|
+
return "@codemod.com/cli-win32-x64-msvc";
|
|
36
|
+
}
|
|
37
|
+
if (arch === "arm64") {
|
|
38
|
+
return "@codemod.com/cli-win32-arm64-msvc";
|
|
39
|
+
}
|
|
40
|
+
break;
|
|
41
|
+
default:
|
|
42
|
+
break;
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
return null;
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
function failToLocateBinary(pkgName, originalError) {
|
|
49
|
+
const messages = ["Failed to locate the codemod native binary."];
|
|
50
|
+
|
|
51
|
+
if (pkgName) {
|
|
52
|
+
messages.push(`Expected package: ${pkgName}`);
|
|
53
|
+
} else {
|
|
54
|
+
messages.push(
|
|
55
|
+
"This platform does not have a published prebuilt codemod binary.",
|
|
56
|
+
);
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
if (originalError) {
|
|
60
|
+
messages.push(`Underlying error: ${originalError.message}`);
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
messages.push(
|
|
64
|
+
"If you are installing from npm, ensure optional dependencies are enabled (e.g. do not use --no-optional).",
|
|
65
|
+
);
|
|
66
|
+
messages.push(
|
|
67
|
+
"For local development, run `cargo build --package codemod-cli --release` before invoking this script.",
|
|
68
|
+
);
|
|
69
|
+
|
|
70
|
+
console.error(messages.join("\n"));
|
|
71
|
+
process.exit(1);
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
function resolveBinaryPath() {
|
|
75
|
+
const pkgName = detectPackageName();
|
|
76
|
+
let moduleError = null;
|
|
77
|
+
|
|
78
|
+
if (pkgName) {
|
|
79
|
+
try {
|
|
80
|
+
const pkgDir = path.dirname(
|
|
81
|
+
require.resolve(`${pkgName}/package.json`, { paths: [__dirname] }),
|
|
82
|
+
);
|
|
83
|
+
const candidate = path.join(pkgDir, binaryName);
|
|
84
|
+
if (fs.existsSync(candidate)) {
|
|
85
|
+
return { binaryPath: candidate, pkgName };
|
|
86
|
+
}
|
|
87
|
+
} catch (err) {
|
|
88
|
+
if (err.code !== "MODULE_NOT_FOUND") {
|
|
89
|
+
moduleError = err;
|
|
90
|
+
} else {
|
|
91
|
+
moduleError = err;
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
}
|
|
95
|
+
|
|
96
|
+
console.log("pkgName", pkgName);
|
|
97
|
+
|
|
98
|
+
const releaseCandidate = path.join(
|
|
99
|
+
__dirname,
|
|
100
|
+
"..",
|
|
101
|
+
"..",
|
|
102
|
+
"..",
|
|
103
|
+
"target",
|
|
104
|
+
"release",
|
|
105
|
+
binaryName,
|
|
106
|
+
);
|
|
107
|
+
if (fs.existsSync(releaseCandidate)) {
|
|
108
|
+
return { binaryPath: releaseCandidate, pkgName: null };
|
|
109
|
+
}
|
|
110
|
+
|
|
111
|
+
const debugCandidate = path.join(
|
|
112
|
+
__dirname,
|
|
113
|
+
"..",
|
|
114
|
+
"..",
|
|
115
|
+
"..",
|
|
116
|
+
"target",
|
|
117
|
+
"debug",
|
|
118
|
+
binaryName,
|
|
119
|
+
);
|
|
120
|
+
|
|
121
|
+
if (fs.existsSync(debugCandidate)) {
|
|
122
|
+
return { binaryPath: debugCandidate, pkgName: null };
|
|
123
|
+
}
|
|
124
|
+
|
|
125
|
+
failToLocateBinary(pkgName, moduleError);
|
|
126
|
+
}
|
|
127
|
+
|
|
128
|
+
const { binaryPath } = resolveBinaryPath();
|
|
129
|
+
|
|
130
|
+
const child = spawn(binaryPath, process.argv.slice(2), {
|
|
131
|
+
stdio: "inherit",
|
|
132
|
+
});
|
|
133
|
+
|
|
134
|
+
child.on("error", (error) => {
|
|
135
|
+
console.error("Failed to execute codemod binary.");
|
|
136
|
+
console.error(error);
|
|
137
|
+
process.exit(1);
|
|
138
|
+
});
|
|
139
|
+
|
|
140
|
+
const signals = ["SIGINT", "SIGTERM", "SIGHUP"];
|
|
141
|
+
|
|
142
|
+
const forwarders = signals.map((signal) => {
|
|
143
|
+
const handler = () => {
|
|
144
|
+
if (child.killed) {
|
|
145
|
+
return;
|
|
146
|
+
}
|
|
147
|
+
try {
|
|
148
|
+
child.kill(signal);
|
|
149
|
+
} catch (_) {
|
|
150
|
+
// Ignore
|
|
151
|
+
}
|
|
152
|
+
};
|
|
153
|
+
process.on(signal, handler);
|
|
154
|
+
return { signal, handler };
|
|
155
|
+
});
|
|
156
|
+
|
|
157
|
+
child.on("exit", (code, signal) => {
|
|
158
|
+
forwarders.forEach(({ signal, handler }) => {
|
|
159
|
+
process.removeListener(signal, handler);
|
|
160
|
+
});
|
|
161
|
+
|
|
162
|
+
if (signal) {
|
|
163
|
+
process.kill(process.pid, signal);
|
|
164
|
+
} else {
|
|
165
|
+
process.exit(code == null ? 1 : code);
|
|
166
|
+
}
|
|
167
|
+
});
|
package/package.json
ADDED
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "codemod",
|
|
3
|
+
"version": "0.0.0",
|
|
4
|
+
"description": "Codemod platform for semantic code transformations",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"ast",
|
|
7
|
+
"codemod",
|
|
8
|
+
"migration",
|
|
9
|
+
"refactoring",
|
|
10
|
+
"transformation"
|
|
11
|
+
],
|
|
12
|
+
"homepage": "https://codemod.com",
|
|
13
|
+
"repository": "https://github.com/codemod/codemod",
|
|
14
|
+
"license": "Apache-2.0",
|
|
15
|
+
"bin": {
|
|
16
|
+
"codemod": "codemod"
|
|
17
|
+
},
|
|
18
|
+
"files": [
|
|
19
|
+
"README.md",
|
|
20
|
+
"codemod"
|
|
21
|
+
],
|
|
22
|
+
"dependencies": {
|
|
23
|
+
"detect-libc": "^2.0.3"
|
|
24
|
+
},
|
|
25
|
+
"optionalDependencies": {
|
|
26
|
+
"@codemod.com/cli-darwin-arm64": "0.0.0",
|
|
27
|
+
"@codemod.com/cli-darwin-x64": "0.0.0",
|
|
28
|
+
"@codemod.com/cli-linux-arm64-gnu": "0.0.0",
|
|
29
|
+
"@codemod.com/cli-linux-x64-gnu": "0.0.0",
|
|
30
|
+
"@codemod.com/cli-win32-x64-msvc": "0.0.0"
|
|
31
|
+
},
|
|
32
|
+
"engines": {
|
|
33
|
+
"node": ">= 16.0.0"
|
|
34
|
+
},
|
|
35
|
+
"publishConfig": {
|
|
36
|
+
"access": "public"
|
|
37
|
+
}
|
|
38
|
+
}
|