artin/tauri
1
0
Fork 0
mirror of https://github.com/tauri-apps/tauri.git synced 2026-02-06 13:57:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix: write default permission words if not empty (#13646)

Browse Source 
* fix: write default permission words if not empty

* Remove left over format!
This commit is contained in:
Tony 2025-06-21 09:52:36 +08:00 committed by GitHub
parent c03cc586e3
commit eb3f0248c2
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 15 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
.changes/default-permissions-doc.md Normal file
View File

@ -0,0 +1,5 @@
---
tauri-utils: "minor:bug"
---
Only write `This default permission set includes the following` to the reference if the default permission set is not empty

26
crates/tauri-utils/src/acl/build.rs
View File

@ -326,11 +326,9 @@ pub fn generate_docs(
out_dir: &Path,
plugin_identifier: &str,
) -> Result<(), Error> {
let mut default_permission = "".to_owned();
let mut permission_table = "".to_string();
let mut default_permission = "## Default Permission\n\n".to_string();
let mut contains_default = false;
fn docs_from(id: &str, description: Option<&str>, plugin_identifier: &str) -> String {
let mut docs = format!("\n<tr>\n<td>\n\n`{plugin_identifier}:{id}`\n\n</td>\n");
if let Some(d) = description {
@ -351,15 +349,16 @@ pub fn generate_docs(
}
if let Some(default) = &permission.default {
contains_default = true;
default_permission.push_str(default.description.as_deref().unwrap_or_default());
default_permission.push_str("## Default Permission\n\n");
default_permission.push_str(default.description.as_deref().unwrap_or_default().trim());
default_permission.push('\n');
default_permission.push('\n');
default_permission.push_str("#### This default permission set includes the following:\n");
default_permission.push('\n');
for permission in &default.permissions {
default_permission.push_str(&format!("- `{permission}`\n"));
if !default.permissions.is_empty() {
default_permission.push_str("#### This default permission set includes the following:\n\n");
for permission in &default.permissions {
default_permission.push_str(&format!("- `{permission}`\n"));
}
default_permission.push('\n');
}
}
@ -373,12 +372,7 @@ pub fn generate_docs(
}
}
if !contains_default {
default_permission = "".to_string();
}
let docs =
format!("{default_permission}\n{PERMISSION_TABLE_HEADER}\n{permission_table}</table>\n");
let docs = format!("{default_permission}{PERMISSION_TABLE_HEADER}\n{permission_table}</table>\n");
let reference_path = out_dir.join(PERMISSION_DOCS_FILE_NAME);
write_if_changed(&reference_path, docs).map_err(|e| Error::WriteFile(e, reference_path))?;

1
examples/api/src-tauri/tauri-plugin-sample/permissions/autogenerated/reference.md
View File

@ -1,4 +1,3 @@
## Permission Table
<table>