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-ts-expect

v2.1.0

Published

Write `dtslint` style comment assertions using eslint.

Downloads

111

Readme

eslint-plugin-ts-expect

Write dtslint style comment assertions using eslint.

Setup

If you do not already have an eslint setup using eslint-plugin-typescript, follow the instructions for configuring that first.

Once your project is setup to use eslint with typescript:

yarn add -D eslint-plugin-ts-expect

Then setup the plugin and rule as you might for any other eslint rule. In your .eslintrc.json:

// tests/.eslintrc.js

module.exports = {
  parser: '@typescript-eslint/parser',
  parserOptions: {
    tsconfigRootDir: __dirname,
    project: ['./tsconfig.json'],
  },

  plugins: ['ts-expect'],
  rules: {
    'ts-expect/expect': 'error',
  },
};

Note: These rules require type information to work so you may need to follow these additional steps to enable type checking rules

You can write assertions in any file that has the rule enabled, though you probably want to scope it to test files.

Usage

const add = (a: number, b: number): number => a + b;

// $ExpectType number
add(1, 1);

// Also works on the next line
add(2, 3); // $ExpectType number

// $ExpectError
add('one');

// $ExpectError
add(1);