sindresorhus/eslint-plugin-unicorn

Rule proposal: `no-exports-in-scripts`

Closed

#2,513 opened on Dec 18, 2024

View on GitHubContributor guide
 (3 comments) (3 reactions) (0 assignees)JavaScript (468 forks)user submission
help wantednew rule

Repository metrics

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

Description

Description

Currently, a js file starts with hashbang #! is script file. In script file, using exports is useless and confused.

Fail

#!/usr/bin/env node

export const foo = {};

Pass

export {}

#!/usr/bin/env node

console.log('foo');

Proposed rule name

no-exports-in-scripts

Additional Info

No response

Contributor guide

Research direction
Study existing rules in eslint plugin unicorn to understand the pattern. Look at how hashbang is detected (e.g., using `node.sourceCode.getText().startsWith('#!')`). Then create a rule that reports exports if the file starts with a hashbang.
Tech stack
javascript
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.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
ESLint rule development basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80