mirror of
https://github.com/docsifyjs/docsify.git
synced 2026-10-29 03:47:04 +08:00
test: run router/history/base tests in both hash and history modes
This commit is contained in:
copilot-swe-agent[bot]
@@ -8,116 +8,141 @@ class MockHistory extends History {
|
||||
}
|
||||
}
|
||||
|
||||
// Suite
|
||||
// -----------------------------------------------------------------------------
|
||||
describe('router/history/base', () => {
|
||||
// Setup & Teardown
|
||||
// ---------------------------------------------------------------------------
|
||||
let history;
|
||||
class MockHTML5History extends History {
|
||||
mode = 'history';
|
||||
|
||||
// resolvePath: true
|
||||
parse(path) {
|
||||
return { path };
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Defines and runs the shared base History tests for a given History subclass.
|
||||
* @param {string} label - Display name for the describe block (e.g. 'hash', 'history')
|
||||
* @param {typeof History} HistoryClass - The History subclass to test
|
||||
*/
|
||||
function runBaseHistoryTests(label, HistoryClass) {
|
||||
// Suite
|
||||
// ---------------------------------------------------------------------------
|
||||
describe('relativePath: true', () => {
|
||||
describe(`router/history/base (${label} mode)`, () => {
|
||||
// Setup & Teardown
|
||||
// -------------------------------------------------------------------------
|
||||
beforeEach(() => {
|
||||
history = new MockHistory({ relativePath: true });
|
||||
});
|
||||
let history;
|
||||
|
||||
// Tests
|
||||
// resolvePath: true
|
||||
// -------------------------------------------------------------------------
|
||||
test('toURL', () => {
|
||||
const url = history.toURL('guide.md', {}, '/zh-ch/');
|
||||
describe('relativePath: true', () => {
|
||||
// Setup & Teardown
|
||||
// -----------------------------------------------------------------------
|
||||
beforeEach(() => {
|
||||
history = new HistoryClass({ relativePath: true });
|
||||
});
|
||||
|
||||
expect(url).toBe('/zh-ch/guide');
|
||||
// Tests
|
||||
// -----------------------------------------------------------------------
|
||||
test('toURL', () => {
|
||||
const url = history.toURL('guide.md', {}, '/zh-ch/');
|
||||
|
||||
expect(url).toBe('/zh-ch/guide');
|
||||
});
|
||||
|
||||
test('toURL with double dot', () => {
|
||||
const url = history.toURL('../README.md', {}, '/zh-ch/');
|
||||
|
||||
expect(url).toBe('/README');
|
||||
});
|
||||
|
||||
test('toURL child path', () => {
|
||||
const url = history.toURL('config/example.md', {}, '/zh-ch/');
|
||||
|
||||
expect(url).toBe('/zh-ch/config/example');
|
||||
});
|
||||
|
||||
test('toURL absolute path', () => {
|
||||
const url = history.toURL('/README', {}, '/zh-ch/');
|
||||
|
||||
expect(url).toBe('/README');
|
||||
});
|
||||
});
|
||||
|
||||
test('toURL with double dot', () => {
|
||||
const url = history.toURL('../README.md', {}, '/zh-ch/');
|
||||
// resolvePath: false
|
||||
// -------------------------------------------------------------------------
|
||||
describe('relativePath: false', () => {
|
||||
// Setup & Teardown
|
||||
// -----------------------------------------------------------------------
|
||||
beforeEach(() => {
|
||||
history = new HistoryClass({ relativePath: false });
|
||||
});
|
||||
|
||||
expect(url).toBe('/README');
|
||||
// Tests
|
||||
// -----------------------------------------------------------------------
|
||||
test('toURL', () => {
|
||||
const url = history.toURL('README', {}, '/zh-ch/');
|
||||
|
||||
expect(url).toBe('/README');
|
||||
});
|
||||
});
|
||||
|
||||
test('toURL child path', () => {
|
||||
const url = history.toURL('config/example.md', {}, '/zh-ch/');
|
||||
describe('default path behavior', () => {
|
||||
beforeEach(() => {
|
||||
history = new HistoryClass({ relativePath: true });
|
||||
});
|
||||
|
||||
expect(url).toBe('/zh-ch/config/example');
|
||||
test('resolves relative links from the current page', () => {
|
||||
expect(history.toURL('guide.md', {}, '/dir/page')).toBe('/dir/guide');
|
||||
expect(history.toURL('../guide.md', {}, '/dir/page')).toBe('/guide');
|
||||
});
|
||||
|
||||
test('keeps absolute links rooted', () => {
|
||||
expect(history.toURL('/guide.md', {}, '/dir/page')).toBe('/guide');
|
||||
});
|
||||
});
|
||||
|
||||
test('toURL absolute path', () => {
|
||||
const url = history.toURL('/README', {}, '/zh-ch/');
|
||||
// getFile test
|
||||
// -------------------------------------------------------------------------
|
||||
describe('getFile', () => {
|
||||
beforeEach(() => {
|
||||
history = new HistoryClass({});
|
||||
});
|
||||
|
||||
expect(url).toBe('/README');
|
||||
// Tests
|
||||
// -----------------------------------------------------------------------
|
||||
test('path is url', () => {
|
||||
const file = history.getFile('https://some/raw/url/README.md');
|
||||
|
||||
expect(file).toBe('https://some/raw/url/README.md');
|
||||
});
|
||||
|
||||
test('path is url, but ext is .html', () => {
|
||||
const file = history.getFile('https://foo.com/index.html');
|
||||
|
||||
expect(file).toBe('https://foo.com/index.html');
|
||||
});
|
||||
|
||||
test('path is url, but with parameters', () => {
|
||||
const file = history.getFile(
|
||||
'https://some/raw/url/README.md?token=Mytoken',
|
||||
);
|
||||
|
||||
expect(file).toBe('https://some/raw/url/README.md?token=Mytoken');
|
||||
});
|
||||
|
||||
test('path is url, but ext is different', () => {
|
||||
history = new HistoryClass({ ext: '.ext' });
|
||||
|
||||
const file = history.getFile('https://some/raw/url/README.md');
|
||||
|
||||
expect(file).toBe('https://some/raw/url/README.md.ext');
|
||||
});
|
||||
|
||||
test('does not duplicate a configured local base path', () => {
|
||||
history = new HistoryClass({ basePath: '/docs/' });
|
||||
|
||||
expect(history.getFile('/docs/guide')).toBe('/docs/guide.md');
|
||||
});
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
// resolvePath: false
|
||||
// ---------------------------------------------------------------------------
|
||||
describe('relativePath: false', () => {
|
||||
// Setup & Teardown
|
||||
// -------------------------------------------------------------------------
|
||||
beforeEach(() => {
|
||||
history = new MockHistory({ relativePath: false });
|
||||
});
|
||||
|
||||
// Tests
|
||||
// -------------------------------------------------------------------------
|
||||
test('toURL', () => {
|
||||
const url = history.toURL('README', {}, '/zh-ch/');
|
||||
|
||||
expect(url).toBe('/README');
|
||||
});
|
||||
});
|
||||
|
||||
describe('default path behavior', () => {
|
||||
beforeEach(() => {
|
||||
history = new MockHistory({ relativePath: true });
|
||||
});
|
||||
|
||||
test('resolves relative links from the current page', () => {
|
||||
expect(history.toURL('guide.md', {}, '/dir/page')).toBe('/dir/guide');
|
||||
expect(history.toURL('../guide.md', {}, '/dir/page')).toBe('/guide');
|
||||
});
|
||||
|
||||
test('keeps absolute links rooted', () => {
|
||||
expect(history.toURL('/guide.md', {}, '/dir/page')).toBe('/guide');
|
||||
});
|
||||
});
|
||||
|
||||
// getFile test
|
||||
// ---------------------------------------------------------------------------
|
||||
describe('getFile', () => {
|
||||
// Tests
|
||||
// -------------------------------------------------------------------------
|
||||
test('path is url', () => {
|
||||
const file = history.getFile('https://some/raw/url/README.md');
|
||||
|
||||
expect(file).toBe('https://some/raw/url/README.md');
|
||||
});
|
||||
test('path is url, but ext is .html', () => {
|
||||
const file = history.getFile('https://foo.com/index.html');
|
||||
|
||||
expect(file).toBe('https://foo.com/index.html');
|
||||
});
|
||||
test('path is url, but with parameters', () => {
|
||||
const file = history.getFile(
|
||||
'https://some/raw/url/README.md?token=Mytoken',
|
||||
);
|
||||
|
||||
expect(file).toBe('https://some/raw/url/README.md?token=Mytoken');
|
||||
});
|
||||
test('path is url, but ext is different', () => {
|
||||
history = new MockHistory({ ext: '.ext' });
|
||||
|
||||
const file = history.getFile('https://some/raw/url/README.md');
|
||||
|
||||
expect(file).toBe('https://some/raw/url/README.md.ext');
|
||||
});
|
||||
|
||||
test('does not duplicate a configured local base path', () => {
|
||||
history = new MockHistory({ basePath: '/docs/' });
|
||||
|
||||
expect(history.getFile('/docs/guide')).toBe('/docs/guide.md');
|
||||
});
|
||||
});
|
||||
});
|
||||
runBaseHistoryTests('hash', MockHistory);
|
||||
runBaseHistoryTests('history', MockHTML5History);
|
||||
|
||||
Reference in New Issue
Block a user