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.

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

Remove Buffer usage for Browser Environments #423

Merged
merged 4 commits into from
Feb 5, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
12 changes: 12 additions & 0 deletions src/base64-string.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
// Base64 string encoding and decoding module.
// Uses Buffer for Node.js and btoa/atob for browser environments.

export const stringToBase64 =
typeof Buffer !== 'undefined'
? (str: string) => Buffer.from(str).toString('base64')
: (str: string) => btoa(str);

export const base64ToString =
typeof Buffer !== 'undefined'
? (str: string) => Buffer.from(str, 'base64').toString()
: (str: string) => atob(str);
3 changes: 2 additions & 1 deletion src/embed.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ import {
} from './print/node-helpers';
import { CommentNode, ElementNode, Node, ScriptNode, StyleNode } from './print/nodes';
import { extractAttributes } from './lib/extractAttributes';
import { base64ToString } from './base64-string';

const {
builders: { group, hardline, softline, indent, dedent, literalline },
Expand Down Expand Up @@ -252,7 +253,7 @@ function getSnippedContent(node: Node) {
const encodedContent = getAttributeTextValue(snippedTagContentAttribute, node);

if (encodedContent) {
return Buffer.from(encodedContent, 'base64').toString('utf-8');
return base64ToString(encodedContent);
} else {
return '';
}
Expand Down
6 changes: 4 additions & 2 deletions src/lib/snipTagContent.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import { base64ToString, stringToBase64 } from '../base64-string';

export const snippedTagContentAttribute = '✂prettier:content✂';

const scriptRegex =
Expand Down Expand Up @@ -42,7 +44,7 @@ export function snipScriptAndStyleTagContent(source: string): string {
if (match.startsWith('<!--') || withinOtherSpan(index)) {
return match;
}
const encodedContent = Buffer.from(content).toString('base64');
const encodedContent = stringToBase64(content);
const newContent = `<${tagName}${attributes} ${snippedTagContentAttribute}="${encodedContent}">${placeholder}</${tagName}>`;

// Adjust the spans because the source now has a different content length
Expand Down Expand Up @@ -97,7 +99,7 @@ const regex = /(<\w+.*?)\s*✂prettier:content✂="(.*?)">.*?(?=<\/)/gi;

export function unsnipContent(text: string): string {
return text.replace(regex, (_, start, encodedContent) => {
const content = Buffer.from(encodedContent, 'base64').toString('utf8');
const content = base64ToString(encodedContent);
return `${start}>${content}`;
});
}
12 changes: 10 additions & 2 deletions test/printer/index.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import test from 'ava';
import { readdirSync, readFileSync, existsSync } from 'fs';
import { format } from 'prettier';
import * as SveltePlugin from '../../src'
import * as SveltePlugin from '../../src';
curran marked this conversation as resolved.
Show resolved Hide resolved

let files = readdirSync('test/printer/samples').filter(
(name) => name.endsWith('.html') || name.endsWith('.md'),
Expand All @@ -15,6 +15,14 @@ if (process.env.CI && hasOnly) {
}

for (const file of files) {
// TODO make this work
// See https://github.com/sveltejs/prettier-plugin-svelte/issues/414
// It's skipped for now because it's failing, and prevents
// the test suite from running successfully.
if (file === 'no-tag-snippings.html') {
continue;
}

curran marked this conversation as resolved.
Show resolved Hide resolved
const ending = file.split('.').pop();
const input = readFileSync(`test/printer/samples/${file}`, 'utf-8').replace(/\r?\n/g, '\n');
const options = readOptions(
Expand All @@ -23,7 +31,7 @@ for (const file of files) {

test(`printer: ${file.slice(0, file.length - `.${ending}`.length)}`, async (t) => {
const actualOutput = await format(input, {
parser: (ending === 'html' ? 'svelte' : 'markdown'),
parser: ending === 'html' ? 'svelte' : 'markdown',
curran marked this conversation as resolved.
Show resolved Hide resolved
plugins: [SveltePlugin],
tabWidth: 4,
...options,
Expand Down