Ghost/apps/admin-x-settings
Ronald Langeveld e82f845d5c
Added flags helper for Acceptance Tests in AdminX (#18500)
refs https://ghost.slack.com/archives/C0568LN2CGJ/p1696495250115289

Adds a new helper function `toggleLabsFlag` that allows toggling of lab
flags within tests. This function can be used directly inside a test
case or within `beforeEach` or `beforeAll` hooks to set the initial
state before tests run.

Usage:
- To toggle a flag within a test: `toggleLabsFlag('recommendations',
false);`
- To set initial state in a hook: 
  ```javascript
  beforeEach(() => {
    toggleLabsFlag('recommendations', true);
  });

---

<!-- Leave the line below if you'd like GitHub Copilot to generate a
summary from your commit -->
<!--
copilot:summary
-->
### <samp>🤖 Generated by Copilot at e138d58</samp>

This change adds a utility module for acceptance testing of experimental
features in Ghost. It allows tests to mock and change the labs settings
using `defaultLabFlags` and `toggleLabsFlag`.
2023-10-05 20:12:54 +07:00
..
.storybook Fixed storybook failing to load due @tryghost/nql usage (#18453) 2023-10-03 16:49:05 +01:00
src Added resize option to Pintura (#18504) 2023-10-05 13:08:23 +00:00
test Added flags helper for Acceptance Tests in AdminX (#18500) 2023-10-05 20:12:54 +07:00
.eslintrc.cjs Temporarily fixed eslint rules being disabled in AdminX (#17565) 2023-08-02 08:37:51 +01:00
.yarnrc Prevented git tags from being created for apps 2023-07-10 13:09:28 +02:00
index.html Moved Admin-X-Settings to apps/ folder 2023-06-23 14:37:39 +02:00
node-shim.cjs Port custom theme setting visibility to admin-x (#18367) 2023-10-02 15:54:14 +01:00
package.json Update dependency vite to v4.4.10 2023-10-04 08:35:18 +02:00
playwright.config.ts Renamed e2e tests to acceptance tests in Admin X (#18439) 2023-10-03 16:20:40 +07:00
postcss.config.cjs Moved Admin-X-Settings to apps/ folder 2023-06-23 14:37:39 +02:00
README.md Moved Admin-X-Settings to apps/ folder 2023-06-23 14:37:39 +02:00
tailwind.config.cjs AdminX mobile updates (#18137) 2023-09-19 12:09:38 +02:00
tsconfig.json Moved Admin-X-Settings to apps/ folder 2023-06-23 14:37:39 +02:00
tsconfig.node.json Moved Admin-X-Settings to apps/ folder 2023-06-23 14:37:39 +02:00
vite.config.ts Port custom theme setting visibility to admin-x (#18367) 2023-10-02 15:54:14 +01:00

Admin X Settings

Experimental re-write of Ghost Admin Settings in React

Development

Pre-requisites

  • Run yarn in Ghost monorepo root
  • Run yarn in this directory

Running the development version

Run yarn dev to start the development server to test/develop the settings standalone. This will generate a demo site from the index.html file which renders the app and makes it available on http://localhost:5173

Running inside Admin

Run yarn dev from the top-level repo with --adminX

Develop

This is a monorepo package.

Follow the instructions for the top-level repo.

  1. git clone this repo & cd into it as usual
  2. Run yarn to install top-level dependencies.

Test

  • yarn lint run just eslint
  • yarn test run lint and tests