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.

Sign up for GitHub

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

Jump to bottom

docs: fix and update transformers #2639

Merged
merged 1 commit into from
May 31, 2024
Merged

docs: fix and update transformers #2639

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 5 additions & 9 deletions docs/content/6.recipes/2.transformers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ You can create custom transformers to support new content types or improve funct
- `transform`: Receives that parsed content and manipulates it.

```ts [my-transformer.ts]
// filename: my-transformer.ts
// @ts-expect-error
import { defineTransformer } from '@nuxt/content/transformers'

export default defineTransformer({
name: 'my-transformer',
extensions: ['.names'],
parse (_id, rawContent) {
parse (_id: string, rawContent: string) {
return {
_id,
body: rawContent.trim().split('\n').map(line => line.trim()).sort()
Expand All @@ -32,8 +32,7 @@ export default defineTransformer({

2. Define simple module to register transformer

```ts [my-module.mjs]
// filename: my-module.mjs
```ts [my-module.ts]
import { resolve } from 'path'
import { defineNuxtModule } from '@nuxt/kit'

Expand All @@ -42,7 +41,7 @@ export default defineNuxtModule({
nuxt.options.nitro.externals = nuxt.options.nitro.externals || {}
nuxt.options.nitro.externals.inline = nuxt.options.nitro.externals.inline || []
nuxt.options.nitro.externals.inline.push(resolve('./my-module'))
// @ts-ignore
// @ts-expect-error
nuxt.hook('content:context', (contentContext) => {
contentContext.transformers.push(resolve('./my-module/my-transformer.ts'))
})
Expand All @@ -54,10 +53,7 @@ export default defineNuxtModule({
3. Register your module

```ts [nuxt.config.ts]
// filename: my-module.mjs
import { resolve } from 'path'
import { defineNuxtConfig } from '@nuxt/kit'
import MyModule from './my-module'
import MyModule from './my-module/my-module'

export default defineNuxtConfig({
modules: [
Expand Down