Skip to content

Commit b71277b

Browse files
balzssbalzss
committed
chore: move axe a11y checks to the regression testing suite
1 parent 71514f3 commit b71277b

File tree

217 files changed

+713
-14397
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

217 files changed

+713
-14397
lines changed

‎commitlint.config.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ const { execSync } = require('child_process')
2626
const fs = require('fs')
2727
const path = require('path')
2828

29-
const ignoredPackages = ['__docs__', '__examples__']
29+
const ignoredPackages = ['__docs__']
3030

3131
function getChangedPackages() {
3232
try {

‎docs/contributor-docs/dev-commands.md‎

Lines changed: 14 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -8,21 +8,17 @@ order: 3
88

99
This is a quick developer reference for common Instructure UI repository commands. All should be run from the repository root. Make sure you run `npm install` first, as many of these commands will require you to have `lerna` dependencies installed before they will work.
1010

11-
| Command | Description |
12-
| ----------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
13-
| `npm run bootstrap` | Clean all node modules and build output, reinstall dependencies, create fresh build including regenerating design tokens and type declaration files. |
14-
| `npm run dev` | Run a local instance of the documentation app in dev mode. Docs will be served at `http://0.0.0.0:9090` |
15-
| `npm run start` | Run a local instance of the documentation app in production mode. The urls where the docs are being served will be included in the output of this command. |
16-
| `npm run build` | Run the build command for all Instructure UI packages. Similar to bootstrap, but without the cleaning steps, installation of dependencies, and without the token and type generation. |
17-
| `npm run build:watch` | Identical to `npm run build` but will watch for changes. Note: this command is rarely necessary to use. If you are running `npm run dev`, the docs app will already be watching for any changes for components. |
18-
| `npm run build -- --scope <package-name>` | Identical to `npm run build` but scoped to a single package. For example, to run the command only for the `ui-badge` package, you would do `npm run build -- --scope @instructure/ui-badge` |
19-
| `npm run build:watch -- --scope <package-name>` | Identical to `npm run build:watch` but scoped to a single package. For example, to run the command only for the `ui-badge` package, you would do `npm run build:watch -- --scope @instructure/ui-badge` |
20-
| `npm run build:ts` | Create type declaration files using `tsc` (TypeScript compiler). |
21-
| `npm run test` | Run all Instructure UI tests in production mode. Tests will be run in a headless instance of chrome. |
22-
| `npm run test:watch` | Run all Instructure UI tests in dev mode. Tests run this way will actually launch a browser and will also give you the option to debug. |
23-
| `npm run test -- --scope <package-name>` | Identical to `npm run test` but scoped to a single package. For example, to run the command only for the `ui-avatar` package you would do `npm run test -- --scope @instructure/ui-avatar` |
24-
| `npm run test:watch -- --scope <package-name>` | Identical to `npm run test:watch` but scoped to a single package. For example, to run the command only for the `ui-avatar` package you would do `npm run test:watch -- --scope @instructure/ui-avatar` |
25-
| `npm run start:examples` | Starts a production instance of [storybook](https://storybook.js.org/) with all component examples. |
26-
| `npm run dev:examples` | Starts a dev instance of [storybook](https://storybook.js.org/) with all component examples. |
27-
| `npm run generate:component` | Create an Instructure UI component with all the boilerplate (for styling etc.) taken care of. There are follow up prompts that will allow you to specify if you would like to create the component in an already existing package or create a new package for it. |
28-
| `npm run generate:package` | Create an Instructure UI package without a component. This is useful if you are creating a utility package that will contain a JavaScript function/class or a script instead of creating a package that will contain a React component. If you are trying to create a package for a React component, use `npm run generate:component` instead. |
11+
| Command | Description |
12+
| ----------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
13+
| `npm run bootstrap` | Clean all node modules and build output, reinstall dependencies, create fresh build including regenerating design tokens and type declaration files. |
14+
| `npm run dev` | Run a local instance of the documentation app in dev mode. Docs will be served at `http://0.0.0.0:9090` |
15+
| `npm run start` | Run a local instance of the documentation app in production mode. The urls where the docs are being served will be included in the output of this command. |
16+
| `npm run build` | Run the build command for all Instructure UI packages. Similar to bootstrap, but without the cleaning steps, installation of dependencies, and without the token and type generation. |
17+
| `npm run build:watch` | Identical to `npm run build` but will watch for changes. Note: this command is rarely necessary to use. If you are running `npm run dev`, the docs app will already be watching for any changes for components. |
18+
| `npm run build -- --scope <package-name>` | Identical to `npm run build` but scoped to a single package. For example, to run the command only for the `ui-badge` package, you would do `npm run build -- --scope @instructure/ui-badge` |
19+
| `npm run build:watch -- --scope <package-name>` | Identical to `npm run build:watch` but scoped to a single package. For example, to run the command only for the `ui-badge` package, you would do `npm run build:watch -- --scope @instructure/ui-badge` |
20+
| `npm run build:ts` | Create type declaration files using `tsc` (TypeScript compiler). |
21+
| `npm run test` | Run all Instructure UI tests in production mode. Tests will be run in a headless instance of chrome. |
22+
| `npm run test:watch` | Run all Instructure UI tests in dev mode. Tests run this way will actually launch a browser and will also give you the option to debug. |
23+
| `npm run test -- --scope <package-name>` | Identical to `npm run test` but scoped to a single package. For example, to run the command only for the `ui-avatar` package you would do `npm run test -- --scope @instructure/ui-avatar` |
24+
| `npm run test:watch -- --scope <package-name>` | Identical to `npm run test:watch` but scoped to a single package. For example, to run the command only for the `ui-avatar` package you would do `npm run test:watch -- --scope @instructure/ui-avatar` |

‎docs/contributor-docs/storybook-examples.md‎

Lines changed: 0 additions & 278 deletions
This file was deleted.

0 commit comments

Comments
 (0)