Skip to content

chore(docs): add info about namespaces & update cli nav #1524

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

Merged
merged 1 commit into from
Apr 30, 2025
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
21 changes: 19 additions & 2 deletions apps/docs/building-codemods/package-requirements.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,22 @@ The `.codemodrc.json` configuration file includes several metafields that can be

<ResponseField name="name" type="string" required>
Specifies the slugified name of the codemod published to the codemod registry.

<Tip>
We recommend using the following naming convention for better codemod discoverability:

```
library/version/codemod-name
```

Optionally, you can specify an organization's namespace for your codemod:

```
@organization/library/version/codemod-name
```

To create an organization namespace, [contact us](https://codemod.com/contact) message us on the [Slack community](https://go.codemod.com/community).
</Tip>
</ResponseField>

<ResponseField name="version" type="string" required>
Expand All @@ -34,8 +50,9 @@ The `.codemodrc.json` configuration file includes several metafields that can be
<ResponseField name="private" type="boolean" default="false">
Can be used to set the codemod visibility to `private`.

By default, when a codemod is published without a namespace, visibility will be set as `public`.
If a codemod is published under a namespace, such as `@codemod/my-codemod`, visibility will be set as `private`.
<Info>
If a codemod is published under an organization's namespace, such as `@codemod/my-codemod`, visibility will default to `private` unless explicitly specified.
</Info>
</ResponseField>

<ResponseField name="engine" type="string" required>
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/deploying-codemods/cli.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "All commands"
title: "Codemod CLI"
description: "Get started with using the Codemod command-line interface."
icon: "terminal"
---
Expand Down
4 changes: 4 additions & 0 deletions apps/docs/docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,10 @@
"codemod-registry/introduction",
"sharing/publishing-codemods"
]
},
{
"group": "Locally Running Codemods",
"pages": ["deploying-codemods/cli"]
}
]
},
Expand Down
Loading