Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

BREAKING CHANGE: Clean up files in repo #2963

Merged
merged 19 commits into from Sep 9, 2023
Merged

BREAKING CHANGE: Clean up files in repo #2963

Show file tree
Hide file tree
Changes from 13 commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
7becfee
remove lib from repo
UziTech Sep 3, 2023
f0467c7
ignore build files in lib
UziTech Sep 3, 2023
865a066
remove marked.1
UziTech Sep 3, 2023
9015b61
ignore man/marked.1
UziTech Sep 3, 2023
9147acb
build man/marked.1 with marked-man
UziTech Sep 3, 2023
243efca
update example
UziTech Sep 3, 2023
23305ea
remove makefile
UziTech Sep 3, 2023
b1f5c5c
remove component.json
UziTech Sep 3, 2023
766ab1a
use rollup to minify
UziTech Sep 3, 2023
2a3f00b
move build docs to docs
UziTech Sep 3, 2023
49139fd
copy license to input
UziTech Sep 3, 2023
063470d
more verbose
UziTech Sep 3, 2023
5d36c43
build before test
UziTech Sep 3, 2023
4eac5cc
docs: use latest instead of master in demo
UziTech Sep 7, 2023
b0f6cc5
get vercel pr link in demo
UziTech Sep 9, 2023
9b12249
remove pr version
UziTech Sep 9, 2023
c07b690
remove marked.min.js
UziTech Sep 9, 2023
d63ed0a
ignore marked.min.js
UziTech Sep 9, 2023
de85e70
ignore some files in docs
UziTech Sep 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
View file
Open in desktop
Expand Up @@ -3,5 +3,7 @@
node_modules/
test/compiled_tests
public
lib
docs/LICENSE.md
vuln.js
man/marked.1
UziTech marked this conversation as resolved.
Show resolved Hide resolved
15 changes: 0 additions & 15 deletions Makefile
View file
Open in desktop

This file was deleted.

10 changes: 0 additions & 10 deletions component.json
View file
Open in desktop

This file was deleted.

10 changes: 6 additions & 4 deletions build-docs.js → docs/build.js
View file
Open in desktop
@@ -1,6 +1,7 @@
/* global marked */
import '../marked.min.js';
import { promises } from 'fs';
import { join, dirname, parse, format } from 'path';
import { Marked } from './lib/marked.esm.js';
import { markedHighlight } from 'marked-highlight';
import { HighlightJS } from 'highlight.js';
import titleize from 'titleize';
Expand All @@ -13,7 +14,7 @@ const outputDir = join(cwd, 'public');
const templateFile = join(inputDir, '_document.html');
const isUppercase = str => /[A-Z_]+/.test(str);
const getTitle = str => str === 'INDEX' ? '' : titleize(str.replace(/_/g, ' ')) + ' - ';
const marked = new Marked(markedHighlight((code, language) => {
const markedInstance = new marked.Marked(markedHighlight((code, language) => {
if (!language) {
return highlightAuto(code).value;
}
Expand All @@ -24,6 +25,8 @@ async function init() {
console.log('Cleaning up output directory ' + outputDir);
await rm(outputDir, { force: true, recursive: true });
await mkdir(outputDir);
console.log(`Copying file ${join(cwd, 'LICENSE.md')}`);
console.log(` to ${join(inputDir, 'LICENSE.md')}`);
await copyFile(join(cwd, 'LICENSE.md'), join(inputDir, 'LICENSE.md'));
Copy link
Member

@styfle styfle Sep 8, 2023 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's add something like:

await copyFile(join(cwd, 'marked.min.js'), join(outputDir, 'marked.min.js''));

Then in the client side JS of the Demo, you can fetch the latest for the given deployment with:

fetch(new URL('/marked.min.js', window.location))`

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a way to get the PR vercel link with just a PR#?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I found it based on the vercel comment View Preview link

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR Demo

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

or we don't even need the pr version because now we can go to the preview and use /marked.min.js

Copy link
Member

@styfle styfle Sep 9, 2023 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Exactly, we don’t need a text input anymore. Either you select an old version or you select “HEAD”. And HEAD for a production deployment is master branch and for a preview deployment it’s the PR branch.

const tmpl = await readFile(templateFile, 'utf8');
console.log('Building markdown...');
Expand All @@ -45,7 +48,7 @@ async function build(currentDir, tmpl) {
let html = await readFile(filename, 'utf8');
const parsed = parse(filename);
if (parsed.ext === '.md' && isUppercase(parsed.name)) {
const mdHtml = marked.parse(html);
const mdHtml = markedInstance.parse(html);
html = tmpl
.replace('<!--{{title}}-->', getTitle(parsed.name))
.replace('<!--{{content}}-->', mdHtml);
Expand All @@ -55,7 +58,6 @@ async function build(currentDir, tmpl) {
}
parsed.dir = parsed.dir.replace(inputDir, outputDir);
const outfile = format(parsed);
// console.log('Ensure directory ' + dirname(outfile));
await mkdir(dirname(outfile), { recursive: true });
console.log('Writing file ' + outfile);
await writeFile(outfile, html, { mode });
Expand Down