Skip to content

Commit e157352

Browse files
authored
docs(scripts): update building and testing scripts (#6298)
1 parent 2eaa6c1 commit e157352

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

docs/development/scripts.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,23 @@ Script name | Description
1616
Script name | Description
1717
--- | ---
1818
`build` | Build a new set of JS and CSS assets, and output them to `/dist`.
19-
`build-bundle` | Build `swagger-ui-bundle.js` only.
20-
`build-core` | Build `swagger-ui.(js\|css)` only.
21-
`build-standalone` | Build `swagger-ui-standalone-preset.js` only.
19+
`build-bundle` | Build `swagger-ui-bundle.js` only (commonJS).
20+
`build-core` | Build `swagger-ui.(js\|css)` only (commonJS).
21+
`build-standalone` | Build `swagger-ui-standalone-preset.js` only (commonJS).
2222
`build-stylesheets` | Build `swagger-ui.css` only.
23+
`build:es:bundle` | Build `swagger-ui-es-bundle.js` only (es2015).
24+
`build:es:bundle:core` | Build `swagger-ui-es-bundle-core.js` only (es2015).
2325

2426
### Testing
2527
Script name | Description
2628
--- | ---
27-
`test` | Run unit tests in Node and run ESLint in errors-only mode.
28-
`just-test` | Run unit tests in the browser with Karma.
29-
`just-test-in-node` | Run unit tests in Node.
29+
`test` | Run unit tests in Node, run Cypress end-to-end tests, and run ESLint in errors-only mode.
30+
`just-test-in-node` | Run Mocha unit tests in Node.
3031
`e2e` | Run end-to-end tests (requires JDK and Selenium).
32+
`e2e-cypress` | Run end-to-end browser tests with Cypress.
33+
`dev-e2e-cypress` | Dev mode, open Cypress runner and manually select tests to run.
34+
`lint` | Run ESLint test
35+
`test:artifact` | Run list of bundle artifact tests in Jest
36+
`test:artifact:umd:bundle` | Run unit test that confirms `swagger-ui-bundle` exports as a Function
37+
`test:artifact:es:bundle` | Run unit test that confirms `swagger-ui-es-bundle` exports as a Function
38+
`test:artifact:es:bundle:core` | Run unit test that confirms `swagger-ui-es-bundle-core` exports as a Function

0 commit comments

Comments
 (0)