Show files added since the last release and not part of the package #456

bunysae · 2019-09-23T20:51:05Z

According to your issue-comment, i implemented a check for files, which were added since the last release and which are not part of file-attribute in package.json or which are ignored by .npmignore.

A unit-test for the new function is implemented mocking the the git command and the package-directory. Therefore i added the directory test/fixtures.

Fixes #103

IssueHunt Summary

Referenced issues

This pull request has been submitted to:

#103: Ensure no extraneous files get published

IssueHunt has been backed by the following sponsors. Become a sponsor

bunysae · 2019-10-08T18:36:54Z

Is anyone interested to review this pull-request?

@sindresorhus @itaisteinherz
This pull-request added the new features, you requested in issue 103.

package.json

source/npm/util.js

source/util.js

@fregante

the last release and not part of package according to pull-request comments from @fregante Pull-Request 456

source/npm/util.js

source/ui.js

source/util.js

source/git-util.js

test/ressources/npmignore/.npmignore

itaisteinherz · 2019-12-20T13:56:12Z

@bunysae Thanks so much for this PR! Sorry for only reviewing it now, I was very busy for a while 😅

I left some comments for you to take look at (please don't be overwhelmed by the amount of them, they're mostly about renaming methods and rephrasing comments).

…ge Iteration 3 1. Moved .npmignore exitence check into separate function 2. According to npm-docs files-attribute has a higher priority than .npmignore-file in the package-root-directory 3. Exclude the files ignored by default (http://npm.github.io/publishing-pkgs-docs/publishing/the-npmignore-file.html) from the comparison 4. Refactoring: naming of variables

…ge Iteration 3 1. Refactorings 2. UI-Improvement

bunysae · 2019-12-27T19:33:12Z

@itaisteinherz
I try to applied your feedback. When using the new function i expected an issue
with directories. If the file-property contains directories, minimatch doesn't
recognize the files in the directory. So they are always shown,
even if they are part of the package.

I created an failing unit-test in commit 4a75e6d for this issue and fixed it with the latest commit.

bunysae · 2020-08-02T09:17:09Z

@sindresorhus

Test files are excluded now.
Files included per default (like package.json) are not taken into account
With a submodule i was able to create a integration-test using no mockups.

Please review again.

sindresorhus · 2020-08-02T11:18:55Z

Please ensure you test all edge-cases and use-cases thoroughly.

Is this done?

bunysae · 2020-08-02T15:48:27Z

The unit-tests in test/npmignore.js contains all edge-cases. The integration-tests in submodule integration-test covers the git- commands as well.

sindresorhus · 2020-08-10T20:07:20Z

This is not fixed: #456 (comment)

Please ensure you fix all the things mentioned in the review and that you also do some manual QA testing (test running np in different ways interactively).

bunysae · 2020-08-11T13:43:33Z

If I run $ np (this branch)` without any Git commited changes, nothing happens.

It's fixed. If no files were added, the process was exited to early.

I did the following manual QA testing (all passed):

prompt

no ignore strategy used
no files added since last release
Prompt answered yes
Prompt answered no

Tags

no last tag exists
last tag exists

Publishing from other than master branch
Test-file, changes.txt and .npmrc added. (Expected result: no prompt should occur)

By the way i found one small bug, which is fixed in commit 3bb2783. Dot-files weren't correctly recognized.

sindresorhus · 2020-08-29T10:37:33Z

readme.md

@@ -123,6 +123,15 @@ module.exports = {

 _**Note:** The global config only applies when using the global `np` binary, and is never inherited when using a local binary._

+### Select published files


I think this was meant to be in the Tips section.

sindresorhus · 2020-08-29T10:37:40Z

readme.md

@@ -123,6 +123,15 @@ module.exports = {

 _**Note:** The global config only applies when using the global `np` binary, and is never inherited when using a local binary._

+### Select published files
+You can select the published files with the `files` property in `package.json`
+or you can use the `.npmignore`-file, to exclude unnecessary stuff.


Don't hard-wrap.

sindresorhus · 2020-08-29T10:37:53Z

readme.md

+To avoid these mistakes, `np` reports all new files added to git, which are not published.
+Test files and other [obvious stuff](https://docs.npmjs.com/files/package.json#files) is excluded by default from this report.
+`np` assumes either a standard directory layout or a customized layout
+depict in the `directories` property (`package.json`).


This whole text could be better written.

sindresorhus · 2020-09-30T17:51:19Z

readme.md

+### Ignore strategy
+The [ignore strategy](https://docs.npmjs.com/files/package.json#files) either maintained in the `files`-property (`package.json`) or in the `.npmignore`-file should minify your packages.
+To ensure package consistency `np` reports all new files added to git, which are not published. Test files and other [obvious stuff](https://docs.npmjs.com/files/package.json#files) isn't considered.
+`np` assumes either a standard directory layout or a customized layout depict in the `directories` property (`package.json`).


I still don't think this text is good enough. Also, please run text through something like https://app.grammarly.com/.

sindresorhus · 2020-09-30T17:54:41Z

readme.md

@@ -255,6 +255,11 @@ Host *

 If you're running into other issues when using SSH, please consult [GitHub's support article](https://help.github.com/articles/connecting-to-github-with-ssh/).

+### Ignore strategy
+The [ignore strategy](https://docs.npmjs.com/files/package.json#files) either maintained in the `files`-property (`package.json`) or in the `.npmignore`-file should minify your packages.
+To ensure package consistency `np` reports all new files added to git, which are not published. Test files and other [obvious stuff](https://docs.npmjs.com/files/package.json#files) isn't considered.


We don't show new files to ensure package consistency. We show them to prevent publishing a broken package.

readme.md

sindresorhus · 2020-09-30T17:56:11Z

readme.md

@@ -255,6 +255,11 @@ Host *

 If you're running into other issues when using SSH, please consult [GitHub's support article](https://help.github.com/articles/connecting-to-github-with-ssh/).

+### Ignore strategy
+The [ignore strategy](https://docs.npmjs.com/files/package.json#files) either maintained in the `files`-property (`package.json`) or in the `.npmignore`-file should minify your packages.


"minify" means something else. It's more about "reducing" the size of the package.

bunysae and others added 5 commits September 14, 2019 06:55

retrieve the files, which were added since the last release

f7473d8

Checks for new files added since the last release implemented

5507f54

test-passes

7278c44

integration ignored files in ui

9f3a1c3

Merge branch 'master' into issue_103

d02e183

fregante requested changes Dec 11, 2019

View reviewed changes

bunysae added 2 commits December 11, 2019 20:36

Refactorings for new function show files since

5bb7561

the last release and not part of package according to pull-request comments from @fregante Pull-Request 456

Resolved merge-conflict in ui.js

c43f900

bunysae force-pushed the issue_103 branch from 01e5073 to 71d179a Compare December 15, 2019 19:10

Merge branch 'master' into issue_103

71d179a