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.

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

Jump to bottom

fix(theme): make Prism code block language / additionalLanguages case insensitive #9183

Merged
merged 11 commits into from
Aug 10, 2023
Merged

fix(theme): make Prism code block language / additionalLanguages case insensitive #9183

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
4a90ad4
add toLowerCase()
heysujal Jul 28, 2023
39088f8
add test code block for good/bad prism language case
heysujal Jul 28, 2023
e95bea7
Merge branch 'facebook:main' into case-agnostic-highlight
heysujal Jul 28, 2023
194f14f
add PR link
heysujal Jul 28, 2023
66aa971
add pHp in additionalLanguages
heysujal Jul 28, 2023
d50265d
add more test code blocks
heysujal Jul 28, 2023
c16a1e4
Merge branch 'facebook:main' into case-agnostic-highlight
heysujal Aug 8, 2023
f86aab4
Add php title to code blocks, easier to debug
slorber Aug 10, 2023
d4ca2b9
Revert changes
slorber Aug 10, 2023
3f07aab
Normalize theme prism languages to lowercase
slorber Aug 10, 2023
5420c57
empty
slorber Aug 10, 2023
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
10 changes: 8 additions & 2 deletions packages/docusaurus-theme-classic/src/__tests__/options.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@ describe('themeConfig', () => {
prism: {
theme,
darkTheme,
defaultLanguage: 'javascript',
additionalLanguages: ['kotlin', 'java'],
defaultLanguage: 'javaSCRIPT',
additionalLanguages: ['koTLin', 'jaVa'],
magicComments: [
{
className: 'theme-code-block-highlighted-line',
Expand Down Expand Up @@ -126,6 +126,12 @@ describe('themeConfig', () => {
expect(testValidateThemeConfig(userConfig)).toEqual({
...DEFAULT_CONFIG,
...userConfig,
prism: {
...userConfig.prism,
// Modified/normalized values
defaultLanguage: 'javascript',
additionalLanguages: ['kotlin', 'java'],
},
});
});

Expand Down
8 changes: 6 additions & 2 deletions packages/docusaurus-theme-classic/src/options.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -313,6 +313,10 @@ const LogoSchema = Joi.object({
className: Joi.string(),
});

// Normalize prism language to lowercase
// See https://github.com/facebook/docusaurus/issues/9012
const PrismLanguage = Joi.string().custom((val) => val.toLowerCase());

export const ThemeConfigSchema = Joi.object<ThemeConfig>({
// TODO temporary (@alpha-58)
// @ts-expect-error: forbidden
Expand Down Expand Up @@ -385,9 +389,9 @@ export const ThemeConfigSchema = Joi.object<ThemeConfig>({
plain: Joi.alternatives().try(Joi.array(), Joi.object()).required(),
styles: Joi.alternatives().try(Joi.array(), Joi.object()).required(),
}),
defaultLanguage: Joi.string(),
defaultLanguage: PrismLanguage,
additionalLanguages: Joi.array()
.items(Joi.string())
.items(PrismLanguage)
.default(DEFAULT_CONFIG.prism.additionalLanguages),
magicComments: Joi.array()
.items(
Expand Down
13 changes: 11 additions & 2 deletions packages/docusaurus-theme-classic/src/theme/CodeBlock/Content/String.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,13 @@ import type {Props} from '@theme/CodeBlock/Content/String';

import styles from './styles.module.css';

// Prism languages are always lowercase
// We want to fail-safe and allow both "php" and "PHP"
// See https://github.com/facebook/docusaurus/issues/9012
function normalizeLanguage(language: string | undefined): string | undefined {
return language?.toLowerCase();
}

export default function CodeBlockString({
children,
className: blockClassName = '',
Expand All @@ -35,8 +42,10 @@ export default function CodeBlockString({
const {
prism: {defaultLanguage, magicComments},
} = useThemeConfig();
const language =
languageProp ?? parseLanguage(blockClassName) ?? defaultLanguage;
const language = normalizeLanguage(
languageProp ?? parseLanguage(blockClassName) ?? defaultLanguage,
);

const prismTheme = usePrismTheme();
const wordWrap = useCodeWordWrap();

Expand Down
35 changes: 35 additions & 0 deletions website/_dogfooding/_pages tests/code-block-tests.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,41 @@ See:
- https://github.com/facebook/docusaurus/pull/3749
- https://github.com/facebook/docusaurus/pull/6177

## Code block prism language tests

Code block with/without the good prism language case(lower or upper) in `additionalLanguages[]`

```php title="php"
<?php
$x=15;
$y=30;
$z=$x+$y;
echo "Sum: ",$z;
?>
```

```PHP title="PHP"
<?php
$x=15;
$y=30;
$z=$x+$y;
echo "Sum: ",$z;
?>
```

```pHp title="pHp"
<?php
$x=15;
$y=30;
$z=$x+$y;
echo "Sum: ",$z;
?>
```

See:

- https://github.com/facebook/docusaurus/pull/9183

## `pre`

### `pre > string`
Expand Down
2 changes: 1 addition & 1 deletion website/docusaurus.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -461,7 +461,7 @@ module.exports = async function createConfigAsync() {
content: `⭐️ If you like Docusaurus, give it a star on <a target="_blank" rel="noopener noreferrer" href="https://github.com/facebook/docusaurus">GitHub</a> and follow us on <a target="_blank" rel="noopener noreferrer" href="https://twitter.com/docusaurus">Twitter ${TwitterSvg}</a>`,
},
prism: {
additionalLanguages: ['java', 'latex'],
additionalLanguages: ['java', 'latex', 'PHp'],
magicComments: [
{
className: 'theme-code-block-highlighted-line',
Expand Down
Loading