Socket
Socket
Sign inDemoInstall

@typescript-eslint/types

Package Overview
Dependencies
0
Maintainers
2
Versions
2843
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @typescript-eslint/types

Types for the TypeScript-ESTree AST spec


Version published
Weekly downloads
48M
decreased by-0.5%
Maintainers
2
Install size
152 kB
Created
Weekly downloads
 

Package description

What is @typescript-eslint/types?

The @typescript-eslint/types package is part of the TypeScript-ESLint project, which provides a TypeScript parser for ESLint and utilities for working with TypeScript and ESLint together. This specific package contains TypeScript definitions for ESLint-specific types, making it easier to work with ESLint configurations, rules, and plugins in a TypeScript environment. It is primarily used by developers who are creating custom ESLint rules or configurations and want to leverage TypeScript's type-checking capabilities for better development experience.

What are @typescript-eslint/types's main functionalities?

AST Node Types

Provides TypeScript interfaces for AST nodes generated by the parser. This is useful for writing type-safe code that inspects or manipulates the AST, such as custom ESLint rules.

import { TSESTree } from '@typescript-eslint/types';

function processNode(node: TSESTree.Node) {
  if (node.type === 'Identifier') {
    console.log('Found an identifier:', node.name);
  }
}

Rule Definition Helpers

Includes types for defining ESLint rules in a TypeScript-friendly way, making it easier to create custom rules with type safety.

import { TSESLint } from '@typescript-eslint/types';

const myRule: TSESLint.RuleModule<'my-error', []> = {
  meta: {
    type: 'problem',
    docs: {
      description: 'My custom rule',
      recommended: 'error'
    }
  },
  create(context) {
    return {
      Identifier(node) {
        context.report({
          node,
          messageId: 'my-error'
        });
      }
    };
  }
};

Other packages similar to @typescript-eslint/types

Changelog

Source

7.7.0 (2024-04-15)

🚀 Features

  • eslint-plugin: replace no-new-symbol with no-new-native-nonconstructor (#8895)
  • typescript-estree: add defaultProject for project service (#8815)

❤️ Thank You

  • Dave @reduckted
  • Josh Goldberg ✨

You can read about our versioning strategy and releases on our website.

Readme

Source

@typescript-eslint/types

Types for the TypeScript-ESTree AST spec

This package exists to help us reduce cycles and provide lighter-weight packages at runtime.

✋ Internal Package

This is an internal package to the typescript-eslint monorepo. You likely don't want to use it directly.

👉 See https://typescript-eslint.io for docs on typescript-eslint.

Keywords

FAQs

Last updated on 15 Apr 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc