Skip to content
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

docs: add usage section about prettier-plugin-embed #327

Merged
merged 3 commits into from
Dec 9, 2023
Merged
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
57 changes: 57 additions & 0 deletions packages/sql/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,63 @@ npx prettier --write db.sql
yarn prettier --write db.sql
```

### SQL-in-JS with `prettier-plugin-embed`

Format SQL-in-JS tagged template literals by installing [`prettier-plugin-embed`](https://github.com/Sec-ant/prettier-plugin-embed) and configuring as follows:

`prettier.config.mjs`

```js
/** @type {import('prettier').Config} */
const prettierConfig = {
plugins: ['prettier-plugin-embed', 'prettier-plugin-sql'],
}

/** @type {import('prettier-plugin-embed').PrettierPluginEmbedOptions} */
const prettierPluginEmbedConfig = {
embeddedSqlIdentifiers: ['sql'],
}

/** @type {import('prettier-plugin-sql').SqlBaseOptions} */
const prettierPluginSqlConfig = {
language: 'postgresql',
keywordCase: 'upper',
}

const config = {
...prettierConfig,
...prettierPluginEmbedConfig,
...prettierPluginSqlConfig,
}

export default config
```

Before formatting:

```ts
const animals = await sql`
sELect first_name, species froM
animals
WhERE
id = ${id}
`
```

After formatting:

```ts
const animals = await sql`
SELECT
first_name,
species
FROM
animals
WHERE
id = ${id}
`
```

## Parser Options

```ts
Expand Down