gantri-components 1.143.2 → 1.143.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
|
@@ -2,12 +2,14 @@
|
|
|
2
2
|
|
|
3
3
|
## Deploying beta code changes
|
|
4
4
|
|
|
5
|
-
If you'd like to deploy some code that can be pulled into another repo, you can merge your changes into the `beta` branch. After deployment (you can verify deployment
|
|
5
|
+
If you'd like to deploy some code that can be pulled into another repo, you can merge your changes into the `beta` branch. After deployment (you can verify deployment status [here](https://github.com/gantri/gantri-components/actions/workflows/publish.yml)), you can install the beta code to your repo using `yarn add gantri-components@beta`. Just be sure not to reinstall the normal version when you're done.
|
|
6
|
+
|
|
7
|
+
#### NOTE: `chore` commit prefixes do not trigger a new version deployment. For a list of commit prefixes and their deployment versions, please see [this document](https://github.com/semantic-release/commit-analyzer/blob/master/lib/default-release-rules.js).
|
|
6
8
|
|
|
7
9
|
## Testing
|
|
8
10
|
|
|
9
11
|
Testing is done using [Jest](https://jestjs.io/docs/using-matchers) for base JavaScript functionality and Jest with [React Testing Library](https://testing-library.com/docs/react-testing-library/cheatsheet) for React functionality.
|
|
10
12
|
|
|
11
|
-
You can run all tests locally by running `
|
|
13
|
+
You can run all tests locally by running `yarn test` in the command line. By default, this script is run with the `--watch` [option](https://jestjs.io/docs/cli#options) which will watch for saved changes and automatically re-run related tests. You can add other options to the command by adding running `yarn test {{option flag}}` (example: `yarn test --verbose`).
|
|
12
14
|
|
|
13
15
|
All tests are run on GitHub each time new code is pushed to your PR.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -3,3 +3,4 @@ import { ReactElement } from 'react';
|
|
|
3
3
|
/** Renders with the required App providers */
|
|
4
4
|
export declare const renderWithProviders: (ui: ReactElement, options?: Omit<RenderOptions<typeof import("@testing-library/dom/types/queries"), HTMLElement, HTMLElement>, "wrapper"> | undefined) => import("@testing-library/react").RenderResult<typeof import("@testing-library/dom/types/queries"), HTMLElement, HTMLElement>;
|
|
5
5
|
export declare const renderWithThemeProvider: (ui: ReactElement, options?: Omit<RenderOptions<typeof import("@testing-library/dom/types/queries"), HTMLElement, HTMLElement>, "wrapper"> | undefined) => import("@testing-library/react").RenderResult<typeof import("@testing-library/dom/types/queries"), HTMLElement, HTMLElement>;
|
|
6
|
+
export declare const renderWithFormikWrapper: (ui: ReactElement, options?: Omit<RenderOptions<typeof import("@testing-library/dom/types/queries"), HTMLElement, HTMLElement>, "wrapper"> | undefined) => import("@testing-library/react").RenderResult<typeof import("@testing-library/dom/types/queries"), HTMLElement, HTMLElement>;
|