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-use-decorator

v0.2.0

Published

This is a custom plugin for eslint which enforces the use of decorators on methods.

Downloads

4,384

Readme

eslint-plugin-use-decorator

Version npm Dependencies peerDependencies Known Vulnerabilities License

This is a custom plugin for eslint which enforces the use of decorators on methods.

Note

This only works with the @typescript-eslint plugin

Installation

npm install --save-dev eslint-plugin-use-decorator

Usage

Add this to your .eslintrc

// .eslintrc
{
  "plugins": ["use-decorator"],
  "rules": {
    "use-decorator/use-decorator": [1, {
      "params": [
        {
          "name": "assertParameter",
          "public": true
        }
      ],
      "methods": [
        {
          "name": "assert",
          "public": true
        },
        {
          "name": "errorcatch",
          "async": true,
          "private": true
        }
      ],
      "class": [
        {
          "superClass": ["Vue", "Mixins"],
          "name": "Component"
        },
      ]
    }]
  }
}

Now methods and its parameters are checked for their decorators. Above rule would enforce following custom decorators:

class SomeClass {
  @assert
  someMethod(
    @assertParameter
      someParameter: number
  ): number {
    return someParameter;
  }
  
  @errorcatch
  private async somePrivateAsyncMethod(
      someParameter: number
  ): Promise<number> {
    return someParameter;
  }
  
  /**
   *  This one does not need a decorator, because its only async.
   *  It would need to be private as well for the linting to take effect.
   */
  async someAsyncMethod(
      someParameter: number
  ): Promise<number> {
    return someParameter;
  }
}

The options object looks like this:

Options

{
  "params": [
    {
      "name": "string",
      "private?": "boolean", // default: false
      "public?": "boolean", // default: false
      "async?": "boolean", // default: false, 
      "static?": "boolean" // default: false
    }
  ],
  "methods": [
    {
      "name": "assert",
      "private?": "boolean", // default: false
      "public?": "boolean", // default: false
      "async?": "boolean", // default: false
      "static?": "boolean" // default: false
    }
  ]
}