codemod 0.8.2 → 0.8.4

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.
Files changed (3) hide show
  1. package/README.md +27 -39
  2. package/dist/index.cjs +740 -737
  3. package/package.json +5 -3
package/README.md CHANGED
@@ -1,70 +1,58 @@
1
- # Codemod's CLI
1
+ ![Codemod](https://raw.githubusercontent.com/codemod-com/docs/main/static/img/github/codemod-billboard.png)
2
2
 
3
- Codemod platform gives you multiple ways to discover, run & share supported codemods and code automation recipes.
3
+ <p align="center">
4
+ <br />
5
+ <a href="https://github.com/codemod-com/codemod">GitHub</a>
6
+ ·
7
+ <a href="https://docs.codemod.com">Documentation</a>
8
+ .
9
+ <a href="https://codemod.com/community">Community</a>
10
+ </p>
4
11
 
5
- ![Running Codemod CLI](https://raw.githubusercontent.com/codemod-com/website/main/theme/assets/images/hero-video.gif)
12
+ The Codemod platform helps you create, distribute, and deploy codemods in codebases of any size.
6
13
 
7
- ## Installation
8
-
9
- npm i codemod
14
+ The AI-powered, community-led codemods enable you to automate framework upgrades, large refactoring, and boilerplate programming with unparalleled speed and developer experience.
10
15
 
11
16
  ## Global installation (recommended)
12
17
 
13
18
  npm i -g codemod
14
19
 
15
- ## Usage
16
-
17
- ### Running a codemod
18
-
19
- codemod [framework/version/codemod-name]
20
+ ## Usage & Documentation
20
21
 
21
- #### Example (running Next.js app router receipe codemod)
22
+ For details on how to use the Codemod platform, check out our [documentation](https://docs.codemod.com).
22
23
 
23
- codemod next/13/app-router-recipe
24
+ ## Quickstart
24
25
 
25
26
  ### List available codemods
26
27
 
27
- The `list` command can be used to list all codemods available in the [Codemod Registry](https://github.com/codemod-com/codemod-registry).
28
+ The `list` command can be used to list all codemods available in the [Codemod Registry](https://codemod.com/automations).
28
29
 
29
30
  codemod list
30
31
 
31
- ### Sync registry
32
+ ### Running a codemod
33
+
34
+ codemod [codemod-name]
32
35
 
33
- The `syncRegistry` command can be used to sync local codemods with the public [Codemod Registry](https://github.com/codemod-com/codemod-registry).
36
+ #### Example:
34
37
 
35
- codemod syncRegistry
38
+ codemod next/13/app-router-recipe
36
39
 
37
- ### Generate codemod from file diff
40
+ ### Create codemod with AI
38
41
 
39
42
  The `learn` command can be used to send the diff of the latest edited file to the Codemod Studio and have it automatically build an explainable and debuggable codemod.
40
43
 
41
- After running this command, if any git diff exists, `codemod` will use the diff as before/after snippets in the [Codemod Studio](https://codemod.studio).
42
-
43
44
  codemod learn
44
45
 
45
- ### Options
46
-
47
- - [`--include`](https://docs.codemod.com/docs/cli/advanced-usage#--include)
48
- - [`--exclude`](https://docs.codemod.com/docs/cli/advanced-usage#--exclude)
49
- - [`--targetPath`](https://docs.codemod.com/docs/cli/advanced-usage#--targetpath)
50
- - [`--sourcePath`](https://docs.codemod.com/docs/cli/advanced-usage#--sourcepath)
51
- - [`--codemodEngine`](https://docs.codemod.com/docs/cli/advanced-usage#--codemodengine)
52
- - [`--fileLimit`](https://docs.codemod.com/docs/cli/advanced-usage#--filelimit)
53
- - [`--usePrettier`](https://docs.codemod.com/docs/cli/advanced-usage#--useprettier)
54
- - [`--useCache`](https://docs.codemod.com/docs/cli/advanced-usage#--usecache)
55
- - [`--useJson`](https://docs.codemod.com/docs/cli/advanced-usage#--usejson)
56
- - [`--threadCount`](https://docs.codemod.com/docs/cli/advanced-usage#--threadcount)
57
- - [`--dryRun`](https://docs.codemod.com/docs/cli/advanced-usage#--dryrun)
58
- - [`--telemetryDisable`](https://docs.codemod.com/docs/cli/advanced-usage#--telemetrydisable)
46
+ After running this command, if any git diff exists, `codemod` will use the diff as before/after snippets in the [Codemod Studio](https://codemod.studio).
59
47
 
60
- ## Contribution
48
+ ## Community
61
49
 
62
- We'd love for you to contribute to the [Codemod Engine](https://github.com/codemod-com/codemod-engine-node) and the [Codemod Registry](https://github.com/codemod-com/codemod-registry). Please note that once you create a pull request, you will be asked to sign our [Contributor License Agreement](https://cla-assistant.io/codemod-com/codemod-registry).
50
+ The Codemod community can be found on [Slack](https://codemod.com/community), where you can ask questions, share your feedback, and contribute to the community.
63
51
 
64
- We're always excited to support codemods for more frameworks and libraries. Contributing allows us to make codemods more accessible to more framework builders, developers, and more.
52
+ Our [Code of Conduct](https://github.com/codemod-com/codemod/blob/main/CODE_OF_CONDUCT.md) applies to all Codemod community channels.
65
53
 
66
- ## Telemetry 🔭
54
+ ## Telemetry
67
55
 
68
56
  We collect anonymous usage data to improve our product. Collected data cannot be linked to individual users. We do not store personal data/code.
69
57
 
70
- For more details and samples of collected data see our [telemetry compliance considerations](https://docs.codemod.com/docs/about/telemetry-compliance) doc.
58
+ For more details and samples of collected data see our [telemetry compliance considerations](https://go.codemod.com/telemetry) doc.