vue-sps/laravel-js-localization

Laravel JavaScript 本地化

v1.9.0 2024-05-08 17:45 UTC

README

Laravel JS Localization - Convert you Laravel messages and use them in the front-end!

Laravel 5.5 Laravel 4.2 Latest Stable Version Total Downloads License

此包将您的 Laravel 应用中的所有本地化消息转换为 JavaScript,使用一个小型库来与这些消息进行交互,语法与您熟悉的语法非常相似。

特性

  • 支持 Laravel 4.2、5、6、7 和 8。
  • 包含 Lang.js(一个高度受 Laravel 的 Translator 类启发的薄库)。
  • 允许指定要转换为 JS 的所需 lang 文件。
  • Lang.js API 基于 Laravel 的 Translator 类。无需学习整个 API。

安装

composer require mariuzzo/laravel-js-localization

在您的 Laravel 应用中,转到 config/app.php 并添加以下服务提供者

Mariuzzo\LaravelJsLocalization\LaravelJsLocalizationServiceProvider::class

使用

Laravel-JS-Localization 包提供了一项命令,该命令将生成所有在 app/lang(Laravel 4)或 resources/lang(Laravel 5)目录中找到的消息的 JavaScript 版本。生成的 JavaScript 文件将包含您的所有消息以及 Lang.js(一个高度受 Laravel 的 Translator 类启发的薄库)。

生成 JS 消息

php artisan lang:js

指定自定义目标

php artisan lang:js public/assets/dist/lang.dist.js

压缩 JS 文件

php artisan lang:js -c

指定自定义源文件夹

php artisan lang:js public/assets/dist/lang.dist.js -s themes/default/lang

输出 JSON 文件。

php artisan lang:js --json

配置

首先,运行以下命令以发布默认包的配置文件

php artisan vendor:publish --provider="Mariuzzo\LaravelJsLocalization\LaravelJsLocalizationServiceProvider"

配置将被发布到 config/localization-js.php

您可以通过编辑配置文件中的 messages 数组来定义您在 Javascript 代码中需要的消息。只需编辑配置文件中的 messages 数组。 空消息数组将包括构建中所有语言文件

仅将 pagination.phpvalidation.php 文件包含在构建过程中

<?php

return [
    'messages' => [
        'pagination',
        'validation',
    ],
];

使用 gulp(可选)

安装 gulp-shell 并然后在您的 gulpfile.js 中直接运行它

var shell = require('gulp-shell');

gulp.task('langjs', shell.task('php artisan lang:js -c public/js/messages.js'));

使用 Laravel 的 elixir(可选)

在 Elixir 4.0 之前

elixir.extend('langjs', function(path) {
    gulp.task('langjs', function() {
        gulp.src('').pipe(shell('php artisan lang:js ' + (path || 'public/js/messages.js')));
    });

    return this.queueTask('langjs');
});

Elixir 4.0+

var Task = elixir.Task;
elixir.extend('langjs', function(path) {
    new Task('langjs', function() {
        gulp.src('').pipe(shell('php artisan lang:js ' + (path || 'public/js/messages.js')));
    });
});

并像这样使用它

elixir(function(mix) {
    mix.langjs();
});

使用 Laravel 5.4+ 的 Laravel 的 Mix(可选)

将 "webpack-shell-plugin" 添加到 package.json 的 "devDependencies" 部分。

在 webpack.mix.js 中添加以下内容

const WebpackShellPlugin = require('webpack-shell-plugin');

// Add shell command plugin configured to create JavaScript language file
mix.webpackConfig({
    plugins:
    [
        new WebpackShellPlugin({onBuildStart:['php artisan lang:js --quiet'], onBuildEnd:[]})
    ]
});

文档

这是关于 Lang.js(由 Laravel-JS-Localization 包包含的薄 JavaScript 库)的快速文档。 Lang.js(一个高度受 Laravel 的 Translator 类启发的薄库)。

💁 前往 Lang.js 文档以查看所有可用方法。

获取消息

Lang.get('messages.home');

使用替换获取消息

Lang.get('messages.welcome', { name: 'Joe' });

更改区域设置

Lang.setLocale('es');

检查消息键是否存在

Lang.has('messages.foo');

基于计数支持单数和复数消息

Lang.choice('messages.apples', 10);

使用替换调用 choice 方法

Lang.choice('messages.apples', 10, { name: 'Joe' });

💁 前往 Lang.js 文档以查看所有可用方法。

想要贡献?

  1. fork此仓库并克隆它。
  2. 从develop创建一个功能分支git checkout develop; git checkout -b feature-foo
  3. 推送您的提交并创建一个pull request。

先决条件

您需要安装以下软件。

  • Composer。
  • PHP 5.5+。

开发设置

在安装所有必需软件后,您可以运行以下命令来准备一切

  1. 安装PHP依赖

    composer install
  2. 安装测试依赖

    composer test-install

现在您可以开始了!祝您编码愉快!

测试

此项目使用PHPUnit。所有测试都存储在tests目录中。要在终端运行所有测试,请输入

composer test

Rubens Mariuzzo用❤️制作。

MIT许可证