f15fb7c65a
Previously our CLI assumed that when using an `--example` flag, the example contains a `package.json` file. There are examples though, like `with-docker-compose` which does not have one. In that case, we can simply clone the directory and show a success message. <details> <summary> Full list of examples without <code>package.json</code>: </summary> <ul> <li>custom-server</li> <li>page-transitions</li> <li>parameterized-routing</li> <li>reproduction-template</li> <li>with-chakra-ui-typescript</li> <li>with-cookie-auth</li> <li>with-docker-compose</li> <li>with-dotenv</li> <li>with-facebook-chat-plugin</li> <li>with-firebase-authentication</li> <li>with-firebase-authentication-serverless</li> <li>with-glamorous</li> <li>with-global-stylesheet</li> <li>with-global-stylesheet-simple</li> <li>with-graphql-faunadb</li> <li>with-markdown</li> <li>with-material-ui</li> <li>with-next-auth</li> <li>with-next-i18next</li> <li>with-next-multilingual</li> <li>with-next-routes</li> <li>with-now-env</li> <li>with-pretty-url-routing</li> <li>with-prisma</li> <li>with-redux-toolkit</li> <li>with-redux-toolkit-typescript</li> <li>with-sentry-simple</li> <li>with-strict-csp-hash</li> <li>with-styled-jsx-postcss</li> <li>with-sw-precache</li> <li>with-typescript-styled-components</li> <li>with-universal-configuration-build-time</li> <li>with-universal-configuration-runtime</li> </ul> </details> Fixes #37884 In a follow-up PR, we can try to detect if an example contains a README.md file only, and if the example was moved, we could either try getting it from the new location or at least show a better message. (Eg.: using a magic comment that we can parse) ## Bug - [ ] Related issues linked using `fixes #number` - [ ] Integration tests added - [ ] Errors have helpful link attached, see `contributing.md` ## Feature - [ ] Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR. - [ ] Related issues linked using `fixes #number` - [ ] Integration tests added - [ ] Documentation added - [ ] Telemetry added. In case of a feature if it's used or not. - [ ] Errors have helpful link attached, see `contributing.md` ## Documentation / Examples - [ ] Make sure the linting passes by running `pnpm lint` - [ ] The examples guidelines are followed from [our contributing doc](https://github.com/vercel/next.js/blob/canary/contributing.md#adding-examples) |
||
---|---|---|
.. | ||
examples.ts | ||
get-pkg-manager.ts | ||
git.ts | ||
install.ts | ||
is-folder-empty.ts | ||
is-online.ts | ||
is-writeable.ts | ||
make-dir.ts | ||
validate-pkg.ts |