https://github.com/1000ch/linter-textlint

A plugin for Atom Linter providing an interface to textlint.
https://github.com/1000ch/linter-textlint

atom atom-linter textlint

Last synced: 4 months ago
JSON representation

A plugin for Atom Linter providing an interface to textlint.

• Host: GitHub
• URL: https://github.com/1000ch/linter-textlint
• Owner: 1000ch
• Created: 2015-09-16T04:09:54.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2023-01-07T03:56:13.000Z (about 2 years ago)
• Last Synced: 2024-10-11T23:51:59.047Z (4 months ago)
• Topics: atom, atom-linter, textlint
• Language: JavaScript
• Homepage: https://atom.io/packages/linter-textlint
• Size: 293 KB
• Stars: 33
• Watchers: 8
• Forks: 13
• Open Issues: 15
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# linter-textlint

[![Dependency Status](https://david-dm.org/1000ch/linter-textlint.svg)](https://david-dm.org/1000ch/linter-textlint)

[![Build Status](https://travis-ci.org/1000ch/linter-textlint.svg?branch=master)](https://travis-ci.org/1000ch/linter-textlint)

[![Build Status](https://ci.appveyor.com/api/projects/status/mhhj7frwj1axt6tw?svg=true)](https://ci.appveyor.com/project/1000ch/linter-textlint)

[![Build Status](https://circleci.com/gh/1000ch/linter-textlint/tree/master.svg?style=shield&circle-token=948bf903ddab915de586ad0afe69cee03dcf3ca1)](https://circleci.com/gh/1000ch/linter-textlint)

A plugin for [Atom Linter](https://github.com/AtomLinter/atom-linter) providing an interface to [textlint](https://github.com/textlint/textlint).

## Installation

```bash

$ apm install linter-textlint

```

## Configuration

### Use your project `.textlintrc` and the rule

You have to do following steps before using.

1. Put `.textlintrc` in your workspace ( [`.textlintrc` file format](https://github.com/textlint/textlint#textlintrc) ).

2. Install textlint plugins (`textlint-rule-*`) in your workspace via `npm install`.

3. Open the workspace with Atom Editor.

### Use global `.textlintrc` and the rule

You have to do following steps before using.

1. Put `.textlintrc` in any directory ( [`.textlintrc` file format](https://github.com/textlint/textlint#textlintrc) ).

2. Install textlint plugins (`textlint-rule-*`) in any directory via `npm install`.

3. Open Atom and Show linter-textlint's setting.

4. Set following setting:

- **.textlintrc Path** : path to `.textlintrc`. It will only be used when there's no config file in project

    - e.g.) `/Users/work/my-textlint-config/.textlintrc`

- **textlint Rules Dir**: path to node_modules directory. It will only be used when there's no config file in project

    - e.g.) `/Users/work/my-textlint-config/node_modules`

![setting](https://monosnap.com/file/R6reaywGTmZMkgob15BEdyhHDvaeQF.png)

Open any file(The workspace has not config file) with Atom Editor.

## License

[MIT](https://1000ch.mit-license.org) © [Shogo Sensui](https://github.com/1000ch)