You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+11-1Lines changed: 11 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -38,11 +38,21 @@ Both of these test environments are setup to deal with Babel and code transpilin
38
38
-`npm run test:only` runs Node.js unit tests without coverage. `npm run test:cover` to run Node.js unit tests with coverage. `npm run test:debug` runs babel-node in debug mode (same as running `node debug`).
39
39
-`npm run test:integration` runs the integration tests against the Contentful CDA API
40
40
-`npm run test:browser-local` runs both the unit and integration tests using Karma against local browsers.
41
+
-`npm run test:ci` runs tests in CI
42
+
-`npm run test:browser-remote` runs both the unit and integration tests using Karma against Sauce Labs. This is only usable in the CI environment, as it expects the credentials and connection tunnel to be present.
41
43
42
44
# Documentation
43
45
44
46
Code is documented using JSDoc 3, and reference documentation is published automatically with each new version.
45
47
48
+
-`npm run docs:watch` watches code directory, and rebuilds documentation when anything changes. Useful for documentation writing and development.
49
+
-`npm run docs:dev` builds code and builds docs afterwards. Used by `npm run docs:watch`. Code building is required as the documentation is generated from the unminified ES5 compiled sources, rather than the original ES6 sources.
50
+
-`npm run docs:build` builds documentation.
51
+
-`npm run docs:publish` builds documentation and publishes it to github pages.
52
+
46
53
# Other tasks
47
54
48
-
Check `package.json` or run `npm run` to see additional tasks. Some of these are used only on CI environments and not relevant for usual development.
55
+
-`npm run clean` removes any built files
56
+
-`npm run build` builds vendored files, node package and browser version
57
+
-`npm run build:dist` builds ES5 sources from ES6 ones
58
+
-`npm run build:standalone` builds unminified and minified sources for browsers
Copy file name to clipboardExpand all lines: SETUP.md
+2Lines changed: 2 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -21,3 +21,5 @@ Axios can be vendored with `npm run vendor:browser` and `npm run vendor:node`.
21
21
The browser vendored version runs on top of the standalone Axios browser version which is already optimized for this use case (it's not a good idea to try and run babel on top of the normal axios commonjs package as it produces an unnecessarily large file)
22
22
23
23
Because of this, the follow-redirects dependency of axios needs to be a dependency on this package as well, otherwise it won't be installed.
24
+
25
+
The additional `npm run vendor:version` task is unrelated to axios vendoring and is used to build the library version into the code, to avoid having to bundle code for reading a json file in the browser build.
0 commit comments