Skip to content

fix(transformers): opt-in to correct extensions spelling #1213

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

Closed
Closed
Show file tree
Hide file tree
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
5 changes: 3 additions & 2 deletions src/module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -279,8 +279,9 @@ export default defineNuxtModule<ModuleOptions>({
// TODO: remove kit usage
templateUtils.importSources(contentContext.transformers),
`const transformers = [${contentContext.transformers.map(templateUtils.importName).join(', ')}]`,
'export const getParser = (ext) => transformers.find(p => ext.match(new RegExp(p.extensions.join("|"), "i")) && p.parse)',
'export const getTransformers = (ext) => transformers.filter(p => ext.match(new RegExp(p.extensions.join("|"), "i")) && p.transform)',
'const matchExtensionPattern = (p) => new RegExp((p.extensions || p.extentions).join("|"), "i")',
'export const getParser = (ext) => transformers.find(p => ext.match(matchExtensionPattern(p)) && p.parse)',
'export const getTransformers = (ext) => transformers.filter(p => ext.match(matchExtensionPattern(p)) && p.transform)',
'export default () => {}'
].join('\n')
})
Expand Down
4 changes: 4 additions & 0 deletions src/runtime/types.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,10 @@ export interface MarkdownParsedContent extends ParsedContent {

export interface ContentTransformer {
name: string
/**
* @deprecated Misspelled, use `extensions`
*/
extentions: string[]
extensions: string[]
parse?(id: string, content: string): Promise<ParsedContent> | ParsedContent
transform?: ((content: ParsedContent) => Promise<ParsedContent>) | ((content: ParsedContent) => ParsedContent)
Expand Down
5 changes: 4 additions & 1 deletion test/basic.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,10 @@ describe('fixtures:basic', async () => {
testJSONParser()

testPathMetaTransformer()

test('transformers:custom', async () => {
const index = await fetchDocument('content:index.md')
expect(index._customTransformed).toBeTruthy()
})
// testMDCComponent()

testRegex()
Expand Down
11 changes: 11 additions & 0 deletions test/fixtures/basic/addons/custom-transformer.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
import { ContentTransformer } from '../../../../src/runtime/types'

export default <ContentTransformer> {
name: 'custom-transformer',
// note this is using the deprecated `extentions` as a test
extentions: ['.*'],
transform (content) {
content._customTransformed = true
return content
}
}
13 changes: 13 additions & 0 deletions test/fixtures/basic/modules/content-helper.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
import { createResolver, defineNuxtModule, useNuxt } from '@nuxt/kit'

export default defineNuxtModule({
setup () {
const nuxt = useNuxt()

const resolver = createResolver(import.meta.url)

nuxt.hooks.hook('content:context', (ctx) => {
ctx.transformers.push(resolver.resolve('../addons/custom-transformer'))
})
}
})
5 changes: 4 additions & 1 deletion test/fixtures/basic/nuxt.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,10 @@ export default defineNuxtConfig({
}
]
},
buildModules: [contentModule],
buildModules: [
'~/modules/content-helper',
contentModule
],
content: {
locales: ['en', 'fa'],
sources: [
Expand Down