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-pedantor

v0.5.4

Published

enforce part of speech and regex naming conventions

Downloads

9

Readme

eslint-plugin-pedantor

Enforce part of speech and regex naming conventions, currently only on functions.

Ever wanted to insist function names:

  • start with a verb?
  • follow some other part of speech / string pattern?
  • do not contain certain parts of speech / string patterns?

Then this is for you.

Installation

You'll first need to install ESLint:

$ npm i eslint --save-dev

Next, install eslint-plugin-pedantor:

$ npm install eslint-plugin-pedantor --save-dev

Note: If you installed ESLint globally (using the -g flag) then you must also install eslint-plugin-pedantor globally.

Usage

Add pedantor to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:

{
    "plugins": [
        "pedantor"
    ]
}

Then configure the rule. Currently only fxn-name-convention is supported, detailed below.

{
	"rules": {
		"pedantor/fxn-name-convention": [1, {
			allow: ['^#Verb' /*,...*/ ]
			,disallow: ["/mapper|reducer|controller/i" /*,...*/ ]
			,assume: {
				"tweet":'Verb'
				,"/XHR/i":'Verb'
				//,...
			}
		}]
	}
}

Each value in allow, disallow can be:

  • a match syntax string used by the natural language processing compromise module
  • or a string-coerced, plain /regex/. So /foo/i +'' == "/foo/i". This enables regular json use.

Note: matching is attempted against the _.lowerCase()d version of the function name. So doThing() becomes do thing.

Given the nlp module is not perfect, or you might want to add your own conventions, you can assign an {} to assume and point some strings or (string-coerced) regex to parts of speech. In the example above, XHR and xhr should be considered a Verb.