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

update list of published files in package.json #3547

Merged
merged 1 commit into from
Nov 8, 2018
Merged

Conversation

boneskull
Copy link
Contributor

PRO TIP: use npm pack --dry-run to see what would be included in
published tarball.

@boneskull boneskull added the semver-patch implementation requires increase of "patch" version number; "bug fixes" label Nov 2, 2018
@boneskull boneskull requested a review from plroebuck November 2, 2018 22:57
@plroebuck
Copy link
Contributor

as long as you're here, we should be documenting:

  • directories.lib
  • directories.test
  • directories.doc

@boneskull
Copy link
Contributor Author

@plroebuck specifying directories doesn't actually do anything, but might as well for metadata purposes.

@coveralls
Copy link

coveralls commented Nov 3, 2018

Coverage Status

Coverage remained the same at 90.353% when pulling 0f26b58 on files-list into be17ea5 on master.

Copy link
Contributor

@plroebuck plroebuck left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The documentation says having both bin and directories.bin is an error (though npm itself does this). directories.doc had incorrect directory name. The two remaining were prefixed for relative reference.

Left wondering about directories.doc as it really feels more like "directories.www" than actual documentation -- unclear (actually doubtful) whether it should be defined as such given our usage.
I'd be good to just remove directories.doc.

  "directories": {
    "doc": "./docs",
    "lib": "./lib",
    "test": "./test"
  },

This field should be added.

  "bugs": {
    "url": "https://github.com/mochajs/mocha/issues/"
  },

Minor modification of existing field to add trailing slash.

 "homepage": "https://mochajs.org/",

package.json Show resolved Hide resolved
@plroebuck plroebuck added this to the v6.0.0 milestone Nov 4, 2018
- this will fix a problem with npm (potentially) publishing certain files
which should always be ignored; see npm/npm-packlist#14.
- also fixes issue with growl images not getting published!
- add `directories` property for metadata

PRO TIP: use `npm pack --dry-run` to see what would be included in
published tarball.
@boneskull
Copy link
Contributor Author

@plroebuck please see changes in 0f26b58

"index.js",
"mocha.css",
"mocha.js",
"browser-entry.js"
],
"directories": {
"lib": "lib",
"test": "test"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Decide not to express these as explicit relative paths?
"lib": "./lib",
"test": "./test"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not sure why this matters...

@boneskull boneskull merged commit 614d35b into master Nov 8, 2018
@boneskull boneskull deleted the files-list branch November 8, 2018 22:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
semver-patch implementation requires increase of "patch" version number; "bug fixes"
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants