mysticatea/eslint-plugin-node

new: no-private-api

Open

#167 opened on Jun 7, 2019

View on GitHub
 (3 comments) (0 reactions) (0 assignees)JavaScript (186 forks)github user discovery
acceptedenhancementhelp wanted

Repository metrics

Stars
 (956 stars)
PR merge metrics
 (PR metrics pending)

Description

it's not a good practice to use non-public api. it would be nice to have a rule warns its usage.

// invalid
var foo = require('foo/bar.js');

// valid
var foo = require('foo');

/* eslint no-private-api: ["error", exceptions: ["foo/bar.js"]]
var foo = require('foo/bar.js');
  • a better rule name?
  • exceptions defaults to ["*/dist"]?

Contributor guide

Research direction
Understand ESLint rule creation by studying existing rules in eslint plugin node. Learn how to traverse AST to find require() calls and check if the module path is a subpath of a package (indicating non public API). Implement a rule with configuration options for exceptions.
Tech stack
javascriptnodejs
Domain
backendapi
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.
Half day
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.
Mostly clear
Prerequisites
JavaScriptESLint basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70