Skip to content

Commit

Permalink
remove codemod package readmes
Browse files Browse the repository at this point in the history
fix bull readmes

fix mui readmes

fix redwood readmes

fix netlify sdk readmes

fix ember readmes

fix biome readme

fix jest to vitest readme

Update .codemodrc.json

fix mocha readmes

fix msw readmes

Update .codemodrc.json

fix next i18n readme

Update README.md

fix react router readmes

fix typescript codemod readmes

fix react codemod readmes

fix cal readmes

update codemod readmes
  • Loading branch information
mohab-sameh committed Apr 22, 2024
1 parent 818c3e3 commit b7318b9
Show file tree
Hide file tree
Showing 222 changed files with 254 additions and 933 deletions.
2 changes: 1 addition & 1 deletion packages/codemods/bull/bullmq/.codemodrc.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"$schema": "https://codemod-utils.s3.us-west-1.amazonaws.com/configuration_schema.json",
"version": "1.0.0",
"version": "1.0.1",
"private": false,
"name": "bull/bullmq",
"engine": "jscodeshift",
Expand Down
10 changes: 2 additions & 8 deletions packages/codemods/bull/bullmq/README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,9 @@
# Bull to BullMQ

## Description

This codemod provides straightforward changes to migrate from bull to bullmq.
You have to manually create queue names for the existing queues in your application.
You need to apply these names for the created workers in the files which previously used .process().
You will have to manually specify connection details if you used `createClient` method on `new Queue()` options before. Connection details should now also be specified for and `Worker` classes.

## Example

### Before
## Before

```ts
import Queue from 'bull';
Expand Down Expand Up @@ -64,7 +58,7 @@ queue.process(async function (job) {
});
```

### After
## After

```ts
import { Queue, DefaultJobOptions, QueueEvents, Worker } from "bullmq";
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"$schema": "https://codemod-utils.s3.us-west-1.amazonaws.com/configuration_schema.json",
"version": "1.0.0",
"version": "1.0.1",
"private": false,
"name": "cal.com/app-directory-boilerplate-calcom",
"description": "This codemod provides boilerplate for the app directory.",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
# App Directory Boilerplate for Cal.com

## Description

The first step to migrate your pages to the `app` directory is to provide a new file structure, respected by the App router.

This is attempted by this codemod, which reads the contents of your `pages` directory and creates the placeholder files.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"$schema": "https://codemod-utils.s3.us-west-1.amazonaws.com/configuration_schema.json",
"version": "1.0.0",
"version": "1.0.1",
"name": "generate-metadata-tests",
"private": false,
"engine": "filemod",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
# Generate Metadata Tests for Cal.com

## Description

This codemod generates metadata tests for all existing paths under the pages router.

It uses the `testPath` argument to place the test file in the proper place.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"$schema": "https://codemod-utils.s3.us-west-1.amazonaws.com/configuration_schema.json",
"version": "1.0.0",
"version": "1.0.1",
"name": "generate-url-patterns",
"private": false,
"engine": "filemod",
Expand Down
4 changes: 0 additions & 4 deletions packages/codemods/cal.com/generate-url-patterns/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1 @@
# Generate URL Patterns for Cal.com

## Description

This codemod generates URL Patterns for all existing paths under the apps router to be placed in the middleware file that controls which pages are active.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"$schema": "https://codemod-utils.s3.us-west-1.amazonaws.com/configuration_schema.json",
"version": "1.0.0",
"version": "1.0.1",
"private": false,
"name": "ember/5/app-controller-router-props",
"engine": "jscodeshift",
Expand Down
10 changes: 2 additions & 8 deletions packages/codemods/ember/5/app-controller-router-props/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,7 @@
# App Controller Router Props

## Description

This codemod replaces all occurrences of `this.currentRouteName` with `this.router.currentRouteName`
and `this.currentPath` with `this.router.currentPath`.

## Example

### Before:
## Before

```jsx
import Controller from '@ember/controller';
Expand All @@ -29,7 +23,7 @@ export default Controller.extend({
});
```

### After:
## After

```tsx
import Controller from '@ember/controller';
Expand Down
2 changes: 1 addition & 1 deletion packages/codemods/ember/5/array-wrapper/.codemodrc.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"$schema": "https://codemod-utils.s3.us-west-1.amazonaws.com/configuration_schema.json",
"version": "1.0.0",
"version": "1.0.1",
"private": false,
"name": "ember/5/array-wrapper",
"engine": "jscodeshift",
Expand Down
10 changes: 2 additions & 8 deletions packages/codemods/ember/5/array-wrapper/README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,14 @@
# Array Wrapper

## Description

This codemod removes any usage of `new` with `A`, and calls `A` as a standard function.

## Example

### Before:
## Before

```jsx
import { A } from '@ember/array';

let arr = new A();
```

### After:
## After

```tsx
import { A as emberA } from '@ember/array';
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"$schema": "https://codemod-utils.s3.us-west-1.amazonaws.com/configuration_schema.json",
"version": "1.0.0",
"version": "1.0.1",
"private": false,
"name": "ember/5/convert-module-for-to-setup-test",
"engine": "jscodeshift",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,6 @@
# Convert moduleFor to setupTest

## Description

This codemod transforms from the older `moduleFor*` syntax of `ember-qunit@2` to the newer `setup*Test` syntax.

## Example

### Before:
## Before

```tsx
import { moduleFor, test } from 'ember-qunit';
Expand All @@ -20,7 +14,7 @@ test('should allow messages to be queued', function (assert) {
});
```

### After:
## After

```tsx
import { setupTest } from 'ember-qunit';
Expand Down
2 changes: 1 addition & 1 deletion packages/codemods/ember/5/cp-property-map/.codemodrc.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"$schema": "https://codemod-utils.s3.us-west-1.amazonaws.com/configuration_schema.json",
"version": "1.0.0",
"version": "1.0.1",
"private": false,
"name": "ember/5/cp-property-map",
"engine": "jscodeshift",
Expand Down
10 changes: 2 additions & 8 deletions packages/codemods/ember/5/cp-property-map/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,6 @@
# Cp Property Map

## Description

`.property()` is a modifier that adds additional property dependencies to an existing computed property. For `filter`, `map`, and `sort` computed property macros, this codemod ensures they receive an array of additional dependent keys as a second parameter.

## Example

### Before:
## Before

```jsx
const Person = EmberObject.extend({
Expand All @@ -16,7 +10,7 @@ const Person = EmberObject.extend({
});
```

### After:
## After

```tsx
const Person = EmberObject.extend({
Expand Down
2 changes: 1 addition & 1 deletion packages/codemods/ember/5/cp-property/.codemodrc.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"$schema": "https://codemod-utils.s3.us-west-1.amazonaws.com/configuration_schema.json",
"version": "1.0.0",
"version": "1.0.1",
"private": false,
"name": "ember/5/cp-property",
"engine": "jscodeshift",
Expand Down
10 changes: 2 additions & 8 deletions packages/codemods/ember/5/cp-property/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,6 @@
# Cp Property

## Description

`.property()` is a modifier that adds additional property dependencies to an existing computed property. This codemod moves the dependencies to the main computed property definition.

## Example

### Before:
## Before

```jsx
const Person = EmberObject.extend({
Expand All @@ -16,7 +10,7 @@ const Person = EmberObject.extend({
});
```

### After:
## After

```tsx
const Person = EmberObject.extend({
Expand Down
2 changes: 1 addition & 1 deletion packages/codemods/ember/5/cp-volatile/.codemodrc.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"$schema": "https://codemod-utils.s3.us-west-1.amazonaws.com/configuration_schema.json",
"version": "1.0.0",
"version": "1.0.1",
"private": false,
"name": "ember/5/cp-volatile",
"engine": "jscodeshift",
Expand Down
10 changes: 2 additions & 8 deletions packages/codemods/ember/5/cp-volatile/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,6 @@
# Cp Volatile

## Description

This codemod removes all calls to `volatile()` and ensures that native getters are directly used.

## Example

### Before:
## Before

```jsx
const Person = EmberObject.extend({
Expand All @@ -16,7 +10,7 @@ const Person = EmberObject.extend({
});
```

### After:
## After

```tsx
const Person = EmberObject.extend({
Expand Down
2 changes: 1 addition & 1 deletion packages/codemods/ember/5/deprecate-merge/.codemodrc.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"$schema": "https://codemod-utils.s3.us-west-1.amazonaws.com/configuration_schema.json",
"version": "1.0.0",
"version": "1.0.1",
"private": false,
"name": "ember/5/deprecate-merge",
"engine": "jscodeshift",
Expand Down
10 changes: 2 additions & 8 deletions packages/codemods/ember/5/deprecate-merge/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,6 @@
# Deprecate Merge

## Description

This codemod replaces all calls to `Ember.merge` with `Ember.assign`.

## Example

### Before:
## Before

```jsx
import { merge } from '@ember/polyfills';
Expand All @@ -16,7 +10,7 @@ var b = { last: 'Katz' };
merge(a, b);
```

### After:
## After

```tsx
import { assign } from '@ember/polyfills';
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"$schema": "https://codemod-utils.s3.us-west-1.amazonaws.com/configuration_schema.json",
"version": "1.0.0",
"version": "1.0.1",
"private": false,
"name": "ember/5/deprecate-router-events",
"engine": "jscodeshift",
Expand Down
10 changes: 2 additions & 8 deletions packages/codemods/ember/5/deprecate-router-events/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,6 @@
# Deprecate Router Events

## Description

This codemod removes all calls to `willTransition` or `didTransition` events on the Router via usage of `routeWillChange` event listener and `routeDidChange` event listener.

## Example

### Before:
## Before

```jsx
import Router from '@ember/routing/router';
Expand All @@ -32,7 +26,7 @@ export default Router.extend({
});
```

### After:
## After

```tsx
import Router from '@ember/routing/router';
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"$schema": "https://codemod-utils.s3.us-west-1.amazonaws.com/configuration_schema.json",
"version": "1.0.0",
"version": "1.0.1",
"private": false,
"name": "ember/5/ember-jquery-legacy",
"engine": "jscodeshift",
Expand Down
10 changes: 2 additions & 8 deletions packages/codemods/ember/5/ember-jquery-legacy/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,6 @@
# Ember Jquery Legacy

## Description

Using event object APIs that are specific to `jQuery.Event`, such as `originalEvent`, is deprecated in Ember.js v3.3. This codemod ensures the access to the native event without triggering any deprecations via wrapping the `event` with the `normalizeEvent` function provided by `ember-jquery-legacy`.

## Example

### Before:
## Before

```jsx
export default Component.extend({
Expand All @@ -16,7 +10,7 @@ export default Component.extend({
});
```

### After:
## After

```tsx
import { normalizeEvent } from 'ember-jquery-legacy';
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"$schema": "https://codemod-utils.s3.us-west-1.amazonaws.com/configuration_schema.json",
"version": "1.0.0",
"version": "1.0.1",
"private": false,
"name": "ember/5/es5-getter-ember-codemod",
"engine": "jscodeshift",
Expand Down
10 changes: 2 additions & 8 deletions packages/codemods/ember/5/es5-getter-ember-codemod/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,6 @@
# ES5 Getter Ember Codemod

## Description

This codemod transforms `get()` to `getProperties()` to use traditional object dot notation. This standard was proposed by Ember.js team in https://github.com/emberjs/rfcs/blob/master/text/0281-es5-getters.md.

## Example

### Before:
## Before

```jsx
let chancancode = Person.create({ firstName: 'Godfrey', lastName: 'Chan' });
Expand All @@ -28,7 +22,7 @@ controller.get('foo.bar');
controller.get('foo-bar');
```

### After:
## After

```tsx
let chancancode = Person.create({ firstName: 'Godfrey', lastName: 'Chan' });
Expand Down
Loading

0 comments on commit b7318b9

Please sign in to comment.