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

@yoo-digital/eslint-config-base

v3.0.0-canary.0

Published

ESLint configuration file containing rules for TypeScript projects

Downloads

840

Readme

YOO ESLint Configuration for TypeScript Projects

npm version

Contains the settings and rules used for TypeScript projects within YOO. It is publicly available via the npm registry.

Purpose

The exported index.js file contains all the ESLint rules that are compatible with our coding guidelines. See the guidelines for more information.

This set of rules is framework agnostic. It only contains rules for pure TypeScript. This allows it to be extended for Angular or React projects. Extensions for these frameworks can be found in their respective packages:

Usage

In order to use the ESLint configuration file in your project, you will have to install its dependencies (including peer-dependencies). The following command should work for both npm and yarn. It will detect the proper client.

npx install-peerdeps --dev @yoo-digital/eslint-config-base

Be aware: The typescript package is one of the peer-dependencies. The versions might collide in your project. Always try to use the latest versions of typescript in your project.

After installing the packages, you can create a .eslintrc.js file in the root of your project and add the following lines:

module.exports = {
  extends: '@yoo-digital/eslint-config-base',
};

You can apply your own set of rules on top of that, but do not turn off any of the rules, except it is an obstacle and making your life harder. Check the chapter below, for a complete set of rules that can be applied.

Development

Before creating a pull request or publishing changes, make sure you tested your changes. You can use yarn link to link your work in progress into an actual project and test your changes. Make sure you are in the directory of the package (./packages/eslint-config-base) before linking. See the official documentation of yarn for more information.

If you want to extend or change the set of rules, you can find all rules in the following list. We follow the Airbnb styleguide as a reference and applied our own set of rules regarding TypeScript: