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-call-func

v0.1.1

Published

This is a rule to encourage the call of specific func

Downloads

5,478

Readme

eslint-plugin-call-func

This is a rule to encourage the use of specific func.

Rule Details

✓ GOOD:: function called in outer function

function outer() {
  checkPermissions() // <-- This rule checks if this function is called.
  someFunc()
}

✓ GOOD:: function called with variable assignment

const runFunctionWithCheckPermission = (fn: () => void) => {
  checkPermissions()
  fn()
}

// ref: https://remix.run/docs/en/main/route/loader
export const loader = runFunctionWithCheckPermission(() => { // <-- This rule also can checks if specific wrapper func is used.
  console.log('function called after check permission')
})

✗ BAD: No function called

function outer() {
  someFunc()
}

NOTE

This is useful when you want to run simple code within a framework that exports functions with specific names.

// Using this rule, you can ensure that permission checks are performed within the loader.
// It can be used to supplement parts not supported by the framework.
// related ref: https://github.com/remix-run/remix/discussions/1432
export const loader = () => {
  checkPermissions()
}

// Or you can use a wrapper function to ensure that the permission check is performed.
export const loader = runFunctionWithCheckPermission(() => {
  console.log('function called after check permission')
})

Installation

Add package

# npm
npm i -D eslint-plugin-call-func

# yarn
yarn add -D eslint-plugin-call-func

Update your eslint config

{
  "plugins": ["call-func"],
  "rules": {
    "call-func/call-inner-func-in-outer-func": [
      "error",
      {
        "functionSets": [
          { "outerFunction": "action", "innerFunction": "checkPermissions" },
          { "outerFunction": "loader", "innerFunction": "checkPermissions" }
        ]
      }
    ]
  }
}