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

Feat/monorepo reconfiguration #12

Merged
merged 9 commits into from
Feb 22, 2024

Conversation

DhivinX
Copy link
Contributor

@DhivinX DhivinX commented Feb 22, 2024

From now, building packages should work without any problems, just use pnpm dist. (Before doing so, remove all node_modules generated by yarn/npm)
See README.md in section Project development.

Changes introduced by this PR:

  • Improved dependencies between packages
  • Configured the repository to use pnpm
  • The README file has been updated with a table of contents and development instructions
  • Turbo and build caching configured
  • Fixed types in LayerRenderer.ts (webglrenderer), however this needs checking, I used type casting to force the correct argument types
  • Completed .gitignore and added .npmignore so that when publishing a package, the "dist" folder is not excluded
  • Added .editorconfig configuration, for now indentation is set to 4 spaces (We could use 2 spaces to get closer to the standards)

Planning:

  • Add eslint and prettier configuration for linting and formatting code
  • Unify tsconfig.json configuration for all packages
  • Remove unnecessary references because packages have the necessary types connection in package.json

We could add Github Actions configuration to automate the publishing of packages when changes are pushed to the main branch. You would need to add a develop branch for the current code and a main branch would be the alive branch. Then when we merge the develop branch into main it would automatically publish the packages to the registry.

We could also add a dependabot configuration to keep external dependencies up to date.

@DhivinX DhivinX marked this pull request as draft February 22, 2024 13:04
@DhivinX DhivinX marked this pull request as ready for review February 22, 2024 13:04
@xeolabs xeolabs merged commit 32f2d7f into xeokit:main Feb 22, 2024
@xeolabs
Copy link
Member

xeolabs commented Feb 22, 2024

Looks good to me, thanks very much @DhivinX

@paireks
Copy link
Member

paireks commented Feb 22, 2024

Wow, I can finally succesfully build it! :)

The only thing I had to do additionally is that between "npm i pnpm -g" and "pnpm install turbo --global" I had to restart the computer, because of that thing that happens on Windows and Macs: https://stackoverflow.com/questions/77224607/how-can-i-help-pnpm-find-its-global-directory

The last thing I personally miss right now probably is running the unit tests existing. @DhivinX have you tried running all of them, or some of them? If so: can the process be written down somewhere, so I can give it a try?

@DhivinX
Copy link
Contributor Author

DhivinX commented Feb 22, 2024

@paireks I will try to fix the tests in the next iteration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants