feat(silo): Initial Silo scaffolding #2096

ospencer · 2024-04-21T22:26:38Z

This PR does some initial project scaffolding for Silo, Grain's new project manager and build system. This isn't quite an initial version, but rather some project setup to provide a foundation for us to work from as we build out functionality. It's not yet hooked up to our release process to allow us to continue Grain releases while we develop Silo in tandem.

Two commands are present, new and build:

$ silo --help
Build and manage Grain projects 🌾

Usage: silo [options] <command>

Options:
    -h, -help, --help  Display help
    -v, --version      Print version and exit

Commands:
    new    Create a new Grain project
    build  Compile the current project

Run silo <command> --help for help with individual commands.

Silo will eventually manage build artifacts itself rather than offload that functionality to grainc, manage dependencies (including the standard library), run wasm files, and more (though not necessarily all of these before an initial release).

As Silo does not yet handle dependencies/stdlib, build.stdlib must be set in your silo.toml to build projects.

I put together a Silo README as a basis for our Silo documentation which includes the following silo.toml configuration information, but I put it here in the PR description as well for easy access.

[package]
name = "my-package" # the name of this package

[build]
elide-type-info = false # compiles without Grain type info
include-dirs = ["../dir1", "../dir2"] # add paths to compiler code lookup
import-memory = false # imports the wasm memory instead of exporting one
initial-memory-pages = 64 # the number of wasm memory pages to start with
maximum-memory-pages = 128 # the limit of wasm memory pages to grow to
memory-base = 4096 # the memory address to begin Grain allocations
gc = true # enable or disable Grain's garbage collector
stdlib = "../custom-stdlib" # set the location of the standard library to use
use-start-section = false # use a wasm (start) section to run code on startup
wasi-polyfill = "src/wasi-polyfill.gr" # code to polyfill wasi imports

[build.wasm-features]
bulk-memory = true # enable or disable wasm bulk memory
tail-call = true # enable or disable wasm tail calls

[bin]
name = "my-name.wasm" # the name of the resulting wasm file
path = "src/main.gr" # the entrypoint of compilation
source-map = false # produce a source map file
wat = false # produce a WebAssembly Text (.wat) file

spotandjake

Looks good to me.

marcusroberts

This is great code to read and very comprehensible. A great start to Silo!

alex-snezhko · 2024-08-16T05:14:11Z

silo/src/config.re

+
+    let build_config = {
+      elide_type_info:
+        get(config, build |-- key("elide-type-info") |-- bool),


I'm curious about the choice of kebab case? The convention within the language itself is camel case so why not use that here?

Afaik there's no key naming convention in TOML and I've seen a mixture of all of

Rust, Gleam: snake case

Python: kebab case (odd that it's not snake case...)

Hugo: camel case

Rust uses kebab case, so that + mostly translating command line flags is what got me here. I'd be open to camel case though. I sort of like the configuration language being different than the source language though.

Ah yeah rust does use kebab case, my bad. Same question about package names and output binary name conventions: I see in the PR description you have kebab case but in the stdlib the convention so far has been camel case. When package management, etc rolls out are we going with kebab case package names like npm?

alex-snezhko

Why is silo a separate cli tool rather than being integrated into the grain command? E.g. grain build, grain new?

alex-snezhko · 2024-08-16T05:54:59Z

silo/src/cli.re

+      ~usage="[options] <path>",
+      ~options=[name_opt],
+      ~args=[path_arg],
+      Cmd.Thunk(() => New.new_(~name=?name^, path^)),


What do you think about the path optional at which point the current dir will be used?

ospencer · 2024-08-16T14:40:21Z

Why is silo a separate cli tool rather than being integrated into the grain command? E.g. grain build, grain new?

Silo is meant to completely replace the grain command, and the grain command will be removed once all of its functionality is built into Silo. It gives us an opportunity to truly integrate all of the tools into one and remove our Node.js dependency.

alex-snezhko

Left a few comments but looks great overall!

alex-snezhko · 2024-08-18T01:03:19Z

silo/src/new.re

+    );
+  Printf.fprintf(oc, "module Main\n\nprint(\"Hello, world!\")\n");
+  close_out(oc);
+};


Maybe can report a cheesy feedback message like "New grain project template created at [path]. Happy coding! 🌾"

alex-snezhko · 2024-08-18T01:20:59Z

silo/src/config.re

+
+    let build_config = {
+      elide_type_info:
+        get(config, build |-- key("elide-type-info") |-- bool),


Ah yeah rust does use kebab case, my bad. Same question about package names and output binary name conventions: I see in the PR description you have kebab case but in the stdlib the convention so far has been camel case. When package management, etc rolls out are we going with kebab case package names like npm?

alex-snezhko · 2024-08-18T01:23:36Z

silo/src/config.re

+
+    {package: package_config, build: build_config, bin: bin_config};
+  | `Error(msg, loc) => raise(LoadError(ConfigParseError(msg, loc)))
+  | exception (Sys_error(_)) => raise(LoadError(ConfigNotFound))


Should parent directories also be looked through?

I feel like it would make sense for us to look through parent directories, (especially if we are using silo.toml for the lsp as you might open vscode on a nested library and want your settings to follow over), I think if we do this though it would be beneificial to have a message like Building <path> project or just something to indicate which config is being used.

alex-snezhko · 2024-08-18T01:28:35Z

silo/src/cli.re

+    Cmd.make(
+      ~name="build",
+      ~doc="Compile the current project",
+      ~usage="[options]",


What do you think about having an optional argument to specify the directory to build from to avoid having to cd into it? So if you had /a/b/silo.toml and you're in /a you could do silo build ./b

alex-snezhko · 2024-08-18T01:30:40Z

silo/src/cli.re

+  let profile = ref(Build.Dev);
+  let release_opt =
+    Cmd.flag(
+      ~names=["--release"],


Why is this a CLI flag rather than something in the config TOML?

I assume this is a cli flag over being in the config because the average workflow would be compiling normally and then release is only used when your building for production at the end.

What if instead of having this as a cli flag though we had build profiles in the config. so you could silo build dev or silo build release, (We could autogenerate a dev and release build, and have the regular build be the development one), this would also help to accomodate multiple build targets.

spotandjake · 2024-08-19T00:05:34Z

silo/src/new.re

+      | None => raise(NewError(MustProvideName(path)))
+      }
+    };
+


Should we check if the new project your trying to make already exists and provide a warning? (Maybe we can allow it to be overridden with a force argument if needed).

feat(silo): Initial Silo scaffolding

cdcfec4

ospencer requested a review from a team April 21, 2024 22:26

ospencer self-assigned this Apr 21, 2024

ospencer requested a review from phated as a code owner April 21, 2024 22:26

spotandjake approved these changes Apr 21, 2024

View reviewed changes

marcusroberts approved these changes Apr 22, 2024

View reviewed changes

spotandjake added the silo Issues related to Silo label Apr 22, 2024

alex-snezhko reviewed Aug 16, 2024

View reviewed changes

alex-snezhko approved these changes Aug 18, 2024

View reviewed changes

spotandjake reviewed Aug 19, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(silo): Initial Silo scaffolding #2096

feat(silo): Initial Silo scaffolding #2096

ospencer commented Apr 21, 2024

spotandjake left a comment

marcusroberts left a comment

alex-snezhko Aug 16, 2024

ospencer Aug 16, 2024

alex-snezhko Aug 18, 2024

alex-snezhko left a comment

alex-snezhko Aug 16, 2024

ospencer commented Aug 16, 2024

alex-snezhko left a comment

alex-snezhko Aug 18, 2024 •

edited

Loading

alex-snezhko Aug 18, 2024

alex-snezhko Aug 18, 2024

spotandjake Aug 18, 2024

alex-snezhko Aug 18, 2024

alex-snezhko Aug 18, 2024

spotandjake Aug 18, 2024 •

edited

Loading

spotandjake Aug 19, 2024

feat(silo): Initial Silo scaffolding #2096

Are you sure you want to change the base?

feat(silo): Initial Silo scaffolding #2096

Conversation

ospencer commented Apr 21, 2024

spotandjake left a comment

Choose a reason for hiding this comment

marcusroberts left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alex-snezhko left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ospencer commented Aug 16, 2024

alex-snezhko left a comment

Choose a reason for hiding this comment

alex-snezhko Aug 18, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

spotandjake Aug 18, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alex-snezhko Aug 18, 2024 •

edited

Loading

spotandjake Aug 18, 2024 •

edited

Loading