mirror of
https://github.com/adoyle0/leptos-use.git
synced 2025-01-23 00:59:22 -05:00
added ffizer new function helper
This commit is contained in:
Maccesch
parent
2e02df3cfc
commit
0e077cf96e
14 changed files with 557 additions and 2 deletions
|
|
@ -22,6 +22,7 @@ pub use use_resize_observer::*;
|
||||||
|
|
||||||
mod on_click_outside;
|
mod on_click_outside;
|
||||||
mod use_breakpoints;
|
mod use_breakpoints;
|
||||||
|
mod use_css_var;
|
||||||
mod use_debounce_fn;
|
mod use_debounce_fn;
|
||||||
mod use_element_visibility;
|
mod use_element_visibility;
|
||||||
mod use_event_listener;
|
mod use_event_listener;
|
||||||
|
|
@ -42,10 +43,10 @@ mod watch_debounced;
|
||||||
mod watch_pausable;
|
mod watch_pausable;
|
||||||
mod watch_throttled;
|
mod watch_throttled;
|
||||||
mod whenever;
|
mod whenever;
|
||||||
mod use_css_var;
|
|
||||||
|
|
||||||
pub use on_click_outside::*;
|
pub use on_click_outside::*;
|
||||||
pub use use_breakpoints::*;
|
pub use use_breakpoints::*;
|
||||||
|
pub use use_css_var::*;
|
||||||
pub use use_debounce_fn::*;
|
pub use use_debounce_fn::*;
|
||||||
pub use use_element_visibility::*;
|
pub use use_element_visibility::*;
|
||||||
pub use use_event_listener::*;
|
pub use use_event_listener::*;
|
||||||
|
|
@ -66,4 +67,3 @@ pub use watch_debounced::*;
|
||||||
pub use watch_pausable::*;
|
pub use watch_pausable::*;
|
||||||
pub use watch_throttled::*;
|
pub use watch_throttled::*;
|
||||||
pub use whenever::*;
|
pub use whenever::*;
|
||||||
pub use use_css_var::*;
|
|
||||||
17
template/.ffizer.yaml
Normal file
17
template/.ffizer.yaml
Normal file
|
|
@ -0,0 +1,17 @@
|
||||||
|
variables:
|
||||||
|
- name: function_name
|
||||||
|
ask: Name of the function
|
||||||
|
- name: category
|
||||||
|
ask: Documentation category (lower case)
|
||||||
|
- name: module
|
||||||
|
default_value: ""
|
||||||
|
ask: Module [optional]
|
||||||
|
- name: feature
|
||||||
|
default_value: ""
|
||||||
|
ask: cfg feature [optional]
|
||||||
|
|
||||||
|
ignores:
|
||||||
|
- modify_files.py
|
||||||
|
|
||||||
|
scripts:
|
||||||
|
- cmd: python3 template/modify_files.py {{ function_name }} {{ category }}{{#if module}} --module {{ module }}{{/if}}{{#if feature}} --feature {{ feature }}{{/if}}
|
||||||
|
|
@ -0,0 +1,3 @@
|
||||||
|
# {{ function_name }}
|
||||||
|
|
||||||
|
<!-- cmdrun python3 ../extract_doc_comment.py {{#if module}}{{ module }}/{{/if}}{{ function_name }} {{ feature }} -->
|
||||||
16
template/examples/{{ function_name }}/Cargo.ffizer.hbs.toml
Normal file
16
template/examples/{{ function_name }}/Cargo.ffizer.hbs.toml
Normal file
|
|
@ -0,0 +1,16 @@
|
||||||
|
[package]
|
||||||
|
name = "{{ function_name }}"
|
||||||
|
version = "0.1.0"
|
||||||
|
edition = "2021"
|
||||||
|
|
||||||
|
[dependencies]
|
||||||
|
leptos = "0.3"
|
||||||
|
console_error_panic_hook = "0.1"
|
||||||
|
console_log = "1"
|
||||||
|
log = "0.4"
|
||||||
|
leptos-use = { path = "../..", features = ["docs"{{#if feature}}, "{{ feature }}"{{/if}}] }
|
||||||
|
web-sys = "0.3"
|
||||||
|
|
||||||
|
[dev-dependencies]
|
||||||
|
wasm-bindgen = "0.2"
|
||||||
|
wasm-bindgen-test = "0.3.0"
|
||||||
23
template/examples/{{ function_name }}/README.ffizer.hbs.md
Normal file
23
template/examples/{{ function_name }}/README.ffizer.hbs.md
Normal file
|
|
@ -0,0 +1,23 @@
|
||||||
|
A simple example for `{{ function_name }}`.
|
||||||
|
|
||||||
|
If you don't have it installed already, install [Trunk](https://trunkrs.dev/) and [Tailwind](https://tailwindcss.com/docs/installation)
|
||||||
|
as well as the nightly toolchain for Rust and the wasm32-unknown-unknown target:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cargo install trunk
|
||||||
|
npm install -D tailwindcss @tailwindcss/forms
|
||||||
|
rustup toolchain install nightly
|
||||||
|
rustup target add wasm32-unknown-unknown
|
||||||
|
```
|
||||||
|
|
||||||
|
Then, open two terminals. In the first one, run:
|
||||||
|
|
||||||
|
```
|
||||||
|
npx tailwindcss -i ./input.css -o ./style/output.css --watch
|
||||||
|
```
|
||||||
|
|
||||||
|
In the second one, run:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
trunk serve --open
|
||||||
|
```
|
||||||
2
template/examples/{{ function_name }}/Trunk.toml
Normal file
2
template/examples/{{ function_name }}/Trunk.toml
Normal file
|
|
@ -0,0 +1,2 @@
|
||||||
|
[build]
|
||||||
|
public_url = "/demo/"
|
||||||
7
template/examples/{{ function_name }}/index.html
Normal file
7
template/examples/{{ function_name }}/index.html
Normal file
|
|
@ -0,0 +1,7 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<link data-trunk rel="css" href="style/output.css">
|
||||||
|
</head>
|
||||||
|
<body></body>
|
||||||
|
</html>
|
||||||
3
template/examples/{{ function_name }}/input.css
Normal file
3
template/examples/{{ function_name }}/input.css
Normal file
|
|
@ -0,0 +1,3 @@
|
||||||
|
@tailwind base;
|
||||||
|
@tailwind components;
|
||||||
|
@tailwind utilities;
|
||||||
|
|
@ -0,0 +1,2 @@
|
||||||
|
[toolchain]
|
||||||
|
channel = "nightly"
|
||||||
21
template/examples/{{ function_name }}/src/main.ffizer.hbs.rs
Normal file
21
template/examples/{{ function_name }}/src/main.ffizer.hbs.rs
Normal file
|
|
@ -0,0 +1,21 @@
|
||||||
|
use leptos::*;
|
||||||
|
use leptos_use::docs::demo_or_body;
|
||||||
|
use leptos_use{{#if module}}::{{ module }}{{/if}}::{{ function_name }};
|
||||||
|
|
||||||
|
#[component]
|
||||||
|
fn Demo(cx: Scope) -> impl IntoView {
|
||||||
|
|
||||||
|
{{ function_name }}();
|
||||||
|
|
||||||
|
view! { cx,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn main() {
|
||||||
|
_ = console_log::init_with_level(log::Level::Debug);
|
||||||
|
console_error_panic_hook::set_once();
|
||||||
|
|
||||||
|
mount_to(demo_or_body(), |cx| {
|
||||||
|
view! { cx, <Demo /> }
|
||||||
|
})
|
||||||
|
}
|
||||||
289
template/examples/{{ function_name }}/style/output.css
Normal file
289
template/examples/{{ function_name }}/style/output.css
Normal file
|
|
@ -0,0 +1,289 @@
|
||||||
|
[type='text'],[type='email'],[type='url'],[type='password'],[type='number'],[type='date'],[type='datetime-local'],[type='month'],[type='search'],[type='tel'],[type='time'],[type='week'],[multiple],textarea,select {
|
||||||
|
-webkit-appearance: none;
|
||||||
|
-moz-appearance: none;
|
||||||
|
appearance: none;
|
||||||
|
background-color: #fff;
|
||||||
|
border-color: #6b7280;
|
||||||
|
border-width: 1px;
|
||||||
|
border-radius: 0px;
|
||||||
|
padding-top: 0.5rem;
|
||||||
|
padding-right: 0.75rem;
|
||||||
|
padding-bottom: 0.5rem;
|
||||||
|
padding-left: 0.75rem;
|
||||||
|
font-size: 1rem;
|
||||||
|
line-height: 1.5rem;
|
||||||
|
--tw-shadow: 0 0 #0000;
|
||||||
|
}
|
||||||
|
|
||||||
|
[type='text']:focus, [type='email']:focus, [type='url']:focus, [type='password']:focus, [type='number']:focus, [type='date']:focus, [type='datetime-local']:focus, [type='month']:focus, [type='search']:focus, [type='tel']:focus, [type='time']:focus, [type='week']:focus, [multiple]:focus, textarea:focus, select:focus {
|
||||||
|
outline: 2px solid transparent;
|
||||||
|
outline-offset: 2px;
|
||||||
|
--tw-ring-inset: var(--tw-empty,/*!*/ /*!*/);
|
||||||
|
--tw-ring-offset-width: 0px;
|
||||||
|
--tw-ring-offset-color: #fff;
|
||||||
|
--tw-ring-color: #2563eb;
|
||||||
|
--tw-ring-offset-shadow: var(--tw-ring-inset) 0 0 0 var(--tw-ring-offset-width) var(--tw-ring-offset-color);
|
||||||
|
--tw-ring-shadow: var(--tw-ring-inset) 0 0 0 calc(1px + var(--tw-ring-offset-width)) var(--tw-ring-color);
|
||||||
|
box-shadow: var(--tw-ring-offset-shadow), var(--tw-ring-shadow), var(--tw-shadow);
|
||||||
|
border-color: #2563eb;
|
||||||
|
}
|
||||||
|
|
||||||
|
input::-moz-placeholder, textarea::-moz-placeholder {
|
||||||
|
color: #6b7280;
|
||||||
|
opacity: 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
input::placeholder,textarea::placeholder {
|
||||||
|
color: #6b7280;
|
||||||
|
opacity: 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
::-webkit-datetime-edit-fields-wrapper {
|
||||||
|
padding: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
::-webkit-date-and-time-value {
|
||||||
|
min-height: 1.5em;
|
||||||
|
}
|
||||||
|
|
||||||
|
::-webkit-datetime-edit,::-webkit-datetime-edit-year-field,::-webkit-datetime-edit-month-field,::-webkit-datetime-edit-day-field,::-webkit-datetime-edit-hour-field,::-webkit-datetime-edit-minute-field,::-webkit-datetime-edit-second-field,::-webkit-datetime-edit-millisecond-field,::-webkit-datetime-edit-meridiem-field {
|
||||||
|
padding-top: 0;
|
||||||
|
padding-bottom: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
select {
|
||||||
|
background-image: url("data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' fill='none' viewBox='0 0 20 20'%3e%3cpath stroke='%236b7280' stroke-linecap='round' stroke-linejoin='round' stroke-width='1.5' d='M6 8l4 4 4-4'/%3e%3c/svg%3e");
|
||||||
|
background-position: right 0.5rem center;
|
||||||
|
background-repeat: no-repeat;
|
||||||
|
background-size: 1.5em 1.5em;
|
||||||
|
padding-right: 2.5rem;
|
||||||
|
-webkit-print-color-adjust: exact;
|
||||||
|
print-color-adjust: exact;
|
||||||
|
}
|
||||||
|
|
||||||
|
[multiple] {
|
||||||
|
background-image: initial;
|
||||||
|
background-position: initial;
|
||||||
|
background-repeat: unset;
|
||||||
|
background-size: initial;
|
||||||
|
padding-right: 0.75rem;
|
||||||
|
-webkit-print-color-adjust: unset;
|
||||||
|
print-color-adjust: unset;
|
||||||
|
}
|
||||||
|
|
||||||
|
[type='checkbox'],[type='radio'] {
|
||||||
|
-webkit-appearance: none;
|
||||||
|
-moz-appearance: none;
|
||||||
|
appearance: none;
|
||||||
|
padding: 0;
|
||||||
|
-webkit-print-color-adjust: exact;
|
||||||
|
print-color-adjust: exact;
|
||||||
|
display: inline-block;
|
||||||
|
vertical-align: middle;
|
||||||
|
background-origin: border-box;
|
||||||
|
-webkit-user-select: none;
|
||||||
|
-moz-user-select: none;
|
||||||
|
user-select: none;
|
||||||
|
flex-shrink: 0;
|
||||||
|
height: 1rem;
|
||||||
|
width: 1rem;
|
||||||
|
color: #2563eb;
|
||||||
|
background-color: #fff;
|
||||||
|
border-color: #6b7280;
|
||||||
|
border-width: 1px;
|
||||||
|
--tw-shadow: 0 0 #0000;
|
||||||
|
}
|
||||||
|
|
||||||
|
[type='checkbox'] {
|
||||||
|
border-radius: 0px;
|
||||||
|
}
|
||||||
|
|
||||||
|
[type='radio'] {
|
||||||
|
border-radius: 100%;
|
||||||
|
}
|
||||||
|
|
||||||
|
[type='checkbox']:focus,[type='radio']:focus {
|
||||||
|
outline: 2px solid transparent;
|
||||||
|
outline-offset: 2px;
|
||||||
|
--tw-ring-inset: var(--tw-empty,/*!*/ /*!*/);
|
||||||
|
--tw-ring-offset-width: 2px;
|
||||||
|
--tw-ring-offset-color: #fff;
|
||||||
|
--tw-ring-color: #2563eb;
|
||||||
|
--tw-ring-offset-shadow: var(--tw-ring-inset) 0 0 0 var(--tw-ring-offset-width) var(--tw-ring-offset-color);
|
||||||
|
--tw-ring-shadow: var(--tw-ring-inset) 0 0 0 calc(2px + var(--tw-ring-offset-width)) var(--tw-ring-color);
|
||||||
|
box-shadow: var(--tw-ring-offset-shadow), var(--tw-ring-shadow), var(--tw-shadow);
|
||||||
|
}
|
||||||
|
|
||||||
|
[type='checkbox']:checked,[type='radio']:checked {
|
||||||
|
border-color: transparent;
|
||||||
|
background-color: currentColor;
|
||||||
|
background-size: 100% 100%;
|
||||||
|
background-position: center;
|
||||||
|
background-repeat: no-repeat;
|
||||||
|
}
|
||||||
|
|
||||||
|
[type='checkbox']:checked {
|
||||||
|
background-image: url("data:image/svg+xml,%3csvg viewBox='0 0 16 16' fill='white' xmlns='http://www.w3.org/2000/svg'%3e%3cpath d='M12.207 4.793a1 1 0 010 1.414l-5 5a1 1 0 01-1.414 0l-2-2a1 1 0 011.414-1.414L6.5 9.086l4.293-4.293a1 1 0 011.414 0z'/%3e%3c/svg%3e");
|
||||||
|
}
|
||||||
|
|
||||||
|
[type='radio']:checked {
|
||||||
|
background-image: url("data:image/svg+xml,%3csvg viewBox='0 0 16 16' fill='white' xmlns='http://www.w3.org/2000/svg'%3e%3ccircle cx='8' cy='8' r='3'/%3e%3c/svg%3e");
|
||||||
|
}
|
||||||
|
|
||||||
|
[type='checkbox']:checked:hover,[type='checkbox']:checked:focus,[type='radio']:checked:hover,[type='radio']:checked:focus {
|
||||||
|
border-color: transparent;
|
||||||
|
background-color: currentColor;
|
||||||
|
}
|
||||||
|
|
||||||
|
[type='checkbox']:indeterminate {
|
||||||
|
background-image: url("data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' fill='none' viewBox='0 0 16 16'%3e%3cpath stroke='white' stroke-linecap='round' stroke-linejoin='round' stroke-width='2' d='M4 8h8'/%3e%3c/svg%3e");
|
||||||
|
border-color: transparent;
|
||||||
|
background-color: currentColor;
|
||||||
|
background-size: 100% 100%;
|
||||||
|
background-position: center;
|
||||||
|
background-repeat: no-repeat;
|
||||||
|
}
|
||||||
|
|
||||||
|
[type='checkbox']:indeterminate:hover,[type='checkbox']:indeterminate:focus {
|
||||||
|
border-color: transparent;
|
||||||
|
background-color: currentColor;
|
||||||
|
}
|
||||||
|
|
||||||
|
[type='file'] {
|
||||||
|
background: unset;
|
||||||
|
border-color: inherit;
|
||||||
|
border-width: 0;
|
||||||
|
border-radius: 0;
|
||||||
|
padding: 0;
|
||||||
|
font-size: unset;
|
||||||
|
line-height: inherit;
|
||||||
|
}
|
||||||
|
|
||||||
|
[type='file']:focus {
|
||||||
|
outline: 1px solid ButtonText;
|
||||||
|
outline: 1px auto -webkit-focus-ring-color;
|
||||||
|
}
|
||||||
|
|
||||||
|
*, ::before, ::after {
|
||||||
|
--tw-border-spacing-x: 0;
|
||||||
|
--tw-border-spacing-y: 0;
|
||||||
|
--tw-translate-x: 0;
|
||||||
|
--tw-translate-y: 0;
|
||||||
|
--tw-rotate: 0;
|
||||||
|
--tw-skew-x: 0;
|
||||||
|
--tw-skew-y: 0;
|
||||||
|
--tw-scale-x: 1;
|
||||||
|
--tw-scale-y: 1;
|
||||||
|
--tw-pan-x: ;
|
||||||
|
--tw-pan-y: ;
|
||||||
|
--tw-pinch-zoom: ;
|
||||||
|
--tw-scroll-snap-strictness: proximity;
|
||||||
|
--tw-gradient-from-position: ;
|
||||||
|
--tw-gradient-via-position: ;
|
||||||
|
--tw-gradient-to-position: ;
|
||||||
|
--tw-ordinal: ;
|
||||||
|
--tw-slashed-zero: ;
|
||||||
|
--tw-numeric-figure: ;
|
||||||
|
--tw-numeric-spacing: ;
|
||||||
|
--tw-numeric-fraction: ;
|
||||||
|
--tw-ring-inset: ;
|
||||||
|
--tw-ring-offset-width: 0px;
|
||||||
|
--tw-ring-offset-color: #fff;
|
||||||
|
--tw-ring-color: rgb(59 130 246 / 0.5);
|
||||||
|
--tw-ring-offset-shadow: 0 0 #0000;
|
||||||
|
--tw-ring-shadow: 0 0 #0000;
|
||||||
|
--tw-shadow: 0 0 #0000;
|
||||||
|
--tw-shadow-colored: 0 0 #0000;
|
||||||
|
--tw-blur: ;
|
||||||
|
--tw-brightness: ;
|
||||||
|
--tw-contrast: ;
|
||||||
|
--tw-grayscale: ;
|
||||||
|
--tw-hue-rotate: ;
|
||||||
|
--tw-invert: ;
|
||||||
|
--tw-saturate: ;
|
||||||
|
--tw-sepia: ;
|
||||||
|
--tw-drop-shadow: ;
|
||||||
|
--tw-backdrop-blur: ;
|
||||||
|
--tw-backdrop-brightness: ;
|
||||||
|
--tw-backdrop-contrast: ;
|
||||||
|
--tw-backdrop-grayscale: ;
|
||||||
|
--tw-backdrop-hue-rotate: ;
|
||||||
|
--tw-backdrop-invert: ;
|
||||||
|
--tw-backdrop-opacity: ;
|
||||||
|
--tw-backdrop-saturate: ;
|
||||||
|
--tw-backdrop-sepia: ;
|
||||||
|
}
|
||||||
|
|
||||||
|
::backdrop {
|
||||||
|
--tw-border-spacing-x: 0;
|
||||||
|
--tw-border-spacing-y: 0;
|
||||||
|
--tw-translate-x: 0;
|
||||||
|
--tw-translate-y: 0;
|
||||||
|
--tw-rotate: 0;
|
||||||
|
--tw-skew-x: 0;
|
||||||
|
--tw-skew-y: 0;
|
||||||
|
--tw-scale-x: 1;
|
||||||
|
--tw-scale-y: 1;
|
||||||
|
--tw-pan-x: ;
|
||||||
|
--tw-pan-y: ;
|
||||||
|
--tw-pinch-zoom: ;
|
||||||
|
--tw-scroll-snap-strictness: proximity;
|
||||||
|
--tw-gradient-from-position: ;
|
||||||
|
--tw-gradient-via-position: ;
|
||||||
|
--tw-gradient-to-position: ;
|
||||||
|
--tw-ordinal: ;
|
||||||
|
--tw-slashed-zero: ;
|
||||||
|
--tw-numeric-figure: ;
|
||||||
|
--tw-numeric-spacing: ;
|
||||||
|
--tw-numeric-fraction: ;
|
||||||
|
--tw-ring-inset: ;
|
||||||
|
--tw-ring-offset-width: 0px;
|
||||||
|
--tw-ring-offset-color: #fff;
|
||||||
|
--tw-ring-color: rgb(59 130 246 / 0.5);
|
||||||
|
--tw-ring-offset-shadow: 0 0 #0000;
|
||||||
|
--tw-ring-shadow: 0 0 #0000;
|
||||||
|
--tw-shadow: 0 0 #0000;
|
||||||
|
--tw-shadow-colored: 0 0 #0000;
|
||||||
|
--tw-blur: ;
|
||||||
|
--tw-brightness: ;
|
||||||
|
--tw-contrast: ;
|
||||||
|
--tw-grayscale: ;
|
||||||
|
--tw-hue-rotate: ;
|
||||||
|
--tw-invert: ;
|
||||||
|
--tw-saturate: ;
|
||||||
|
--tw-sepia: ;
|
||||||
|
--tw-drop-shadow: ;
|
||||||
|
--tw-backdrop-blur: ;
|
||||||
|
--tw-backdrop-brightness: ;
|
||||||
|
--tw-backdrop-contrast: ;
|
||||||
|
--tw-backdrop-grayscale: ;
|
||||||
|
--tw-backdrop-hue-rotate: ;
|
||||||
|
--tw-backdrop-invert: ;
|
||||||
|
--tw-backdrop-opacity: ;
|
||||||
|
--tw-backdrop-saturate: ;
|
||||||
|
--tw-backdrop-sepia: ;
|
||||||
|
}
|
||||||
|
|
||||||
|
.block {
|
||||||
|
display: block;
|
||||||
|
}
|
||||||
|
|
||||||
|
.text-\[--brand-color\] {
|
||||||
|
color: var(--brand-color);
|
||||||
|
}
|
||||||
|
|
||||||
|
.text-green-600 {
|
||||||
|
--tw-text-opacity: 1;
|
||||||
|
color: rgb(22 163 74 / var(--tw-text-opacity));
|
||||||
|
}
|
||||||
|
|
||||||
|
.opacity-75 {
|
||||||
|
opacity: 0.75;
|
||||||
|
}
|
||||||
|
|
||||||
|
@media (prefers-color-scheme: dark) {
|
||||||
|
.dark\:text-green-500 {
|
||||||
|
--tw-text-opacity: 1;
|
||||||
|
color: rgb(34 197 94 / var(--tw-text-opacity));
|
||||||
|
}
|
||||||
|
}
|
||||||
15
template/examples/{{ function_name }}/tailwind.config.js
Normal file
15
template/examples/{{ function_name }}/tailwind.config.js
Normal file
|
|
@ -0,0 +1,15 @@
|
||||||
|
/** @type {import('tailwindcss').Config} */
|
||||||
|
module.exports = {
|
||||||
|
content: {
|
||||||
|
files: ["*.html", "./src/**/*.rs", "../../src/docs/**/*.rs"],
|
||||||
|
},
|
||||||
|
theme: {
|
||||||
|
extend: {},
|
||||||
|
},
|
||||||
|
corePlugins: {
|
||||||
|
preflight: false,
|
||||||
|
},
|
||||||
|
plugins: [
|
||||||
|
require('@tailwindcss/forms'),
|
||||||
|
],
|
||||||
|
}
|
||||||
110
template/modify_files.py
Normal file
110
template/modify_files.py
Normal file
|
|
@ -0,0 +1,110 @@
|
||||||
|
import argparse
|
||||||
|
import os
|
||||||
|
import re
|
||||||
|
|
||||||
|
parser = argparse.ArgumentParser()
|
||||||
|
|
||||||
|
|
||||||
|
def main():
|
||||||
|
parser.add_argument("function_name")
|
||||||
|
parser.add_argument("category")
|
||||||
|
parser.add_argument("--module", type=str)
|
||||||
|
parser.add_argument("--feature", type=str)
|
||||||
|
|
||||||
|
args = parser.parse_args()
|
||||||
|
|
||||||
|
modify_librs(args)
|
||||||
|
modify_modrs(args)
|
||||||
|
modify_summarymd(args)
|
||||||
|
modify_workspace(args)
|
||||||
|
|
||||||
|
|
||||||
|
def modify_workspace(args):
|
||||||
|
config_path = os.path.join("examples", "Cargo.toml")
|
||||||
|
|
||||||
|
with open(config_path, "r") as f:
|
||||||
|
config_source = f.read()
|
||||||
|
|
||||||
|
before_members, after_members = config_source.split("members = [\n", 1)
|
||||||
|
parts = after_members.split("]", 1)
|
||||||
|
members = parts[0]
|
||||||
|
after_members = parts[1] if len(parts) > 1 else ""
|
||||||
|
|
||||||
|
members = members.splitlines()
|
||||||
|
members.append(f" \"{args.function_name}\",")
|
||||||
|
members.sort()
|
||||||
|
|
||||||
|
with open(config_path, "w") as f:
|
||||||
|
f.write(before_members + "members = [\n" + "\n".join(members) + "\n]" + after_members)
|
||||||
|
|
||||||
|
|
||||||
|
def modify_summarymd(args):
|
||||||
|
summary_path = os.path.join("docs", "book", "src", "SUMMARY.md")
|
||||||
|
|
||||||
|
with open(summary_path, "r") as f:
|
||||||
|
summary_source = f.read()
|
||||||
|
|
||||||
|
function_link = f"- [{args.function_name}]({args.category}/{args.function_name}.md)"
|
||||||
|
|
||||||
|
m = re.search(rf"# @?{args.category}\n\n", summary_source, re.IGNORECASE)
|
||||||
|
if m:
|
||||||
|
|
||||||
|
parts = summary_source[m.end():].split("\n# ", 1)
|
||||||
|
|
||||||
|
functions = parts[0]
|
||||||
|
after = f"\n# {parts[1]}" if len(parts) > 1 else ""
|
||||||
|
|
||||||
|
functions = list(filter(lambda x: x.strip() != "", functions.splitlines()))
|
||||||
|
functions.append(function_link)
|
||||||
|
functions.sort()
|
||||||
|
|
||||||
|
summary_source = summary_source[:m.end()] + "\n".join(functions) + "\n" + after
|
||||||
|
|
||||||
|
with open(summary_path, "w") as f:
|
||||||
|
f.write(summary_source)
|
||||||
|
else:
|
||||||
|
println(
|
||||||
|
f"Category {args.category} not found in docs/book/src/SUMMARY.md. Please add it manually together with the link to the new function")
|
||||||
|
|
||||||
|
|
||||||
|
def modify_modrs(args):
|
||||||
|
if args.module is not None:
|
||||||
|
mod_path = os.path.join("src", args.module, "mod.rs")
|
||||||
|
if os.path.exists(mod_path):
|
||||||
|
with open(mod_path, "r") as f:
|
||||||
|
mod_source = f.read()
|
||||||
|
|
||||||
|
mod_source = mod_source.replace("mod", f"mod {args.function_name};\nmod", 1)
|
||||||
|
mod_source = mod_source.replace("pub use", f"pub use {args.function_name}::*;\npub use", 1)
|
||||||
|
else:
|
||||||
|
mod_source = f"#![doc(cfg(feature = \"{args.feature}\"))]\n" if args.feature is not None else ""
|
||||||
|
mod_source += f"""
|
||||||
|
mod {args.function_name};
|
||||||
|
|
||||||
|
pub use {args.function_name}::*;
|
||||||
|
"""
|
||||||
|
|
||||||
|
with open(mod_path, "w") as f:
|
||||||
|
f.write(mod_source)
|
||||||
|
|
||||||
|
|
||||||
|
def modify_librs(args):
|
||||||
|
with open("src/lib.rs", "r") as f:
|
||||||
|
lib_source = f.read()
|
||||||
|
|
||||||
|
feature_prefix = "" if args.feature is None else f"#[cfg(feature = \"{args.feature}\"))]\n"
|
||||||
|
|
||||||
|
if args.module is None:
|
||||||
|
lib_source = lib_source.replace("mod on_click_outside;",
|
||||||
|
f"mod on_click_outside;\n{feature_prefix}mod {args.function_name};")
|
||||||
|
lib_source = lib_source.replace("pub use on_click_outside::*;",
|
||||||
|
f"pub use on_click_outside::*;\n{feature_prefix}pub use {args.function_name}::*;")
|
||||||
|
elif args.module not in lib_source:
|
||||||
|
lib_source = lib_source.replace("pub mod utils;", f"pub mod utils;\n{feature_prefix}pub mod {args.module};")
|
||||||
|
|
||||||
|
with open("src/lib.rs", "w") as f:
|
||||||
|
f.write(lib_source)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == '__main__':
|
||||||
|
main()
|
||||||
47
template/src/{{ module }}/{{ function_name }}.ffizer.hbs.rs
Normal file
47
template/src/{{ module }}/{{ function_name }}.ffizer.hbs.rs
Normal file
|
|
@ -0,0 +1,47 @@
|
||||||
|
use default_struct_builder::DefaultBuilder;
|
||||||
|
use leptos::*;
|
||||||
|
|
||||||
|
///
|
||||||
|
///
|
||||||
|
/// ## Demo
|
||||||
|
///
|
||||||
|
/// [Link to Demo](https://github.com/Synphonyte/leptos-use/tree/main/examples/{{ function_name }})
|
||||||
|
///
|
||||||
|
/// ## Usage
|
||||||
|
///
|
||||||
|
/// ```
|
||||||
|
/// # use leptos::*;
|
||||||
|
/// use leptos_use{{#if module}}::{{ module }}{{/if}}::{{ function_name }};
|
||||||
|
/// #
|
||||||
|
/// # #[component]
|
||||||
|
/// # fn Demo(cx: Scope) -> impl IntoView {
|
||||||
|
/// {{ function_name }}();
|
||||||
|
/// #
|
||||||
|
/// # view! { cx, }
|
||||||
|
/// # }
|
||||||
|
/// ```
|
||||||
|
{{#if feature}}#[doc(cfg(feature = "{{feature}}"))]{{/if}}
|
||||||
|
pub fn {{ function_name }}() -> {{ to_pascal_case function_name }}Return {
|
||||||
|
{{ function_name }}_with_options({{ to_pascal_case function_name }}Options::default())
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Version of [`{{ function_name }}`] that takes a `{{ to_pascal_case function_name }}Options`. See [`{{ function_name }}`] for how to use.
|
||||||
|
{{#if feature}}#[doc(cfg(feature = "{{feature}}"))]{{/if}}
|
||||||
|
pub fn {{ function_name }}_with_options(options: {{ to_pascal_case function_name }}Return) -> {{ to_pascal_case function_name }}Return {
|
||||||
|
{{ to_pascal_case function_name }}Return {}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Options for [`{{ function_name }}_with_options`].
|
||||||
|
{{#if feature}}#[doc(cfg(feature = "{{feature}}"))]{{/if}}
|
||||||
|
#[derive(DefaultBuilder)]
|
||||||
|
pub struct {{ to_pascal_case function_name }}Options {}
|
||||||
|
|
||||||
|
impl Default for {{ to_pascal_case function_name }}Options {
|
||||||
|
fn default() -> Self {
|
||||||
|
Self {}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Return type of [`{{ function_name }}`].
|
||||||
|
{{#if feature}}#[doc(cfg(feature = "{{feature}}"))]{{/if}}
|
||||||
|
pub struct {{ to_pascal_case function_name }}Return {}
|
||||||
Loading…
Add table
Reference in a new issue