Merge branch '0.6.x' into add-polling-2

.github/workflows/ci.yml

@@ -34,6 +34,8 @@ jobs:
           override: true
           profile: minimal
 
+      - uses: Swatinem/rust-cache@v2
+
       - name: Build
         run: cargo build --locked --verbose
 
@@ -56,6 +58,8 @@ jobs:
           override: true
           components: rustfmt, clippy
 
+      - uses: Swatinem/rust-cache@v2
+
       - name: Rustfmt
         run: cargo fmt -- --check
 

.github/workflows/docs.yml

@@ -2,13 +2,6 @@ name: Docs
 
 on:
   workflow_dispatch: {}
-  push:
-    branches:
-      - '0.6.x'
-    tags-ignore:
-      - "**"
-    paths:
-      - docs/**
   release:
     types:
       - published

cli/src/main.rs

@@ -69,6 +69,26 @@ fn main() -> Result<()> {
 			std::fs::write(file_path, defs)?;
 		}
 
+		if let Some(types_output) = code.types {
+			let types_path = config_path.parent().unwrap().join(types_output.path);
+
+			if let Some(parent) = types_path.parent() {
+				std::fs::create_dir_all(parent)?;
+			}
+
+			if let Some(defs) = types_output.defs {
+				let defs_path = if types_path.file_stem().unwrap() == "init" {
+					types_path.with_file_name("index.d.ts")
+				} else {
+					types_path.with_extension("d.ts")
+				};
+
+				std::fs::write(defs_path, defs)?;
+			}
+
+			std::fs::write(types_path, types_output.code)?;
+		}
+
 		if let Some(tooling) = code.tooling {
 			let tooling_path = config_path.parent().unwrap().join(tooling.path);
 

docs/config/options.md

@@ -5,6 +5,8 @@ opt client_output = "path/to/client/output.lua"`
 const outputExample = `opt server_output = "./network/client.luau"
 opt client_output = "src/client/zap.luau"`
 
+const typesOutputExample = `opt types_output = "network/types.luau"`
+
 const asyncLibExample = `opt yield_type = "promise"
 opt async_lib = "require(game:GetService('ReplicatedStorage').Promise)"`
 
@@ -37,14 +39,24 @@ The paths are relative to the configuration file and should point to a lua(u) fi
 
 <CodeBlock :code="outputExample" />
 
+## `types_output` [`0.6.18+`]
+
+Configures where Luau types will be output.
+
+The path is relative to the configuration file and should point to a lua(u) file.
+
+### Example
+
+<CodeBlock :code="typesOutputExample" />
+
 ## `call_default` `[0.6.18+]`
 
 The default `call` field that will be used for events. See [call](events.html#call) for possible options.
 
 ### Example
 
 <CodeBlock code = `opt call_default = "ManySync" />
-<CodeBlock code = `opt call_default = "Polling" />
+<CodeBlock code =`opt call_default = "Polling" />
 
 ### Default
 
@@ -58,15 +70,12 @@ This option changes the name of the remotes generated by Zap.
 
 <CodeBlock code = 'opt remote_scope = "ZAP"' />
 
-
 The generated remotes will be `ZAP_RELIABLE` and `ZAP_UNRELIABLE` respectively.
 
-
 ### Example
 
 <CodeBlock code = 'opt remote_scope = "PACKAGE_NAME"' />
 
-
 The generated remotes will change to be `PACKAGE_NAME_RELIABLE` and `PACKAGE_NAME_UNRELIABLE` respectively.
 
 ## `remote_folder`
@@ -77,15 +86,12 @@ This option changes the name folder that Zap's remotes are placed inside of Repl
 
 <CodeBlock code = 'opt remote_folder = "ZAP"' />
 
-
 The generated remotes will be in `ReplicatedStorage -> ZAP`.
 
-
 ### Example
 
 <CodeBlock code = 'opt remote_scope = "CHARACTER"' />
 
-
 The generated remotes be in `ReplicatedStorage -> CHARACTER`
 
 ## `casing`
@@ -179,13 +185,13 @@ This can be mitigated by firing remotes to the server at a timed rate, so as to
 local Timer = 0
 
 RunService.Heartbeat:Connect(function(DeltaTime)
-	Timer += DeltaTime
+ Timer += DeltaTime
 
-	-- Only send events 60 times per second
-	if Timer >= 1 / 60 then
-		Timer = 0
-		Zap.SendEvents()
-	end
+ -- Only send events 60 times per second
+ if Timer >= 1 / 60 then
+  Timer = 0
+  Zap.SendEvents()
+ end
 end)
 ```
 

zap/src/config.rs

@@ -23,6 +23,7 @@ pub struct Config<'src> {
 
 	pub server_output: &'src str,
 	pub client_output: &'src str,
+	pub types_output: Option<&'src str>,
 	pub tooling_output: &'src str,
 
 	pub casing: Casing,

zap/src/lib.rs

@@ -39,6 +39,7 @@ pub struct Output {
 pub struct Code {
 	pub server: Output,
 	pub client: Output,
+	pub types: Option<Output>,
 	pub tooling: Option<Output>,
 }
 
@@ -79,6 +80,11 @@ pub fn run(input: &str, no_warnings: bool) -> Return {
 						code: output::luau::client::code(&config),
 						defs: output::typescript::client::code(&config),
 					},
+					types: config.types_output.map(|types_output| Output {
+						path: types_output.into(),
+						code: output::luau::types::code(&config),
+						defs: output::typescript::types::code(&config),
+					}),
 					tooling: output::tooling::output(&config),
 				}),
 				diagnostics,

zap/src/output/luau/mod.rs

@@ -5,6 +5,7 @@ use crate::{
 
 pub mod client;
 pub mod server;
+pub mod types;
 
 pub trait Output {
 	fn push(&mut self, s: &str);

zap/src/output/luau/types.rs

@@ -0,0 +1,71 @@
+use crate::config::{Config, TyDecl};
+
+use super::Output;
+
+struct TypesOutput<'src> {
+	config: &'src Config<'src>,
+	tabs: u32,
+	buf: String,
+}
+
+impl Output for TypesOutput<'_> {
+	fn push(&mut self, s: &str) {
+		self.buf.push_str(s);
+	}
+
+	fn indent(&mut self) {
+		self.tabs += 1;
+	}
+
+	fn dedent(&mut self) {
+		self.tabs -= 1;
+	}
+
+	fn push_indent(&mut self) {
+		for _ in 0..self.tabs {
+			self.push("\t");
+		}
+	}
+}
+
+impl<'a> TypesOutput<'a> {
+	pub fn new(config: &'a Config) -> Self {
+		Self {
+			config,
+			tabs: 0,
+			buf: String::new(),
+		}
+	}
+
+	fn push_tydecl(&mut self, tydecl: &TyDecl) {
+		let name = &tydecl.name;
+		let ty = &tydecl.ty;
+
+		self.push_indent();
+		self.push(&format!("export type {name} = "));
+		self.push_ty(ty);
+		self.push("\n");
+	}
+
+	fn push_tydecls(&mut self) {
+		for tydecl in self.config.tydecls.iter() {
+			self.push_tydecl(tydecl);
+		}
+	}
+
+	pub fn output(mut self) -> String {
+		self.push_line(&format!(
+			"-- Types generated by Zap v{} (https://github.com/red-blox/zap)",
+			env!("CARGO_PKG_VERSION")
+		));
+
+		self.push_tydecls();
+		self.push_line("return nil");
+
+		self.buf
+	}
+}
+
+pub fn code(config: &Config) -> String {
+	TypesOutput::new(config).output()
+}

zap/src/output/typescript/mod.rs

@@ -2,6 +2,7 @@ use crate::config::{Config, Enum, Parameter, Ty};
 
 pub mod client;
 pub mod server;
+pub mod types;
 
 pub trait ConfigProvider {
 	fn get_config(&self) -> &Config;

zap/src/output/typescript/types.rs

@@ -0,0 +1,76 @@
+use crate::config::{Config, TyDecl};
+
+use super::{ConfigProvider, Output};
+
+struct TypesOutput<'src> {
+	config: &'src Config<'src>,
+	tabs: u32,
+	buf: String,
+}
+
+impl Output for TypesOutput<'_> {
+	fn push(&mut self, s: &str) {
+		self.buf.push_str(s);
+	}
+
+	fn indent(&mut self) {
+		self.tabs += 1;
+	}
+
+	fn dedent(&mut self) {
+		self.tabs -= 1;
+	}
+
+	fn push_indent(&mut self) {
+		for _ in 0..self.tabs {
+			self.push("\t");
+		}
+	}
+}
+
+impl ConfigProvider for TypesOutput<'_> {
+	fn get_config(&self) -> &Config {
+		self.config
+	}
+}
+
+impl<'a> TypesOutput<'a> {
+	pub fn new(config: &'a Config) -> Self {
+		Self {
+			config,
+			tabs: 0,
+			buf: String::new(),
+		}
+	}
+
+	fn push_tydecl(&mut self, tydecl: &TyDecl) {
+		let name = &tydecl.name;
+		let ty = &tydecl.ty;
+
+		self.push_indent();
+		self.push(&format!("export type {name} = "));
+		self.push_ty(ty);
+		self.push("\n");
+	}
+
+	fn push_tydecls(&mut self) {
+		for tydecl in self.config.tydecls.iter() {
+			self.push_tydecl(tydecl);
+		}
+	}
+
+	pub fn output(mut self) -> String {
+		self.push_line(&format!(
+			"// Types generated by Zap v{} (https://github.com/red-blox/zap)",
+			env!("CARGO_PKG_VERSION")
+		));
+
+		self.push_tydecls();
+
+		self.buf
+	}
+}
+
+pub fn code(config: &Config) -> Option<String> {
+	Some(TypesOutput::new(config).output())
+}

zap/src/parser/convert.rs

@@ -125,6 +125,7 @@ impl<'src> Converter<'src> {
 
 		let (server_output, ..) = self.str_opt("server_output", "network/server.lua", &config.opts);
 		let (client_output, ..) = self.str_opt("client_output", "network/client.lua", &config.opts);
+		let types_output: Option<&str> = self.types_output_opt(&config.opts);
 		let (tooling_output, ..) = self.str_opt("tooling_output", "network/tooling.lua", &config.opts);
 
 		let casing = self.casing_opt(&config.opts);
@@ -152,6 +153,7 @@ impl<'src> Converter<'src> {
 
 			server_output,
 			client_output,
+			types_output,
 			tooling_output,
 
 			casing,
@@ -236,6 +238,21 @@ impl<'src> Converter<'src> {
 		}
 	}
 
+	fn types_output_opt(&mut self, opts: &[SyntaxOpt<'src>]) -> Option<&'src str> {
+		let opt = opts.iter().find(|opt| opt.name.name == "types_output")?;
+
+		if let SyntaxOptValueKind::Str(opt_value) = &opt.value.kind {
+			Some(self.str(opt_value))
+		} else {
+			self.report(Report::AnalyzeInvalidOptValue {
+				span: opt.value.span(),
+				expected: "Types output path expected.",
+			});
+
+			None
+		}
+	}
+
 	fn call_default_opt(&mut self, opts: &[SyntaxOpt<'src>]) -> Option<EvCall> {
 		let opt = opts.iter().find(|opt| opt.name.name == "call_default")?;
 

zap/tests/lune/base.luau

@@ -3,7 +3,7 @@ local luau = require("@lune/luau")
 local process = require("@lune/process")
 local roblox = require("@lune/roblox")
 local task = require("@lune/task")
-local serverCode, clientCode, toolingCode = unpack(process.args)
+local serverCode, clientCode, typesCode, toolingCode = unpack(process.args)
 
 local noop = function() end
 
@@ -80,6 +80,12 @@ local client = luau.load(clientCode, {
 	environment = environment
 })()
 
+local types = luau.load(typesCode, {
+	debugName = "Types",
+	codegenEnabled = true,
+	environment = environment,
+})()
+
 local tooling = luau.load(toolingCode, {
 	debugName = "Tooling",
 	codegenEnabled = true,