Skip to content
Draft
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
3 changes: 2 additions & 1 deletion packages/create-payload-app/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,8 @@
"fs-extra": "^9.0.1",
"globby": "11.1.0",
"tar": "^7.4.3",
"terminal-link": "^2.1.1"
"terminal-link": "^2.1.1",
"ts-morph": "27.0.0"
},
"devDependencies": {
"@types/esprima": "^4.0.6",
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
import { fileURLToPath } from 'node:url'
import path from 'path'
const filename = fileURLToPath(import.meta.url)
const dirname = path.dirname(filename)

import { addPluginsToConfig } from './add-plugins-to-config.js'
import { pluginReplacements } from './ast-replacements.js'

describe('populateConfigWithPlugins', () => {
it('should populate the config with plugins', async () => {
const configPath = path.resolve(dirname, '../../../../templates/blank/src/payload.config.ts')
const { configContent } = await addPluginsToConfig({
configPath,
plugins: ['@payloadcms/plugin-search'],
saveConfig: false,
})

const plugin = pluginReplacements['@payloadcms/plugin-search']

expect(configContent).toContain(`import { ${plugin.importName} } from '${plugin.importModule}'`)
expect(configContent).toMatch(/plugins:\s\[.*searchPlugin\(\).*\]/s)
})
})
68 changes: 68 additions & 0 deletions packages/create-payload-app/src/lib/add-plugins-to-config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
import { Project, QuoteKind, SyntaxKind } from 'ts-morph'

import type { PluginPackageName } from './ast-replacements.js'

import { pluginReplacements } from './ast-replacements.js'

export async function addPluginsToConfig({
configPath,
plugins,
saveConfig = true,
}: {
configPath: string
plugins: PluginPackageName[]
/** Save modifications to the config. Set to false for unit testing */
saveConfig?: boolean
}) {
const project = new Project({
manipulationSettings: {
quoteKind: QuoteKind.Single,
},
})

project.addSourceFilesAtPaths(configPath)
const sourceFile = project.getSourceFileOrThrow(configPath)

// Find the default export assignment
const exportAssignment = sourceFile.getExportAssignmentOrThrow(
(e) => e.isExportEquals() === false,
)

// Get the buildConfig call expression
const buildConfigCall = exportAssignment.getExpressionIfKindOrThrow(SyntaxKind.CallExpression)

// Get the first argument of buildConfig, which should be an object literal
const configObject = buildConfigCall
?.getArguments?.()?.[0]
?.asKindOrThrow(SyntaxKind.ObjectLiteralExpression)

// Find the plugins property on the config object
const pluginsProperty = configObject?.getPropertyOrThrow('plugins')

const pluginsArray = pluginsProperty
?.asKindOrThrow(SyntaxKind.PropertyAssignment)
?.getInitializerIfKindOrThrow(SyntaxKind.ArrayLiteralExpression)

const pluginsToAdd = plugins.map((name) => pluginReplacements[name]).filter(Boolean)

pluginsToAdd.forEach((plugin) => {
console.log(`Adding plugin: ${plugin.packageName}`)
pluginsArray?.addElement(plugin.pluginCode.join('\n')) // Questionable

sourceFile.addImportDeclaration({
moduleSpecifier: plugin.importModule,
namedImports: [plugin.importName],
})
})

// Save changes
if (saveConfig) {
await project.save()
}

console.log('Project changes saved.')

// TODO: Add plugin packages to package.json

return { configContent: sourceFile.getFullText() }
}
21 changes: 21 additions & 0 deletions packages/create-payload-app/src/lib/ast-replacements.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
export type PluginPackageName = '@payloadcms/plugin-search'
export const pluginReplacements: Record<
PluginPackageName,
{
/** Module used in import statement */
importModule: string
/** Named import used in import statement */
importName: string
/** Package to be added to the package.json */
packageName: string
/** Code to be added to the plugins array */
pluginCode: string[]
}
> = {
'@payloadcms/plugin-search': {
importModule: '@payloadcms/plugin-search',
importName: 'searchPlugin',
packageName: '@payloadcms/plugin-search',
pluginCode: ['searchPlugin()'],
},
}
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import path from 'path'
import type { DbType, StorageAdapterType } from '../types.js'

import { warning } from '../utils/log.js'
import { addPluginsToConfig } from './add-plugins-to-config.js'
import { dbReplacements, storageReplacements } from './replacements.js'

/** Update payload config with necessary imports and adapters */
Expand Down Expand Up @@ -138,6 +139,12 @@ export async function configurePayloadConfig(args: {
}

fse.writeFileSync(payloadConfigPath, configLines.join('\n'))

// Hard-coded plugin for POC
await addPluginsToConfig({
configPath: payloadConfigPath,
plugins: ['@payloadcms/plugin-search'],
})
} catch (err: unknown) {
warning(
`Unable to update payload.config.ts with plugins: ${err instanceof Error ? err.message : ''}`,
Expand Down
Loading
Loading