Skip to content

Commit 0fed10f

Browse files
lucasfernoglucasfernog
authored
feat(cli): add plugin (#304)
1 parent 4b22903 commit 0fed10f

File tree

16 files changed

+1731
-471
lines changed

16 files changed

+1731
-471
lines changed

‎Cargo.lock

Lines changed: 243 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎plugins/cli/Cargo.toml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
[package]
2+
name = "tauri-plugin-cli"
3+
version = "0.1.0"
4+
edition.workspace = true
5+
authors.workspace = true
6+
license.workspace = true
7+
8+
[dependencies]
9+
serde.workspace = true
10+
serde_json.workspace = true
11+
tauri.workspace = true
12+
log.workspace = true
13+
thiserror.workspace = true
14+
clap = { version = "4", features = ["string"] }

‎plugins/cli/LICENSE.spdx

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
SPDXVersion: SPDX-2.1
2+
DataLicense: CC0-1.0
3+
PackageName: tauri
4+
DataFormat: SPDXRef-1
5+
PackageSupplier: Organization: The Tauri Programme in the Commons Conservancy
6+
PackageHomePage: https://tauri.app
7+
PackageLicenseDeclared: Apache-2.0
8+
PackageLicenseDeclared: MIT
9+
PackageCopyrightText: 2019-2022, The Tauri Programme in the Commons Conservancy
10+
PackageSummary: <text>Tauri is a rust project that enables developers to make secure
11+
and small desktop applications using a web frontend.
12+
</text>
13+
PackageComment: <text>The package includes the following libraries; see
14+
Relationship information.
15+
</text>
16+
Created: 2019-05-20T09:00:00Z
17+
PackageDownloadLocation: git://github.com/tauri-apps/tauri
18+
PackageDownloadLocation: git+https://github.com/tauri-apps/tauri.git
19+
PackageDownloadLocation: git+ssh://github.com/tauri-apps/tauri.git
20+
Creator: Person: Daniel Thompson-Yvetot

‎plugins/cli/LICENSE_APACHE-2.0

Lines changed: 177 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,177 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS

‎plugins/cli/LICENSE_MIT

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2017 - Present Tauri Apps Contributors
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎plugins/cli/README.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
![{{plugin name}}](banner.jpg)
2+
3+
<!-- description -->
4+
5+
## Install
6+
7+
_This plugin requires a Rust version of at least **1.64**_
8+
9+
There are three general methods of installation that we can recommend.
10+
11+
1. Use crates.io and npm (easiest, and requires you to trust that our publishing pipeline worked)
12+
2. Pull sources directly from Github using git tags / revision hashes (most secure)
13+
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)
14+
15+
Install the Core plugin by adding the following to your `Cargo.toml` file:
16+
17+
`src-tauri/Cargo.toml`
18+
19+
```toml
20+
[dependencies]
21+
<!-- plugin here --> = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "dev" }
22+
```
23+
24+
You can install the JavaScript Guest bindings using your preferred JavaScript package manager:
25+
26+
> 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.
27+
28+
```sh
29+
pnpm add <!-- plugin here -->
30+
# or
31+
npm add <!-- plugin here -->
32+
# or
33+
yarn add <!-- plugin here -->
34+
```
35+
36+
## Usage
37+
38+
First you need to register the core plugin with Tauri:
39+
40+
`src-tauri/src/main.rs`
41+
42+
```rust
43+
fn main() {
44+
tauri::Builder::default()
45+
.plugin(<!-- plugin here -->)
46+
.run(tauri::generate_context!())
47+
.expect("error while running tauri application");
48+
}
49+
```
50+
51+
Afterwards all the plugin's APIs are available through the JavaScript guest bindings:
52+
53+
```javascript
54+
55+
```
56+
57+
## Contributing
58+
59+
PRs accepted. Please make sure to read the Contributing Guide before making a pull request.
60+
61+
## License
62+
63+
Code: (c) 2015 - Present - The Tauri Programme within The Commons Conservancy.
64+
65+
MIT or MIT/Apache 2.0 where applicable.

‎plugins/cli/guest-js/index.ts

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
2+
// SPDX-License-Identifier: Apache-2.0
3+
// SPDX-License-Identifier: MIT
4+
5+
/**
6+
* Parse arguments from your Command Line Interface.
7+
*
8+
* @module
9+
*/
10+
11+
import { invoke } from '@tauri-apps/api/tauri';
12+
13+
/**
14+
* @since 1.0.0
15+
*/
16+
interface ArgMatch {
17+
/**
18+
* string if takes value
19+
* boolean if flag
20+
* string[] or null if takes multiple values
21+
*/
22+
value: string | boolean | string[] | null
23+
/**
24+
* Number of occurrences
25+
*/
26+
occurrences: number
27+
}
28+
29+
/**
30+
* @since 1.0.0
31+
*/
32+
interface SubcommandMatch {
33+
name: string
34+
matches: CliMatches
35+
}
36+
37+
/**
38+
* @since 1.0.0
39+
*/
40+
interface CliMatches {
41+
args: Record<string, ArgMatch>
42+
subcommand: SubcommandMatch | null
43+
}
44+
45+
/**
46+
* Parse the arguments provided to the current process and get the matches using the configuration defined [`tauri.cli`](https://tauri.app/v1/api/config/#tauriconfig.cli) in `tauri.conf.json`
47+
*
48+
* @example
49+
* ```typescript
50+
* import { getMatches } from 'tauri-plugin-cli-api';
51+
* const matches = await getMatches();
52+
* if (matches.subcommand?.name === 'run') {
53+
* // `./your-app run $ARGS` was executed
54+
* const args = matches.subcommand?.matches.args
55+
* if ('debug' in args) {
56+
* // `./your-app run --debug` was executed
57+
* }
58+
* } else {
59+
* const args = matches.args
60+
* // `./your-app $ARGS` was executed
61+
* }
62+
* ```
63+
*
64+
* @since 1.0.0
65+
*/
66+
async function getMatches(): Promise<CliMatches> {
67+
return await invoke('plugin:cli|cli_matches');
68+
}
69+
70+
export type { ArgMatch, SubcommandMatch, CliMatches }
71+
72+
export { getMatches }

0 commit comments

Comments
 (0)