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

npm: slim down distributed files. #147

Merged
merged 1 commit into from
Sep 2, 2014

Conversation

stephenplusplus
Copy link
Contributor

https://www.npmjs.org/doc/files/package.json.html#files

Best to keep it slim 👍 Did I miss any files?

@ryanseys
Copy link
Contributor

This is effectively the inverse effect of .npmignore (which we have), so we should pick one and crown it the victor. 👑

@stephenplusplus
Copy link
Contributor Author

Oh, wow. Didn't know we had that! I prefer a whitelist, and less root level dot file noise. I'll update the PR to remove that file, then leave it to the judges 🔨

@ryanseys
Copy link
Contributor

A whitelist will be shorter than the .npmignore blacklist if we really want to exclude a lot from npm publish but it's always nice to have more info available to the developer for debugging and whitelists are known to be more error-prone if not done correctly (ahem, Google IO 2014 @silvolu & @rakyll). E.g. README for npmjs.org to display is always nice, and tests so that Windows users can run tests from node_modules easily and report their errors 😄

So at the end of the day, I'm really indifferent as long as it's done correctly. 👍

@ryanseys
Copy link
Contributor

That final statement is a lie, I changed my mind. I like the blacklist / .npmignore even if it means more dotfiles.

@stephenplusplus
Copy link
Contributor Author

but it's always nice to have more info available to the developer for debugging

This should be done by cloning the repository, not by sorting through files in a node_modules directory.

whitelists are known to be more error-prone if not done correctly

I think each are as likely to cause problems if misused, but since "main" is defined in package.json to point to "lib", along with our dependencies, our scripts, etc. it makes the most sense to me to continue to use that as the source of truth of how we define our project.

E.g. README for npmjs.org to display is always nice

npm includes the readme by default.

@ryanseys
Copy link
Contributor

This should be done by cloning the repository

Fair enough. Don't really know what the convention is for that but I always like to run tests on the specific version installed rather than trying to track it down, clone and checkout.. Some projects exclude tests, I like to keep them in but that's just me.

I think each are as likely to cause problems if misused

Tru dat.

npm includes the readme by default.

Didn't know this! 👍

You know what you're doing, carry on 😄

rakyll pushed a commit that referenced this pull request Sep 2, 2014
npm: slim down distributed files.
@rakyll rakyll merged commit 0ae0917 into googleapis:master Sep 2, 2014
chingor13 pushed a commit that referenced this pull request Sep 12, 2022
*build!: Update library to use Node 12
chingor13 pushed a commit that referenced this pull request Sep 14, 2022
*build!: Update library to use Node 12
@release-please release-please bot mentioned this pull request Sep 14, 2022
sofisl pushed a commit that referenced this pull request Sep 15, 2022
sofisl pushed a commit that referenced this pull request Oct 12, 2022
sofisl pushed a commit that referenced this pull request Oct 13, 2022
sofisl pushed a commit that referenced this pull request Nov 11, 2022
#147)

* build(node): add feat in node post-processor to add client library version number in snippet metadata

Co-authored-by: Benjamin E. Coe <[email protected]>
Source-Link: googleapis/synthtool@d337b88
Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-nodejs:latest@sha256:d106724ad2a96daa1b8d88de101ba50bdb30b8df62ffa0aa2b451d93b4556641
sofisl pushed a commit that referenced this pull request Nov 11, 2022
🤖 I have created a release *beep* *boop*
---


## [2.0.2](https://togithub.com/googleapis/nodejs-iam-credentials/compare/v2.0.1...v2.0.2) (2022-11-10)


### Bug Fixes

* Allow passing gax instance to client constructor ([#145](https://togithub.com/googleapis/nodejs-iam-credentials/issues/145)) ([e3cfeba](https://togithub.com/googleapis/nodejs-iam-credentials/commit/e3cfebad3d72c4e844d95758d8571f8969c94ab4))
* better support for fallback mode ([e3cfeba](https://togithub.com/googleapis/nodejs-iam-credentials/commit/e3cfebad3d72c4e844d95758d8571f8969c94ab4))
* Change import long to require ([#146](https://togithub.com/googleapis/nodejs-iam-credentials/issues/146)) ([cbd8f76](https://togithub.com/googleapis/nodejs-iam-credentials/commit/cbd8f76476b6ab2f37f47f1597375af2937f96e2))
* **deps:** Use google-gax v3.5.2 ([#156](https://togithub.com/googleapis/nodejs-iam-credentials/issues/156)) ([4bd9f8b](https://togithub.com/googleapis/nodejs-iam-credentials/commit/4bd9f8b60e50ee6e6a3da08ef6d07999d81b39d7))
* Do not import the whole google-gax from proto JS ([#1553](https://togithub.com/googleapis/nodejs-iam-credentials/issues/1553)) ([#149](https://togithub.com/googleapis/nodejs-iam-credentials/issues/149)) ([ecd43bd](https://togithub.com/googleapis/nodejs-iam-credentials/commit/ecd43bdd58621e4d967d52d185fcda846b65e657))
* Preserve default values in x-goog-request-params header ([#150](https://togithub.com/googleapis/nodejs-iam-credentials/issues/150)) ([0cb6540](https://togithub.com/googleapis/nodejs-iam-credentials/commit/0cb6540ed6efcc905547845d71dd923ba5743d0e))
* Regenerated protos JS and TS definitions ([#159](https://togithub.com/googleapis/nodejs-iam-credentials/issues/159)) ([cece8c7](https://togithub.com/googleapis/nodejs-iam-credentials/commit/cece8c758df280204a4a1f4fd60b00c3161c1424))
* Remove pip install statements ([#1546](https://togithub.com/googleapis/nodejs-iam-credentials/issues/1546)) ([#148](https://togithub.com/googleapis/nodejs-iam-credentials/issues/148)) ([bc7ddbf](https://togithub.com/googleapis/nodejs-iam-credentials/commit/bc7ddbfbfb8151a6cdc6422bb345c6e993867539))
* use google-gax v3.3.0 ([ecd43bd](https://togithub.com/googleapis/nodejs-iam-credentials/commit/ecd43bdd58621e4d967d52d185fcda846b65e657))

---
This PR was generated with [Release Please](https://togithub.com/googleapis/release-please). See [documentation](https://togithub.com/googleapis/release-please#release-please).
sofisl pushed a commit that referenced this pull request Nov 11, 2022
[![WhiteSource Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [sinon](https://sinonjs.org/) ([source](https://togithub.com/sinonjs/sinon)) | [`^13.0.0` -> `^14.0.0`](https://renovatebot.com/diffs/npm/sinon/13.0.2/14.0.0) | [![age](https://badges.renovateapi.com/packages/npm/sinon/14.0.0/age-slim)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://badges.renovateapi.com/packages/npm/sinon/14.0.0/adoption-slim)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://badges.renovateapi.com/packages/npm/sinon/14.0.0/compatibility-slim/13.0.2)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://badges.renovateapi.com/packages/npm/sinon/14.0.0/confidence-slim/13.0.2)](https://docs.renovatebot.com/merge-confidence/) |

---

### Release Notes

<details>
<summary>sinonjs/sinon</summary>

### [`v14.0.0`](https://togithub.com/sinonjs/sinon/blob/HEAD/CHANGES.md#&#8203;1400)

[Compare Source](https://togithub.com/sinonjs/sinon/compare/v13.0.2...v14.0.0)

-   [`c2bbd826`](https://togithub.com/sinonjs/sinon/commit/c2bbd82641444eb5b32822489ae40f185afbbf00)
    Drop node 12 (Morgan Roderick)
    > And embrace Node 18
    >
    > See https://nodejs.org/en/about/releases/

*Released by Morgan Roderick on 2022-05-07.*

</details>

---

### Configuration

📅 **Schedule**: "after 9am and before 3pm" (UTC).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, click this checkbox.

---

This PR has been generated by [WhiteSource Renovate](https://renovate.whitesourcesoftware.com). View repository job log [here](https://app.renovatebot.com/dashboard#github/googleapis/nodejs-channel).
sofisl added a commit that referenced this pull request Nov 11, 2022
*  build!: Update library to use Node 12
sofisl pushed a commit that referenced this pull request Nov 11, 2022
- [ ] Regenerate this pull request now.

PiperOrigin-RevId: 468790263

Source-Link: googleapis/googleapis@873ab45

Source-Link: googleapis/googleapis-gen@cb6f37a
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiY2I2ZjM3YWVmZjJhMzQ3MmU0MGE3YmJhY2U4YzY3ZDc1ZTI0YmVlNSJ9
sofisl pushed a commit that referenced this pull request Nov 11, 2022
[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [jsdoc-fresh](https://togithub.com/googleapis/jsdoc-fresh) | [`^1.0.2` -> `^2.0.0`](https://renovatebot.com/diffs/npm/jsdoc-fresh/1.1.1/2.0.0) | [![age](https://badges.renovateapi.com/packages/npm/jsdoc-fresh/2.0.0/age-slim)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://badges.renovateapi.com/packages/npm/jsdoc-fresh/2.0.0/adoption-slim)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://badges.renovateapi.com/packages/npm/jsdoc-fresh/2.0.0/compatibility-slim/1.1.1)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://badges.renovateapi.com/packages/npm/jsdoc-fresh/2.0.0/confidence-slim/1.1.1)](https://docs.renovatebot.com/merge-confidence/) |

---

### Release Notes

<details>
<summary>googleapis/jsdoc-fresh</summary>

### [`v2.0.0`](https://togithub.com/googleapis/jsdoc-fresh/blob/HEAD/CHANGELOG.md#&#8203;200-httpsgithubcomgoogleapisjsdoc-freshcomparev111v200-2022-05-18)

[Compare Source](https://togithub.com/googleapis/jsdoc-fresh/compare/v1.1.1...v2.0.0)

##### ⚠ BREAKING CHANGES

-   update library to use Node 12 ([#&#8203;108](https://togithub.com/googleapis/jsdoc-fresh/issues/108))

##### Build System

-   update library to use Node 12 ([#&#8203;108](https://togithub.com/googleapis/jsdoc-fresh/issues/108)) ([e61c223](https://togithub.com/googleapis/jsdoc-fresh/commit/e61c2238db8900e339e5fe7fb8aea09642290182))

##### [1.1.1](https://www.github.com/googleapis/jsdoc-fresh/compare/v1.1.0...v1.1.1) (2021-08-11)

##### Bug Fixes

-   **build:** migrate to using main branch ([#&#8203;83](https://www.togithub.com/googleapis/jsdoc-fresh/issues/83)) ([9474adb](https://www.github.com/googleapis/jsdoc-fresh/commit/9474adbf0d559d319ff207397ba2be6b557999ac))

</details>

---

### Configuration

📅 **Schedule**: Branch creation - "after 9am and before 3pm" (UTC), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, click this checkbox.

---

This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://app.renovatebot.com/dashboard#github/googleapis/nodejs-service-management).
sofisl pushed a commit that referenced this pull request Nov 16, 2022
* chore(main): release 2.1.1

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
sofisl pushed a commit that referenced this pull request Nov 16, 2022
Source-Link: googleapis/synthtool@d229a12
Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-nodejs:latest@sha256:74ab2b3c71ef27e6d8b69b1d0a0c9d31447777b79ac3cd4be82c265b45f37e5e
sofisl pushed a commit that referenced this pull request Nov 30, 2022
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.

3 participants