<feed xmlns='http://www.w3.org/2005/Atom'>
<title>BMC/OpenBmc/webui-vue.git/docs/guide/quickstart, branch master</title>
<subtitle>Web-based user interface built on Vue.js for managing OpenBMC systems (mirror)</subtitle>
<id>https://git.radix-linux.su/BMC/OpenBmc/webui-vue.git/atom?h=master</id>
<link rel='self' href='https://git.radix-linux.su/BMC/OpenBmc/webui-vue.git/atom?h=master'/>
<link rel='alternate' type='text/html' href='https://git.radix-linux.su/BMC/OpenBmc/webui-vue.git/'/>
<updated>2026-01-23T20:01:27+00:00</updated>
<entry>
<title>Migrate unit tests from Jest to Vitest</title>
<updated>2026-01-23T20:01:27+00:00</updated>
<author>
<name>Jason Westover</name>
<email>jwestover@nvidia.com</email>
</author>
<published>2026-01-08T16:57:41+00:00</published>
<link rel='alternate' type='text/html' href='https://git.radix-linux.su/BMC/OpenBmc/webui-vue.git/commit/?id=e5b9cca7a85b49ae95d629765529b872d6a4d57e'/>
<id>urn:sha1:e5b9cca7a85b49ae95d629765529b872d6a4d57e</id>
<content type='text'>
Replace Jest test runner with Vitest for native ES modules support
and faster test execution. This migration aligns the test tooling
with the Vite build system and eliminates CommonJS compatibility
issues.

Why Vitest over Jest?

While Jest is a mature ecosystem with broader adoption (45.5k
GitHub stars vs Vitest's 15.7k), Vitest is the recommended testing
framework for Vue 3 + Vite projects:

1. **Native ESM Support**: Vitest runs tests directly as ESM
   without transformation, while Jest requires Babel/transformation
   layers that add complexity and slow down test execution.

2. **Vite Integration**: Shares the same configuration, plugins,
   and resolvers as the Vite build system. This eliminates the
   dual-config maintenance burden (vite.config.js + jest.config.js).

3. **Vue 3 Ecosystem Alignment**: Vitest is created by the Vue
   team and is the official recommendation in Vue 3 documentation.
   It has first-class Vue component testing support via
   @vue/test-utils.

4. **Performance**: Cold start is significantly faster due to
   Vite's on-demand compilation. HMR for tests provides instant
   feedback during test-driven development.

5. **API Compatibility**: Vitest intentionally matches Jest's API,
   making migration straightforward and allowing developers to
   leverage existing Jest knowledge.

ESLint 9 Upgrade:
- Upgrade ESLint from 8.57.1 to 9.18.0
- Migrate from .eslintrc.cjs to eslint.config.js (flat config)
- Upgrade eslint-plugin-vue from 9.2.0 to 10.0.0
- Replace eslint-plugin-vitest with @vitest/eslint-plugin@1.1.43
- Replace @vue/eslint-config-prettier with eslint-config-prettier
- Add globals package for flat config environment definitions
- Update lint-staged from 13.0.3 to 16.0.0
- Update prettier from 3.2.5 to 3.4.2
- Disable stricter vue rules for follow-up PR:
  vue/no-reserved-component-names, vue/no-unused-components,
  vue/no-deprecated-delete-set, vue/no-required-prop-with-default

Pre-commit Hooks:
- Add simple-git-hooks and lint-staged for automatic linting
- Run eslint --fix on JS/Vue files before commit
- Run prettier --write on markdown files before commit
- Add .prettierrc.yaml matching CI configuration
- Include .cjs/.mjs files in prettier JS override

Documentation:
- Update unit testing guide for Vitest
- Update coding standards with pre-commit hook details

References:
- Vitest official comparison:
  https://vitest.dev/guide/comparisons.html#jest
- Vue 3 testing guide:
  https://vuejs.org/guide/scaling-up/testing.html#unit-testing
- Vite ecosystem recommendations:
  https://vitejs.dev/guide/features.html#testing

Test Results:
  - 19 test files, 123 tests passing
  - No warnings or deprecation messages
  - Test execution: ~3.1s (on par with Jest)

Changes:
- Replace jest.config.js with Vitest config in vite.config.js
- Create tests/vitest.setup.js with Vitest-compatible mocks
- Update package.json scripts for Vitest
- Add vue3-snapshot-serializer for cleaner snapshots
- Use happy-dom and real i18n instance for faster tests

Dependency Updates:
- Remove @vue/cli-plugin-unit-jest, @vue/vue3-jest, babel-jest,
  jest
- Add vitest, @vitest/coverage-v8, jsdom, happy-dom,
  vue3-snapshot-serializer

Test File Migrations:
- Replace jest.fn() with vi.fn()
- Replace jest.spyOn() with vi.spyOn()
- Replace jest.mock() with vi.mock()
- Replace jest.resetModules() with vi.resetModules()
- Replace jest.unmock() with vi.unmock()
- Replace require() with dynamic import() for ESM compatibility
- Add explicit Vitest imports (vi, describe, it, expect, etc.)

Snapshot Improvements:
- Use vue3-snapshot-serializer to strip data-v-* scoped style
  attributes from snapshots for cleaner, more stable output
- Add SVG component stubs for logo assets to avoid verbose path
  data in snapshots (logo-header.svg, login-company-logo.svg,
  built-on-openbmc-logo.svg)
- Updated all snapshot files for Vitest format
- Removed obsolete Jest snapshot entries

Performance Optimizations:
- Use happy-dom instead of jsdom (17% faster environment setup)
- Use real i18n instance instead of mock (eliminates redundant
  dynamic imports, 55% faster test execution)

Tested:
- npm run test:unit runs 19 test files, 123 tests, and passed
  them all with 0 warnings.

Change-Id: Iaf04335db54a5ceeff09bcd43675a488828dc44f
Signed-off-by: Jason Westover &lt;jwestover@nvidia.com&gt;
</content>
</entry>
<entry>
<title>prettier: re-format</title>
<updated>2022-12-08T12:13:13+00:00</updated>
<author>
<name>Patrick Williams</name>
<email>patrick@stwcx.xyz</email>
</author>
<published>2022-12-08T12:13:13+00:00</published>
<link rel='alternate' type='text/html' href='https://git.radix-linux.su/BMC/OpenBmc/webui-vue.git/commit/?id=7385e139b0c9efca7430458cee982e63e282f4ae'/>
<id>urn:sha1:7385e139b0c9efca7430458cee982e63e282f4ae</id>
<content type='text'>
Prettier is enabled in openbmc-build-scripts on Markdown, JSON, and YAML
files to have consistent formatting for these file types.  Re-run the
formatter on the whole repository.

Change-Id: I2804ee3ab5ff6bcbf986b028db2fafec8e616779
Signed-off-by: Patrick Williams &lt;patrick@stwcx.xyz&gt;
</content>
</entry>
<entry>
<title>Add form quick start documentation</title>
<updated>2021-04-06T01:18:43+00:00</updated>
<author>
<name>Dixsie</name>
<email>dixsie@ibm.com</email>
</author>
<published>2021-03-24T11:33:30+00:00</published>
<link rel='alternate' type='text/html' href='https://git.radix-linux.su/BMC/OpenBmc/webui-vue.git/commit/?id=dbc691c61ea5d112e7d9e3f393856574ac5d1d37'/>
<id>urn:sha1:dbc691c61ea5d112e7d9e3f393856574ac5d1d37</id>
<content type='text'>
Form quick start documentation contains info on
using the form and form group components, and the Vuelidate plugin.

This doc also provides a template for creating a new form.

Signed-off-by: Dixsie Wolmers &lt;dixsie@ibm.com&gt;
Change-Id: I5d05141ff05cd069e55853a8b2cb4adecb3c848a
</content>
</entry>
<entry>
<title>Update text wrapping in documentation</title>
<updated>2021-03-22T13:27:10+00:00</updated>
<author>
<name>Derick Montague</name>
<email>derick.montague@ibm.com</email>
</author>
<published>2021-03-17T00:52:33+00:00</published>
<link rel='alternate' type='text/html' href='https://git.radix-linux.su/BMC/OpenBmc/webui-vue.git/commit/?id=492875622b39cb2cf04bbb9248b6ed0c52ced2df'/>
<id>urn:sha1:492875622b39cb2cf04bbb9248b6ed0c52ced2df</id>
<content type='text'>
To meet best practices and standards for markdown, this commit updates
all markdown files used for the VuePress documentation so that each
line is limited to 80 characters.

Signed-off-by: Derick Montague &lt;derick.montague@ibm.com&gt;
Change-Id: I0cadb33343ce1bc331dfefd096d8137a04c33604
</content>
</entry>
<entry>
<title>Update component documentation</title>
<updated>2020-12-15T23:12:41+00:00</updated>
<author>
<name>Derick Montague</name>
<email>derick.montague@ibm.com</email>
</author>
<published>2020-12-10T00:37:11+00:00</published>
<link rel='alternate' type='text/html' href='https://git.radix-linux.su/BMC/OpenBmc/webui-vue.git/commit/?id=f6df801b384118b946bb3b7b3248832ec70cfd0a'/>
<id>urn:sha1:f6df801b384118b946bb3b7b3248832ec70cfd0a</id>
<content type='text'>
The component structure was not consistent. We determined how we
wanted to save image examples within the component directory, but not
all of the components were updated. The result was that some images
were not displaying on the component pages. This patchset resolves
that issue, along with removing the page component since it is not an
actual component within the application.

- Add directory for each component, move example images to the
directory, and update the image path
- Create a page-title and page-section directory and index.md for each
- Move content for page-title and page-section from the page.md file
into the index.md within the respective component directory
- Delete the page.md from the component directory as it is not a
component
- Update links to page.md in the page-anatomy.md file.

Signed-off-by: Derick Montague &lt;derick.montague@ibm.com&gt;
Change-Id: I1e554adf71abb4c84f423a30d3c3b598f678ade0
</content>
</entry>
<entry>
<title>Add page components documentation</title>
<updated>2020-12-02T01:10:17+00:00</updated>
<author>
<name>Dixsie Wolmers</name>
<email>dixsie@ibm.com</email>
</author>
<published>2020-11-16T03:45:03+00:00</published>
<link rel='alternate' type='text/html' href='https://git.radix-linux.su/BMC/OpenBmc/webui-vue.git/commit/?id=e2707ef0ca20b669aca7ac06274591bd795719a9'/>
<id>urn:sha1:e2707ef0ca20b669aca7ac06274591bd795719a9</id>
<content type='text'>
Components include: b-container, page-title, and page-section.

Signed-off-by: Dixsie Wolmers &lt;dixsie@ibm.com&gt;
Change-Id: I5933767d44504dbfb87c2772d140de4d0607d4ab
</content>
</entry>
<entry>
<title>Add store documentation</title>
<updated>2020-11-23T05:13:53+00:00</updated>
<author>
<name>Dixsie Wolmers</name>
<email>dixsie@ibm.com</email>
</author>
<published>2020-11-16T17:29:17+00:00</published>
<link rel='alternate' type='text/html' href='https://git.radix-linux.su/BMC/OpenBmc/webui-vue.git/commit/?id=8da32b5c42ca7f35676a11f257adac83215dd99c'/>
<id>urn:sha1:8da32b5c42ca7f35676a11f257adac83215dd99c</id>
<content type='text'>
Signed-off-by: Dixsie Wolmers &lt;dixsie@ibm.com&gt;
Change-Id: I8597247305e1c3f7958f84b8496a7b75914b85c8
</content>
</entry>
<entry>
<title>Add page anatomy quick start to documentation</title>
<updated>2020-11-02T15:46:58+00:00</updated>
<author>
<name>Dixsie Wolmers</name>
<email>dixsie@ibm.com</email>
</author>
<published>2020-10-26T13:59:51+00:00</published>
<link rel='alternate' type='text/html' href='https://git.radix-linux.su/BMC/OpenBmc/webui-vue.git/commit/?id=26c8fae0398b4cfe1312f7812b7f1109fb8f1f51'/>
<id>urn:sha1:26c8fae0398b4cfe1312f7812b7f1109fb8f1f51</id>
<content type='text'>
The page anatomy quick start is intended to give developers a
quick reference for building out new pages.

Signed-off-by: Dixsie Wolmers &lt;dixsie@ibm.com&gt;
Change-Id: Idfed9e62822283c971e228a8a8a186ae05e485ae
</content>
</entry>
</feed>
