Nexus

Uplift's frontend core library.

Docs

View docs nexus.uplift.ltd.

Contributing

Semantic Versioning

We use conventional commits to manage version updates. The title of your PR needs to have a valid prefix.

Note that changing the PR title won't re-run the job so you have to re-run the workflow jobs yourself.

Quick reference:

fix: Correct typo.
feat: Add support for Node 12.
feat(apollo): Add useEnhancedQuery hook.
refactor!: Drop support for Node 6.
feat!: Breaking change feature.

Note that since PR titles only have a single line, you have to use the ! syntax for breaking changes.

What are the files in each package?

babel.config.js   <== extends root babelrc, needed for jest
jest.config.js    <== extends root jest.config.js, needed for jest to find config
package.json
README.md         <== package readme, should match in `website/docs`
tsconfig.json     <== if the package supports typescript it needs to configure include

Publishing a new version

Run the publish workflow.

Select the branch you want to publish from and enter latest or prerelease as the distTag.

For production release use main branch and latest.

For prereleases use any branch and the prerelease dist tag.

The versioning is based on conventional commit history (see the Contributing section).

Adding a new package

See the documentation for create-nexus-package. To summarize:

Create a new folder and cd to it.

mkdir packages/my-package && cd packages/my-package

Initialize a new package using the @uplit-ltd/create-nexus-package initializer.

npm init @uplift-ltd/nexus-package

Working with local packages

There's some weirdness with yarn link. The most reliable way seems to be to use npm link. Also if the package depends on react you may have to alias that to the app react to avoid duplicate react versions (and hooks failing).

cd packages/formik
npm link
cd ../..
npm link ../../../myapp/node_modules/react
cd myapp
npm link @uplift-ltd/formik

Additionally you may need to alias @apollo/client and its own react version to the app.

cd packages/apollo
npm link
cd ../..
npm link ../myapp/node_modules/react
npm link ../myapp/node_modules/@apollo/client
cd node_modules/@apollo/client
npm link ../../../myapp/node_modules/react

Don't forget to run npm run build after every change.

You might have to wipe node_modules/.cache in your app if you ran into duplicate react issue.

See react docs for more details.

Sponsor

This project proudly sponsored by 🚀 Uplift.ltd.