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

fix: add missing fields, fix up array type, add comments #60

Merged
merged 6 commits into from
Jul 24, 2024

Conversation

broofa
Copy link
Contributor

@broofa broofa commented Jul 1, 2024

Making the following changes:

  1. Add missing fields:
  • funding
  • licenses (deprecated)
  • overrides
  • peerDependenciesMeta
  • workspaces
  1. Allow mixed object/string entries in contributors
  2. Misc. comment cleanup

References

types/index.d.ts Outdated Show resolved Hide resolved
@broofa
Copy link
Contributor Author

broofa commented Jul 1, 2024

Ugh. Fixture tests failing... looking into it.

@broofa
Copy link
Contributor Author

broofa commented Jul 1, 2024

CI tests were failing because tap#matchSnapshot() is sensitive to key-iteration order..

Quick fix was to npm run snap to regenerate fixtures. Actual fix was to sort fixture keys alphabetically.

@broofa broofa mentioned this pull request Jul 19, 2024
types/index.d.ts Outdated Show resolved Hide resolved
@reggi
Copy link
Contributor

reggi commented Jul 19, 2024

Thanks a bunch for the changes! I found one issue with overrides!

'Turns out VSCode and `tsc` aren't able to "find" the types if the
package.json#exports field is defined.  'Something to do with the
NodeNext loading logic?  I'm not sure what exactly the issue is, but
removing this field from package.json fixes the problem.
@reggi reggi merged commit 6ffee7f into npm:main Jul 24, 2024
7 checks passed
reggi pushed a commit that referenced this pull request Aug 13, 2024
🤖 I have created a release *beep* *boop*
---


## [2.0.0](v1.0.2...v2.0.0)
(2024-08-07)

### ⚠️ BREAKING CHANGES

* update types (#29)
* refactor to use @npmcli/template-oss (#31)

### Features

*
[`123bb67`](123bb67)
[#29](#29) update types (#29) (@broofa,
@jablko, @lukekarrys)
*
[`f09f754`](f09f754)
[#31](#31) refactor to use
@npmcli/template-oss (#31) (@lukekarrys)

### Bug Fixes

*
[`6ffee7f`](6ffee7f)
[#60](#60) add missing fields, fix up
array type, add comments (#60) (@broofa, @styfle)
*
[`4548f2c`](4548f2c)
[#39](#39) linting cleanup (#39)
(@lukekarrys)

### Documentation

*
[`5511d4b`](5511d4b)
[#40](#40) fix README typo, improve
PackageJSON description (#40) (@broofa, @styfle)
*
[`1a08144`](1a08144)
[#37](#37) fix typo in readme (#37)
(@lukekarrys)

### Chores

*
[`d323311`](d323311)
[#70](#70) bump @types/node from
20.12.10 to 22.1.0 (#70) (@dependabot[bot])
*
[`4761562`](4761562)
[#71](#71) bump
@typescript-eslint/parser from 7.18.0 to 8.0.1 (#71) (@dependabot[bot])
*
[`3687a18`](3687a18)
[#38](#38) simplify template-oss config
(#38) (@lukekarrys)
*
[`1a1fd85`](1a1fd85)
[#36](#36) remove build script and
update snapshots and tsconfig (#36) (@lukekarrys)
*
[`3172a32`](3172a32)
update template-oss files for main branch (@lukekarrys)

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
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.

[BUG] PackageJson type missing numerous npm-documented fields
3 participants