This plugin provides support for textlint.
<h3>What’s the textlint?</h3>
<p>See <a href="https://github.com/textlint/textlint">https://github.com/textlint/textlint</a></p>
<h3>Usage</h3>
<h4>Install textlint and rules</h4>
<p>Of course, it assumes that nodejs and npm are installed.</p>
<p>e.g.</p>
<pre><code>$ mkdir txtlint
$ cd txtlint
$ npm init
$ npm install textlint --save-dev
$ npm install textlint-rule-max-ten textlint-rule-spellcheck-tech-word textlint-rule-no-mix-dearu-desumasu --save-dev
</code></pre>
<h4>Create .textlintrc</h4>
<pre><code>$ touch .textlintrc
</code></pre>
<pre><code class="json">{
"rules": {
"max-ten": {
"max": 3
},
"spellcheck-tech-word": true,
"no-mix-dearu-desumasu": true
}
}
</code></pre>
<p>You can also set parameters to Options (see below).</p>
<h4>Set textlint and .textlintrc paths</h4>
<p>Set paths to the Options (see below).</p>
<p>e.g.</p>
<ul>
<li>textlint Path: /path/to/txtlint/node_modules/.bin/textlint (textlint.cmd in Windows)</li>
<li>.textlintrc Path: /path/to/textlint/.textlintrc</li>
</ul>
<h4>Open Action Items window</h4>
<ul>
<li>Click Window > Action Items.</li>
<li>Click “Show action items for currently edited file only” icon.</li>
<li>Open your markdown or text file.</li>
</ul>
<h3>Options</h3>
<p>Tools > Options > Editor > textlint</p>
<ul>
<li>textlint Path: Absolute path to textlint</li>
<li>.textlintrc Path: Absolute path to .textlintrc</li>
<li>Options : You can set options for the textlint command</li>
<li>Enable in HTML files: To use the html plugin, you can check this</li>
<li>Refresh on Save: To scan the document on save, you can check this (Checked by default)</li>
<li>Show Annotations: To show annotations in the glyph gutter, you can check this (Checked by default)</li>
</ul>
<h3>Actions</h3>
<h4>Fix</h4>
<p>You have to save your file before you run this action.<br/>
If there is a fixable rule’s error, you can fix it. Right-click an item > Click <code>Fix</code>.<br/>
To refresh items, your document is saved once.</p>
<h4>Fix All</h4>
<p>You have to save your file before you run this action.<br/>
If there are fixable rule’s errors, you can fix them. Right-click an item > Click <code>Fix All</code>.<br/>
This action runs <code>textlint --fix</code> command.</p>
<h4>Refresh</h4>
<p>You can refresh results forcibly by the following action: Right-click your editor > Click "textlint Refresh".</p>
<p>You can also set the shortcut key(Tools > Options > Keymap). </p>
<h3>NOTE</h3>
<ul>
<li>The plugin scans only current file.</li>
<li>The plugin does not refresh results automatically. Please save your file or run the refresh action.</li>
<li>Use <code>UTF-8</code> as file encoding and <code>LF</code> as line endings.</li>
<li>This plugin may not work properly in Windows. (Please try to check above.)</li>
<li>If you cannot get expected results, just try to run the <code>textlint</code> commands once in your CLI.</li>
</ul>
There are no modules declared in this project.
NetBeans textlint Plugin
This plugin provides support for textlint.
Donation
What's the textlint?
See https://github.com/textlint/textlint
Downloads
Usage
Install textlint and rules
Of course, it assumes that nodejs and npm are installed.
e.g.
$ mkdir txtlint
$ cd txtlint
$ npm init
$ npm install textlint --save-dev
$ npm install textlint-rule-max-ten textlint-rule-spellcheck-tech-word textlint-rule-no-mix-dearu-desumasu --save-dev
Create .textlintrc
$ touch .textlintrc
{
"rules": {
"max-ten": {
"max": 3
},
"spellcheck-tech-word": true,
"no-mix-dearu-desumasu": true
}
}
You can also set parameters to Options (see below).
Set textlint and .textlintrc paths
Set paths to the Options (see below).
e.g.
- textlint Path: /path/to/txtlint/node_modules/.bin/textlint (textlint.cmd in Windows)
- .textlintrc Path: /path/to/textlint/.textlintrc
Open Action Items window
- Click Window > Action Items.
- Click "Show action items for currently edited file only" icon.
- Open your markdown or text file.
Options
Tools > Options > Editor > textlint
- textlint Path: Absolute path to textlint
- .textlintrc Path: Absolute path to .textlintrc
- Options : You can set options for the textlint command
- Enable in HTML files: To use the html plugin, you can check this
- Refresh on Save: To scan the document on save, you can check this (Checked by default)
- Show Annotations: To show annotations in the glyph gutter, you can check this (Checked by default)
Actions
Fix
You have to save your file before you run this action. If there is a fixable rule's error, you can fix it. Right-click an item > Click Fix. To refresh items, your document is saved once.
Fix All
You have to save your file before you run this action. If there are fixable rule's errors, you can fix them. Right-click an item > Click Fix All. This action runs textlint --fixcommand.
Refresh
You can refresh results forcibly by the following action: Right-click your editor > Click textlint Refresh. You can also set the shortcut key(Tools > Options > Keymap).
Icons
: Normal errors
: Fixable errors
Color & Effect
See Tools > Options > Fonts & Colors > Annotations > com-junichi11-netbeans-modules-textlint-*
NOTE
- The plugin scans only current file.
- The plugin does not refresh results automatically. Please save your file or run the refresh action.
- Use
UTF-8 as file encoding and LF as line endings.
- This plugin may not work properly in Windows. (Please try to check above.)
- If you cannot get expected results, just try to run the
textlint commands once in your CLI.
JarCasting
