npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

eslint-plugin-textlint

v0.2.2

Published

Enable textlint in eslint

Downloads

243

Readme

eslint-plugin-textlint

npm test

Introduction

Enable textlint in eslint.

If there are any advices or questions, submit issue.

中文版 README

Installation

You'll first need to install ESLint and TextLint:

npm i eslint textlint --save-dev

Next, install eslint-plugin-textlint:

npm install eslint-plugin-textlint --save-dev

Usage

.eslintrc configuration

  1. Add textlint to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:
{
    "plugins": [
        "textlint"
    ]
}
  1. Configure the rules you want to use under the rules section in .eslintrc.
{
    "rules": {
        "textlint/textlint": [2, { "lintType": "all", "ignoreImportDeclaration": true }]
    }
}

rule: textlint/textlint

This rule has an object option:

  • "lintType": "all" (default) | "comment" | "code"
    • "all": (default) inspect comments and codes.
    • "comment": inspect only comments.
    • "code": inspect only codes (strings and templates in codes).
  • "ignoreImportDeclaration": true (default) | false
    • true: ignore literal in import(ES Module) and require(CMD) statement.
    • false: check literal in import(ES Module) and require(CMD) statement.

.textlintrc configuration

  1. Add "@textlint/text": true to the plugins section of your .textlintrc configuration file.
{
  "plugins": {
    "@textlint/text": true,
  }
}
  1. Configure the rules you want to use under the rules section in .textlintrc.
{
  "rules": {
    // whatever you want
  }
}

Rules

🔧 Automatically fixable by the --fix CLI option.

| Name | Description | 🔧 | |:-----------------------------------|:--------------------------|:---| | textlint | Enable textlint in eslint | 🔧 |

License

eslint-plugin-textlint is licensed under the MIT License.