import { useState, useEffect, ReactNode } from 'react' import { useRouter } from 'next/router' import dynamic from 'next/dynamic' import cx from 'classnames' import { ActionList, Heading } from '@primer/react' import { ZapIcon, InfoIcon, ShieldLockIcon } from '@primer/octicons-react' import { Callout } from 'components/ui/Callout' import { Link } from 'components/Link' import { DefaultLayout } from 'components/DefaultLayout' import { ArticleTitle } from 'components/article/ArticleTitle' import { MiniTocItem, useArticleContext } from 'components/context/ArticleContext' import { useTranslation } from 'components/hooks/useTranslation' import { LearningTrackNav } from './LearningTrackNav' import { MarkdownContent } from 'components/ui/MarkdownContent' import { Lead } from 'components/ui/Lead' import { ArticleGridLayout } from './ArticleGridLayout' import { PlatformPicker } from 'components/article/PlatformPicker' import { ToolPicker } from 'components/article/ToolPicker' const ClientSideRedirectExceptions = dynamic(() => import('./ClientsideRedirectExceptions'), { ssr: false, }) const ClientSideHighlightJS = dynamic(() => import('./ClientSideHighlightJS'), { ssr: false }) // Mapping of a "normal" article to it's interactive counterpart const interactiveAlternatives: Record = { '/actions/automating-builds-and-tests/building-and-testing-nodejs': { href: '/actions/automating-builds-and-tests/building-and-testing-nodejs-or-python?langId=nodejs', }, '/actions/automating-builds-and-tests/building-and-testing-python': { href: '/actions/automating-builds-and-tests/building-and-testing-nodejs-or-python?langId=python', }, '/codespaces/setting-up-your-project-for-codespaces/setting-up-your-nodejs-project-for-codespaces': { href: '/codespaces/setting-up-your-project-for-codespaces/setting-up-your-project-for-codespaces?langId=nodejs', }, '/codespaces/setting-up-your-project-for-codespaces/setting-up-your-dotnet-project-for-codespaces': { href: '/codespaces/setting-up-your-project-for-codespaces/setting-up-your-project-for-codespaces?langId=dotnet', }, '/codespaces/setting-up-your-project-for-codespaces/setting-up-your-java-project-for-codespaces': { href: '/codespaces/setting-up-your-project-for-codespaces/setting-up-your-project-for-codespaces?langId=java', }, '/codespaces/setting-up-your-project-for-codespaces/setting-up-your-python-project-for-codespaces': { href: '/codespaces/setting-up-your-project-for-codespaces/setting-up-your-project-for-codespaces?langId=py', }, } export type StructuredContentT = { structuredContent?: ReactNode } export const ArticlePage = ({ structuredContent }: StructuredContentT) => { const { asPath } = useRouter() const { title, intro, effectiveDate, renderedPage, contributor, permissions, includesPlatformSpecificContent, includesToolSpecificContent, product, miniTocItems, currentLearningTrack, } = useArticleContext() const renderedContent = structuredContent || renderedPage const { t } = useTranslation('pages') const currentPath = asPath.split('?')[0] const renderTocItem = (item: MiniTocItem) => { return (
{item.items && item.items.length > 0 ? (
    {item.items.map(renderTocItem)}
) : null}
) } // We have some one-off redirects for rest api docs // currently those are limited to the repos page, but // that will grow soon as we restructure the rest api docs. // This is a workaround to updating the hardcoded links // directly in the REST API code in a separate repo, which // requires many file changes and teams to sign off. // While the organization is turbulent, we can do this. // Once it's more settled, we can refactor the rest api code // to leverage the OpenAPI urls rather than hardcoded urls. // The code below determines if we should bother loading this redirecting // component at all. // The reason this isn't done at the server-level is because there you // can't possibly access the URL hash. That's only known in client-side // code. const [loadClientsideRedirectExceptions, setLoadClientsideRedirectExceptions] = useState(false) useEffect(() => { const { hash, pathname } = window.location // Today, Jan 2022, it's known explicitly what the pathname. // In the future there might be more. // Hopefully, we can some day delete all of this and no longer // be dependent on the URL hash to do the redirect. if ( hash && (pathname.endsWith('/rest/reference/repos') || pathname.endsWith('/rest/reference/enterprise-admin')) ) { setLoadClientsideRedirectExceptions(true) } }, []) // If the page contains `[data-highlight]` blocks, these pages need // syntax highlighting. But not every page needs it, so it's conditionally // lazy-loaded on the client. const [lazyLoadHighlightJS, setLazyLoadHighlightJS] = useState(false) useEffect(() => { // It doesn't need to use querySelector because all we care about is if // there is greater than zero of these in the DOM. // Note! This "core selector", which determines whether to bother // or not, needs to match what's used inside ClientSideHighlightJS.tsx if (document.querySelector('[data-highlight]')) { setLazyLoadHighlightJS(true) } // Important to depend on the current path because the first page you // load, before any client-side navigation, might not need it, but the // consecutive one does. }, [asPath]) // Scrollable code blocks in our REST API docs and elsewhere aren't accessible // via keyboard navigation without setting tabindex="0". But we don't want to set // this attribute on every `
` code block, only the ones where there are scroll
  // bars because the content isn't all visible.
  useEffect(() => {
    const codeBlocks = document.querySelectorAll('pre')

    codeBlocks.forEach((codeBlock) => {
      if (
        codeBlock.scrollWidth > codeBlock.clientWidth ||
        codeBlock.scrollHeight > codeBlock.clientHeight
      ) {
        codeBlock.setAttribute('tabindex', '0')
      }
    })
  }, [])

  return (
    
      {/* Doesn't matter *where* this is included because it will
      never render anything. It always just return null. */}
      {loadClientsideRedirectExceptions && }

      {/* Doesn't matter *where* this is included because it will
      never render anything. It always just return null. */}
      {lazyLoadHighlightJS && }

      
{title}} intro={ <> {contributor && (

{t('contributor_callout')} {contributor.name}.

)} {intro && ( {intro} )} {permissions && (
)} {includesPlatformSpecificContent && } {includesToolSpecificContent && } {product && ( )} } toc={ <> {!!interactiveAlternatives[currentPath] && (
Try the new interactive article
)} {miniTocItems.length > 1 && ( <> {t('miniToc')} { return { key: title + i, text: title, renderItem: () =>
    {renderTocItem(items)}
, } })} /> )} } >
{renderedContent} {effectiveDate && (
Effective as of:{' '}
)}
{currentLearningTrack?.trackName ? (
) : null}
) }