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

Clean up examples package.json #27121

Merged
merged 14 commits into from
Jul 12, 2021

Conversation

lucleray
Copy link
Member

@lucleray lucleray commented Jul 12, 2021

Clean up package.json files in the examples directory:

  • Add private: true
  • Remove version (because they are irrelevant for packages that are not meant to be published)
  • Remove name (because they are optional for packages that are not meant to be published, and when someone clones an example, they often rename it and the property becomes stale)
  • Remove author
  • Remove description
  • Remove license

Also remove with-dynamic-app-layout example completely, since it does the same as layout-component (#27121 (comment)).

Documentation / Examples

  • Make sure the linting passes

@ijjk ijjk added the examples Issue/PR related to examples label Jul 12, 2021
@lucleray lucleray marked this pull request as ready for review July 12, 2021 18:52
styfle
styfle previously approved these changes Jul 12, 2021
Copy link
Member

@styfle styfle left a comment

Choose a reason for hiding this comment

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

Looks good, thanks! 🎉

It would be nice to add a lint step to make sure the package.json follows this pattern for new examples in the future 👍

ijjk
ijjk previously approved these changes Jul 12, 2021
examples/blog/package.json Outdated Show resolved Hide resolved
examples/with-dynamic-app-layout/package.json Show resolved Hide resolved
examples/with-patternfly/package.json Outdated Show resolved Hide resolved
examples/with-quill-js/package.json Outdated Show resolved Hide resolved
examples/with-react-bootstrap/package.json Outdated Show resolved Hide resolved
examples/with-stencil/packages/test-component/package.json Outdated Show resolved Hide resolved
@lucleray lucleray dismissed stale reviews from ijjk and styfle via 3dcb428 July 12, 2021 19:32
@lucleray lucleray requested review from leerob, ijjk and styfle July 12, 2021 19:35
leerob
leerob previously approved these changes Jul 12, 2021
@kodiakhq kodiakhq bot merged commit f52955e into vercel:canary Jul 12, 2021
oBusk added a commit to oBusk/next.js that referenced this pull request Aug 14, 2021
This was mentioned in vercel#27121 but it looks like it didn't end up being in the merge?
oBusk added a commit to oBusk/next.js that referenced this pull request Aug 14, 2021
ijjk added a commit that referenced this pull request Aug 14, 2021
* Add licences to all example/package.json that lack them

* Revert "Add licences to all example/package.json that lack them"

This reverts commit 5d4e250.

* Update check-examples to remove `license` field from examples

* Remove `license` from all examples.

This was mentioned in #27121 but it looks like it didn't end up being in the merge?

Co-authored-by: JJ Kasper <jj@jjsweb.site>
ijjk pushed a commit that referenced this pull request Aug 14, 2021
* Add ci script to check examples

* Install moreutils for `sponge` command.

It's not very pretty, but I'm not sure how to replace sponge in a good way in the shell script

* Prettier names in the workflow

* Move "check-examples" into build_test_deploy workflow

* Start breaking the jq script into multiple lines

* Add checks for cleanups in #27121

* Run the `check-examples.sh` script to cleanup all remaining examples.
flybayer pushed a commit to blitz-js/next.js that referenced this pull request Aug 19, 2021
Clean up package.json files in the `examples` directory:
- Add `private: true`
- Remove `version` (because they are irrelevant for packages that are not meant to be published)
- Remove `name` (because they are optional for packages that are not meant to be published, and when someone clones an example, they often rename it and the property becomes stale)
- Remove `author`
- Remove `description`
- Remove `license`

Also remove `with-dynamic-app-layout` example completely, since it does the same as `layout-component` (vercel#27121 (comment)).

## Documentation / Examples

- [x] Make sure the linting passes
oBusk added a commit to oBusk/next.js that referenced this pull request Oct 26, 2021
oBusk added a commit to oBusk/next.js that referenced this pull request Oct 26, 2021
@vercel vercel locked as resolved and limited conversation to collaborators Jan 28, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
examples Issue/PR related to examples
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants