amrbashir
3 years ago
commit
adfb011a94
@ -0,0 +1,5 @@
|
|||||||
|
# Order is important; the last matching pattern takes the most precedence.
|
||||||
|
* @tauri-apps/plugin-maintainers
|
||||||
|
|
||||||
|
# Currently CI/CD for plugins are in heavy flux, and the plugin team manages it themselves.
|
||||||
|
# .github @tauri-apps/wg-devops
|
||||||
@ -1,3 +1,5 @@
|
|||||||
target
|
target
|
||||||
node_modules
|
node_modules
|
||||||
dist
|
dist
|
||||||
|
pnpm-lock.yaml
|
||||||
|
Cargo.lock
|
||||||
@ -1,25 +1,88 @@
|
|||||||
|
|
||||||
|
|
||||||
<!-- description -->
|
Configurable logging for your Tauri app.
|
||||||
|
|
||||||
## Install
|
## Install
|
||||||
|
|
||||||
|
There are three general methods of installation that we can recommend.
|
||||||
|
|
||||||
|
1. Use crates.io and npm (easiest, and requires you to trust that our publishing pipeline worked)
|
||||||
|
2. Pull sources directly from Github using git tags / revision hashes (most secure)
|
||||||
|
3. Git submodule install this repo in your tauri project and then use file protocol to ingest the source (most secure, but inconvenient to use)
|
||||||
|
|
||||||
|
Install the Core plugin by adding the following to your `Cargo.toml` file:
|
||||||
|
|
||||||
|
`src-tauri/Cargo.toml`
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[dependencies]
|
||||||
|
tauri-plugin-log = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "dev" }
|
||||||
```
|
```
|
||||||
|
|
||||||
|
You can install the JavaScript Guest bindings using your preferred JavaScript package manager:
|
||||||
|
|
||||||
|
> Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
pnpm add https://github.com/tauri-apps/tauri-plugin-log
|
||||||
|
# or
|
||||||
|
npm add https://github.com/tauri-apps/tauri-plugin-log
|
||||||
|
# or
|
||||||
|
yarn add https://github.com/tauri-apps/tauri-plugin-log
|
||||||
```
|
```
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
|
First you need to register the core plugin with Tauri:
|
||||||
|
|
||||||
|
`src-tauri/src/main.rs`
|
||||||
|
|
||||||
|
```rust
|
||||||
|
use tauri_plugin_log::{LogTarget};
|
||||||
|
|
||||||
|
fn main() {
|
||||||
|
tauri::Builder::default()
|
||||||
|
.plugin(tauri_plugin_log::Builder::default().targets([
|
||||||
|
LogTarget::LogDir,
|
||||||
|
LogTarget::Stdout,
|
||||||
|
LogTarget::Webview,
|
||||||
|
]).build())
|
||||||
|
.run(tauri::generate_context!())
|
||||||
|
.expect("error while running tauri application");
|
||||||
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Afterwards all the plugin's APIs are available through the JavaScript guest bindings:
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
import { trace, info, error, attachConsole } from "tauri-plugin-log-api";
|
||||||
|
|
||||||
|
// with LogTarget::Webview enabled this function will print logs to the browser console
|
||||||
|
const detach = await attachConsole();
|
||||||
|
|
||||||
|
trace("Trace");
|
||||||
|
info("Info");
|
||||||
|
error("Error");
|
||||||
|
|
||||||
|
// detach the browser console from the log stream
|
||||||
|
detach();
|
||||||
```
|
```
|
||||||
|
|
||||||
|
To log from rust code, add the log crate to your `Cargo.toml`:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[dependencies]
|
||||||
|
log = "^0.4"
|
||||||
|
```
|
||||||
|
|
||||||
|
Now, you can use the macros provided by the log crate to log messages from your backend. See the [docs](https://docs.rs/log/latest) for more details.
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
PRs accepted. Please make sure to read the Contributing Guide before making a pull request.
|
PRs accepted. Please make sure to read the Contributing Guide before making a pull request.
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
Code: (c) 2015 - 2021 - The Tauri Programme within The Commons Conservancy.
|
Code: (c) 2015 - Present - The Tauri Programme within The Commons Conservancy.
|
||||||
|
|
||||||
MIT or MIT/Apache 2.0 where applicable.
|
MIT or MIT/Apache 2.0 where applicable.
|
||||||
|
|||||||
@ -1 +1,14 @@
|
|||||||
|
authenticator
|
||||||
|
autostart
|
||||||
|
fs-extra
|
||||||
|
fs-watch
|
||||||
|
localhost
|
||||||
|
log
|
||||||
|
persisted-scope
|
||||||
|
positioner
|
||||||
|
sql
|
||||||
|
store
|
||||||
|
stronghold
|
||||||
|
upload
|
||||||
websocket
|
websocket
|
||||||
|
window-state
|
||||||
|
|||||||
@ -1,25 +1,47 @@
|
|||||||
|
|
||||||
|
|
||||||
<!-- description -->
|
Save filesystem and asset scopes and restore them when the app is reopened.
|
||||||
|
|
||||||
## Install
|
## Install
|
||||||
|
|
||||||
```
|
There are three general methods of installation that we can recommend.
|
||||||
|
|
||||||
|
1. Use crates.io and npm (easiest, and requires you to trust that our publishing pipeline worked)
|
||||||
|
2. Pull sources directly from Github using git tags / revision hashes (most secure)
|
||||||
|
3. Git submodule install this repo in your tauri project and then use file protocol to ingest the source (most secure, but inconvenient to use)
|
||||||
|
|
||||||
|
Install the Core plugin by adding the following to your `Cargo.toml` file:
|
||||||
|
|
||||||
|
`src-tauri/Cargo.toml`
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[dependencies]
|
||||||
|
tauri-plugin-persisted-scope = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "dev" }
|
||||||
```
|
```
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
```
|
First you need to register the core plugin with Tauri:
|
||||||
|
|
||||||
|
`src-tauri/src/main.rs`
|
||||||
|
|
||||||
|
```rust
|
||||||
|
fn main() {
|
||||||
|
tauri::Builder::default()
|
||||||
|
.plugin(tauri_plugin_persisted_scope::init())
|
||||||
|
.run(tauri::generate_context!())
|
||||||
|
.expect("error while running tauri application");
|
||||||
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Afterwards the plugin will automatically save and restore filesystem and asset scopes.
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
PRs accepted. Please make sure to read the Contributing Guide before making a pull request.
|
PRs accepted. Please make sure to read the Contributing Guide before making a pull request.
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
Code: (c) 2015 - 2021 - The Tauri Programme within The Commons Conservancy.
|
Code: (c) 2015 - Present - The Tauri Programme within The Commons Conservancy.
|
||||||
|
|
||||||
MIT or MIT/Apache 2.0 where applicable.
|
MIT or MIT/Apache 2.0 where applicable.
|
||||||
|
|||||||
@ -0,0 +1,4 @@
|
|||||||
|
{
|
||||||
|
"extends": ["config:base"],
|
||||||
|
"enabledManagers": ["cargo", "npm"]
|
||||||
|
}
|
||||||
@ -1 +0,0 @@
|
|||||||
../../../shared/tsconfig.json
|
|
||||||
@ -1,8 +1,9 @@
|
|||||||
import { readFileSync } from "fs";
|
import { readFileSync } from "fs";
|
||||||
|
|
||||||
import { createConfig } from "../../../shared/rollup.config.mjs";
|
import { createConfig } from "../rollup.config.mjs";
|
||||||
|
|
||||||
export default createConfig({
|
export default createConfig({
|
||||||
|
input: "guest-js/index.ts",
|
||||||
pkg: JSON.parse(
|
pkg: JSON.parse(
|
||||||
readFileSync(new URL("./package.json", import.meta.url), "utf8")
|
readFileSync(new URL("./package.json", import.meta.url), "utf8")
|
||||||
),
|
),
|
||||||
@ -0,0 +1 @@
|
|||||||
|
../tsconfig.json
|
||||||
Loading…
Reference in new issue