create-relay-app

Changes

• Add --legacy-peer-deps flag when installing packages via npm

Full Changelog: https://github.com/tobias-tengler/create-relay-app/compare/v2.1.1...v2.1.2

Changes

• Install relay-runtime package
• Support _app.{tsx,jsx} being located under src/pages/ instead of pages/

Full Changelog: https://github.com/tobias-tengler/create-relay-app/compare/v2.1.0...v2.1.1

Changes

• Configure relay-compiler in relay.config.json instead of in package.json
• Add --watch to relay-compiler script, if watchman is installed
• Send recommended Accept header as per the GraphQL over HTTP spec:
  Accept: application/graphql-response+json; charset=utf-8, application/json; charset=utf-8

Full Changelog: https://github.com/tobias-tengler/create-relay-app/compare/v2.0.0...v2.1.0

Changes

• Script now infers project details per default. Interactive mode needs to be requested via --interactive explicitly
• Put script arguments into README.md

Full Changelog: https://github.com/tobias-tengler/create-relay-app/compare/v1.0.0...v2.0.0

Changes

• Fix Next.js 12.3 Typescript issue, by passing RelayPageProps to AppProps<T> in _app component
• Prevent initialRecords regenerating Relay environment upon new page visit
• Introduce new typescript helpers like the afformentioned RelayPageProps, and GetRelayServerSideProps as well as GetRelayStaticProps
• Update documentation to reflect changes: updated documentation

Full Changelog: https://github.com/tobias-tengler/create-relay-app/compare/v0.0.7...v1.0.0

Changes

• Re-add vite-plugin-relay now that it supports Vite 3

Problems

I'm aware of a Typescript issue with Next.js 12.3. I'm working on resolving it for v1.0.0.

Full Changelog: https://github.com/tobias-tengler/create-relay-app/compare/v0.0.6...v0.0.7

Changes

• Do not install vite-plugin-relay from GIT branch. Instead showcase how to add the plugin manually until it's fixed for Vite 3.

Full Changelog: https://github.com/tobias-tengler/create-relay-app/compare/v0.0.5...v0.0.6

Changes

• New --subscriptions option to configure subscriptions via graphql-ws
• Fix line ending of Relay artifacts to LF using .gitattributes (when in a GIT repository)
• Improve default value for --package-manager
• Add Next steps documentation in case the user clears their terminal output
• Surface filesystem errors in a better format

Full Changelog: https://github.com/tobias-tengler/create-relay-app/compare/v0.0.4...v0.0.5

Changes

• Add integration tests using Playwright to ensure that the tool is compatible with scaffolded projects produced by CRA, Vite and Next.js.
• Support Next.js server side rending
• Merge configuration in next.config.js instead of bailing
• Project can now only be run from the root directory of a project
• Lots of internal refactoring to make it more testable

Full Changelog: https://github.com/tobias-tengler/create-relay-app/compare/v0.0.3...v0.0.4

Changes

• Support Create React App Typescript and Javascript projects
• Provide guidance on babel-plugin-relay setup for CRA: Link
• Add reminder to use the babel-plugin-relay macro

Full Changelog: https://github.com/tobias-tengler/create-relay-app/compare/v0.0.2...v0.0.3

Changes

• Add relay-compiler --validate to "build" script in package.json, if present
• existing "relay" configuration in package.json is merged with new configuration
• Consolidate CLI argument / prompt handling
• Speed up checking for installed dependencies
• Add "eagerEsModules": true to relay-compiler configuration for Vite, to generate correct artifacts also for Javascript
• Display default values that were chosen when running with --yes

Full Changelog: https://github.com/tobias-tengler/create-relay-app/compare/v0.0.1...v0.0.2

⚠️ This package is not stable yet! I'm just publishing it, so you don't have to remember to append @experimental. I'll consider it stable, once a v1.0.0 is released. In the meantime feel free to try it out and give feedback! :)

New features

• Support configuration of Next.js Javascript and Typescript projects
• Support configuration of Vite.js Javascript and Typescript projects
  • We are installing the vite-plugin-relay package from an open PR at the moment, until it's published and the latest Vite version is officially supported.
• Support configuration of Create React App Javascript and Typescript projects
  • The babel-plugin-relay transform is currently not being setup. This will be added in the next version!

Learn how to use it

Full Changelog: https://github.com/tobias-tengler/create-relay-app/commits/v0.0.1