palantir/blueprint

[node-build-scripts] sass-lint path logic is broken

Open

#4,942 opened on Sep 30, 2021

View on GitHub
 (0 comments) (0 reactions) (0 assignees)TypeScript (20,263 stars) (2,167 forks)batch import
Domain: toolingP2Type: bughelp wanted

Description

Environment

  • Package version(s): node-build-scripts v1.6.x

Steps to reproduce

  1. Use sass-lint.js script outside of this repo, through @blueprintjs/node-build-scripts

Actual behavior

It always fails to find .stylelintrc because it's looking inside the node_modules folder where the scripts package is installed.

Expected behavior

The script is usable outside this repo...

Possible solution

Use process.cwd() instead of __dirname, and also allow a CLI argument to override the configFile option

Contributor guide

Tech stack
javascriptnodejs
Domain
build systemdeveloper experience
Issue type
bug
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.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
node.jsprocess.cwd()cli arguments
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
The script uses dirname to find .stylelintrc, which fails when used externally. The fix is to replace dirname with process.cwd() and optionally accept a config CLI argument. The relevant file is likely sass lint.js in the node build scripts package. No discussion has occurred, so first time contributors should verify with maintainers before working.
[node-build-scripts] sass-lint path logic is broken · palantir/blueprint#4942 | Good First Issue