Skip to content

Commit 8f58bbb

Browse files
author
Daniel Del Core
committed
seo
1 parent 841ee2e commit 8f58bbb

File tree

13 files changed

+77
-10
lines changed

13 files changed

+77
-10
lines changed

website/docs/authoring.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
id: authoring
33
title: Authoring
44
slug: /authoring
5+
6+
description: Learn how to author and contribute codemods. From setting up your development environment to publishing your codemod for others to use.
7+
keywords: [codemod, authoring, contribution, publishing, deployment]
58
---
69

710
There are currently three approaches to authoring and publishing a codeshift package.

website/docs/configuration.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
id: configuration
33
title: Configuration
44
slug: /configuration
5+
description: Learn how to configure codeshift. This page covers the different ways you can configure codemods withing your codebase.
6+
keywords: [codemod, configuration, presets, deployment, publishing]
57
---
68

79
All codeshift packages must be coupled with a `codeshift.config.js` file.

website/docs/consuming.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
id: consuming
33
title: Consuming
44
slug: /consuming
5+
description: Learn how to consume codemods. This page covers the different ways you can use codemods to automatically refactor your codebase, including integrating them into your development workflow and running them from the command line.
6+
keywords:
7+
[codemod, consuming, refactor, codebase, development workflow, command line]
58
---
69

710
Running codemods is made simple through our CLI tool, [@codeshift/cli](/docs/cli).

website/docs/contribution.mdx

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,13 @@
22
id: contribution
33
title: Contribution
44
slug: /contribution
5+
description: Learn how to contribute codemods. This page covers the process of authoring and publishing codemods, including tips and best practices for creating high-quality codemods that others can use and benefit from.
6+
keywords: [codemod, contribution, authoring, publishing, tips, best practices]
57
---
68

7-
This page covers contribution to [the public registry](https://github.com/CodeshiftCommunity/CodeshiftCommunity/tree/main/community) and is for authors who want:
9+
This page covers the process of authoring and publishing codemods, including tips and best practices for creating high-quality codemods that others can use and benefit from.
10+
11+
It is intended to explain in detail contribution to [the public registry](https://github.com/CodeshiftCommunity/CodeshiftCommunity/tree/main/community) and is for authors who want:
812

913
- Codemods to be open source
1014
- Build tooling, dependency management and project setup to be handled for you

website/docs/external-packages.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
id: external-packages
33
title: External Packages
44
slug: /external-packages
5+
description: Learn how to create stand-alone codeshift packages. This page covers the process of packaging your codemods as standalone npm packages, including tips and best practices for creating packages that are easy to use and maintain.
6+
keywords: [codeshift, package, creation, npm, tips, best practices]
57
---
68

79
This page covers creation of stand-alone codeshift packages and is for authors who want:

website/docs/guides/css-codemods.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,12 @@
22
id: css-codemods
33
title: CSS codemods via PostCSS
44
slug: /css-codemods
5+
description: Learn how to create CSS codemods. This page covers the process of writing codemods that can automatically refactor CSS stylesheets, including tips and best practices for working with CSS and creating maintainable codemods.
6+
keywords: [stylesheets, postcss, stylus, css-in-js]
57
---
68

9+
This page covers the process of writing codemods that can automatically refactor CSS stylesheets, including tips and best practices for working with CSS and creating maintainable codemods.
10+
711
In some cases, it's possible that you may need to write a codemod that applies changes across different programming languages JS, CSS, etc.
812
It could be because the package you're writing a codemod for has an API that spans across both JS and CSS, for example a Design System or CSS-in-JS library. Where some of your consumers may be using the JS interface and some the CSS interface.
913

website/docs/guides/monorepos.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
id: monorepos
33
title: Integrating with monorepos
44
slug: /monorepos
5+
description: Learn about monorepos and how they can be used with codeshift. This page covers the benefits of using a monorepo for your codebase, including improved organization, collaboration, and scalability. We'll also discuss how to use codeshift to automatically refactor code in a monorepo and the best practices for working with monorepos and codemods.
6+
keywords: [monorepos, workspaces, lerna, yarn, scalability, packages]
57
---
68

79
Codeshift is specifically designed to play nicely with monorepos (AKA multi-package repositories, multi-project repositories, or monolithic repositories) such as [Turborepo](https://turborepo.org/), [Yarn](https://classic.yarnpkg.com/lang/en/docs/workspaces/), [npm](https://docs.npmjs.com/cli/v7/using-npm/workspaces/) and [pnpm](https://pnpm.io/workspaces) workspaces and [Lerna](https://lerna.js.org/).

website/docs/guides/understanding-asts.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,11 @@
22
id: understanding-asts
33
title: Understanding ASTs
44
slug: /understanding-asts
5+
description: Learn about abstract syntax trees (ASTs) and how they are used in codemods. This page covers the basics of ASTs, including what they are and how they are used to represent the structure of code. We'll also discuss how to read and manipulate ASTs in your codemods to automatically refactor your codebase.
6+
keywords: [abstract syntax trees, ASTs, codemods, refactor, codebase]
57
---
68

7-
Before writing your first codemod, it’s important to first have a good conceptual understanding of ASTs and how to work with them.
9+
Before writing your first codemod, it’s important to first have a good conceptual understanding of ASTs (abstract syntax trees) and how to work with them.
810

911
## Abstract Syntax Tree (aka AST)
1012

website/docs/introduction.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
id: introduction
33
title: Introduction
44
slug: /
5+
description: 'Welcome to the codeshiftcommunity. This is a community of developers who use codeshift to automatically refactor their codebase. Join us to learn more about codeshift, share your own codemods, and collaborate with others.'
6+
keywords: [codeshift, getting started, best practices]
57
---
68

79
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, CodeshiftCommunity aims to promote the use of codemods as a standard development practice and reduce the learning curve for these tools.

website/docs/registry.mdx

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,22 @@
22
id: registry
33
title: Registry
44
slug: /registry
5+
description: Welcome to the codemod registry. This is a collection of high-quality codemods that have been contributed by members of the codeshiftcommunity. Browse our registry to find codemods that can help you automatically refactor your codebase, or contribute your own codemods to share with the community.'
6+
keywords:
7+
[
8+
codemod registry,
9+
codeshiftcommunity,
10+
codemods,
11+
refactor,
12+
codebase,
13+
contribution,
14+
]
515
---
616

7-
Welcome to the CodeshiftCommunity Public Registry. This registry contains community contributed codemods,
8-
hosted and published directly from the CodeshiftCommunity repository.
17+
Welcome to the CodeshiftCommunity Public Registry. This is a collection of high-quality codemods that have been contributed by members of the community.
18+
Browse our registry to find codemods that can help you automatically refactor your codebase, or contribute your own codemods to share with the community.
919

10-
Source for these packages are located in the [/community folder](https://github.com/CodeshiftCommunity/CodeshiftCommunity/tree/main/community).
20+
Source for these packages can be found in the [/community folder](https://github.com/CodeshiftCommunity/CodeshiftCommunity/tree/main/community).
1121

1222
## Contribution
1323

0 commit comments

Comments
 (0)