Skip to content

fix smart quotes #770

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

Merged
merged 1 commit into from
Nov 2, 2024
Merged

fix smart quotes #770

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 25 additions & 26 deletions packages/site-kit/src/lib/markdown/renderer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -281,34 +281,33 @@ export async function render_content_markdown(
snippets.save(token.text, html);
}

// ensure that `foo`/`bar` is transformed to `foo` / `bar`
// https://github.com/sveltejs/svelte.dev/pull/577
const slash_index =
// @ts-expect-error
token.tokens?.findIndex((token) => token.type === 'text' && token.text === '/') ?? -1;

if (slash_index !== -1) {
// @ts-expect-error
const before = token.tokens[slash_index - 1];
// @ts-expect-error
const after = token.tokens[slash_index + 1];

if (before?.type === 'codespan' && after?.type === 'codespan') {
// @ts-expect-error
token.tokens[slash_index].raw = token.tokens[slash_index].text = ' / ';
const tokens = 'tokens' in token ? token.tokens : undefined;

if (tokens) {
// ensure that `foo`/`bar` is transformed to `foo` / `bar`
// https://github.com/sveltejs/svelte.dev/pull/577
const slash_index =
tokens.findIndex((token) => token.type === 'text' && token.text === '/') ?? -1;

if (slash_index !== -1) {
const before = tokens[slash_index - 1];
const after = tokens[slash_index + 1];

if (before?.type === 'codespan' && after?.type === 'codespan') {
// @ts-expect-error
tokens[slash_index].raw = tokens[slash_index].text = ' / ';
}
}
}
},
text(token) {
// @ts-expect-error I think this is a bug in marked — some text tokens have children,
// but that's not reflected in the types. In these cases we can't just use `token.tokens`
// because that will result in e.g. `<code>` elements not being generated
if (token.tokens) {
// @ts-expect-error
return this.parser!.parseInline(token.tokens);
}

return smart_quotes(token.text, true);
// smart quotes
for (let i = 0; i < tokens.length; i += 1) {
const token = tokens[i];

if (token.type === 'text') {
token.text = smart_quotes(token.text, { first: i === 0, html: true });
}
}
}
},
heading({ tokens, depth }) {
const text = this.parser!.parseInline(tokens);
Expand Down
8 changes: 5 additions & 3 deletions packages/site-kit/src/lib/markdown/utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,16 +42,18 @@ export const slugify = (str: string) => {
.replace(/-$/, '');
};

export function smart_quotes(str: string, html: boolean = false) {
export function smart_quotes(
str: string,
{ first = true, html = false }: { first?: boolean; html?: boolean } = {}
) {
// replace dumb quotes with smart quotes. This isn't a perfect algorithm — it
// wouldn't correctly handle `That '70s show` or `My country 'tis of thee`
// but a) it's very unlikely they'll occur in our docs, and
// b) they can be dealt with manually
return str.replace(
html ? /(.|^)(&#39;|&quot;)(.|$)/g : /(.|^)('|")(.|$)/g,
(m, before, quote, after) => {
const trimmed = before.trim();
const left = trimmed === '' || trimmed === '(';
const left = (first && before === '') || [' ', '\n', '('].includes(before);
let replacement = '';

if (html) {
Expand Down
Loading