{"id":15730098,"url":"https://github.com/jj/test-text","last_synced_at":"2025-03-13T04:31:05.090Z","repository":{"id":16595167,"uuid":"19349595","full_name":"JJ/Test-Text","owner":"JJ","description":"A module for testing (mainly spell-check) and doing metrics on normal text. As in books or novels. ","archived":false,"fork":false,"pushed_at":"2023-01-04T18:58:54.000Z","size":2719,"stargazers_count":3,"open_issues_count":10,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-26T18:24:42.214Z","etag":null,"topics":["fiction","hacktoberfest","metrics","spell-checking"],"latest_commit_sha":null,"homepage":"","language":"Perl","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/JJ.png","metadata":{"files":{"readme":"README.md","changelog":"Changes","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-05-01T16:00:18.000Z","updated_at":"2022-07-07T17:44:18.000Z","dependencies_parsed_at":"2023-01-13T18:55:33.989Z","dependency_job_id":null,"html_url":"https://github.com/JJ/Test-Text","commit_stats":null,"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JJ%2FTest-Text","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JJ%2FTest-Text/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JJ%2FTest-Text/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JJ%2FTest-Text/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JJ","download_url":"https://codeload.github.com/JJ/Test-Text/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243341406,"owners_count":20275866,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["fiction","hacktoberfest","metrics","spell-checking"],"created_at":"2024-10-03T23:41:49.204Z","updated_at":"2025-03-13T04:31:04.671Z","avatar_url":"https://github.com/JJ.png","language":"Perl","readme":"Test::Text\n=========\n\n[![Build Status](https://travis-ci.org/JJ/Test-Text.svg?branch=master)](https://travis-ci.org/JJ/Test-Text)\n\n\nObjective\n---\n\nA module for testing and doing other kind of metrics on regular text, as in books or\nnovels, or, for that matter, manuals.\n\nWe're not there yet, but for the time being it is a pretty\ngood spelling checker that can be used *on the cloud* in continuous\nintegration literary environments. \n\nwho is this module for?\n---\n\nPeople who write fiction or non-fiction using simple text, Markdown or\nsimilar formats. You don't need to know Perl or continuous integration\nor nothing more techie than clicking here and there and saving\nfiles. You probably do know programming stuff, but it's not really needed for using it.\n\nwhat is this for?\n---\n\nSaves you time by checking spelling automatically. Also measures\nprogress by telling you how many words you have written so far and in\ntotal, which is an intended side effect of counting the number of\ntests == number of words. \n\nhow can I use it in a CI pipeline?\n---\n\n1. Save the files you want to be tested to a single directory called,\nfor instance, `text`, using\n`.markdown`, `.txt` or `.md` extensions. That directory will also hold\nthe `words.dic` where you will save real words that are not included\nin the general dictionary. That's your personal dictionary, for short.\n\n2. Sign up for [Travis CI](http://travis-ci.org). You can use your\nGitHub account. Choose the repo where your text is hosted and enable it. You\nmight have to sync your account if the repo has been recently created.\n\n3. Create a `.travis.yml` configuration file in the home directory of\nyour repo. There are a couple of examples (English and Spanish) in\nthis repo. You can also copy and paste this\n\n```\nbranches:\n  except:\n    - gh-pages\nlanguage: perl\nperl:\n  - \"5.22\"\nbefore_install:\n  - sudo apt-get install libhunspell-1.3-0 libhunspell-dev\n  - curl https://raw.githubusercontent.com/JJ/Test-Text/master/files/just_check_en.t -o just_check.t\n  - sudo update-locale LANG=en_US.UTF-8 LANGUAGE=en.UTF-8\ninstall: cpanm Test::Text TAP::Harness\nscript: perl -MTAP::Harness -e 'use utf8; my $harness = TAP::Harness-\u003enew( { verbosity =\u003e 0} ); die \"FAIL\" if $harness-\u003eruntests( \"just_check.t\" )-\u003efailed;'\n```\n\nand save it to that file. You can also use examples\n[like this one for a data science manual](https://github.com/JJ/aprende-datos/blob/master/.travis.yml)\ndirectly:\n\n```\nwget https://github.com/JJ/aprende-datos/blob/master/.travis.yml\n```\n\nThat's it. Every time you `push`, your text files will be checked and\nit will return the words that it does not know about. You can them fix\nthem or enter them in your `words.dic` file, with this format\n\n```\n4\nOneWord\nAnotherWord\nFooBar\nÞor\n```\n\nSimple enough, ain't it?\n\nYou can also directly\nuse\n[this GitHub action](.github/workflows/check-readme.yml) in\nyour repository to have the README checked. It deletes all markdown\nelements that are not README, you might have to adapt it to your\nsituation (or leave it there).\n\nit does not work!\n---\n\nYou can raise [an issue](https://github.com/JJ/Test-Text/issues)\nrequesting help.\n\nI'd like to help!\n---\n\nHelp with other languages would be great. Adding tests other than pure\nspell checking, like grammar, would be great too. Check out\nthe [issues](https://github.com/JJ/Test-Text/issues) and\nthe [TODO file](TODO.md) for ideas, or create your own issues.\n\nLICENSES\n---\n\nThis distribution is licensed under the GPL. In includes\n`Test::Text::Sentence`, originally `Text::Sentence`\nfrom [`HTML::Summary`](https://metacpan.org/pod/HTML::Summary), (c) by\nNEILB, initial copyright by CRE, and licensed under the Artistic license.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjj%2Ftest-text","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjj%2Ftest-text","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjj%2Ftest-text/lists"}