Merged

Chore: Clean up server implementation and update test docs #2316

Show file tree
Hide file tree
Changes from all commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
c2c0d76
Preven dev site break on Carbon Ads plugin error
jhildenbiddleDec 1, 2023
71a5fd3
Replace live-server with browsersync
jhildenbiddleDec 2, 2023
4756e59
Update test docs
jhildenbiddleDec 2, 2023
34477d8
Preview fix test
jhildenbiddleDec 3, 2023
0709c47
Preview fix test (continued)
jhildenbiddleDec 3, 2023
adad7b3
Preview fix test (continued)
jhildenbiddleDec 3, 2023
0bcc4f3
Preview fix test (continued)
jhildenbiddleDec 3, 2023
b7cf1a3
Preview fix test (continued)
jhildenbiddleDec 3, 2023
f9b969c
Preview fix test (continued)
jhildenbiddleDec 3, 2023
8a9a649
Preview fix test (continued)
jhildenbiddleDec 3, 2023
58df808
Preview fix test (continued)
jhildenbiddleDec 3, 2023
f9ed0d4
Rename preview index and move to docs
jhildenbiddleDec 4, 2023
b5848b9
Remove need for duplicate themes folder in root
jhildenbiddleDec 4, 2023
5b21dac
Handle server args and log config details on start
jhildenbiddleDec 4, 2023
9373ab6
Remove unnecessary entry
jhildenbiddleDec 4, 2023
a3e92b3
Append build comment to preview.html
jhildenbiddleDec 4, 2023
9f11819
Build HTML only on serve:dev
jhildenbiddleDec 4, 2023
4904ef3
Add Vercel preview redirect
jhildenbiddleDec 4, 2023
b55fb54
Fix lint error
jhildenbiddleDec 4, 2023
9c2d29f
Clean up index.html
jhildenbiddleDec 4, 2023
d9a7f30
Merge branch 'develop' into replace-live-server
jhildenbiddleDec 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Failed to load files.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
import * as fs from 'node:fs';
import * as path from 'node:path';
import * as url from 'node:url';
import prettier from 'prettier';
import stripIndent from 'common-tags/lib/stripIndent/index.js';

const __filename = url.fileURLToPath(import.meta.url);
const __dirname = path.dirname(__filename);
const prettierConfig = prettier.resolveConfig.sync(__dirname);

// Preview
// =============================================================================
function generatePreview() {
const comment = stripIndent`
<!--
This file is generated by the build/html.js script.
Do not edit this file directly.
-->
`;
const srcFile = 'index.html';
const srcPath = path.resolve(__dirname, '..', 'docs');
const srcHTML = fs.readFileSync(path.resolve(srcPath, srcFile), 'utf8');
const outFile = 'preview.html';
const outPath = path.resolve(__dirname, '..', 'docs');
const outHTML = srcHTML
// Append comment
.replace(/(<!DOCTYPE html>)/, `${comment}\n$1`)
// Modify title
.replace(/(<\/title>)/, ' (Preview)$1')
// Replace CDN URLs with local paths
.replace(/\/\/cdn.jsdelivr.net\/npm\/docsify@4\//g, '/');
const formattedHTML = prettier.format(outHTML, {
...prettierConfig,
filepath: outFile,
});

console.log(`\nBuilding ${outFile} in ${outPath}`);

fs.writeFileSync(path.resolve(outPath, outFile), formattedHTML);
}

generatePreview();
Original file line numberDiff line numberDiff line change
Expand Up@@ -56,19 +56,22 @@
width: auto !important;
}
</style>
<script>
(function () {
const lang = location.hash.match(/#\/(de-de|es|ru-ru|zh-cn)\//);

// Set html "lang" attribute based on URL
if (lang) {
document.documentElement.setAttribute('lang', lang[1]);
}
})();
</script>
</head>

<body>
<div id="app">Loading ...</div>
<script src="//cdn.jsdelivr.net/npm/docsify-plugin-carbon@1"></script>
<script>
// Set html "lang" attribute based on URL
const lang = location.hash.match(/#\/(de-de|es|ru-ru|zh-cn)\//);

if (lang) {
document.documentElement.setAttribute('lang', lang[1]);
}

// Docsify configuration
window.$docsify = {
alias: {
Expand DownExpand Up@@ -184,7 +187,9 @@
},
},
plugins: [
DocsifyCarbon.create('CEBI6KQE', 'docsifyjsorg'),
function () {
DocsifyCarbon.create('CEBI6KQE', 'docsifyjsorg');
},
function (hook, vm) {
hook.beforeEach(html => {
if (/usercontent\.com/.test(vm.route.file)) {
Expand DownExpand Up@@ -214,21 +219,12 @@
</script>
<script src="//cdn.jsdelivr.net/npm/docsify@4/lib/docsify.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/docsify@4/lib/plugins/search.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/docsify@4/lib/plugins/ga.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/docsify@4/lib/plugins/matomo.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-bash.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-markdown.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-nginx.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-php.min.js"></script>
<script>
// Public site only
if (/docsify/.test(location.host)) {
document.write(
'<script src="//cdn.jsdelivr.net/npm/docsify@4/lib/plugins/ga.min.js"><\/script>'
);
document.write(
'<script src="//cdn.jsdelivr.net/npm/docsify@4/lib/plugins/matomo.min.js"><\/script>'
);
}
</script>
<script src="//cdn.jsdelivr.net/npm/vue@2/dist/vue.min.js"></script>
<!-- <script src="//cdn.jsdelivr.net/npm/vue@3/dist/vue.global.prod.js"></script> -->
</body>
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
import { TEST_HOST } from './test/config/server.js';
import serverConfig from './server.config.js';

const { hostname, port } = serverConfig.test;
const TEST_HOST = `http://${hostname}:${port}`;
const sharedConfig = {
errorOnDeprecated: true,
globalSetup: './test/config/jest.setup.js',
Expand All@@ -11,6 +13,8 @@ const sharedConfig = {
testURL: `${TEST_HOST}/_blank.html`,
};

process.env.TEST_HOST = TEST_HOST;

export default {
transform: {},
projects: [
Expand Down
Loading