mirror of
https://github.com/docsifyjs/docsify.git
synced 2025-12-08 19:55:52 +00:00
* 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
268 lines
8.7 KiB
JavaScript
268 lines
8.7 KiB
JavaScript
const stripIndent = require('common-tags/lib/stripIndent');
|
|
const docsifyInit = require('../helpers/docsify-init');
|
|
|
|
// Suite
|
|
// -----------------------------------------------------------------------------
|
|
describe('render', function() {
|
|
// Setup & Teardown
|
|
// -------------------------------------------------------------------------
|
|
beforeEach(async () => {
|
|
await docsifyInit();
|
|
});
|
|
|
|
// Helpers
|
|
// ---------------------------------------------------------------------------
|
|
describe('helpers', () => {
|
|
test('important content', () => {
|
|
const output = window.marked('!> Important content');
|
|
|
|
expect(output).toMatchInlineSnapshot(
|
|
`"<p class=\\"tip\\">Important content</p>"`
|
|
);
|
|
});
|
|
|
|
test('general tip', () => {
|
|
const output = window.marked('?> General tip');
|
|
|
|
expect(output).toMatchInlineSnapshot(
|
|
`"<p class=\\"warn\\">General tip</p>"`
|
|
);
|
|
});
|
|
});
|
|
|
|
// Lists
|
|
// ---------------------------------------------------------------------------
|
|
describe('lists', function() {
|
|
test('as unordered task list', async function() {
|
|
const output = window.marked(stripIndent`
|
|
- [x] Task 1
|
|
- [ ] Task 2
|
|
- [ ] Task 3
|
|
`);
|
|
|
|
expect(output).toMatchInlineSnapshot(
|
|
`"<ul class=\\"task-list\\"><li class=\\"task-list-item\\"><label><input checked=\\"\\" disabled=\\"\\" type=\\"checkbox\\"> Task 1</label></li><li class=\\"task-list-item\\"><label><input disabled=\\"\\" type=\\"checkbox\\"> Task 2</label></li><li class=\\"task-list-item\\"><label><input disabled=\\"\\" type=\\"checkbox\\"> Task 3</label></li></ul>"`
|
|
);
|
|
});
|
|
|
|
test('as ordered task list', async function() {
|
|
const output = window.marked(stripIndent`
|
|
1. [ ] Task 1
|
|
2. [x] Task 2
|
|
`);
|
|
|
|
expect(output).toMatchInlineSnapshot(
|
|
`"<ol class=\\"task-list\\"><li class=\\"task-list-item\\"><label><input disabled=\\"\\" type=\\"checkbox\\"> Task 1</label></li><li class=\\"task-list-item\\"><label><input checked=\\"\\" disabled=\\"\\" type=\\"checkbox\\"> Task 2</label></li></ol>"`
|
|
);
|
|
});
|
|
|
|
test('normal unordered', async function() {
|
|
const output = window.marked(stripIndent`
|
|
- [linktext](link)
|
|
- just text
|
|
`);
|
|
|
|
expect(output).toMatchInlineSnapshot(
|
|
`"<ul ><li><a href=\\"#/link\\" >linktext</a></li><li>just text</li></ul>"`
|
|
);
|
|
});
|
|
|
|
test('unordered with custom start', async function() {
|
|
const output = window.marked(stripIndent`
|
|
1. first
|
|
2. second
|
|
|
|
text
|
|
|
|
3. third
|
|
`);
|
|
|
|
expect(output).toMatchInlineSnapshot(
|
|
`"<ol ><li>first</li><li>second</li></ol><p>text</p><ol start=\\"3\\"><li>third</li></ol>"`
|
|
);
|
|
});
|
|
|
|
test('nested', async function() {
|
|
const output = window.marked(stripIndent`
|
|
- 1
|
|
- 2
|
|
- 2 a
|
|
- 2 b
|
|
- 3
|
|
`);
|
|
|
|
expect(output).toMatchInlineSnapshot(
|
|
`"<ul ><li>1</li><li>2<ul ><li>2 a</li><li>2 b</li></ul></li><li>3</li></ul>"`
|
|
);
|
|
});
|
|
});
|
|
|
|
// Images
|
|
// ---------------------------------------------------------------------------
|
|
describe('images', function() {
|
|
test('regular', async function() {
|
|
const output = window.marked('');
|
|
|
|
expect(output).toMatchInlineSnapshot(
|
|
`"<p><img src=\\"http://imageUrl\\" data-origin=\\"http://imageUrl\\" alt=\\"alt text\\"></p>"`
|
|
);
|
|
});
|
|
|
|
test('class', async function() {
|
|
const output = window.marked(
|
|
""
|
|
);
|
|
|
|
expect(output).toMatchInlineSnapshot(
|
|
`"<p><img src=\\"http://imageUrl\\" data-origin=\\"http://imageUrl\\" alt=\\"alt text\\" class=\\"someCssClass\\" /></p>"`
|
|
);
|
|
});
|
|
|
|
test('id', async function() {
|
|
const output = window.marked(
|
|
""
|
|
);
|
|
|
|
expect(output).toMatchInlineSnapshot(
|
|
`"<p><img src=\\"http://imageUrl\\" data-origin=\\"http://imageUrl\\" alt=\\"alt text\\" id=\\"someCssID\\" /></p>"`
|
|
);
|
|
});
|
|
|
|
test('no-zoom', async function() {
|
|
const output = window.marked("");
|
|
|
|
expect(output).toMatchInlineSnapshot(
|
|
`"<p><img src=\\"http://imageUrl\\" data-origin=\\"http://imageUrl\\" alt=\\"alt text\\" data-no-zoom /></p>"`
|
|
);
|
|
});
|
|
|
|
describe('size', function() {
|
|
test('width and height', async function() {
|
|
const output = window.marked(
|
|
""
|
|
);
|
|
|
|
expect(output).toMatchInlineSnapshot(
|
|
`"<p><img src=\\"http://imageUrl\\" data-origin=\\"http://imageUrl\\" alt=\\"alt text\\" width=\\"WIDTH\\" height=\\"HEIGHT\\" /></p>"`
|
|
);
|
|
});
|
|
|
|
test('width', async function() {
|
|
const output = window.marked("");
|
|
|
|
expect(output).toMatchInlineSnapshot(
|
|
`"<p><img src=\\"http://imageUrl\\" data-origin=\\"http://imageUrl\\" alt=\\"alt text\\" width=\\"50\\" /></p>"`
|
|
);
|
|
});
|
|
});
|
|
});
|
|
|
|
// Headings
|
|
// ---------------------------------------------------------------------------
|
|
describe('headings', function() {
|
|
test('h1', async function() {
|
|
const output = window.marked('# h1 tag');
|
|
|
|
expect(output).toMatchInlineSnapshot(
|
|
`"<h1 id=\\"h1-tag\\"><a href=\\"#/?id=h1-tag\\" data-id=\\"h1-tag\\" class=\\"anchor\\"><span>h1 tag</span></a></h1>"`
|
|
);
|
|
});
|
|
|
|
test('h2', async function() {
|
|
const output = window.marked('## h2 tag');
|
|
|
|
expect(output).toMatchInlineSnapshot(
|
|
`"<h2 id=\\"h2-tag\\"><a href=\\"#/?id=h2-tag\\" data-id=\\"h2-tag\\" class=\\"anchor\\"><span>h2 tag</span></a></h2>"`
|
|
);
|
|
});
|
|
|
|
test('h3', async function() {
|
|
const output = window.marked('### h3 tag');
|
|
|
|
expect(output).toMatchInlineSnapshot(
|
|
`"<h3 id=\\"h3-tag\\"><a href=\\"#/?id=h3-tag\\" data-id=\\"h3-tag\\" class=\\"anchor\\"><span>h3 tag</span></a></h3>"`
|
|
);
|
|
});
|
|
|
|
test('h4', async function() {
|
|
const output = window.marked('#### h4 tag');
|
|
|
|
expect(output).toMatchInlineSnapshot(
|
|
`"<h4 id=\\"h4-tag\\"><a href=\\"#/?id=h4-tag\\" data-id=\\"h4-tag\\" class=\\"anchor\\"><span>h4 tag</span></a></h4>"`
|
|
);
|
|
});
|
|
|
|
test('h5', async function() {
|
|
const output = window.marked('##### h5 tag');
|
|
|
|
expect(output).toMatchInlineSnapshot(
|
|
`"<h5 id=\\"h5-tag\\"><a href=\\"#/?id=h5-tag\\" data-id=\\"h5-tag\\" class=\\"anchor\\"><span>h5 tag</span></a></h5>"`
|
|
);
|
|
});
|
|
|
|
test('h6', async function() {
|
|
const output = window.marked('###### h6 tag');
|
|
|
|
expect(output).toMatchInlineSnapshot(
|
|
`"<h6 id=\\"h6-tag\\"><a href=\\"#/?id=h6-tag\\" data-id=\\"h6-tag\\" class=\\"anchor\\"><span>h6 tag</span></a></h6>"`
|
|
);
|
|
});
|
|
});
|
|
|
|
describe('link', function() {
|
|
test('regular', async function() {
|
|
const output = window.marked('[alt text](http://url)');
|
|
|
|
expect(output).toMatchInlineSnapshot(
|
|
`"<p><a href=\\"http://url\\" target=\\"_blank\\" rel=\\"noopener\\">alt text</a></p>"`
|
|
);
|
|
});
|
|
|
|
test('linkrel', async function() {
|
|
// const { docsify } = await init('default', {
|
|
// externalLinkTarget: '_blank',
|
|
// externalLinkRel: 'noopener',
|
|
// });
|
|
const output = window.marked('[alt text](http://www.example.com)');
|
|
|
|
expect(output).toMatchInlineSnapshot(
|
|
`"<p><a href=\\"http://www.example.com\\" target=\\"_blank\\" rel=\\"noopener\\">alt text</a></p>"`
|
|
);
|
|
});
|
|
|
|
test('disabled', async function() {
|
|
const output = window.marked("[alt text](http://url ':disabled')");
|
|
|
|
expect(output).toMatchInlineSnapshot(
|
|
`"<p><a href=\\"javascript:void(0)\\" target=\\"_blank\\" rel=\\"noopener\\" disabled>alt text</a></p>"`
|
|
);
|
|
});
|
|
|
|
test('target', async function() {
|
|
const output = window.marked("[alt text](http://url ':target=_self')");
|
|
|
|
expect(output).toMatchInlineSnapshot(
|
|
`"<p><a href=\\"http://url\\" target=\\"_self\\" >alt text</a></p>"`
|
|
);
|
|
});
|
|
|
|
test('class', async function() {
|
|
const output = window.marked(
|
|
"[alt text](http://url ':class=someCssClass')"
|
|
);
|
|
|
|
expect(output).toMatchInlineSnapshot(
|
|
`"<p><a href=\\"http://url\\" target=\\"_blank\\" rel=\\"noopener\\" class=\\"someCssClass\\">alt text</a></p>"`
|
|
);
|
|
});
|
|
|
|
test('id', async function() {
|
|
const output = window.marked("[alt text](http://url ':id=someCssID')");
|
|
|
|
expect(output).toMatchInlineSnapshot(
|
|
`"<p><a href=\\"http://url\\" target=\\"_blank\\" rel=\\"noopener\\" id=\\"someCssID\\">alt text</a></p>"`
|
|
);
|
|
});
|
|
});
|
|
});
|