mirror of
https://github.com/scm-manager/scm-manager.git
synced 2025-11-03 12:05:52 +01:00
a0737a2c90
We unified syntax highlighting and extracted it into a low level module. Syntax highlighting from now on takes place in a web worker, so that the user interface stays responsive. The web worker stops automatically if the number of nodes which should be highlighted exceeds the defined limit we believe the browser can handle. Co-authored-by: Sebastian Sdorra <sebastian.sdorra@cloudogu.com> Co-authored-by: Konstantin Schaper <konstantin.schaper@cloudogu.com>
109 lines
3.8 KiB
TypeScript
109 lines
3.8 KiB
TypeScript
/*
|
|
* MIT License
|
|
*
|
|
* Copyright (c) 2020-present Cloudogu GmbH and Contributors
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
* of this software and associated documentation files (the "Software"), to deal
|
|
* in the Software without restriction, including without limitation the rights
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
* copies of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in all
|
|
* copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
* SOFTWARE.
|
|
*/
|
|
import React, { FC, useCallback, useMemo, useState } from "react";
|
|
import { defaultLanguage, determineLanguage } from "./languages";
|
|
import { useLocation } from "react-router-dom";
|
|
import { urls } from "@scm-manager/ui-api";
|
|
import createSyntaxHighlighterRenderer from "./SyntaxHighlighterRenderer";
|
|
import useScrollToElement from "./useScrollToElement";
|
|
import styled from "styled-components";
|
|
import { useTranslation } from "react-i18next";
|
|
import copyToClipboard from "./CopyToClipboard";
|
|
import { Button } from "./buttons";
|
|
import { SyntaxHighlighter as NewSyntaxHighlighter } from "@scm-manager/ui-syntaxhighlighting";
|
|
|
|
const LINE_NUMBER_URL_HASH_REGEX = /^#line-(.*)$/;
|
|
|
|
const TopRightButton = styled(Button)`
|
|
height: inherit;
|
|
position: absolute;
|
|
display: none;
|
|
top: 0;
|
|
right: 0;
|
|
`;
|
|
|
|
const Container = styled.div`
|
|
&:hover > ${TopRightButton} {
|
|
display: inline-block;
|
|
}
|
|
`;
|
|
|
|
type Props = {
|
|
language?: string;
|
|
value: string;
|
|
showLineNumbers?: boolean;
|
|
permalink?: string;
|
|
};
|
|
|
|
const SyntaxHighlighter: FC<Props> = ({ language = defaultLanguage, showLineNumbers = true, value, permalink }) => {
|
|
const location = useLocation();
|
|
const [contentRef, setContentRef] = useState<HTMLElement | null>();
|
|
const [copied, setCopied] = useState(false);
|
|
const [t] = useTranslation("commons");
|
|
const createLinePermaLink = useCallback(
|
|
(lineNumber: number) =>
|
|
window.location.protocol +
|
|
"//" +
|
|
window.location.host +
|
|
urls.withContextPath((permalink || location.pathname) + "#line-" + lineNumber),
|
|
[permalink, location]
|
|
);
|
|
const Renderer = useMemo(
|
|
() => createSyntaxHighlighterRenderer(createLinePermaLink, showLineNumbers),
|
|
[createLinePermaLink, showLineNumbers]
|
|
);
|
|
|
|
useScrollToElement(
|
|
contentRef,
|
|
() => {
|
|
const match = location.hash.match(LINE_NUMBER_URL_HASH_REGEX);
|
|
if (match) {
|
|
return `#line-${match[1]}`;
|
|
}
|
|
},
|
|
value
|
|
);
|
|
|
|
const copy = () => copyToClipboard(value).then(() => setCopied(true));
|
|
|
|
let valueWithoutTrailingLineBreak = value;
|
|
if (value && value.length > 1 && value.endsWith("\n")) {
|
|
valueWithoutTrailingLineBreak = value.substr(0, value.length - 1);
|
|
}
|
|
return (
|
|
<Container ref={setContentRef} className="is-relative">
|
|
<NewSyntaxHighlighter
|
|
value={valueWithoutTrailingLineBreak}
|
|
language={determineLanguage(language)}
|
|
renderer={Renderer}
|
|
/>
|
|
<TopRightButton className="is-small" title={t("syntaxHighlighting.copyButton")} action={copy}>
|
|
<i className={copied ? "fa fa-clipboard-check" : "fa fa-clipboard"} />
|
|
</TopRightButton>
|
|
</Container>
|
|
);
|
|
};
|
|
|
|
export default SyntaxHighlighter;
|