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-nestjs-apiresponse

v1.2.0

Published

ESLint plugin enforcing HttpStatus enum usage in NestJS ApiResponse decorators

Downloads

288

Readme

eslint-nestjs-apiresponse

A simple ESLint plugin that enforces the use of HttpStatus enum from @nestjs/common in NestJS applications.

Features

  • Enforces the use of HttpStatus enum instead of numeric literals
  • Works with both @ApiResponse decorators and returned response objects
  • Automatically adds HttpStatus import when missing
  • Includes autofix functionality
  • Full TypeScript support out of the box

Installation

npm install eslint-nestjs-apiresponse --save-dev

Usage

For ESLint 9+ (flat config), add to your eslint.config.js or eslint.config.mjs:

import nestjsApiResponse from "eslint-nestjs-apiresponse";

export default [
  {
    plugins: {
      "eslint-nestjs-apiresponse": nestjsApiResponse
    },
    rules: {
      "eslint-nestjs-apiresponse/require-http-status": "error"
    }
  }
];

For ESLint 8 and below (.eslintrc):

{
  "plugins": ["eslint-nestjs-apiresponse"],
  "rules": {
    "eslint-nestjs-apiresponse/require-http-status": "error"
  }
}

Or use the recommended configuration:

{
  "extends": ["plugin:eslint-nestjs-apiresponse/recommended"]
}

Running from CLI

To run the plugin directly from command line:

# Check files
npx eslint --rule 'eslint-nestjs-apiresponse/require-http-status: error' src/

# With auto-fix
npx eslint --rule 'eslint-nestjs-apiresponse/require-http-status: error' --fix src/

Examples

❌ Incorrect:

// In decorators
@ApiResponse({ status: 200, description: 'Success' })

// In response objects
return { status: 200, data: result };

✅ Correct:

import { HttpStatus } from '@nestjs/common';

// In decorators
@ApiResponse({ status: HttpStatus.OK, description: 'Success' })

// In response objects
return { status: HttpStatus.OK, data: result };

TypeScript Support

The plugin includes TypeScript type definitions out of the box. No additional @types packages are required. Just install and use - TypeScript will automatically pick up the type definitions.

Requirements

  • Node.js >=14.0.0
  • ESLint >=9.0.0 (for flat config) or >=7.0.0 (for legacy config)
  • @nestjs/common >=8.0.0
  • @nestjs/swagger >=5.0.0

Authors

  • Cline (Senior TypeScript Developer)
  • 1MaJKeL1 (Project Supervisor)

License

ISC