Repository navigation
[bug] tauri::command breaks the #![deny(missing_docs)] directive #4550
Description
Describe the bug
I am unable to include the #![deny(missing_docs)] directive in a tauri application that uses tauri commands.
Reproduction
- Create a new tauri app
- Add
#![deny(missing_docs)]at the top ofmain.rs - Create a command using
#[derive(tauri::command)], with or without documentation
Expected behavior
The application compiles without errors.
Platform and versions
Environment
› OS: Windows 10.0.19044 X64
› Webview2: 103.0.1264.37
› MSVC:
- Visual Studio Build Tools 2019
› Node.js: 16.15.1
› npm: 8.11.0
› pnpm: Not installed!
› yarn: 1.22.19
› rustup: 1.24.3
› rustc: 1.61.0
› cargo: 1.61.0
› Rust toolchain: stable-x86_64-pc-windows-msvc
Packages
› @tauri-apps/cli [NPM]: 1.0.0
› @tauri-apps/api [NPM]: 1.0.1
› tauri [RUST]: 1.0.0,
› tauri-build [RUST]: 1.0.0,
› tao [RUST]: 0.11.2,
› wry [RUST]: 0.18.3,
App
› build-type: bundle
› CSP: unset
› distDir: ../dist
› devPath: http://localhost:3000/
› framework: React
App directory structure
├─ .git
├─ .github
├─ .storybook
├─ .vscode
├─ dist
├─ lib
├─ node_modules
├─ schema
├─ src
└─ src-tauriStack trace
error: missing documentation for a macro
--> src\commands.rs:14:1
|
14 | #[tauri::command]
| ^^^^^^^^^^^^^^^^^
|
note: the lint level is defined here
--> src\main.rs:5:9
|
5 | #![deny(missing_docs)] //<- tauri commands break this
| ^^^^^^^^^^^^
= note: this error originates in the attribute macro `tauri::command` (in Nightly builds, run with -Z macro-backtrace for more info)
error: could not compile `app` due to previous errorAdditional context
This is a known limitation that requires support from the macro to resolve.
Activity
[-][bug] tauri::command breaks the #![deny(missing_docs)]] directive[/-][+][bug] tauri::command breaks the #![deny(missing_docs)] directive[/+]feat(macros): hide command macro from docs, closes #4550
lucasfernog commentedon Jul 1, 2022
Fix will be available in the next release. For now you can add
#![allow(missing_docs)]to the src/commands.rs file.will-hart commentedon Jul 2, 2022
Awesome, thanks! I love what you're doing with tauri 💯