Tools and utilities for building PatternFly Elements and other design systems.
Repos using pfe-tools can customize the docs pages, dev server, and custom-elements manifest
generator by adding a .pfe.config.json
file to the repository root.
See config.ts for info on what that file can contain.
- Helpers for collating and rendering custom-elements manifests in 11ty sites.
- Various 11ty utility plugins
Helpers for testing web components using web test runner
Preset web-dev-server configuration.
I ran
npm start
but get404 not found
when the dev server launches the browser
The dev server config in pfe-tools tries its best to find the root directory of your project, but there are cases where this may not work. If you get a 404 error to index.html,
- Confirm that you have an
index.html
file in your repository root - Set the
rootDir
option topfeDevServerConfig
, e.g.import { pfeDevServerConfig } from '@patternfly/pfe-tools/dev-server/config.js'; export default pfeDevServerConfig({ rootDir: '.', });
Make sure to do the same in web-test-runner.config.js
as well, for your unit tests