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

@proofdict/textlint-rule-proofdict

v3.1.2

Published

textlint rule check text using proofdict.

Downloads

4,316

Readme

@proofdict/textlint-rule-proofdict

textlint rule check text using proofdict.

proofdict is a opinionated dictionary.

Install

Install with npm:

npm install @proofdict/textlint-rule-proofdict

Usage

Via .textlintrc(Recommended)

{
    "rules": {
        "@proofdict/proofdict": {
          "dictURL": "https://azu.github.io/proof-dictionary/"
        }
    }
}

Via CLI

textlint --rule proofdict README.md

Options

A Dictionary options:

{
    // If you want to use live-proofdict
    // Proofdict-style dictionary URL
    // Example: "https://azu.github.io/proofdict/"
    // If you want to specific JSON end point, please pass object.
    // `dictURL; { jsonAPI: string, ruleBase: string }`
    "dictURL": undefined,
    // If you want to use local proofdict
    // dictPath is glob style path
    // `dictGlob: "./dict/*.yml"`
    "dictGlob": undefined,
    // Default: 60sec(60 * 1000ms)
    "autoUpdateInterval": 60 * 1000,
    // = Tag settings
    // Filter dictionary by allow or deny
    // Default: Enable all terms of the dictionary.
    // When set both options, this rule prefer allowTags to denyTags
    "allowTags": [],
    "denyTags": [],
}

Multiple dictionary options:

{
    "dicts": [
        /* Dictionary Option */
        {
          "dictURL": "..."
        }
    ]
}

Each Dictionary should have one of dictURL or dictGlob option.

dictURL

dictURL is a dictionary website url.

For example, set https://azu.github.io/proof-dictionary/ to dictURL. This url fetch dictionary data from https://azu.github.io/proof-dictionary/dictionary.json.

If you want to custom API end point, pass object instead of string.

{
  "dictURL": { 
    "jsonAPI": "https://azu.github.io/proof-dictionary/custom-dict.json",
    "ruleBase": "https://azu.github.io/proof-dictionary/item/",
  }
}

dictGlob

dictGlob is a glob pattern for loading local dictionary files.

Each yml file should be Proofdict format.

{
    "dictGlob": "./dict/*.yml"
} 

AllowTags/DenyTags

This rule use proofdict as the source of dictionary.

Each dictionary items has tag.

For example, WebKit has noun tag.

You can setting enable/disable by allowTags and denyTags

e.g.) Enable only "noun" tag.

{
    "rules": {
        "@proofdict/proofdict": {
          "allowTags": ["noun"]
        }
    }
}

e.g.) Use items without "opinion" tag

{
    "rules": {
        "@proofdict/proofdict": {
          "denyTags": ["opinion"]
        }
    }
}

Running tests

Install devDependencies and Run npm test:

npm i -d && npm test

Contributing

Pull requests and stars are always welcome.

For bugs and feature requests, please create an issue.

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Author

License

MIT © azu