View Source SaladUI.Patcher (SaladUI v0.13.1)
Provides functionality to patch various configuration and source files in Phoenix projects.
This module is intended to be used by the CLI during the installation of SaladUI in a project.
It handles patching of config files, Tailwind CSS configuration, CSS files, and JavaScript files.
Summary
Functions
Patches the Elixir project configuration file.
Patches a CSS file by adding all variables needed for a color scheme. Also adds optional tweaks to the CSS file.
Patches a JavaScript file by adding JS code snippet to handle events from the server.
Patches the Tailwind CSS configuration in a Phoenix project.
Functions
Patches the Elixir project configuration file.
Adds new configuration to the existing config file without modifying or removing previous content.
Parameters
- config_path: The path to the project's
config.exsfile - configs: A list of configurations to add to the config file. Each configuration must be a tuple with the name of the configuration and a map with the description and values to add. If you want to insert Elixir code, suchs as modules or an expression, use a string with the code you want to insert.
Patches a CSS file by adding all variables needed for a color scheme. Also adds optional tweaks to the CSS file.
Parameters
- css_file_path: Path to the CSS file
- color_scheme_file_path: Path to the file containing the color scheme CSS code
Patches a JavaScript file by adding JS code snippet to handle events from the server.
Parameters
- js_file_path: Path to the JavaScript file
- code_to_add_file_path: Path to the file containing the JS code to be added
Patches the Tailwind CSS configuration in a Phoenix project.
Adds required plugins to the Tailwind configuration and extends the theme configuration to use a JSON file that enables theming via CSS variables, without modifying existing user configuration.
Parameters
- tailwind_config_path: Path to the Tailwind configuration file