build: move larger scripts into tools dir in workspace (#10653)
Having the `scripts` dir re-use all packages from the top-level was getting quite unwieldy. Created new `tools` directory that is part of the workspace. Packages are exported with the `@tools` package namespace.
This commit is contained in:
Elliot DeNolf
83
tools/scripts/src/build-template-with-local-pkgs.ts
Normal file
83
tools/scripts/src/build-template-with-local-pkgs.ts
Normal file
@@ -0,0 +1,83 @@
|
||||
import { TEMPLATES_DIR } from '@tools/constants'
|
||||
import chalk from 'chalk'
|
||||
import { exec as execOrig, execSync } from 'child_process'
|
||||
import fs from 'fs/promises'
|
||||
import path from 'path'
|
||||
|
||||
main().catch((error) => {
|
||||
console.error(error)
|
||||
process.exit(1)
|
||||
})
|
||||
|
||||
async function main() {
|
||||
const templateName = process.argv[2]
|
||||
if (!templateName) {
|
||||
throw new Error('Please provide a template name')
|
||||
}
|
||||
const templatePath = path.join(TEMPLATES_DIR, templateName)
|
||||
const databaseConnection = process.argv[3] || 'mongodb://127.0.0.1/your-database-name'
|
||||
|
||||
console.log({
|
||||
templatePath,
|
||||
databaseConnection,
|
||||
})
|
||||
|
||||
const execOpts = {
|
||||
cwd: templatePath,
|
||||
stdio: 'inherit' as const,
|
||||
}
|
||||
|
||||
const allFiles = await fs.readdir(templatePath, { withFileTypes: true })
|
||||
const allTgzs = allFiles
|
||||
.filter((file) => file.isFile())
|
||||
.map((file) => file.name)
|
||||
.filter((file) => file.endsWith('.tgz'))
|
||||
|
||||
console.log({
|
||||
allTgzs,
|
||||
})
|
||||
|
||||
execSync('pnpm add ./*.tgz --ignore-workspace', execOpts)
|
||||
execSync('pnpm install --ignore-workspace', execOpts)
|
||||
|
||||
const packageJsonPath = path.join(templatePath, 'package.json')
|
||||
const packageJson = await fs.readFile(packageJsonPath, 'utf-8')
|
||||
const packageJsonObj = JSON.parse(packageJson) as {
|
||||
dependencies: Record<string, string>
|
||||
pnpm?: { overrides: Record<string, string> }
|
||||
}
|
||||
|
||||
// Get key/value pairs for any package that starts with '@payloadcms'
|
||||
const payloadValues =
|
||||
packageJsonObj.dependencies &&
|
||||
Object.entries(packageJsonObj.dependencies).filter(
|
||||
([key, value]) => key.startsWith('@payloadcms') || key === 'payload',
|
||||
)
|
||||
|
||||
// Add each package to the overrides
|
||||
const overrides = packageJsonObj.pnpm?.overrides || {}
|
||||
payloadValues.forEach(([key, value]) => {
|
||||
overrides[key] = value
|
||||
})
|
||||
|
||||
// Write package.json back to disk
|
||||
packageJsonObj.pnpm = { overrides }
|
||||
await fs.writeFile(packageJsonPath, JSON.stringify(packageJsonObj, null, 2))
|
||||
|
||||
execSync('pnpm install --ignore-workspace --no-frozen-lockfile', execOpts)
|
||||
await fs.writeFile(
|
||||
path.resolve(templatePath, '.env'),
|
||||
// Populate POSTGRES_URL just in case it's needed
|
||||
`PAYLOAD_SECRET=secret
|
||||
DATABASE_URI=${databaseConnection}
|
||||
POSTGRES_URL=${databaseConnection}
|
||||
BLOB_READ_WRITE_TOKEN=vercel_blob_rw_TEST_asdf`,
|
||||
)
|
||||
execSync('pnpm run build', execOpts)
|
||||
|
||||
header(`\n🎉 Done!`)
|
||||
}
|
||||
|
||||
function header(message: string, opts?: { enable?: boolean }) {
|
||||
console.log(chalk.bold.green(`${message}\n`))
|
||||
}
|
||||
378
tools/scripts/src/generate-template-variations.ts
Normal file
378
tools/scripts/src/generate-template-variations.ts
Normal file
@@ -0,0 +1,378 @@
|
||||
/**
|
||||
* This script generates variations of the templates into the `templates` directory.
|
||||
*
|
||||
* How to use:
|
||||
*
|
||||
* pnpm run script:gen-templates
|
||||
*
|
||||
* NOTE: You will likely have to commit by using the `--no-verify` flag to avoid the repo linting
|
||||
* There is no way currently to have lint-staged ignore the templates directory.
|
||||
*/
|
||||
|
||||
import type { DbType, StorageAdapterType } from 'create-payload-app/types'
|
||||
|
||||
import { PROJECT_ROOT, TEMPLATES_DIR } from '@tools/constants'
|
||||
import chalk from 'chalk'
|
||||
import { execSync } from 'child_process'
|
||||
import { configurePayloadConfig } from 'create-payload-app/lib/configure-payload-config.js'
|
||||
import { copyRecursiveSync } from 'create-payload-app/utils/copy-recursive-sync.js'
|
||||
import minimist from 'minimist'
|
||||
import * as fs from 'node:fs/promises'
|
||||
import path from 'path'
|
||||
|
||||
type TemplateVariations = {
|
||||
/** Base template to copy from */
|
||||
base?: string
|
||||
configureConfig?: boolean
|
||||
db: DbType
|
||||
/** Directory in templates dir */
|
||||
dirname: string
|
||||
envNames?: {
|
||||
dbUri: string
|
||||
}
|
||||
generateLockfile?: boolean
|
||||
/** package.json name */
|
||||
name: string
|
||||
sharp: boolean
|
||||
skipConfig?: boolean
|
||||
/**
|
||||
* @default false
|
||||
*/
|
||||
skipDockerCompose?: boolean
|
||||
/**
|
||||
* @default false
|
||||
*/
|
||||
skipReadme?: boolean
|
||||
storage: StorageAdapterType
|
||||
vercelDeployButtonLink?: string
|
||||
}
|
||||
|
||||
main().catch((error) => {
|
||||
console.error(error)
|
||||
process.exit(1)
|
||||
})
|
||||
|
||||
async function main() {
|
||||
const args = minimist(process.argv.slice(2))
|
||||
const template = args['template'] // template directory name
|
||||
|
||||
const templateRepoUrlBase = `https://github.com/payloadcms/payload/tree/main/templates`
|
||||
|
||||
let variations: TemplateVariations[] = [
|
||||
{
|
||||
name: 'payload-vercel-postgres-template',
|
||||
db: 'vercel-postgres',
|
||||
dirname: 'with-vercel-postgres',
|
||||
envNames: {
|
||||
// This will replace the process.env.DATABASE_URI to process.env.POSTGRES_URL
|
||||
dbUri: 'POSTGRES_URL',
|
||||
},
|
||||
sharp: false,
|
||||
storage: 'vercelBlobStorage',
|
||||
vercelDeployButtonLink:
|
||||
`https://vercel.com/new/clone?repository-url=` +
|
||||
encodeURI(
|
||||
`${templateRepoUrlBase}/with-vercel-postgres` +
|
||||
'&project-name=payload-project' +
|
||||
'&env=PAYLOAD_SECRET' +
|
||||
'&build-command=pnpm run ci' +
|
||||
'&stores=[{"type":"postgres"},{"type":"blob"}]', // Postgres and Vercel Blob Storage
|
||||
),
|
||||
},
|
||||
{
|
||||
name: 'payload-vercel-website-template',
|
||||
base: 'website', // This is the base template to copy from
|
||||
db: 'vercel-postgres',
|
||||
dirname: 'with-vercel-website',
|
||||
envNames: {
|
||||
// This will replace the process.env.DATABASE_URI to process.env.POSTGRES_URL
|
||||
dbUri: 'POSTGRES_URL',
|
||||
},
|
||||
sharp: true,
|
||||
skipDockerCompose: true,
|
||||
skipReadme: true,
|
||||
storage: 'vercelBlobStorage',
|
||||
vercelDeployButtonLink:
|
||||
`https://vercel.com/new/clone?repository-url=` +
|
||||
encodeURI(
|
||||
`${templateRepoUrlBase}/with-vercel-website` +
|
||||
'&project-name=payload-project' +
|
||||
'&env=PAYLOAD_SECRET%2CCRON_SECRET' +
|
||||
'&build-command=pnpm run ci' +
|
||||
'&stores=[{"type":"postgres"},{"type":"blob"}]', // Postgres and Vercel Blob Storage
|
||||
),
|
||||
},
|
||||
{
|
||||
name: 'payload-postgres-template',
|
||||
db: 'postgres',
|
||||
dirname: 'with-postgres',
|
||||
sharp: true,
|
||||
storage: 'localDisk',
|
||||
},
|
||||
{
|
||||
name: 'payload-vercel-mongodb-template',
|
||||
db: 'mongodb',
|
||||
dirname: 'with-vercel-mongodb',
|
||||
envNames: {
|
||||
dbUri: 'MONGODB_URI',
|
||||
},
|
||||
sharp: false,
|
||||
storage: 'vercelBlobStorage',
|
||||
vercelDeployButtonLink:
|
||||
`https://vercel.com/new/clone?repository-url=` +
|
||||
encodeURI(
|
||||
`${templateRepoUrlBase}/with-vercel-mongodb` +
|
||||
'&project-name=payload-project' +
|
||||
'&env=PAYLOAD_SECRET' +
|
||||
'&build-command=pnpm run ci' +
|
||||
'&stores=[{"type":"blob"}]' + // Vercel Blob Storage
|
||||
'&integration-ids=oac_jnzmjqM10gllKmSrG0SGrHOH', // MongoDB Atlas
|
||||
),
|
||||
},
|
||||
{
|
||||
name: 'blank',
|
||||
db: 'mongodb',
|
||||
dirname: 'blank',
|
||||
generateLockfile: true,
|
||||
sharp: true,
|
||||
skipConfig: true, // Do not copy the payload.config.ts file from the base template
|
||||
storage: 'localDisk',
|
||||
// The blank template is used as a base for create-payload-app functionality,
|
||||
// so we do not configure the payload.config.ts file, which leaves the placeholder comments.
|
||||
configureConfig: false,
|
||||
},
|
||||
]
|
||||
|
||||
// If template is set, only generate that template
|
||||
if (template) {
|
||||
const variation = variations.find((v) => v.dirname === template)
|
||||
if (!variation) {
|
||||
throw new Error(`Variation not found: ${template}`)
|
||||
}
|
||||
variations = [variation]
|
||||
}
|
||||
|
||||
for (const {
|
||||
name,
|
||||
base,
|
||||
configureConfig,
|
||||
db,
|
||||
dirname,
|
||||
envNames,
|
||||
generateLockfile,
|
||||
sharp,
|
||||
skipConfig = false,
|
||||
skipDockerCompose = false,
|
||||
skipReadme = false,
|
||||
storage,
|
||||
vercelDeployButtonLink,
|
||||
} of variations) {
|
||||
header(`Generating ${name}...`)
|
||||
const destDir = path.join(TEMPLATES_DIR, dirname)
|
||||
copyRecursiveSync(path.join(TEMPLATES_DIR, base || '_template'), destDir, [
|
||||
'node_modules',
|
||||
'\\*\\.tgz',
|
||||
'.next',
|
||||
'.env$',
|
||||
'pnpm-lock.yaml',
|
||||
...(skipReadme ? ['README.md'] : []),
|
||||
...(skipDockerCompose ? ['docker-compose.yml'] : []),
|
||||
...(skipConfig ? ['payload.config.ts'] : []),
|
||||
])
|
||||
|
||||
log(`Copied to ${destDir}`)
|
||||
|
||||
if (configureConfig !== false) {
|
||||
log('Configuring payload.config.ts')
|
||||
const configureArgs = {
|
||||
dbType: db,
|
||||
envNames,
|
||||
packageJsonName: name,
|
||||
projectDirOrConfigPath: { projectDir: destDir },
|
||||
sharp,
|
||||
storageAdapter: storage,
|
||||
}
|
||||
await configurePayloadConfig(configureArgs)
|
||||
|
||||
log('Configuring .env.example')
|
||||
// Replace DATABASE_URI with the correct env name if set
|
||||
await writeEnvExample({
|
||||
dbType: db,
|
||||
destDir,
|
||||
envNames,
|
||||
})
|
||||
}
|
||||
|
||||
if (!skipReadme) {
|
||||
await generateReadme({
|
||||
data: {
|
||||
name,
|
||||
attributes: { db, storage },
|
||||
description: name, // TODO: Add descriptions
|
||||
...(vercelDeployButtonLink && { vercelDeployButtonLink }),
|
||||
},
|
||||
destDir,
|
||||
})
|
||||
}
|
||||
|
||||
if (generateLockfile) {
|
||||
log('Generating pnpm-lock.yaml')
|
||||
execSyncSafe(`pnpm install --ignore-workspace`, { cwd: destDir })
|
||||
} else {
|
||||
log('Installing dependencies without generating lockfile')
|
||||
execSyncSafe(`pnpm install --ignore-workspace`, { cwd: destDir })
|
||||
await fs.rm(`${destDir}/pnpm-lock.yaml`, { force: true })
|
||||
}
|
||||
|
||||
// Copy in initial migration if db is postgres. This contains user and media.
|
||||
if (db === 'postgres' || db === 'vercel-postgres') {
|
||||
// Add "ci" script to package.json
|
||||
const packageJsonPath = path.join(destDir, 'package.json')
|
||||
const packageJson = JSON.parse(await fs.readFile(packageJsonPath, 'utf8'))
|
||||
packageJson.scripts = packageJson.scripts || {}
|
||||
packageJson.scripts.ci = 'payload migrate && pnpm build'
|
||||
await fs.writeFile(packageJsonPath, JSON.stringify(packageJson, null, 2))
|
||||
|
||||
const migrationDestDir = path.join(destDir, 'src/migrations')
|
||||
|
||||
// Delete and recreate migrations directory
|
||||
await fs.rm(migrationDestDir, { force: true, recursive: true })
|
||||
await fs.mkdir(migrationDestDir, { recursive: true })
|
||||
|
||||
log(`Generating initial migrations in ${migrationDestDir}`)
|
||||
|
||||
execSyncSafe(`pnpm run payload migrate:create initial`, {
|
||||
cwd: destDir,
|
||||
env: {
|
||||
...process.env,
|
||||
BLOB_READ_WRITE_TOKEN: 'vercel_blob_rw_TEST_asdf',
|
||||
DATABASE_URI: process.env.POSTGRES_URL || 'postgres://localhost:5432/your-database-name',
|
||||
PAYLOAD_SECRET: 'asecretsolongnotevensantacouldguessit',
|
||||
},
|
||||
})
|
||||
}
|
||||
|
||||
// TODO: Email?
|
||||
|
||||
// TODO: Sharp?
|
||||
|
||||
log(`Done configuring payload config for ${destDir}/src/payload.config.ts`)
|
||||
}
|
||||
log('Running prettier on generated files...')
|
||||
execSyncSafe(`pnpm prettier --write templates "*.{js,jsx,ts,tsx}"`, { cwd: PROJECT_ROOT })
|
||||
|
||||
log('Template generation complete!')
|
||||
}
|
||||
|
||||
async function generateReadme({
|
||||
data: { name, attributes, description, vercelDeployButtonLink },
|
||||
destDir,
|
||||
}: {
|
||||
data: {
|
||||
attributes: Pick<TemplateVariations, 'db' | 'storage'>
|
||||
description: string
|
||||
name: string
|
||||
vercelDeployButtonLink?: string
|
||||
}
|
||||
destDir: string
|
||||
}) {
|
||||
let header = `# ${name}\n`
|
||||
if (vercelDeployButtonLink) {
|
||||
header += `\n[](${vercelDeployButtonLink})`
|
||||
}
|
||||
|
||||
const readmeContent = `${header}
|
||||
|
||||
${description}
|
||||
|
||||
## Attributes
|
||||
|
||||
- **Database**: ${attributes.db}
|
||||
- **Storage Adapter**: ${attributes.storage}
|
||||
`
|
||||
|
||||
const readmePath = path.join(destDir, 'README.md')
|
||||
await fs.writeFile(readmePath, readmeContent)
|
||||
log('Generated README.md')
|
||||
}
|
||||
|
||||
async function writeEnvExample({
|
||||
dbType,
|
||||
destDir,
|
||||
envNames,
|
||||
}: {
|
||||
dbType: DbType
|
||||
destDir: string
|
||||
envNames?: TemplateVariations['envNames']
|
||||
}) {
|
||||
const envExamplePath = path.join(destDir, '.env.example')
|
||||
const envFileContents = await fs.readFile(envExamplePath, 'utf8')
|
||||
|
||||
const fileContents = envFileContents
|
||||
.split('\n')
|
||||
.filter((l) => {
|
||||
// Remove the unwanted PostgreSQL connection comment for "with-vercel-website"
|
||||
if (
|
||||
dbType === 'vercel-postgres' &&
|
||||
(l.startsWith('# Or use a PG connection string') ||
|
||||
l.startsWith('#DATABASE_URI=postgresql://'))
|
||||
) {
|
||||
return false // Skip this line
|
||||
}
|
||||
return true // Keep other lines
|
||||
})
|
||||
.map((l) => {
|
||||
if (l.startsWith('DATABASE_URI')) {
|
||||
if (dbType === 'mongodb') {
|
||||
l = 'MONGODB_URI=mongodb://127.0.0.1/your-database-name'
|
||||
}
|
||||
// Use db-appropriate connection string
|
||||
if (dbType.includes('postgres')) {
|
||||
l = 'DATABASE_URI=postgresql://127.0.0.1:5432/your-database-name'
|
||||
}
|
||||
|
||||
// Replace DATABASE_URI with the correct env name if set
|
||||
if (envNames?.dbUri) {
|
||||
l = l.replace('DATABASE_URI', envNames.dbUri)
|
||||
}
|
||||
}
|
||||
return l
|
||||
})
|
||||
.filter((l) => l.trim() !== '')
|
||||
.join('\n')
|
||||
|
||||
console.log(`Writing to ${envExamplePath}`)
|
||||
await fs.writeFile(envExamplePath, fileContents)
|
||||
}
|
||||
|
||||
function header(message: string) {
|
||||
console.log(chalk.bold.green(`\n${message}\n`))
|
||||
}
|
||||
|
||||
function log(message: string) {
|
||||
console.log(chalk.dim(message))
|
||||
}
|
||||
function execSyncSafe(command: string, options?: Parameters<typeof execSync>[1]) {
|
||||
try {
|
||||
console.log(`Executing: ${command}`)
|
||||
execSync(command, { stdio: 'inherit', ...options })
|
||||
} catch (error) {
|
||||
if (error instanceof Error) {
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
const stderr = (error as any).stderr?.toString()
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
const stdout = (error as any).stdout?.toString()
|
||||
|
||||
if (stderr && stderr.trim()) {
|
||||
console.error('Standard Error:', stderr)
|
||||
} else if (stdout && stdout.trim()) {
|
||||
console.error('Standard Output (likely contains error details):', stdout)
|
||||
} else {
|
||||
console.error('An unknown error occurred with no output.')
|
||||
}
|
||||
} else {
|
||||
console.error('An unexpected error occurred:', error)
|
||||
}
|
||||
throw error
|
||||
}
|
||||
}
|
||||
0
tools/scripts/src/index.ts
Normal file
0
tools/scripts/src/index.ts
Normal file
92
tools/scripts/src/pack-all-to-dest.ts
Normal file
92
tools/scripts/src/pack-all-to-dest.ts
Normal file
@@ -0,0 +1,92 @@
|
||||
import type { PackageDetails } from '@tools/releaser'
|
||||
import type { ExecSyncOptions } from 'child_process'
|
||||
|
||||
import { PROJECT_ROOT } from '@tools/constants'
|
||||
import { getPackageDetails } from '@tools/releaser'
|
||||
import chalk from 'chalk'
|
||||
import { exec as execOrig, execSync } from 'child_process'
|
||||
import minimist from 'minimist'
|
||||
import path from 'path'
|
||||
import util from 'util'
|
||||
|
||||
const execOpts: ExecSyncOptions = { stdio: 'inherit', cwd: PROJECT_ROOT }
|
||||
|
||||
const exec = util.promisify(execOrig)
|
||||
|
||||
main().catch((error) => {
|
||||
console.error(error)
|
||||
process.exit(1)
|
||||
})
|
||||
|
||||
async function main() {
|
||||
const all = process.argv.includes('--all')
|
||||
process.argv = process.argv.filter((arg) => arg !== '--all')
|
||||
|
||||
const noBuild = process.argv.includes('--no-build')
|
||||
process.argv = process.argv.filter((arg) => arg !== '--no-build')
|
||||
|
||||
const args = minimist(process.argv.slice(2))
|
||||
const { dest } = args
|
||||
if (!dest) {
|
||||
throw new Error('--dest is required')
|
||||
}
|
||||
|
||||
const resolvedDest = path.resolve(path.isAbsolute(dest) ? dest : path.join(PROJECT_ROOT, dest))
|
||||
|
||||
const packageWhitelist = all
|
||||
? undefined
|
||||
: [
|
||||
'payload',
|
||||
'db-mongodb',
|
||||
'db-postgres',
|
||||
'db-sqlite',
|
||||
'db-vercel-postgres',
|
||||
'drizzle',
|
||||
'graphql',
|
||||
'live-preview-react',
|
||||
'next',
|
||||
'payload-cloud',
|
||||
'plugin-cloud',
|
||||
'plugin-form-builder',
|
||||
'plugin-nested-docs',
|
||||
'plugin-redirects',
|
||||
'plugin-search',
|
||||
'plugin-seo',
|
||||
'richtext-lexical',
|
||||
'translations',
|
||||
'ui',
|
||||
]
|
||||
|
||||
const packageDetails = await getPackageDetails(packageWhitelist)
|
||||
|
||||
// Prebuild all packages
|
||||
header(`\n🔨 Prebuilding all packages...`)
|
||||
|
||||
const filtered = packageDetails.filter((p): p is Exclude<typeof p, null> => p !== null)
|
||||
|
||||
if (!noBuild) {
|
||||
execSync('pnpm build:all --output-logs=errors-only', execOpts)
|
||||
}
|
||||
|
||||
header(`\nOutputting ${filtered.length} packages...
|
||||
|
||||
${chalk.white.bold(listPackages(filtered))}`)
|
||||
|
||||
header(`\n📦 Packing all packages to ${resolvedDest}...`)
|
||||
|
||||
await Promise.all(
|
||||
filtered.map(async (p) => {
|
||||
await exec(`pnpm pack -C ${p.packagePath} --pack-destination ${resolvedDest}`, execOpts)
|
||||
}),
|
||||
)
|
||||
|
||||
header(`\n🎉 Done!`)
|
||||
}
|
||||
|
||||
function header(message: string, opts?: { enable?: boolean }) {
|
||||
console.log(chalk.bold.green(`${message}\n`))
|
||||
}
|
||||
|
||||
function listPackages(packages: PackageDetails[]) {
|
||||
return packages.map((p) => ` - ${p.name}`).join('\n')
|
||||
}
|
||||
Reference in New Issue
Block a user