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

unified-lint-rule

v2.1.2

Published

unified plugin to make it a bit easier to create linting rules

Downloads

846,136

Readme

unified-lint-rule

Build Coverage Downloads Size Sponsors Backers Chat

unified plugin to help make lint rules.

See the monorepo readme for more info on remark lint.

Contents

What is this?

This package is a unified plugin that makes it a bit easier to create linting rules.

unified is a project that transforms content with abstract syntax trees (ASTs). This is a plugin that make it easier to inspect trees.

When should I use this?

You can use this package when you want to make custom lint rules.

Install

This package is ESM only. In Node.js (version 12.20+, 14.14+, or 16.0+), install with npm:

npm install unified-lint-rule

In Deno with esm.sh:

import {lintRule} from 'https://esm.sh/unified-lint-rule@2'

In browsers with esm.sh:

<script type="module">
  import {lintRule} from 'https://esm.sh/unified-lint-rule@2?bundle'
</script>

Use

import {lintRule} from 'unified-lint-rule'

const remarkLintFileExtension = lintRule(
  'remark-lint:file-extension',
  (tree, file, option = 'md') => {
    var ext = file.extname

    if (ext && ext.slice(1) !== option) {
      file.message('Incorrect extension: use `' + option + '`')
    }
  }
)

export default remarkLintFileExtension

API

This package exports the following identifier: lintRule. There is no default export.

lintRule(origin|meta, rule)

Create a plugin.

Parameters
  • origin (string) — treated as a meta of {origin}
  • meta (Object) — rule metadata
  • meta.origin (string) — message origin, either a rule name ('file-extension') or both a rule source and name joined with : ('remark-lint:file-extension')
  • meta.url (string, optional) — URL to documentation for messages
  • rule (Function, optional) — your code, like a transform function, except that an extra option is passed
Returns

A unified plugin that handles all kinds of options (see Configure in the monorepo readme for how them).

Compatibility

Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, and 16.0+. Our projects sometimes work with older versions, but this is not guaranteed.

Contribute

See contributing.md in remarkjs/.github for ways to get started. See support.md for ways to get help.

This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.

License

MIT © Titus Wormer