https://github.com/nonchalant/docker-textlint
Lint Japanese techniqual text
https://github.com/nonchalant/docker-textlint
Last synced: 5 months ago
JSON representation
Lint Japanese techniqual text
- Host: GitHub
- URL: https://github.com/nonchalant/docker-textlint
- Owner: Nonchalant
- Created: 2019-03-30T09:20:05.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-03-30T14:47:45.000Z (over 6 years ago)
- Last Synced: 2024-12-27T20:44:36.112Z (7 months ago)
- Language: Ruby
- Homepage:
- Size: 24.4 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# docker-textlint
Lint **Japanese** techniqual text
## Support
- *.txt
- *.md
- *.re
## Rules
- cf. https://github.com/textlint-ja/textlint-rule-preset-ja-technical-writing#%E3%83%AB%E3%83%BC%E3%83%AB%E4%B8%80%E8%A6%A7
## Usage
### textlint only
#### command
```
$ docker pull nonchalant/textlint:0.0.1
$ docker run -e TXT=[Path to Text] -v [Directory to contains Text]:/app/volume:ro nonchalant/textlint:0.0.1
```
#### docker-compose.yml (Recommend)
```
version: '2'
services:
lint:
image: nonchalant/textlint:0.0.1
volumes:
- [Directory to contains Text]:/app/volume
environment:
TXT: [Path to Text]
```
```
$ docker-compose up
```
### textlint + danger
Run on CI
```
$ docker pull nonchalant/textlint-danger:0.0.1
$ docker run nonchalant/textlint-danger:0.0.1
```
## Development
### textlint only
#### Local
```
$ npm install
$ npm run lint -- README.md
```
#### Docker
```
$ docker build -t nonchalant/textlint:0.0.1 .
$ docker run -e TXT=README.md -v `pwd`:/app/volume:ro nonchalant/textlint:0.0.1
```
### textlint + danger
#### Local
```
$ bundle install
$ bundle exec danger pr https://github.com/Nonchalant/docker-textlint/pull/1
```
#### Docker
```
$ docker build -f Dockerfile-with-danger -t nonchalant/textlint-danger:0.0.1 .
$ docker run nonchalant/textlint-danger:0.0.1
```