Skip to content

Better readme docs #100

Better readme docs

Better readme docs #100

Triggered via pull request February 24, 2024 02:30
Status Success
Total duration 5m 59s
Artifacts

ci.yml

on: pull_request
Matrix: build
Fit to window
Zoom out
Zoom in

Annotations

30 warnings
very complex type used. Consider factoring parts into `type` definitions: src/lib.rs#L414
warning: very complex type used. Consider factoring parts into `type` definitions --> src/lib.rs:414:24 | 414 | fn render(self) -> Result<(String, (TCommands::InvokeHandler, EventCollection)), TLang::Error> { | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#type_complexity = note: `#[warn(clippy::type_complexity)]` implied by `#[warn(clippy::all)]`
used `unwrap()` on a `Result` value: src/lib.rs#L382
warning: used `unwrap()` on a `Result` value --> src/lib.rs:382:50 | 382 | let (invoke_handler, event_collection) = self.export_inner().unwrap(); | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | = note: if this value is an `Err`, it will panic = help: consider using `expect()` to provide a better panic message = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#unwrap_used note: the lint level is defined here --> src/lib.rs:111:22 | 111 | #![warn(clippy::all, clippy::unwrap_used, clippy::panic | ^^^^^^^^^^^^^^^^^^^
`panic` should not be present in production code: src/event.rs#L81
warning: `panic` should not be present in production code --> src/event.rs:81:28 | 81 | .unwrap_or_else(|| panic!("Event {name} not found in registry!")) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#panic
`panic` should not be present in production code: src/event.rs#L34
warning: `panic` should not be present in production code --> src/event.rs:34:13 | 34 | panic!("Another event with name {} is already registered!", E::NAME) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#panic
`panic` should not be present in production code: src/event.rs#L30
warning: `panic` should not be present in production code --> src/event.rs:30:13 | 30 | panic!("Event {} registered twice!", E::NAME) | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#panic note: the lint level is defined here --> src/lib.rs:111:43 | 111 | #![warn(clippy::all, clippy::unwrap_used, clippy::panic | ^^^^^^^^^^^^^
single-character string constant used as pattern: src/ts.rs#L56
warning: single-character string constant used as pattern --> src/ts.rs:56:60 | 56 | builder.extend(function.docs.split("\n")); | ^^^^ help: try using a `char` instead: `'\n'` | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#single_char_pattern
single-character string constant used as pattern: src/js.rs#L43
warning: single-character string constant used as pattern --> src/js.rs:43:60 | 43 | builder.extend(function.docs.split("\n")); | ^^^^ help: try using a `char` instead: `'\n'` | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#single_char_pattern = note: `#[warn(clippy::single_char_pattern)]` implied by `#[warn(clippy::all)]`
unit tests in doctest are not executed: src/lib.rs#L86
warning: unit tests in doctest are not executed --> src/lib.rs:86:5 | 86 | //! #[test] | _____^ 87 | | //! fn export_bindings() { | |______________________^ | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#test_attr_in_doctest = note: `#[warn(clippy::test_attr_in_doctest)]` implied by `#[warn(clippy::all)]`
using tabs in doc comments is not recommended: src/lib.rs#L98
warning: using tabs in doc comments is not recommended --> src/lib.rs:98:4 | 98 | //! .unwrap(); | ^^^^^^^^^^^^ help: consider using four spaces per tab | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#tabs_in_doc_comments
using tabs in doc comments is not recommended: src/lib.rs#L97
warning: using tabs in doc comments is not recommended --> src/lib.rs:97:4 | 97 | //! .export() | ^^^^^^^^^^^^ help: consider using four spaces per tab | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#tabs_in_doc_comments
using tabs in doc comments is not recommended: src/lib.rs#L96
warning: using tabs in doc comments is not recommended --> src/lib.rs:96:4 | 96 | //! .path("../src/bindings.js") | ^^^^^^^^^^^^ help: consider using four spaces per tab | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#tabs_in_doc_comments
using tabs in doc comments is not recommended: src/lib.rs#L95
warning: using tabs in doc comments is not recommended --> src/lib.rs:95:4 | 95 | //! .commands(collect_commands![greet, greet2, greet3]) | ^^^^^^^^^^^^ help: consider using four spaces per tab | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#tabs_in_doc_comments
using tabs in doc comments is not recommended: src/lib.rs#L94
warning: using tabs in doc comments is not recommended --> src/lib.rs:94:4 | 94 | //! js::builder() | ^^^^^^^^ help: consider using four spaces per tab | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#tabs_in_doc_comments
using tabs in doc comments is not recommended: src/lib.rs#L92
warning: using tabs in doc comments is not recommended --> src/lib.rs:92:4 | 92 | //! .unwrap(); | ^^^^^^^^^^^^ help: consider using four spaces per tab | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#tabs_in_doc_comments
using tabs in doc comments is not recommended: src/lib.rs#L91
warning: using tabs in doc comments is not recommended --> src/lib.rs:91:4 | 91 | //! .export() | ^^^^^^^^^^^^ help: consider using four spaces per tab | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#tabs_in_doc_comments
using tabs in doc comments is not recommended: src/lib.rs#L90
warning: using tabs in doc comments is not recommended --> src/lib.rs:90:4 | 90 | //! .path("../src/bindings.ts") | ^^^^^^^^^^^^ help: consider using four spaces per tab | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#tabs_in_doc_comments
using tabs in doc comments is not recommended: src/lib.rs#L89
warning: using tabs in doc comments is not recommended --> src/lib.rs:89:4 | 89 | //! .commands(collect_commands![greet, greet2, greet3]) | ^^^^^^^^^^^^ help: consider using four spaces per tab | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#tabs_in_doc_comments
using tabs in doc comments is not recommended: src/lib.rs#L88
warning: using tabs in doc comments is not recommended --> src/lib.rs:88:4 | 88 | //! ts::builder() | ^^^^^^^^ help: consider using four spaces per tab | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#tabs_in_doc_comments
using tabs in doc comments is not recommended: src/lib.rs#L83
warning: using tabs in doc comments is not recommended --> src/lib.rs:83:4 | 83 | //! .unwrap(); | ^^^^^^^^^^^^ help: consider using four spaces per tab | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#tabs_in_doc_comments
using tabs in doc comments is not recommended: src/lib.rs#L82
warning: using tabs in doc comments is not recommended --> src/lib.rs:82:4 | 82 | //! .export() | ^^^^^^^^^^^^ help: consider using four spaces per tab | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#tabs_in_doc_comments
using tabs in doc comments is not recommended: src/lib.rs#L81
warning: using tabs in doc comments is not recommended --> src/lib.rs:81:4 | 81 | //! .path("../src/bindings.js") | ^^^^^^^^^^^^ help: consider using four spaces per tab | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#tabs_in_doc_comments
using tabs in doc comments is not recommended: src/lib.rs#L80
warning: using tabs in doc comments is not recommended --> src/lib.rs:80:4 | 80 | //! .commands(collect_commands![greet, greet2, greet3]) | ^^^^^^^^^^^^ help: consider using four spaces per tab | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#tabs_in_doc_comments
using tabs in doc comments is not recommended: src/lib.rs#L79
warning: using tabs in doc comments is not recommended --> src/lib.rs:79:4 | 79 | //! js::builder() | ^^^^^^^^ help: consider using four spaces per tab | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#tabs_in_doc_comments
using tabs in doc comments is not recommended: src/lib.rs#L75
warning: using tabs in doc comments is not recommended --> src/lib.rs:75:4 | 75 | //! .unwrap(); | ^^^^^^^^^^^^ help: consider using four spaces per tab | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#tabs_in_doc_comments
using tabs in doc comments is not recommended: src/lib.rs#L74
warning: using tabs in doc comments is not recommended --> src/lib.rs:74:4 | 74 | //! .export() | ^^^^^^^^^^^^ help: consider using four spaces per tab | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#tabs_in_doc_comments
using tabs in doc comments is not recommended: src/lib.rs#L73
warning: using tabs in doc comments is not recommended --> src/lib.rs:73:4 | 73 | //! .path("../src/bindings.ts") | ^^^^^^^^^^^^ help: consider using four spaces per tab | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#tabs_in_doc_comments
using tabs in doc comments is not recommended: src/lib.rs#L72
warning: using tabs in doc comments is not recommended --> src/lib.rs:72:4 | 72 | //! .commands(collect_commands![greet, greet2, greet3]) | ^^^^^^^^^^^^ help: consider using four spaces per tab | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#tabs_in_doc_comments
using tabs in doc comments is not recommended: src/lib.rs#L71
warning: using tabs in doc comments is not recommended --> src/lib.rs:71:4 | 71 | //! ts::builder() | ^^^^^^^^ help: consider using four spaces per tab | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#tabs_in_doc_comments note: the lint level is defined here --> src/lib.rs:111:9 | 111 | #![warn(clippy::all, clippy::unwrap_used, clippy::panic | ^^^^^^^^^^^ = note: `#[warn(clippy::tabs_in_doc_comments)]` implied by `#[warn(clippy::all)]`
clippy
Node.js 16 actions are deprecated. Please update the following actions to use Node.js 20: actions-rs/clippy-check@v1. For more information see: https://github.blog/changelog/2023-09-22-github-actions-transitioning-from-node-16-to-node-20/.
clippy
The following actions uses node12 which is deprecated and will be forced to run on node16: actions-rs/clippy-check@v1. For more info: https://github.blog/changelog/2023-06-13-github-actions-all-actions-will-run-on-node16-instead-of-node12-by-default/