glicer/spell-checker

检查 HTML 文件的拼写

dev-master 2016-10-30 20:29 UTC

This package is not auto-updated.

Last update: 2024-09-28 17:07:17 UTC


README

Scrutinizer Code Quality Build Status Coverage Status SensioLabsInsight Dependency Status

检查 HTML 文件的拼写

它正在与

安装 LanguageTool 服务器

使用 Docker

Docker 必须已安装

make docker_build
make docker_run

或者使用独立版本

必须安装 Java

下载并安装 LanguageTool 独立桌面版 到目录中。

Enchant(可选拼写建议)

PECL Enchant 可以使用

sudo apt-get install php5.6-enchant

语言词典在 dicts 词典中

安装 php-spellchecker

此库可在 Packagist 上找到。

推荐通过 composer 安装。

编辑你的 composer.json 并添加

{
    "require": {
       "glicer/spell-checker": "dev-master"
    }
}

安装依赖

php composer.phar install

如何检查 HTML 文件的拼写?

require 'vendor/autoload.php';

use GlSpellChecker\GlSpellChecker;
use Symfony\Component\Finder\Finder;

//language to check, define languagetool directory, and languagetool port used
$spellchecker  = new GlSpellChecker("fr", "fr_FR","C:\\Glicer\\LanguageTool\\",'localhost', 8081);
// or with docker $spellchecker = new GlSpellChecker("fr","fr_FR",null,'localhost',8010);

//construct list of local html files to check spell
$finder = new Finder();
$files  = $finder->files()->in('./public')->name("*.html");

//launch html checking
$filereport = $spellchecker->checkHtmlFiles(
                                    $files,
                                        function (SplFileInfo $file, $nbrsentences) {
                                            // called at beginning - $nbr sentences to check
                                        },
                                        function ($sentence) {
                                            // called each sentence to check
                                        },
                                        function () {
                                            // called at the end
                                        }
            );


//$filereport contain fullpath to html file report
print_r($filereport);

你可以通过浏览器查看 $filereport

如何检查 yaml 文件的拼写?

require 'vendor/autoload.php';

use GlSpellChecker\GlSpellChecker;
use Symfony\Component\Finder\Finder;

//define languagetool directory, language to check and languagetool port used
$spellchecker  = new GlSpellChecker("fr", "fr_FR","C:\\Glicer\\LanguageTool\\",'localhost',8081);
// or with docker $spellchecker = new GlSpellChecker("fr","fr_FR",null,'localhost',8010);

//construct list of local html files to check spell
$finder = new Finder();
$files  = $finder->files()->in('./public')->name("*.yml");

//launch html checking
$filereport = $spellchecker->checkYamlFiles(
                                    $files,
                                    ['test'], //list of fields to check
                                        function (SplFileInfo $file, $nbrsentences) {
                                            // called at beginning - $nbr sentences to check
                                        },
                                        function ($sentence) {
                                            // called each sentence to check
                                        },
                                        function () {
                                            // called at the end
                                        }
            );


//$filereport contain fullpath to html file report
print_r($filereport);

运行测试

在 phpunit.xml.dist 中更改 LanguageTool

  • 如果使用 Docker 服务器,输入 ip/port
  • 如果使用本地服务器,输入目录

从命令行启动

vendor\bin\phpunit

许可证 MIT

联系

作者:Emmanuel ROECKER & Rym BOUCHAGOUR

Web 开发博客 - http://dev.glicer.com