Skip to content

docs: remove redundant statement about files attribute - #6557

Merged
wraithgar merged 1 commit into
npm:latestfrom
DaviDevMod:patch-1
Jun 20, 2023
Merged

docs: remove redundant statement about files attribute#6557
wraithgar merged 1 commit into
npm:latestfrom
DaviDevMod:patch-1

Conversation

@DaviDevMod

Copy link
Copy Markdown
Contributor

The statement:

Files included with the "package.json#files" field cannot be excluded through .npmignore or .gitignore.

Is inaccurate and redundant as the concept is already being explained right above:

You can also provide a .npmignore file in the root of your package or in subdirectories, which will keep files from being included. At the root of your package it will not override the "files" field, but in subdirectories it will. The .npmignore file works just like a .gitignore. If there is a .gitignore file, and .npmignore is missing, .gitignore's contents will be used instead.

References

…es" field
The statement:
'Files included with the "package.json#files" field cannot be excluded through `.npmignore` or `.gitignore`'.
Is inaccurate and redundant as the concept is already being explained right above:
'You can also provide a `.npmignore` file in the root of your package or in subdirectories, which will keep files from being included. At the root of your package it will not override the "files" field, but in subdirectories it will. The `.npmignore` file works just like a `.gitignore.` If there is a `.gitignore` file, and `.npmignore` is missing, `.gitignore`'s contents will be used instead'.
@DaviDevMod
DaviDevMod requested a review from a team as a code ownerJune 14, 2023 13:45
@wraithgarwraithgar changed the title Remove redundant and inaccurate statement about the "package.json#files" fielddocs: Remove redundant and inaccurate statement about the "package.json#files" fieldJun 14, 2023
@wraithgarwraithgar changed the title docs: Remove redundant and inaccurate statement about the "package.json#files" fielddocs: remove redundant statement about files attributeJun 14, 2023
@wraithgar
wraithgar merged commit 405ffbf into npm:latestJun 20, 2023
@github-actionsgithub-actionsBot mentioned this pull request Jun 20, 2023
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@DaviDevMod@wraithgar