Test Text

Test :: Text

Objektiv

Ein Modul zum Testen und Durchführen anderer Metriken in regulärem Text, wie in Büchern oder Romanen, oder, für diese Angelegenheit, Handbücher.

Wir sind noch nicht da, aber vorerst ist es ein ziemlich guter Rechtschreibprüfung, der in der Continuous Integration Literary -Umgebungen in der Cloud verwendet werden kann.

Für wen ist dieses Modul?

Personen, die Fiktion oder Sachbücher mit einfachem Text, Markdown oder ähnlichen Formaten schreiben. Sie müssen Perl oder kontinuierliche Integration nicht kennen oder nichts mehr technischer als hier und da klicken und Dateien speichern. Sie kennen wahrscheinlich das Programmieren von Sachen, aber es ist nicht wirklich benötigt, um es zu benutzen.

Wofür ist das?

Er spart Ihnen Zeit, indem Sie die Rechtschreibung automatisch überprüfen. Misst auch den Fortschritt, indem Sie Ihnen mitteilen, wie viele Wörter Sie bisher und insgesamt geschrieben haben. Dies ist ein beabsichtigter Nebeneffekt bei der Zählung der Anzahl der Tests == Anzahl der Wörter.

Wie kann ich es in einer CI -Pipeline verwenden?

1. Speichern Sie die Dateien, die Sie in einem einzigen Verzeichnis namens genannt werden möchten, beispielsweise text unter Verwendung von .markdown , .txt oder .md -Erweiterungen. Dieses Verzeichnis wird auch die words.dic enthält. Das ist kurz Ihr persönliches Wörterbuch.

2. Melden Sie sich für Travis CI an. Sie können Ihr Github -Konto verwenden. Wählen Sie das Repo, in dem Ihr Text gehostet wird, und aktivieren Sie ihn. Möglicherweise müssen Sie Ihr Konto synchronisieren, wenn das Repo kürzlich erstellt wurde.

3. Erstellen Sie eine .travis.yml -Konfigurationsdatei im Home -Verzeichnis Ihres Repo. In diesem Repo gibt es einige Beispiele (Englisch und Spanisch). Sie können dies auch kopieren und einfügen

 branches:
  except:
    - gh-pages
language: perl
perl:
  - "5.22"
before_install:
  - sudo apt-get install libhunspell-1.3-0 libhunspell-dev
  - curl https://raw.githubusercontent.com/JJ/Test-Text/master/files/just_check_en.t -o just_check.t
  - sudo update-locale LANG=en_US.UTF-8 LANGUAGE=en.UTF-8
install: cpanm Test::Text TAP::Harness
script: perl -MTAP::Harness -e 'use utf8; my $harness = TAP::Harness->new( { verbosity => 0} ); die "FAIL" if $harness->runtests( "just_check.t" )->failed;'

und speichern Sie es in dieser Datei. Sie können auch Beispiele wie dieses für ein Data Science -Handbuch direkt verwenden:

 wget https://github.com/JJ/aprende-datos/blob/master/.travis.yml

Das war's. Jedes Mal, wenn Sie push , werden Ihre Textdateien überprüft und gibt die Wörter zurück, von denen sie nicht wissen. Sie können sie reparieren oder in Ihrer Datei in Ihrer words.dic eingeben, mit diesem Format

 4
OneWord
AnotherWord
FooBar
Þor

Einfach genug, nicht wahr?

Sie können diese GitHub -Aktion auch direkt in Ihrem Repository verwenden, um die Readme zu überprüfen. Es löscht alle Markdown -Elemente, die nicht Readme sind, Sie müssen es möglicherweise an Ihre Situation anpassen (oder es dort lassen).

Es funktioniert nicht!

Sie können ein Problem aufwerfen, das Hilfe anfordert.

Ich möchte helfen!

Hilfe bei anderen Sprachen wäre großartig. Auch andere Tests als reine Zauberprüfung wie die Grammatik wäre großartig. Schauen Sie sich die Probleme und die TODO -Datei nach Ideen an oder erstellen Sie Ihre eigenen Probleme.

Lizenzen

Diese Verteilung ist unter der GPL lizenziert. In enthält Test::Text::Sentence , ursprünglich Text::Sentence von HTML::Summary , (c) von neilb, anfängliches Urheberrecht durch CRE und lizenziert unter der künstlerischen Lizenz.