Skip to content
This repository was archived by the owner on Apr 11, 2024. It is now read-only.

Commit

Permalink
Renaming package to less generic api-codegen-preset
Browse files Browse the repository at this point in the history
  • Loading branch information
paulomarg committed Nov 10, 2023
1 parent bb5c3ab commit f0fe540
Show file tree
Hide file tree
Showing 23 changed files with 10 additions and 10 deletions.
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# `@shopify/codegen-preset`
# `@shopify/api-codegen-preset`

<!-- ![Build Status]() -->

[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](../../LICENSE.md)
[![npm version](https://badge.fury.io/js/%40shopify%codegen-preset.svg)](https://badge.fury.io/js/%40shopify%codegen-preset)
[![npm version](https://badge.fury.io/js/%40shopify%api-codegen-preset.svg)](https://badge.fury.io/js/%40shopify%api-codegen-preset)

This package enables JavaScript / TypeScript apps to use a `#graphql` tag to parse queries with [`graphql-codegen`](https://the-guild.dev/graphql/codegen).

Expand All @@ -12,18 +12,18 @@ Shopify's clients are then able to use those types to automatically type your op

## Getting started

The first step is to install the `@shopify/codegen-preset` package, using your preferred package manager:
The first step is to install the `@shopify/api-codegen-preset` package, using your preferred package manager:

```sh
yarn add --dev @shopify/codegen-preset
yarn add --dev @shopify/api-codegen-preset
```

```sh
npm add --save-dev @shopify/codegen-preset
npm add --save-dev @shopify/api-codegen-preset
```

```sh
pnpm add -D @shopify/codegen-preset
pnpm add -D @shopify/api-codegen-preset
```

## Configuration
Expand Down Expand Up @@ -75,7 +75,7 @@ The quickest way to set this package up is to use `shopifyApiProject`.
To do that, create a `.graphqlrc.ts` file in your app's root folder, and add the following content to it:

```js
import { shopifyApiProject, ApiType } from "@shopify/codegen-preset";
import { shopifyApiProject, ApiType } from "@shopify/api-codegen-preset";

export default {
// For syntax highlighting / auto-complete when writing operations
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "@shopify/codegen-preset",
"name": "@shopify/api-codegen-preset",
"version": "0.0.1",
"description": "Preset for graphql-codegen to parse and type queries to Shopify APIs",
"repository": {
Expand Down Expand Up @@ -76,5 +76,5 @@
"bugs": {
"url": "https://github.com/Shopify/shopify-api-js/issues"
},
"homepage": "https://github.com/Shopify/shopify-api-js/packages/codegen-preset#readme"
"homepage": "https://github.com/Shopify/shopify-api-js/packages/api-codegen-preset#readme"
}
2 changes: 1 addition & 1 deletion tsconfig.base.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,6 @@
{"path": "./packages/graphql-client"},
{"path": "./packages/storefront-api-client"},
{"path": "./packages/admin-api-client"},
{"path": "./packages/codegen-preset"}
{"path": "./packages/api-codegen-preset"}
]
}

0 comments on commit f0fe540

Please sign in to comment.