Documentation
¶
Overview ¶
Package ypy holds the one version of the repository. The file VERSION at the root is the source: the build stamps it into the core (ypy.version), `ypy gen` writes it into the editor data, and the tools report it through Version.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
This section is empty.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
ypy
command
Command ypy is the YPY toolbox: one binary, explicit subcommands.
|
Command ypy is the YPY toolbox: one binary, explicit subcommands. |
|
examples
|
|
|
server
command
Command server is the example server of the end to end suite.
|
Command server is the example server of the end to end suite. |
|
internal
|
|
|
assets
Package assets implements "ypy gen assets": it takes the CSS and the small scripts an author writes next to a template and extracts them into files whose names carry a hash of their content, so the page that results has nothing inline and passes a strict Content-Security-Policy.
|
Package assets implements "ypy gen assets": it takes the CSS and the small scripts an author writes next to a template and extracts them into files whose names carry a hash of their content, so the page that results has nothing inline and passes a strict Content-Security-Policy. |
|
bench
Package bench is "ypy bench": the performance harness of the framework.
|
Package bench is "ypy bench": the performance harness of the framework. |
|
browsers
Package browsers finds and drives the browsers that run the YPY test suites: Chrome or Chromium through the DevTools protocol (chromedp), Safari through safaridriver and Firefox through geckodriver (the WebDriver HTTP protocol).
|
Package browsers finds and drives the browsers that run the YPY test suites: Chrome or Chromium through the DevTools protocol (chromedp), Safari through safaridriver and Firefox through geckodriver (the WebDriver HTTP protocol). |
|
build
Package build generates the dist/ directory of the framework from src/: the unminified and minified bundles (script and ES module), the extensions, the ypy.max bundle, the editor files, the skills, the type declarations and the brotli copies.
|
Package build generates the dist/ directory of the framework from src/: the unminified and minified bundles (script and ES module), the extensions, the ypy.max bundle, the editor files, the skills, the type declarations and the brotli copies. |
|
cli
Package cli is the small command framework behind the ypy binary: an explicit list of subcommands, a usage printer and a flag parser that accepts flags and positional arguments in any order.
|
Package cli is the small command framework behind the ypy binary: an explicit list of subcommands, a usage printer and a flag parser that accepts flags and positional arguments in any order. |
|
e2e
Package e2e runs the end to end scenarios of the example app (examples/native), driven in Chrome, Firefox and Safari against the Go example server (examples/server).
|
Package e2e runs the end to end scenarios of the example app (examples/native), driven in Chrome, Firefox and Safari against the Go example server (examples/server). |
|
gates
Package gates is "ypy ci": the checks every change passes before it is pushed.
|
Package gates is "ypy ci": the checks every change passes before it is pushed. |
|
gen
Package gen is "ypy gen": it reads the table of YPY names (src/attributes.json and one fragment per extension in src/attributes.d/) and generates the editor data from it: the VS Code HTML Custom Data, the JetBrains web-types and the JSON schema of ypy.config.
|
Package gen is "ypy gen": it reads the table of YPY names (src/attributes.json and one fragment per extension in src/attributes.d/) and generates the editor data from it: the VS Code HTML Custom Data, the JetBrains web-types and the JSON schema of ypy.config. |
|
styling
Package styling holds the checks of the styling contract of the framework (MISSION section 7): the optional stylesheet and the Tailwind variants in src/css, the names the core and the extensions put on elements, and the CSS fixtures of the visual matrix.
|
Package styling holds the checks of the styling contract of the framework (MISSION section 7): the optional stylesheet and the Tailwind variants in src/css, the names the core and the extensions put on elements, and the CSS fixtures of the visual matrix. |
Click to show internal directories.
Click to hide internal directories.