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

@fictivekin/eslint-config-fk

v3.0.0

Published

Fictive Kin sharable eslint configuration

Downloads

928

Readme

eslint-config-fk

Fictive Kin sharable eslint configuration

Usage

Run the following in your project directory to install:

yarn add eslint @fictivekin/eslint-config-fk --dev

In your package.json file, add:

"eslintConfig": {
    "extends": "@fictivekin/eslint-config-fk"
}

Development

Use the dev branch for on-going development. Merge PRs against dev.

master branch is for the latest production release.

We need to be careful with changes to our lint config, as our linting rules directly affect project workflows, possibly breaking builds when new errors are introduced. Every so often, we will evaluate the changes to dev and cut a new release. Changes that introduce new errors are considered a breaking change and will constitute a new major version. So, we want to batch those changes together in bigger releases, rather that smaller incremental releases.

Notes

Quiet warnings with --quiet

Add the --quiet option to suppress warnings and show only errors.

# yarn
yarn lint:js --quiet

# npm
npm run lint:js -- --quiet

JSDoc

Writing JSDocs for functions can feel like a chore, but we've eased on some rules to make it easier. Parameter descriptions and return descriptions are not required. If your variable names are self-documenting, you can omit descriptions and document just the types.

/**
 * @param {Object} post
 * @param {String} attr
 * @return {String}
 */
function getTitle(post, attr) {
  return post[attr]; // contrived example, but you get the idea
}

no-used-vars error in destructured Array

You may encounter this error:

error  'key' is defined but never used  no-unused-vars

The linter is likely catching an unused argument variable within a destructured Array. Prefix the argument with an underscore _ to make the linter ignore it. See no-unused-vars destructuredArrayIgnorePattern.

Object.entries(items, (_key, value) => {})