yarnpkg/yarn

'yarn pack' should not process .gitignore if .npmignore is present

Open

#754 opened on Oct 11, 2016

View on GitHub
 (9 comments) (5 reactions) (0 assignees)JavaScript (41,514 stars) (2,731 forks)batch import
cat-bughelp wantedtriaged

Description

Do you want to request a feature or report a bug?

Report a bug.

What is the current behavior?

yarn pack ignores files specified in .gitignore while npm pack does not.

When .js files are generated from another language or flavor of javascript, generated files are often not checked-in and thus *.js or **/*.js entry is added to .gitignore. These generated files should be included in the package at runtime.

If the current behavior is a bug, please provide the steps to reproduce.

  1. create index.js file at project root.
  2. create .gitignore file at project root with entry *.js.
  3. run yarn pack.
  4. decompress package .tgz file.
  5. index.js file will not be in the decompressed package, only package.json and node_modules.

What is the expected behavior?

index.js should be there.

Please mention your node.js, yarn and operating system version.

Node.js v6.7 Yarn v0.15.1 macOS Sierra

Contributor guide

Tech stack
nodejsjavascript
Domain
backendtooling
Issue type
bug
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.
1-3 hours
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.
mostly clear
Prerequisites
Understanding of npm packFamiliarity with .npmignore and .gitignore
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Investigate the `yarn pack` command implementation, likely in `src/commands/pack.js`. The issue expects that if a `.npmignore` file exists, `.gitignore` should be ignored entirely, following npm's behavior. Review the current logic for file exclusion and compare with npm's source code. Check if there are any comments or linked PRs (none visible). The maintainers may have indicated desired behavior; look through issue comments #754 for any guidance.
'yarn pack' should not process .gitignore if .npmignore is present · yarnpkg/yarn#754 | Good First Issue