kyy/swagger-ui
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(scripts): update building and testing scripts (#6298)

Browse Source
This commit is contained in:
Tim Lai
2020-08-13 19:53:16 -07:00
committed by GitHub
parent 2eaa6c10e4
commit e1573527de
1 changed files with 14 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/development/scripts.md
View File

@@ -16,15 +16,23 @@ Script name | Description
Script name | Description Script name | Description
--- | --- --- | ---
`build` | Build a new set of JS and CSS assets, and output them to `/dist`. `build` | Build a new set of JS and CSS assets, and output them to `/dist`.
`build-bundle` | Build `swagger-ui-bundle.js` only. `build-bundle` | Build `swagger-ui-bundle.js` only (commonJS).
`build-core` | Build `swagger-ui.(js\|css)` only. `build-core` | Build `swagger-ui.(js\|css)` only (commonJS).
`build-standalone` | Build `swagger-ui-standalone-preset.js` only. `build-standalone` | Build `swagger-ui-standalone-preset.js` only (commonJS).
`build-stylesheets` | Build `swagger-ui.css` only. `build-stylesheets` | Build `swagger-ui.css` only.
`build:es:bundle` | Build `swagger-ui-es-bundle.js` only (es2015).
`build:es:bundle:core` | Build `swagger-ui-es-bundle-core.js` only (es2015).
### Testing ### Testing
Script name | Description Script name | Description
--- | --- --- | ---
`test` | Run unit tests in Node and run ESLint in errors-only mode. `test` | Run unit tests in Node, run Cypress end-to-end tests, and run ESLint in errors-only mode.
`just-test` | Run unit tests in the browser with Karma. `just-test-in-node` | Run Mocha unit tests in Node.
`just-test-in-node` | Run unit tests in Node.
`e2e` | Run end-to-end tests (requires JDK and Selenium). `e2e` | Run end-to-end tests (requires JDK and Selenium).
`e2e-cypress` | Run end-to-end browser tests with Cypress.
`dev-e2e-cypress` | Dev mode, open Cypress runner and manually select tests to run.
`lint` | Run ESLint test
`test:artifact` | Run list of bundle artifact tests in Jest
`test:artifact:umd:bundle` | Run unit test that confirms `swagger-ui-bundle` exports as a Function
`test:artifact:es:bundle` | Run unit test that confirms `swagger-ui-es-bundle` exports as a Function
`test:artifact:es:bundle:core` | Run unit test that confirms `swagger-ui-es-bundle-core` exports as a Function