105 lines
3.2 KiB
ReStructuredText
105 lines
3.2 KiB
ReStructuredText
|
Hacking on Anaconda Web UI
|
||
|
|
==========================
|
||
|
|
|
||
|
|
The commands here assume you're in the top level of the Anaconda Web UI git
|
||
|
|
repository checkout.
|
||
|
|
|
||
|
|
Setting up development container
|
||
|
|
--------------------------------
|
||
|
|
|
||
|
|
The anaconda team uses a containerized development environment using toolbx.
|
||
|
|
If you can install `toolbx <https://containertoolbx.org/>`_ or
|
||
|
|
`distrobox <https://distrobox.privatedns.org/>`_ on your system, it is highly
|
||
|
|
recommended to do that:
|
||
|
|
|
||
|
|
- It is known to work and gives you reproducible results.
|
||
|
|
- It avoids having to install development packages on your main machine.
|
||
|
|
|
||
|
|
If you are not interested in dealing with containers, just skip this part and continue on the next one::
|
||
|
|
|
||
|
|
sudo dnf install toolbox
|
||
|
|
|
||
|
|
To create and enter a development toolbx for Anaconda Web UI run this command::
|
||
|
|
|
||
|
|
toolbox create --image ghcr.io/cockpit-project/tasks -c anaconda-webui
|
||
|
|
toolbox enter anaconda-webui
|
||
|
|
|
||
|
|
|
||
|
|
Working on Anaconda Web UI
|
||
|
|
--------------------------
|
||
|
|
|
||
|
|
To prepare Anaconda Web UI sources, you need to run this command::
|
||
|
|
|
||
|
|
make dist
|
||
|
|
|
||
|
|
The easiest way to test changes you make is to set up a test VM.
|
||
|
|
You can find intructions for preparing a test VM at ``test/README.rst``.
|
||
|
|
|
||
|
|
Running eslint
|
||
|
|
--------------
|
||
|
|
|
||
|
|
Anaconda Web UI uses `ESLint <https://eslint.org/>`_ to automatically check
|
||
|
|
JavaScript code style in `.js` and `.jsx` files.
|
||
|
|
|
||
|
|
ESLint is executed as part of `test/common/static-code`, aka. `make codecheck`.
|
||
|
|
|
||
|
|
For developer convenience, the ESLint can be started explicitly by::
|
||
|
|
|
||
|
|
npm run eslint
|
||
|
|
|
||
|
|
Violations of some rules can be fixed automatically by::
|
||
|
|
|
||
|
|
npm run eslint:fix
|
||
|
|
|
||
|
|
Rules configuration can be found in the `.eslintrc.json` file.
|
||
|
|
|
||
|
|
Running stylelint
|
||
|
|
------------------
|
||
|
|
|
||
|
|
Cockpit uses `Stylelint <https://stylelint.io/>`_ to automatically check CSS code
|
||
|
|
style in `.css` and `scss` files.
|
||
|
|
|
||
|
|
Styleint is executed as part of `test/common/static-code`, aka. `make codecheck`.
|
||
|
|
|
||
|
|
For developer convenience, the Stylelint can be started explicitly by::
|
||
|
|
|
||
|
|
npm run stylelint
|
||
|
|
|
||
|
|
Violations of some rules can be fixed automatically by::
|
||
|
|
|
||
|
|
npm run stylelint:fix
|
||
|
|
|
||
|
|
Rules configuration can be found in the `.stylelintrc.json` file.
|
||
|
|
|
||
|
|
Development with rsync mode
|
||
|
|
---------------------------
|
||
|
|
|
||
|
|
When developing the Web UI, after every change to your sources we need to re-build
|
||
|
|
and the contents of dist directory need to be copied to the SSH target's
|
||
|
|
/usr/share/cockpit/anaconda-webui directory.
|
||
|
|
|
||
|
|
For automating this, you need to set up the SSH `test-updates` alias,
|
||
|
|
as described in `<test/README.rst>`_.
|
||
|
|
|
||
|
|
Then you can run::
|
||
|
|
|
||
|
|
make rsync
|
||
|
|
|
||
|
|
Updating `node_modules`
|
||
|
|
----------------------
|
||
|
|
|
||
|
|
Before making any changes, ensure the following environment variable is set::
|
||
|
|
|
||
|
|
GITHUB_BASE="rhinstaller/anaconda-webui"
|
||
|
|
|
||
|
|
If you need to update package.json — for example, to add or remove a dependency — run::
|
||
|
|
|
||
|
|
tools/node-modules install
|
||
|
|
|
||
|
|
This command regenerates the node_modules cache based on your updated package.json using npm install.
|
||
|
|
|
||
|
|
Note: Your locally rebuilt changes to `node_modules` won't be used by others. A new
|
||
|
|
version will be created by a GitHub workflow when you open your pull request.
|
||
|
|
|
||
|
|
For more details, see the `Cockpit HACKING.md guide <https://github.com/cockpit-project/cockpit/blob/main/HACKING.md#updating-node_modules>`_.
|