Skip to content

feat(i18n): add command to publish localization templates #5037

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

Open
guoyunhe wants to merge 6 commits into
base: 6.x
Choose a base branch
from
+162 −0
Open

feat(i18n): add command to publish localization templates #5037

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
9fe88ea
feat(i18n): add command to publish localization templates
guoyunhe Jan 27, 2026
ff2ec4f
fix: update import paths to use node: prefix for fs modules
guoyunhe Jan 27, 2026
19c6765
feat(i18n): add merge flag for localization template publishing
guoyunhe Feb 1, 2026
c603c9c
feat(lang): add mkdir for validator.json destination and implement te…
guoyunhe Feb 1, 2026
97c822b
refactor(tests): format log messages and improve test readability in …
guoyunhe Feb 1, 2026
5bee8f7
refactor(tests): remove outdated comments and clarify message merging…
guoyunhe Feb 1, 2026
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
80 changes: 80 additions & 0 deletions commands/lang/publish.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
/*
* @adonisjs/core
*
* (c) AdonisJS
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

import { BaseCommand, flags } from '../../modules/ace/main.js'
import { writeFile, readFile, mkdir } from 'node:fs/promises'
import { existsSync } from 'node:fs'
import { dirname } from 'node:path'

/**
* Publish localization templates
*/
export default class MakeCommand extends BaseCommand {
static commandName = 'lang:publish'
static description = 'Eject localization templates to resources/lang/en directory'

@flags.boolean({ description: 'Merge with existing "validator.json" file' })
declare merge?: boolean

async run() {
let messages: any = {}
try {
const vine = await import('@vinejs/vine/defaults')
messages = vine.messages
} catch {
this.exitCode = 1
this.logger.error('Vine is not installed. No localization templates to publish.')
return
}

const destination = this.app.languageFilesPath('en', 'validator.json')

if (existsSync(destination) && !this.merge) {
this.exitCode = 1
this.logger.error(
'File "resources/lang/en/validator.json" already exists. Use "--merge" flag to update the file'
)
return
}

let validatorMessages = {
shared: {
messages: {},
},
}

if (existsSync(destination)) {
try {
validatorMessages = JSON.parse(await readFile(destination, 'utf-8'))
} catch {
this.exitCode = 1
this.logger.error(
'Failed to parse existing validator.json. Overwriting with default contents.'
)
return
}
}

validatorMessages = {
...validatorMessages,
shared: {
...validatorMessages.shared,
messages: {
...messages,
...validatorMessages.shared?.messages,
},
},
}

await mkdir(dirname(destination), { recursive: true })
await writeFile(destination, JSON.stringify(validatorMessages, null, 2))

this.logger.success('Localization template published to resources/lang/en/validator.json')
}
}
82 changes: 82 additions & 0 deletions tests/commands/lang_publish.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
import { test } from '@japa/runner'
import { AceFactory } from '../../factories/core/ace.js'
import LangPublishCommand from '../../commands/lang/publish.js'

test.group('Lang publish', () => {
test('publish validator messages', async ({ assert, fs }) => {
const ace = await new AceFactory().make(fs.baseUrl)
await ace.app.init()
ace.ui.switchMode('raw')

const command = await ace.create(LangPublishCommand, [])
await command.exec()

await assert.fileExists('resources/lang/en/validator.json')
const json = await fs.contentsJson('resources/lang/en/validator.json')
assert.isObject(json.shared)
assert.isObject(json.shared.messages)
assert.isTrue(Object.keys(json.shared.messages).length > 0)

assert.deepEqual(ace.ui.logger.getLogs(), [
{
message:
'[ green(success) ] Localization template published to resources/lang/en/validator.json',
stream: 'stdout',
},
])
})

test('skip when validator messages file already exists', async ({ assert, fs }) => {
const ace = await new AceFactory().make(fs.baseUrl)
await ace.app.init()
ace.ui.switchMode('raw')

await fs.create('resources/lang/en/validator.json', JSON.stringify({ old: true }))

const command = await ace.create(LangPublishCommand, [])
await command.exec()

const json = await fs.contentsJson('resources/lang/en/validator.json')
assert.deepEqual(json, { old: true })

assert.deepEqual(ace.ui.logger.getLogs(), [
{
message:
'[ red(error) ] File "resources/lang/en/validator.json" already exists. Use "--merge" flag to update the file',
stream: 'stderr',
},
])
})

test('merge when validator messages file already exists and --merge is used', async ({
assert,
fs,
}) => {
const ace = await new AceFactory().make(fs.baseUrl)
await ace.app.init()
ace.ui.switchMode('raw')

await fs.create(
'resources/lang/en/validator.json',
JSON.stringify({
shared: { messages: { required: 'foo' } },
other: true,
})
)

const command = await ace.create(LangPublishCommand, ['--merge'])
await command.exec()

const json = await fs.contentsJson('resources/lang/en/validator.json')
assert.property(json, 'other')
assert.equal(json.shared.messages.required, 'foo')

assert.deepEqual(ace.ui.logger.getLogs(), [
{
message:
'[ green(success) ] Localization template published to resources/lang/en/validator.json',
stream: 'stdout',
},
])
})
})
Loading