netbeans-textlint

pkg:maven/com.junichi11.netbeans.modules/netbeans-textlint@1.1.0

Used in: 0 components

Overview
Overview

Versions
Versions

Dependents
Dependents

Dependencies
Dependencies

Overview

Description

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>

Snippets

<dependency>
    <groupId>com.junichi11.netbeans.modules</groupId>
    <artifactId>netbeans-textlint</artifactId>
    <version>1.1.0</version>
</dependency>

Maven POM File

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.junichi11.netbeans.modules</groupId>
    <artifactId>netbeans-textlint</artifactId>
    <version>1.1.0</version>
    <packaging>nbm</packaging>
    <name>textlint Support</name>
    <url>https://github.com/junichi11/netbeans-textlint-plugin</url>
    <developers>
        <developer>
            <id>junichi11</id>
            <name>Junichi Yamamoto</name>
            <url>https://github.com/junichi11</url>
        </developer>
    </developers>
    <scm>
        <connection>scm:git:https://github.com/junichi11/netbeans-textlint-plugin.git</connection>
        <developerConnection>scm:git:https://github.com/junichi11/netbeans-textlint-plugin.git</developerConnection>
        <url>https://github.com/junichi11/netbeans-textlint-plugin</url>
        <tag>HEAD</tag>
    </scm>
    <licenses>
        <license>
            <name>Apache License, Version 2.0</name>
            <url>https://www.apache.org/licenses/LICENSE-2.0</url>
        </license>
    </licenses>
    <build>
        <plugins>
            <plugin>
                <groupId>org.sonatype.plugins</groupId>
                <artifactId>nexus-staging-maven-plugin</artifactId>
                <version>1.6.7</version>
                <extensions>true</extensions>
                <configuration>
                    <serverId>ossrh</serverId>
                    <nexusUrl>https://oss.sonatype.org/</nexusUrl>
                    <autoReleaseAfterClose>true</autoReleaseAfterClose>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.apache.netbeans.utilities</groupId>
                <artifactId>nbm-maven-plugin</artifactId>
                <version>4.4</version>
                <extensions>true</extensions>
                <configuration>
                    <codeNameBase>com.junichi11.netbeans.modules.textlint</codeNameBase>
                    <verifyRuntime>warn</verifyRuntime>
                    <licenseName>Apache 2.0 license</licenseName>
                    <licenseFile>LICENSE</licenseFile>
                    <author>junichi11(Junichi Yamamoto)</author>
                    <homePageUrl>https://github.com/junichi11/netbeans-textlint-plugin</homePageUrl>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.8.1</version>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-jar-plugin</artifactId>
                <version>3.2.0</version>
                <configuration>
                    <archive>
                        <manifestFile>${project.build.outputDirectory}/META-INF/MANIFEST.MF</manifestFile>
                    </archive>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-surefire-plugin</artifactId>
                <version>2.15</version>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-gpg-plugin</artifactId>
                <version>1.6</version>
                <executions>
                    <execution>
                        <id>sign-artifacts</id>
                        <phase>verify</phase>
                        <goals>
                            <goal>sign</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
    <repositories>
        <repository>
            <id>netbeans</id>
            <name>Repository hosting NetBeans modules</name>
            <url>https://bits.netbeans.org/nexus/content/groups/netbeans</url>
            <snapshots>
                <enabled>false</enabled>
            </snapshots>
        </repository>
    </repositories>
    <distributionManagement>
        <repository>
            <id>ossrh</id>
            <url>https://oss.sonatype.org/service/local/staging/deploy/maven2/</url>
        </repository>
        <snapshotRepository>
            <id>ossrh</id>
            <url>https://oss.sonatype.org/content/repositories/snapshots</url>
        </snapshotRepository>
    </distributionManagement>
    <dependencies>
        <!-- https://mvnrepository.com/artifact/org.apache.commons/commons-lang3 -->
        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-lang3</artifactId>
            <version>3.0</version>
        </dependency>
        <dependency>
            <groupId>com.google.code.gson</groupId>
            <artifactId>gson</artifactId>
            <version>2.8.2</version>
        </dependency>
        <dependency>
            <groupId>org.netbeans.api</groupId>
            <artifactId>org-netbeans-api-annotations-common</artifactId>
            <version>${netbeans.release.version}</version>
        </dependency>
        <dependency>
            <groupId>org.netbeans.api</groupId>
            <artifactId>org-netbeans-spi-tasklist</artifactId>
            <version>${netbeans.release.version}</version>
        </dependency>
        <dependency>
            <groupId>org.netbeans.api</groupId>
            <artifactId>org-openide-filesystems</artifactId>
            <version>${netbeans.release.version}</version>
        </dependency>
        <dependency>
            <groupId>org.netbeans.api</groupId>
            <artifactId>org-openide-util-lookup</artifactId>
            <version>${netbeans.release.version}</version>
        </dependency>
        <dependency>
            <groupId>org.netbeans.api</groupId>
            <artifactId>org-netbeans-modules-extexecution</artifactId>
            <version>${netbeans.release.version}</version>
        </dependency>
        <dependency>
            <groupId>org.netbeans.api</groupId>
            <artifactId>org-netbeans-modules-extexecution-base</artifactId>
            <version>${netbeans.release.version}</version>
        </dependency>
        <dependency>
            <groupId>org.netbeans.api</groupId>
            <artifactId>org-openide-windows</artifactId>
            <version>${netbeans.release.version}</version>
        </dependency>
        <dependency>
            <groupId>org.netbeans.api</groupId>
            <artifactId>org-openide-io</artifactId>
            <version>${netbeans.release.version}</version>
        </dependency>
        <dependency>
            <groupId>org.netbeans.api</groupId>
            <artifactId>org-netbeans-modules-editor-lib2</artifactId>
            <version>${netbeans.release.version}</version>
            <type>jar</type>
        </dependency>
        <dependency>
            <groupId>org.netbeans.api</groupId>
            <artifactId>org-openide-text</artifactId>
            <version>${netbeans.release.version}</version>
        </dependency>
        <dependency>
            <groupId>org.netbeans.api</groupId>
            <artifactId>org-netbeans-modules-csl-api</artifactId>
            <version>${netbeans.release.version}</version>
        </dependency>
        <dependency>
            <groupId>org.netbeans.api</groupId>
            <artifactId>org-netbeans-modules-editor-lib</artifactId>
            <version>${netbeans.release.version}</version>
        </dependency>
        <dependency>
            <groupId>org.netbeans.api</groupId>
            <artifactId>org-openide-loaders</artifactId>
            <version>${netbeans.release.version}</version>
        </dependency>
        <dependency>
            <groupId>org.netbeans.api</groupId>
            <artifactId>org-openide-dialogs</artifactId>
            <version>${netbeans.release.version}</version>
        </dependency>
        <dependency>
            <groupId>org.netbeans.api</groupId>
            <artifactId>org-openide-util</artifactId>
            <version>${netbeans.release.version}</version>
        </dependency>
        <dependency>
            <groupId>org.netbeans.api</groupId>
            <artifactId>org-openide-nodes</artifactId>
            <version>${netbeans.release.version}</version>
        </dependency>
        <dependency>
            <groupId>org.netbeans.api</groupId>
            <artifactId>org-openide-util-ui</artifactId>
            <version>${netbeans.release.version}</version>
        </dependency>
        <dependency>
            <groupId>org.netbeans.api</groupId>
            <artifactId>org-netbeans-modules-options-api</artifactId>
            <version>${netbeans.release.version}</version>
        </dependency>
        <dependency>
            <groupId>org.netbeans.api</groupId>
            <artifactId>org-openide-awt</artifactId>
            <version>${netbeans.release.version}</version>
        </dependency>
        <dependency>
            <groupId>org.netbeans.api</groupId>
            <artifactId>org-openide-filesystems-nb</artifactId>
            <version>${netbeans.release.version}</version>
        </dependency>
        <dependency>
            <groupId>org.netbeans.api</groupId>
            <artifactId>org-netbeans-api-progress</artifactId>
            <version>${netbeans.release.version}</version>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.hamcrest</groupId>
            <artifactId>hamcrest-core</artifactId>
            <version>1.3</version>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.netbeans.api</groupId>
            <artifactId>org-netbeans-modules-nbjunit</artifactId>
            <version>${netbeans.release.version}</version>
            <scope>test</scope>
            <type>jar</type>
        </dependency>
    </dependencies>
    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <netbeans.release.version>RELEASE110</netbeans.release.version>
        <!-- deploy: mvn -Dgpg.skip=false deploy -->
        <gpg.skip>true</gpg.skip>
    </properties>
    <description>This plugin provides support for textlint.

&lt;h3&gt;What&amp;rsquo;s the textlint?&lt;/h3&gt;
&lt;p&gt;See &lt;a href="https://github.com/textlint/textlint"&gt;https://github.com/textlint/textlint&lt;/a&gt;&lt;/p&gt;

&lt;h3&gt;Usage&lt;/h3&gt;
&lt;h4&gt;Install textlint and rules&lt;/h4&gt;
&lt;p&gt;Of course, it assumes that nodejs and npm are installed.&lt;/p&gt;
&lt;p&gt;e.g.&lt;/p&gt;
&lt;pre&gt;&lt;code&gt;$ 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
&lt;/code&gt;&lt;/pre&gt;
&lt;h4&gt;Create .textlintrc&lt;/h4&gt;
&lt;pre&gt;&lt;code&gt;$ touch .textlintrc
&lt;/code&gt;&lt;/pre&gt;
&lt;pre&gt;&lt;code class="json"&gt;{
  &amp;quot;rules&amp;quot;: {
    &amp;quot;max-ten&amp;quot;: {
      &amp;quot;max&amp;quot;: 3
    },
    &amp;quot;spellcheck-tech-word&amp;quot;: true,
    &amp;quot;no-mix-dearu-desumasu&amp;quot;: true
  }
}
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;You can also set parameters to Options (see below).&lt;/p&gt;

&lt;h4&gt;Set textlint and .textlintrc paths&lt;/h4&gt;
&lt;p&gt;Set paths to the Options (see below).&lt;/p&gt;
&lt;p&gt;e.g.&lt;/p&gt;
&lt;ul&gt;
  &lt;li&gt;textlint Path: /path/to/txtlint/node_modules/.bin/textlint (textlint.cmd in Windows)&lt;/li&gt;
  &lt;li&gt;.textlintrc Path: /path/to/textlint/.textlintrc&lt;/li&gt;
&lt;/ul&gt;

&lt;h4&gt;Open Action Items window&lt;/h4&gt;
&lt;ul&gt;
  &lt;li&gt;Click Window &gt; Action Items.&lt;/li&gt;
  &lt;li&gt;Click &amp;ldquo;Show action items for currently edited file only&amp;rdquo; icon.&lt;/li&gt;
  &lt;li&gt;Open your markdown or text file.&lt;/li&gt;
&lt;/ul&gt;

&lt;h3&gt;Options&lt;/h3&gt;
&lt;p&gt;Tools &gt; Options &gt; Editor &gt; textlint&lt;/p&gt;
&lt;ul&gt;
  &lt;li&gt;textlint Path: Absolute path to textlint&lt;/li&gt;
  &lt;li&gt;.textlintrc Path: Absolute path to .textlintrc&lt;/li&gt;
  &lt;li&gt;Options : You can set options for the textlint command&lt;/li&gt;
  &lt;li&gt;Enable in HTML files: To use the html plugin, you can check this&lt;/li&gt;
  &lt;li&gt;Refresh on Save: To scan the document on save, you can check this (Checked by default)&lt;/li&gt;
  &lt;li&gt;Show Annotations: To show annotations in the glyph gutter, you can check this (Checked by default)&lt;/li&gt;
&lt;/ul&gt;

&lt;h3&gt;Actions&lt;/h3&gt;
&lt;h4&gt;Fix&lt;/h4&gt;
&lt;p&gt;You have to save your file before you run this action.&lt;br/&gt;
If there is a fixable rule&amp;rsquo;s error, you can fix it. Right-click an item &gt; Click &lt;code&gt;Fix&lt;/code&gt;.&lt;br/&gt;
To refresh items, your document is saved once.&lt;/p&gt;

&lt;h4&gt;Fix All&lt;/h4&gt;
&lt;p&gt;You have to save your file before you run this action.&lt;br/&gt;
If there are fixable rule&amp;rsquo;s errors, you can fix them. Right-click an item &gt; Click &lt;code&gt;Fix All&lt;/code&gt;.&lt;br/&gt;
This action runs &lt;code&gt;textlint --fix&lt;/code&gt; command.&lt;/p&gt;

&lt;h4&gt;Refresh&lt;/h4&gt;
&lt;p&gt;You can refresh results forcibly by the following action: Right-click your editor &gt; Click "textlint Refresh".&lt;/p&gt;
&lt;p&gt;You can also set the shortcut key(Tools &gt; Options &gt; Keymap). &lt;/p&gt;
&lt;h3&gt;NOTE&lt;/h3&gt;
&lt;ul&gt;
  &lt;li&gt;The plugin scans only current file.&lt;/li&gt;
  &lt;li&gt;The plugin does not refresh results automatically. Please save your file or run the refresh action.&lt;/li&gt;
  &lt;li&gt;Use &lt;code&gt;UTF-8&lt;/code&gt; as file encoding and &lt;code&gt;LF&lt;/code&gt; as line endings.&lt;/li&gt;
  &lt;li&gt;This plugin may not work properly in Windows. (Please try to check above.)&lt;/li&gt;
  &lt;li&gt;If you cannot get expected results, just try to run the &lt;code&gt;textlint&lt;/code&gt; commands once in your CLI.&lt;/li&gt;
&lt;/ul&gt;
</description>
</project>

Metadata

Age:5 years ago

Licenses:

Apache License, Version 2.0

Organization

com.junichi11.netbeans.modules

External Resources

Project URL

Source Control

Known Contributors

Junichi Yamamoto

OSS Index

View