Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: remove redundant statement about files attribute #6557

Merged
merged 1 commit into from
Jun 20, 2023

Conversation

DaviDevMod
Copy link
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 owner June 14, 2023 13:45
@wraithgar wraithgar changed the title Remove redundant and inaccurate statement about the "package.json#files" field docs: Remove redundant and inaccurate statement about the "package.json#files" field Jun 14, 2023
@wraithgar wraithgar changed the title docs: Remove redundant and inaccurate statement about the "package.json#files" field docs: remove redundant statement about files attribute Jun 14, 2023
@wraithgar wraithgar merged commit 405ffbf into npm:latest Jun 20, 2023
@github-actions github-actions bot mentioned this pull request Jun 20, 2023
Sign up for free to 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