sindresorhus/eslint-plugin-unicorn

Rule proposal: `prefer-https`

Closed

#971 opened on Dec 30, 2020

View on GitHubContributor guide
 (9 comments) (6 reactions) (1 assignee)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

Enforce using HTTPS URLs over HTTP.

Fail

const foo = 'http://sindresorhus.com';

// Hello: http://sindresorhus.com

Pass

const foo = 'https://sindresorhus.com';

// Hello: https://sindresorhus.com

Alternative name: prefer-https. Which one do people prefer?

I'm aware this could be partly solved with the string-content rule, but I don't think most people would think of this and it also wouldn't work in comments.

Contributor guide

Research direction
Implement a new rule in the eslint plugin unicorn repository. Look at existing rules in the 'rules' directory for structure. The rule should detect HTTP URLs in string literals and comments and suggest HTTPS. Use AST node types like Literal and Comment. Write tests following the project's testing pattern.
Tech stack
javascript
Domain
securitytooling
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.
Blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
ESLint plugin developmentJavaScript regex
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30