mirror of
https://github.com/facebook/docusaurus.git
synced 2025-12-28 12:33:10 +00:00
1a572757f1
* Adding last updated time for docs * Making file path general and other suggested changes * Checking if time returned is null due to absence of git or some other issue * Adding option to enable/disable update time feature and test-doc * Adding simple unit tests for getGitUpdateTime() * nits & rewrote failing test * consistent test naming * Adding optional updateEnableTime in documentation * package-lock & yarn.lock
101 lines
3.7 KiB
JavaScript
101 lines
3.7 KiB
JavaScript
/**
|
|
* Copyright (c) 2017-present, Facebook, Inc.
|
|
*
|
|
* This source code is licensed under the MIT license found in the
|
|
* LICENSE file in the root directory of this source tree.
|
|
*/
|
|
|
|
const path = require('path');
|
|
const fs = require('fs');
|
|
const utils = require('../utils');
|
|
|
|
const blogPostWithTruncateContents = fs.readFileSync(
|
|
path.join(__dirname, '__fixtures__', 'blog-post-with-truncate.md'),
|
|
'utf8'
|
|
);
|
|
|
|
const blogPostWithoutTruncateContents = fs.readFileSync(
|
|
path.join(__dirname, '__fixtures__', 'blog-post-without-truncate.md'),
|
|
'utf8'
|
|
);
|
|
|
|
describe('utils', () => {
|
|
test('blogPostHasTruncateMarker', () => {
|
|
expect(utils.blogPostHasTruncateMarker(blogPostWithTruncateContents)).toBe(
|
|
true
|
|
);
|
|
expect(
|
|
utils.blogPostHasTruncateMarker(blogPostWithoutTruncateContents)
|
|
).toBe(false);
|
|
});
|
|
|
|
test('extractBlogPostBeforeTruncate', () => {
|
|
expect(
|
|
utils.extractBlogPostBeforeTruncate(blogPostWithTruncateContents)
|
|
).toMatchSnapshot();
|
|
expect(
|
|
utils.extractBlogPostBeforeTruncate(blogPostWithoutTruncateContents)
|
|
).toMatchSnapshot();
|
|
});
|
|
|
|
test('getPath', () => {
|
|
// does not change/transform path
|
|
expect(utils.getPath('/en/users.html', false)).toBe('/en/users.html');
|
|
expect(utils.getPath('/docs/en/versioning.html', false)).toBe(
|
|
'/docs/en/versioning.html'
|
|
);
|
|
expect(utils.getPath(undefined, false)).toBeUndefined();
|
|
expect(utils.getPath(null, false)).toBeNull();
|
|
|
|
// transform to pretty/clean path
|
|
const cleanPath = pathStr => utils.getPath(pathStr, true);
|
|
expect(cleanPath('/en/users')).toBe('/en/users');
|
|
expect(cleanPath('/docs/versioning.html')).toBe('/docs/versioning');
|
|
expect(cleanPath('/en/users.html')).toBe('/en/users');
|
|
expect(cleanPath('/docs/en/asd/index.html')).toBe('/docs/en/asd/');
|
|
expect(cleanPath('/en/help/index.html')).toBe('/en/help/');
|
|
expect(cleanPath('/index.html')).toBe('/');
|
|
expect(cleanPath('/react/index.html')).toBe('/react/');
|
|
expect(cleanPath('/en/help.a.b.c.d.e.html')).toBe('/en/help.a.b.c.d.e');
|
|
expect(cleanPath('/en/help.js')).toBe('/en/help.js');
|
|
expect(cleanPath('/test.md')).toBe('/test.md');
|
|
expect(cleanPath('/blog/7.0.0')).toBe('/blog/7.0.0');
|
|
expect(cleanPath('/test/5.html.2')).toBe('/test/5.html.2');
|
|
expect(cleanPath('/docs/en/5.2')).toBe('/docs/en/5.2');
|
|
});
|
|
|
|
test('removeExtension', () => {
|
|
expect(utils.removeExtension('/endiliey.html')).toBe('/endiliey');
|
|
expect(utils.removeExtension('/a.b/')).toBe('/a.b/');
|
|
expect(utils.removeExtension('/a.b/c.png')).toBe('/a.b/c');
|
|
expect(utils.removeExtension('/a.b/c.d.e')).toBe('/a.b/c.d');
|
|
expect(utils.removeExtension('/docs/test')).toBe('/docs/test');
|
|
expect(utils.removeExtension('pages.js')).toBe('pages');
|
|
});
|
|
|
|
test('getGitLastUpdated', () => {
|
|
// existing test file in repository with git timestamp
|
|
const existingFilePath = path.join(__dirname, '__fixtures__', 'test.md');
|
|
const gitLastUpdated = utils.getGitLastUpdated(existingFilePath);
|
|
expect(typeof gitLastUpdated).toBe('string');
|
|
expect(Date.parse(gitLastUpdated)).not.toBeNaN();
|
|
expect(gitLastUpdated).not.toBeNull();
|
|
|
|
// non existing file
|
|
const nonExistingFilePath = path.join(
|
|
__dirname,
|
|
'__fixtures__',
|
|
'.nonExisting'
|
|
);
|
|
expect(utils.getGitLastUpdated(null)).toBeNull();
|
|
expect(utils.getGitLastUpdated(undefined)).toBeNull();
|
|
expect(utils.getGitLastUpdated(nonExistingFilePath)).toBeNull();
|
|
|
|
// temporary created file that has no git timestamp
|
|
const tempFilePath = path.join(__dirname, '__fixtures__', '.temp');
|
|
fs.writeFileSync(tempFilePath, 'Lorem ipsum :)');
|
|
expect(utils.getGitLastUpdated(tempFilePath)).toBeNull();
|
|
fs.unlinkSync(tempFilePath);
|
|
});
|
|
});
|