supsign / laravel-js-localization
Laravel JavaScript 本地化
Requires
- php: ^5.4 || ^7.0 || ^8.0
- illuminate/config: ^4.2 || ^5.0 || ^6.0 || ^7.0 || ^8.0 || ^9.0 || ^10.0 || ^11.0
- illuminate/console: ^4.2 || ^5.0 || ^6.0 || ^7.0 || ^8.0 || ^9.0 || ^10.0 || ^11.0
- illuminate/filesystem: ^4.2 || ^5.0 || ^6.0 || ^7.0 || ^8.0 || ^9.0 || ^10.0 || ^11.0
- tedivm/jshrink: ~1.0
Requires (Dev)
- orchestra/testbench: ^2.2 || ^3.0 || ^4.0 || ^5.0 || ^6.0 || ^7.0 || ^8.0 || ^9.0
- phpunit/phpunit: ^4.0 || ^5.0 || ^6.0 || ^7.0 || ^8.0 || ^9.0 || ^10.0 || ^11.0
This package is auto-updated.
Last update: 2024-09-19 16:20:20 UTC
README
此包可以将您的 Laravel 应用中的所有本地化消息转换为 JavaScript,使用一个小型库来与这些消息交互,语法与您所熟悉的语法非常相似。
功能
- 支持 Laravel 5.0 至 11.0
- 包含 Lang.js(一个受 Laravel 的
Translator
类高度启发的精简库)。 - 允许指定要转换为 JS 的所需语言文件。
- 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
。
您可以编辑此文件以定义您的 JavaScript 代码中所需的消息。只需编辑配置文件中的 messages
数组即可。 空的消息数组将包括构建中的所有语言文件。
仅将 pagination.php
和 validation.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 的 Mix 与 Laravel 5.4+(可选)
将 "webpack-shell-plugin-next" 添加到 package.json 的 "devDependencies" 部分。
将以下内容添加到 webpack.mix.js
const WebpackShellPluginNext = require('webpack-shell-plugin-next'); // Add shell command plugin configured to create JavaScript language file mix.webpackConfig({ plugins: [ new WebpackShellPluginNext({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文档以查看所有可用方法。
想要贡献吗?
- Fork 此仓库并克隆它。
- 从 develop 创建一个 特性分支:
git checkout develop; git checkout -b feature-foo
。 - 推送您的提交并创建一个拉取请求。
前置条件
您需要安装以下软件。
- Composer。
- PHP 5.5+。
开发环境设置
获取所有必需软件后,您可以运行以下命令来准备一切
-
安装 PHP 依赖项
composer install
-
安装测试依赖项
composer test-install
现在您已经准备好开始了!祝您编码愉快!
测试
此项目使用 PHPUnit。所有测试都存储在 tests
目录中。要在终端运行所有测试,请输入
composer test
由 Rubens Mariuzzo 献爱。