lmucs-shared-types
v1.0.25
Published
Shared types
Readme
- Quick Start
- Linking a NextJS project with these shared types
- Shared Types Repo Setup
- Troubleshooting
- NPM Setup
- Reference
Shared TypeScript Types
Quick Start
Note: You should only need to do this once.
- Clone this repo and run
bun link. - Then, in your project that uses these types, run
bun link lmucs-shared-types.
Updating types
You should run bun ci after each update to the types, so your other projects are refreshed.
- Add/update your types, then run
bun ciwhich willcleanandbuildnew types. - For projects hosted on Vercel, you must
bun pubto publish these types to NPM.
Linking a NextJS project with these shared types
https://chatgpt.com/share/58780926-f656-46f7-b106-7a033b075789
Notes
- Main project (NextJS) will use types in the
distdirectory, which is why it must be refreshed each time.
Shared Types Repo Setup
- Remove
distfrom.gitignore, so thedistfiles are in the repo
package.json
"files": [
"/dist"
],Troubleshooting
Types are not reflected in Vercel
- Remove
bun.lockbandnode_modulesfrom NextJS project and re-install usingbun i, then push again.
NPM Setup
npm login
cd project-shared-types
npm init
npm publishhttps://chatgpt.com/share/eaa775d6-4252-4969-bc3b-ac50d4721da0
Reference
- https://github.com/masaok/react-hook-gyroscope/blob/main/package.json
