Commit Graph

279 Commits

Author SHA1 Message Date
John Hildenbiddle
b135f8417d Add Vue 3 compatibility
- Update docs
- Update tests
- Add Vue 2 to docs site
- Add Vue 2 & 3 dependencies for tests
2020-10-07 13:13:03 -05:00
John Hildenbiddle
7f0c42eda5
Jest + Playwright Testing (#1276)
* Initial Jest+Playwright setup

* Fix eslint warnings

* Add placeholder for common options

* Fix load order of scriptURLs

* Add docsifyURL and waitForSelector options

* Add executeScript scenarios

* Enable firefox and webkit tests by default

* Prevent prettier from reformatting browsers list

* Update options and add JSDoc comments

* Initial commit

* Complete initial example tests

* Minor tweaks

* Change suite name

* Rename file

* Add npm script to run jest+playwright example test

* Clean up server properties

* Isolate e2e, integration, and unit test environments

- Setup projects for e2e, integration, and unit tests in Jest configuration
- Setup /tests/e2e/ tests for Jest+PlayWright
- Setup /tests/integration/ tests for Jest
- Setup /tests/unit/ tests for Jest
- Setup eslint for Jest and Jest+Playwright environments
- Move e2e configuration files into separate folder
- Update e2e example tests
- Update unit example tests
- Update HTML fixtures

* Update docsifyInit helper

- Add `debug` option
- Append `Markdown` suffix to markdown-related options
- Reorder options alphabetically

* Add jestPlaywright.debug() to e2e examples

* Removed need to pass page as arg to docsifyInit()

* Add VSCode debug configurations

* Change test server port from 8080 to 3001

* Clean up test names and expect() order

* Update npm scripts to ignore example tests

* Add CLI commands and resources section

* Add Jest unit test snapshot example

* Added Jest unit and e2e tests to Github workflows

* Add npm script to run Jest examples

Added for new devs who are exploring the examples, as the need for passing --testPathIgnorePatterns is not obvious. This flag is required because the example tests are excluded by default.

* Remove node 10.x and add 14.x from tests

Required for jest+playwright testitng

* Temporarily disable testPathIgnorePatterns for ci

* Temporarily remove node 14 from matrix

Cypress fails on node 14.x

* Alternate workflow setup for new test env

* Update workflow platforms and node versions

Also cleaning up naming

* Restoring original workflow names

* Remove Cypress tests

* Remove/Reset GitHub actions

* Restore/reset workflows

* Bump actions/checkout@v1 to v2

* Use playright GH action

* Update playwright GH action configuration

* Remove unnecessary steps and update checkout version

* Add install step

* Add --ignore-scripts flag

Linting does not require running scripts automatically executred after install.

* Swicth from ci to i for install

* Add new Build & Test workflow

* Add OS tests

* Wait for network idle for more reliable ready state

* Configure image snapshot testing and add example

* Remove example fixture file

* Adjust image snapshot threshold for local & CI tests

* Upload diff-output artifact

* Add failure() check to upload-artifact

* Bump image snapshot threshold for local & CI tests

* Set diffDirection

* Fix XHR caching in playwright tests

* Update image snapshot example and theshold

* Bump image snapshot threshold for local & CI tests

* Remove old workflows

* Bump image snapshot threshold for local & CI tests

* Bump image snapshot failureThreshold for local & CI tests

* Set failureThresholdType to percent

* Change image snapshot comparisonMethod to ssim

* Remove pixelMatch options (incompatible with ssim)

* Bump image snapshot failureThreshold

* Bump image snapshot failureThreshold

* Disable fast-fail to allow all checks to complete

* Rename workflow

* Disable fast-fail to allow all checks to complete

* Store pixel and ssim comparison configs

* Add link to image snapshot test

* Fix CI errors on Windows due to image size mismatch

* Attempt to fix macos e2e exit code 134 issue

* Update test.yml

* Update test.yml

* Update test.yml

* Fix --ci flag

* Set Jets to use --runInBand for macOS e2e

* Remove unnecessary macOS check

* Set image snapshot to runInProcess (macOS CI fix)

* Update test.yml

* Temporary failureThreshold change for debugging

* Upload os+node-specific diff artifacts

* Remove node version from diff artifact

* Revert "Remove node version from diff artifact"

This reverts commit 9cfcc4342bb22f18da30363a4c52758f13ba0cc9.

* Revert "Revert "Remove node version from diff artifact""

This reverts commit ad6c1891e48c70c9973a5c0d7b876b2d4621f3b9.

* Restoring failureThreshold after debugging

* Remove runInProcess option

* Revert "Remove runInProcess option"

This reverts commit 667ed6c870fc56f0349fc5eccc2cdeead3eff4ea.

* Add node-specific artifact uploads

* Set ssim mode to fast and restore runInProcess

* Set failureThreshold to 0.01

* Updating to playwright@next for webkit fix

* Restore optimal ssim configuration

* Testing pixel vs. ssim image comparison

* Move shared test setup to unit/int/e2e setups

* Refactor test server setup

* Replace live-server with browser-sync

* Update script for running local docs site

- Only init GA plugin on public site
- Only init Gitter plugin on public site
- Only init Matomo plugin on public site

NOTE: Large diff is a result of initial Prettier formatting. Actual change limited to last <script> block on page.

* Allow launching test server preview with --start

* Add integration tests and refactor unit + e2e

* Unify docsifyInit() and cleanup

- Create unified docsifyInit() for jest and playwright
- Move shared helpers to /tests/helpers
- Update tests
- Update globals

* Fixed webkit routes by specifying ContentType

* Update snapshot

* Update dependencies

* Update tests to use unified docsifyInit()

* Remove Cypress (old e2e test environment)

* Update tests to run (unit/integration/e2e)

- Add new integration tests (Jest)
- Remove old unit tests (mocha+jsdom)
- Remove old e2e tests (Cypress)

* Remove Cypress-related dependency

* Remove mocha+chai+jsdom (old unit/int test env)

* Rename testing directories and scripts

- Rename /tests/ directory to /test/
- Rename script/task names by removing “jest” identifier
- Remove “test:jest-examples” script

* - Configure test server for availability with all tests (previously e2e only)
- Create identical docsifyInit() tests using Jest (integration) and Playwright (e2e)
- Update docsifyInit() to convert relative URLs to absolute URLs to work in both JSDOM and Playwright
- Update docsifyInit() to append style- and js-related tags using createElement instead of insertAdjacentHTML
- Update paths in test files to use unified docsifyInit()
- Added option to docsifyInit() to enable/disable formatted HTML output to console
- Removed vue.css as default docsify theme from docsifyInit()
- Removed outdated files

* Reorganize test files

* Fix basePath option

* Replace do-mock-ajax with xhr-mock

- Allows mocking all XMLHttpRequests instead of just those initiated via /src/core/fetch/ajax.js
- Allows JSDOM tests to use /lib/docsify.js instead of /src/core/index.js (same as Playwright tests)
- Allows JSDOM tests to use /docs site as test content

* Added new waitFor helpers

* Clean up globals

- Import globals from various files instead of manually adding them to ensure they are availability in Jest and eslint configurations
- Add middleware to server configuration for serving virtual “_blank.html” file
- Add BLANK_URL
- Rename TEST_URL to TEST_HOST
- Removed ./test/fixtures/ directory (blank page now served via server.js middleware)
- Added page.goto(BLANK_URL) call to global Playwright beforeEach() setup

* Add try/catch for waitForFunction callback

* Move playwright config into jest.config.js

* Add runInBand option to tests for reliability

* Remove unnecessary XHR Mock teardown

* Add —runInBand to test script

* Merge develop

* Cleanup

- Relocate carbon plugin script with other scripts
- Update zh-cn docs URL to align with other translatins (GitHub, not jsdelivr)
- Add major version locks to URLs

* Removed fixed host value from docs

* Updated test after merge (docsify version change)

* Added startPath for manual instance

* Remove Node 10 from CI tests

* Remove Node 10 from CI lint tests
2020-10-05 14:10:30 -05:00
sy-records
d3482aca46 chore: add changelog 4.11.6 2020-08-22 19:37:04 +08:00
sy-records
e474ea86d4 chore: add changelog 4.11.5 2020-08-21 19:15:39 +08:00
沈唁
5037f0b4e6
chore: Remove the src directory from packages.json's files (#1344) 2020-08-20 11:36:45 +05:30
Snyk bot
59d090fe90
fix: upgrade tinydate from 1.2.0 to 1.3.0 (#1341)
Snyk has created this PR to upgrade tinydate from 1.2.0 to 1.3.0.

See this package in npm:
https://www.npmjs.com/package/tinydate

See this project in Snyk:
https://app.snyk.io/org/anikethsaha/project/836f877b-b98e-47ed-89fc-554e9b2e146d?utm_source=github&utm_medium=upgrade-pr
2020-08-18 22:04:44 +08:00
snyk-bot
3beaa6666b fix: upgrade medium-zoom from 1.0.5 to 1.0.6
Snyk has created this PR to upgrade medium-zoom from 1.0.5 to 1.0.6.

See this package in npm:
https://www.npmjs.com/package/medium-zoom

See this project in Snyk:
https://app.snyk.io/org/anikethsaha/project/836f877b-b98e-47ed-89fc-554e9b2e146d?utm_source=github&utm_medium=upgrade-pr
2020-08-17 08:39:14 +00:00
Snyk bot
086c2859ad
[Snyk] Security upgrade marked from 0.7.0 to 1.1.1 (#1313)
* fix: package.json & package-lock.json to reduce vulnerabilities

The following vulnerabilities are fixed with an upgrade:
- https://snyk.io/vuln/SNYK-JS-MARKED-584281

* fix: fix CompileError

* fix: embed files error

Co-authored-by: Koy <369491420@qq.com>
Co-authored-by: 沈唁 <52o@qq52o.cn>
2020-08-14 07:53:23 +08:00
anikethsaha
13f91a4fcb chore: add changelog 4.11.4 2020-06-18 23:48:00 +05:30
Anix
714ef29afe
feat: added html sanitizer for remote rendering (#1128)
Co-authored-by: Joe Pea <joe@trusktr.io>
2020-06-17 23:55:59 +05:30
Joe Pea
8f3f263cee Merge branch 'develop' into allow-config-function
* develop:
  chore: update auto format config
2020-06-12 21:37:46 -07:00
Joe Pea
63f1b88a41 Revert "ensure that the test script runs a prod build"
This reverts commit 41dc2c7d10 because the
GitHub Action (unit.yml) already run `npm run build`.
2020-06-07 13:24:47 -07:00
Joe Pea
41dc2c7d10 ensure that the test script runs a prod build 2020-06-07 11:59:52 -07:00
Joe Pea
7e002bf939 feat: update src/core/index.js to export all global APIs, deprecate old globals in favor of a single global DOCSIFY, and add tests for this 2020-05-23 14:10:00 -07:00
jamesgeorge007
96d5b19a96 chore: update auto format config 2020-04-09 10:35:59 +05:30
anikethsaha
ab597ca8e0 v4.11.3 2020-03-24 20:08:55 +05:30
Anix
b62a0c8f3e chore: add changelog 4.11.2 2020-03-09 21:15:00 +05:30
Anix
9afa66607d chore: removed circular dep and css.escape 2020-03-09 20:33:07 +05:30
Anix
1811842979 chore: add changelog 4.11.1 2020-03-09 18:11:20 +05:30
Anix
86df3bb32d chore: add changelog 4.11.0 2020-03-09 17:12:15 +05:30
snyk-bot
9981c4361a fix: upgrade prismjs from 1.17.1 to 1.19.0
Snyk has created this PR to upgrade prismjs from 1.17.1 to 1.19.0.

See this package in NPM:
https://www.npmjs.com/package/prismjs

See this project in Snyk:
https://app.snyk.io/org/anikethsaha/project/836f877b-b98e-47ed-89fc-554e9b2e146d?utm_source=github&utm_medium=upgrade-pr
2020-03-09 14:30:21 +05:30
snyk-bot
39ebd73021 fix: upgrade medium-zoom from 1.0.4 to 1.0.5
Snyk has created this PR to upgrade medium-zoom from 1.0.4 to 1.0.5.

See this package in NPM:
https://www.npmjs.com/package/medium-zoom

See this project in Snyk:
https://app.snyk.io/org/anikethsaha/project/836f877b-b98e-47ed-89fc-554e9b2e146d?utm_source=github&utm_medium=upgrade-pr
2020-03-09 14:29:10 +05:30
Anix
75c72e917b
chore: added new linter config (#1028)
* chore: added new linter config

* chore: linting fixes

* chore: refactore in linting config and minor linting fixes
2020-02-20 14:01:04 +05:30
Anix
a111df9980
chore: documented __colon__ tip (#1025) 2020-02-14 20:41:53 +05:30
Anix
5f7464af48
chore: migrate CI to github, refactore CI and npm scripts, linting fixes (#1023) 2020-02-14 15:22:53 +05:30
Atsushi Tanaka
90a35ab952
Fix #895 (#896)
* Don't replace leading digit

* Install css.escape

* Escape leading digit of the anchor id
2020-02-05 22:23:05 +05:30
Anix
0e54ea1177
[Test] : e2e tests using cypress (#999)
* chore: added cypresss

* chore: added sidebar tests

* chore: script update

* chore: removed cypress examples

* chore: added lib to eslintignore

* chore: script fixes

* chore: updated the snapshot
2020-01-30 17:44:13 +05:30
Joe Pea
e566e9c6e7
Merge branch 'develop' into prepare-script 2020-01-27 23:18:22 -08:00
Joe Pea
efbea24de7 feat: Add a prepare script.
This makes it possible to depend on the docsify package using a git commit hash instead of a version number in package.json, and causes the `lib` folder to be built in those cases, otherwise consumers will try to import from a folder that doesn't exist.
2020-01-24 20:02:10 -08:00
Muhammad Surya
7fb50b95f1 strip indent when embedding code fragment 2020-01-05 11:28:38 +07:00
Giulio Ambrogi
db97a1d22a Eslint fixes for v4x (#989)
* UPDATE .eslintrc

* UPDATE lint task

* FIX lint errors

* CLEANUP

* FIX no-eq-null warning

* FIX many jsdoc warnings

* FIX jsdoc issues

* FIX jsdoc warnings

* FIX jsdoc

* FIX eqeq and no-eq-null

* ADD lint to travis

* UPDATE test env for eslint
2019-12-30 22:01:46 +05:30
James George
5b77b0f628 fix: stage modified files as part of pre-commit hook (#985) 2019-12-22 17:18:28 +05:30
James George
eea41a1207 feat(chore): configure pre-commit hook (#983)
* chore: add husky as a devDep

* chore: add lint-staged as a devDep

* configure: pre-commit hook for staged files

* fix: minor tweak

* chore: update glob
2019-12-19 14:08:21 +05:30
anikethsaha
3cd03d480d chore: add changelog 4.10.2 2019-12-17 03:20:41 +05:30
anikethsaha
b0b3de0a66 chore: changed the opencollective cli to light 2019-12-17 02:48:47 +05:30
anikethsaha
589a5732d3 chore: add changelog 4.10.0 2019-12-16 23:00:23 +05:30
anikethsaha
4a8f2c5bfa chore: fixed the npm script and added css build file 2019-12-16 22:32:32 +05:30
Andrey Chalkin
615205cfdb fix: npm audit issues (#934) 2019-10-16 09:20:54 -04:00
Anton Wilhelm
676f84cffa chore: add changelog 4.9.4 2019-05-05 18:41:18 +02:00
Anton Wilhelm
d355272461 chore: add changelog 4.9.2 2019-04-21 12:06:17 +02:00
Anton Wilhelm
5bcb016bee Keep themes directory which is required for npm run dev 2019-04-21 12:05:41 +02:00
Anton Wilhelm
dac0bfec6c split test into unit and integration
provide some dummy tests cases
2019-02-25 07:14:00 +01:00
Anton Wilhelm
01ea44106b fix xhr usage, fix init URL setup
provide full test setup including fixtures
2019-02-25 07:14:00 +01:00
liqingwei
bc4d06bb16 chore: add changelog 4.9.1 2019-02-21 17:26:41 +08:00
liqingwei
dfd31b5de7 chore: add changelog 4.9.0 2019-02-19 11:26:54 +08:00
Anton Wilhelm
b53571810b Setup test environment and provide first tests 🌟 2019-02-14 18:33:33 +01:00
Anton Wilhelm
fd86c727af preperation to run the code in nodejs 2019-01-30 09:45:50 +01:00
Qingwei Li
049726e11e fix: upgrade npm-run-all 2018-11-27 13:13:38 +08:00
Qingwei Li
a257a4ab4e chore: add changelog 4.8.6 2018-11-12 10:24:23 +08:00
qingwei.li
cc79e2e992 chore: add changelog 4.8.5 2018-11-02 08:59:35 +08:00