Skip to content

Commit

Permalink
Use correct highlight.js call
Browse files Browse the repository at this point in the history
Previous call signature was deprecated.

See highlightjs/highlight.js#2277

Signed-off-by: Clark Fischer <clark.fischer@gmail.com>
  • Loading branch information
clarkf committed Jan 13, 2023
1 parent 906bc95 commit 14ccc08
Show file tree
Hide file tree
Showing 3 changed files with 70 additions and 1 deletion.
3 changes: 2 additions & 1 deletion src/components/views/elements/SyntaxHighlight.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
/*
Copyright 2017 Michael Telatynski <7t3chguy@gmail.com>
Copyright 2023 The Matrix.org Foundation C.I.C.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand All @@ -25,7 +26,7 @@ interface IProps {
export default class SyntaxHighlight extends React.PureComponent<IProps> {
public render(): JSX.Element {
const { children: content, language } = this.props;
const highlighted = language ? hljs.highlight(language, content) : hljs.highlightAuto(content);
const highlighted = language ? hljs.highlight(content, { language }) : hljs.highlightAuto(content);

return (
<pre className={`mx_SyntaxHighlight hljs language-${highlighted.language}`}>
Expand Down
38 changes: 38 additions & 0 deletions test/components/views/elements/SyntaxHighlight-test.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
/* eslint @typescript-eslint/no-unused-vars: ["error", { "varsIgnorePattern": "^_" }] */
/*
Copyright 2023 The Matrix.org Foundation C.I.C.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

import { render } from "@testing-library/react";
import hljs from "highlight.js";
import React from "react";

import SyntaxHighlight from "../../../../src/components/views/elements/SyntaxHighlight";

describe("<SyntaxHighlight />", () => {
it("renders", () => {
const { container } = render(<SyntaxHighlight>console.log("Hello, World!");</SyntaxHighlight>);
expect(container).toMatchSnapshot();
});

it.each(["json", "javascript", "css"])("uses the provided language", (lang) => {
const mock = jest.spyOn(hljs, "highlight");

render(<SyntaxHighlight language={lang}>// Hello, World</SyntaxHighlight>);

const [_lang, opts] = mock.mock.lastCall!;
expect(opts["language"]).toBe(lang);
});
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
// Jest Snapshot v1, https://goo.gl/fbAQLP

exports[`<SyntaxHighlight /> renders 1`] = `
<div>
<pre
class="mx_SyntaxHighlight hljs language-arcade"
>
<code>
<span
class="hljs-built_in"
>
console
</span>
.
<span
class="hljs-built_in"
>
log
</span>
(
<span
class="hljs-string"
>
"Hello, World!"
</span>
);
</code>
</pre>
</div>
`;

0 comments on commit 14ccc08

Please sign in to comment.