sindresorhus/eslint-plugin-unicorn

Export exact types/schema

Closed

#2,408 opened on Jul 25, 2024

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)JavaScript (468 forks)user submission
enhancementhelp wanted

Repository metrics

Stars
 (5,022 stars)
PR merge metrics
 (Avg merge 1d 16h) (399 merged PRs in 30d)

Description

The PR (v55) silenced type issues when importing the plugin, but it does not actually enforce a valid configuration nor helps auto-completion in the IDE.

I think ESLint itself will validate the config on run, but IDE users are still left out.

Contributor guide

Research direction
Review the referenced PR #2382 and issue #2324 to understand the previous type workaround. Examine the current main entry point (likely 'index.js' or 'index.ts') to see how the plugin exports its rules and config. Then, create a new type declaration file (e.g., 'index.d.ts') that exports the exact TypeScript types for the plugin's configuration schema. Ensure the 'types' field in package.json points to this file. Look at other ESLint plugins that provide typed configs for reference.
Tech stack
javascripttypescript
Domain
toolingdeveloper experience
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
TypeScript basicsESLint plugin architectureHow to export types from a package
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65