https://github.com/nikialeksey/arspell
Resources spell testing library
https://github.com/nikialeksey/arspell
android gradle-plugin hunspell markdown spell-checking
Last synced: about 1 year ago
JSON representation
Resources spell testing library
- Host: GitHub
- URL: https://github.com/nikialeksey/arspell
- Owner: nikialeksey
- License: gpl-3.0
- Created: 2018-11-12T17:16:32.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-02-11T12:08:24.000Z (over 3 years ago)
- Last Synced: 2025-04-14T15:13:54.433Z (about 1 year ago)
- Topics: android, gradle-plugin, hunspell, markdown, spell-checking
- Language: Kotlin
- Homepage:
- Size: 1.07 MB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Arspell
[![Build Status][build-status-badge]][build-status-link]
[![codecov][codecov-badge]][codecov-link]
[![Lib version][lib-version-badge]][lib-version-link]
[![Gradle plugin version][gradle-plugin-badge]][gradle-plugin-link]
[![License: GPLv3][license-badge]][license-link]
Resources spell testing library and gradle plugin.
## How to
For example, you have two files:
`readme.md`:
```text
Hello world!
Привет, миииир!
```
`strings.xml`:
```xml
Hello, world!
Hello, worllld!
```
To check it, you should define plugin and configure it:
```groovy
plugins {
id("com.nikialeksey.arspell").version("")
}
arspell {
md(file("./readme.md")) {
dictionary {
en()
ru()
}
ignoreWords(["миииир"])
}
android(file("./strings.xml")) {
dictionary {
en()
}
ignoreKeys(["hello_world_bad"])
}
}
```
Then run it as gradle task:
```shell
./gradlew arspell
```
## @todo #10:30 m Write docs about LanguageTool using
## Publish
```bash
gradlew build publish closeAndReleaseRepository
```
## Changelog
- `3.1.3` - support aarch64
- `3.1.2` - small fixes for Android strings (skip format specifiers, skip
references in string resources)
- `3.1.1` - upgrade dependencies
- `3.1.0` - migrate to maven central
[build-status-badge]: https://github.com/nikialeksey/arspell/actions/workflows/ci.yml/badge.svg
[build-status-link]: https://github.com/nikialeksey/arspell/actions/
[codecov-badge]: https://codecov.io/gh/nikialeksey/arspell/branch/master/graph/badge.svg
[codecov-link]: https://codecov.io/gh/nikialeksey/arspell
[lib-version-badge]: https://img.shields.io/maven-central/v/com.nikialeksey/arspell.svg?label=lib
[lib-version-link]: https://maven-badges.herokuapp.com/maven-central/com.nikialeksey/arspell
[gradle-plugin-badge]: https://img.shields.io/maven-metadata/v/https/plugins.gradle.org/m2/com/nikialeksey/arspell-plugin-gradle/maven-metadata.xml.svg?label=plugin
[gradle-plugin-link]: https://plugins.gradle.org/plugin/com.nikialeksey.arspell
[license-badge]: https://img.shields.io/badge/License-GPLv3-yellow
[license-link]: https://github.com/nikialeksey/arspell/blob/master/LICENSE