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

Re-structure project source directory #4061

Closed
wants to merge 7 commits into from
Closed

Re-structure project source directory #4061

wants to merge 7 commits into from

Conversation

James-Yu
Copy link
Owner

@James-Yu James-Yu commented Nov 16, 2023

This PR aims at creating a more straightforward source code directory under src/.

The original one was used for seven years, seeing the project to grow from a small toy with a few source files to a large one as is. The old component-provider structure no longer being meaningful with the growth of features.

The new directory structure re-organize all source files according to their nature in LaTeX-Workshop. As all file moves are performed with git mv, the file editing history and git blame are preserved. Hopefully this won't be a big problem for later development.

I consider this change to be necessary in order to maintain the project for the upcoming years and make the project less messy to new and potential contributors and maintainers.

The next steps after this PR will be 1) extract interfaces and types, 2) decouple the source codes, which I had been doing terribly, 3) re-visit the math preview files for a possible refactor with unified-latex.

@James-Yu
Copy link
Owner Author

@jlelong May I have your insights on it? I'm sorry that the file changes may look scary, yet there's only two things: 1) move files and 2) fix imports. So everything works as it was 😆

@James-Yu
Copy link
Owner Author

After some test, git mv turned out not a good way of preserving file history. I will look for other solutions.

@James-Yu James-Yu closed this Nov 19, 2023
@James-Yu James-Yu deleted the re-structure branch November 19, 2023 15:48
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 20, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant