[Refactor] Changed stanza.proj tree structure #42
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Closes JITX-7191
This commit changes the way that the `stanza.proj` files are created for
projects.
In the old way, the `.slm/stanza.proj` was effectively the `root` stanza
project file. This meant that to build, slm had to change directories to `.slm`
and then run the `stanza build` there.
This caused a lot of complexity. It meant that I couldn't just run
`stanza build` at the root directory. It also broke dependency resolution
in vscode via the stanza language server.
This commit creates the root `stanza.proj` at the root of the project
and then has the root `stanza.proj` import `.slm/stanza.proj`. The
`.slm/stanza.proj` still manages all of the resolved dependencies of
the project and abstracts that away from the end user. With this setup:
1. The user can run `stanza build` from the root
2. VSCode language server continues to work as expected.
3. The structure of the project is a lot more clear.
4. We can more easily define configuration options that affect the build
without hiding them inside the `slm` executable. Specifically - I
moved the `-pkg pkgs` command line option and put it in the `stanza.proj`
file for the `main` target. This means `stanza build` will just work.
tjknoth
reviewed
Nov 29, 2023
| @@ -76,13 +77,15 @@ public defn init (cmd-args:CommandArgs) -> False: | |||
| val main-package = to-string("%_/main" % [project-name]) | |||
| val stanza-proj-path = to-string("%_/stanza.proj" % [project-dir]) | |||
| if not file-exists?(stanza-proj-path): | |||
| spit(stanza-proj-path, \<>include "src/stanza.proj" | |||
| spit(stanza-proj-path, \<>include ".slm/stanza.proj" ; Dependencies | |||
| include "src/stanza.proj" ; Project Sources | |||
There was a problem hiding this comment.
at some point it might be nice to parameterize the src directory
There was a problem hiding this comment.
Ya - I'm not a fan of all the string literals that are bandied about in this project. I'll add a ticket in linear.
tjknoth
approved these changes
Nov 29, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes JITX-7191
This commit changes the way that the
stanza.projfiles are created for projects.In the old way, the
.slm/stanza.projwas effectively therootstanza project file. This meant that to build, slm had to change directories to.slmand then run thestanza buildthere.This caused a lot of complexity. It meant that I couldn't just run
stanza buildat the root directory. It also broke dependency resolution in vscode via the stanza language server.This commit creates the root
stanza.projat the root of the project and then has the rootstanza.projimport.slm/stanza.proj. The.slm/stanza.projstill manages all of the resolved dependencies of the project and abstracts that away from the end user. With this setup:stanza buildfrom the rootslmexecutable. Specifically - I moved the-pkg pkgscommand line option and put it in thestanza.projfile for themaintarget. This meansstanza buildwill just work.Notes
stanza.projfile.cmd-clickin vscode on dependencies in my project and they resolve to.slm/deps/<project>/.... That all seems to be working well.