You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: website/docs/authoring.mdx
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -19,14 +19,14 @@ Which one to use depends on your particular use case.
19
19
The public registry is the public directory of codemods hosted and published directly from this repository, [visible here](https://github.com/hypermod-io/hypermod-community/tree/main/community).
20
20
This directory can be compared to and treated the same as the Typescript type definition registry: [DefinitelyTyped](https://github.com/DefinitelyTyped/DefinitelyTyped).
21
21
22
-
_Please see the [Contribution guide](contribution) for more information._
22
+
_Please see the [Contribution guide](./contribution.mdx) for more information._
23
23
24
24
Use this method if you want:
25
25
26
26
- Your codemods to be open source
27
27
- Build tooling, dependency management and project setup to be handled for you
28
28
- The community to help maintain and contribute to your codemods
29
-
- Documentation to be automatically generated and available on the [Registry page](registry)
29
+
- Documentation to be automatically generated and available on the [Registry page](./registry.mdx)
30
30
31
31
Do not use this method if:
32
32
@@ -49,13 +49,13 @@ Use this method if you want:
49
49
50
50
Do not use this method if:
51
51
52
-
- You want docs to be automatically generated and available on the [Registry page](registry)
52
+
- You want docs to be automatically generated and available on the [Registry page](./registry.mdx)
53
53
54
54
## 3. Create a stand-alone Hypermod package
55
55
56
56
Hypermod packages can be created as a stand-alone package.
57
57
58
-
_Please see the [External Packages guide](external-packages) for more information._
58
+
_Please see the [External Packages guide](./external-packages.mdx) for more information._
Copy file name to clipboardExpand all lines: website/docs/introduction.mdx
+9-9Lines changed: 9 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ description: 'Welcome to Hypermod. This is a community of developers who use Hyp
6
6
keywords: [codeshift, getting started, best practices]
7
7
---
8
8
9
-
Hypermod (prev CodeshiftCommunity) is a community-owned global registry and documentation hub for codemods. This project provides users and maintainers of libraries with tools and resources to help them [write](authoring), [test](testing), [publish](contribution) and [use](consuming) codemods in a structured and familiar way. By providing a standardized platform for codemod authoring, publishing, and consumption, Hypermod aims to promote the use of codemods as a standard development practice and reduce the learning curve for these tools.
9
+
Hypermod (prev CodeshiftCommunity) is a community-owned global registry and documentation hub for codemods. This project provides users and maintainers of libraries with tools and resources to help them [write](./authoring.mdx), [test](./testing.mdx), [publish](./contribution.mdx) and [use](./consuming.mdx) codemods in a structured and familiar way. By providing a standardized platform for codemod authoring, publishing, and consumption, Hypermod aims to promote the use of codemods as a standard development practice and reduce the learning curve for these tools.
10
10
11
11
## Why?
12
12
@@ -62,9 +62,9 @@ Our goal is to remove the stigma that codemods are difficult or time-consuming t
62
62
63
63
### A standardized CLI
64
64
65
-
Hypermod allows developers to publish codemods as their own NPM packages or as part of an existing NPM package. We provide a [standardized CLI tool](cli) that can download and run the latest codemods from any location. This approach has the added benefit of allowing codemods to be published with dependencies, which is not currently possible with most JSCodeshift CLI implementations.
65
+
Hypermod allows developers to publish codemods as their own NPM packages or as part of an existing NPM package. We provide a [standardized CLI tool](./api/hypermod-cli.mdx) that can download and run the latest codemods from any location. This approach has the added benefit of allowing codemods to be published with dependencies, which is not currently possible with most JSCodeshift CLI implementations.
66
66
67
-
By using NPM, we aim to make it easy for developers to adopt codemods. All they need to do is publish an existing package with a codemod.config.js file and they are ready to go. For more information, see our guide on [authoring with existing packages](authoring#2-add-hypermod-to-an-existing-package).
67
+
By using NPM, we aim to make it easy for developers to adopt codemods. All they need to do is publish an existing package with a codemod.config.js file and they are ready to go. For more information, see our guide on [authoring with existing packages](./authoring.mdx#2-add-hypermod-to-an-existing-package).
68
68
69
69
### A centralized registry
70
70
@@ -86,9 +86,9 @@ We want to remove the perception that codemods are difficult or time-consuming t
86
86
87
87
## Getting started
88
88
89
-
-[Your first codemod](/docs/your-first-codemod)
90
-
-[Consuming codemods](consuming)
91
-
-[Writing codemods](authoring)
92
-
-[Testing codemods](testing)
93
-
-[Learning resources](your-first-codemod)
94
-
-[Publishing & contribution](contribution)
89
+
-[Your first codemod](./guides/your-first-codemod.mdx)
0 commit comments