diff --git a/.cspell.json b/.cspell.json
index 92f8bf1dfb..ba31d09cfd 100644
--- a/.cspell.json
+++ b/.cspell.json
@@ -21,12 +21,11 @@
],
"ignorePaths": [
"CHANGELOG.md",
- "examples",
"packages/docusaurus-theme-translations/locales",
- "__tests__",
"package.json",
"yarn.lock",
"project-words.txt",
+ "__snapshots__",
"website/src/data/users.tsx",
"website/src/data/tweets.tsx",
"*.xyz",
diff --git a/__tests__/validate-package-json.test.ts b/__tests__/validate-package-json.test.ts
index 23b81e4f27..b4bdd9a8b9 100644
--- a/__tests__/validate-package-json.test.ts
+++ b/__tests__/validate-package-json.test.ts
@@ -47,7 +47,7 @@ describe('packages', () => {
/*
If a package starts with @, if won't be published to public npm registry
- without an additional publishConfig.acces: "public" config
+ without an additional publishConfig.access: "public" config
This will make you publish an incomplete list of Docusaurus packages
when trying to release with lerna-publish
*/
diff --git a/packages/docusaurus-logger/src/__tests__/index.test.ts b/packages/docusaurus-logger/src/__tests__/index.test.ts
index e564fc2bb1..ba7ecfbebc 100644
--- a/packages/docusaurus-logger/src/__tests__/index.test.ts
+++ b/packages/docusaurus-logger/src/__tests__/index.test.ts
@@ -10,6 +10,7 @@ import logger from '../index';
describe('formatters', () => {
it('path', () => {
+ // cSpell:ignore mhey
expect(logger.path('hey')).toMatchInlineSnapshot(`"[36m[4mhey[24m[39m"`);
});
it('id', () => {
@@ -39,6 +40,7 @@ describe('interpolate', () => {
expect(
logger.interpolate`The package at path=${'packages/docusaurus'} has number=${10} files. name=${'Babel'} is exported here subdue=${'(as a preset)'} that you can with code=${"require.resolve('@docusaurus/core/lib/babel/preset')"}`,
).toMatchInlineSnapshot(
+ // cSpell:ignore mpackages
`"The package at [36m[4mpackages/docusaurus[24m[39m has [33m10[39m files. [34m[1mBabel[22m[39m is exported here [90m(as a preset)[39m that you can with [36m\`require.resolve('@docusaurus/core/lib/babel/preset')\`[39m"`,
);
});
diff --git a/packages/docusaurus-mdx-loader/src/remark/headings/__tests__/index.test.ts b/packages/docusaurus-mdx-loader/src/remark/headings/__tests__/index.test.ts
index 371080d273..2f9683e6e8 100644
--- a/packages/docusaurus-mdx-loader/src/remark/headings/__tests__/index.test.ts
+++ b/packages/docusaurus-mdx-loader/src/remark/headings/__tests__/index.test.ts
@@ -199,7 +199,9 @@ describe('headings remark plugin', () => {
const expected = u('root', [
heading('I ♥ unicode', 'i--unicode'),
heading('Dash-dash', 'dash-dash'),
+ // cSpell:ignore endash
heading('en–dash', 'endash'),
+ // cSpell:ignore emdash
heading('em–dash', 'emdash'),
heading('😄 unicode emoji', '-unicode-emoji'),
heading('😄-😄 unicode emoji', '--unicode-emoji'),
@@ -214,6 +216,7 @@ describe('headings remark plugin', () => {
heading(':ok_hand: Single', 'ok_hand-single'),
heading(
':ok_hand::hatched_chick: Two in a row with no spaces',
+ // cSpell:ignore handhatched
'ok_handhatched_chick-two-in-a-row-with-no-spaces',
),
heading(
@@ -251,11 +254,11 @@ describe('headings remark plugin', () => {
## Heading Two {#custom-heading-two}
-# With *Bold* {#custom-withbold}
+# With *Bold* {#custom-with-bold}
-# With *Bold* hello{#custom-withbold-hello}
+# With *Bold* hello{#custom-with-bold-hello}
-# With *Bold* hello2 {#custom-withbold-hello2}
+# With *Bold* hello2 {#custom-with-bold-hello2}
# Snake-cased ID {#this_is_custom_id}
@@ -281,15 +284,15 @@ describe('headings remark plugin', () => {
text: 'Heading Two',
},
{
- id: 'custom-withbold',
+ id: 'custom-with-bold',
text: 'With Bold',
},
{
- id: 'custom-withbold-hello',
+ id: 'custom-with-bold-hello',
text: 'With Bold hello',
},
{
- id: 'custom-withbold-hello2',
+ id: 'custom-with-bold-hello2',
text: 'With Bold hello2',
},
{
diff --git a/packages/docusaurus-mdx-loader/src/remark/transformLinks/__tests__/__fixtures__/asset.md b/packages/docusaurus-mdx-loader/src/remark/transformLinks/__tests__/__fixtures__/asset.md
index 407c853eb1..a23a16a928 100644
--- a/packages/docusaurus-mdx-loader/src/remark/transformLinks/__tests__/__fixtures__/asset.md
+++ b/packages/docusaurus-mdx-loader/src/remark/transformLinks/__tests__/__fixtures__/asset.md
@@ -40,4 +40,4 @@
[json](./data.json)
-[static json](/staticjson.json)
+[static json](/static-json.json)
diff --git a/packages/docusaurus-mdx-loader/src/remark/transformLinks/__tests__/__fixtures__/static/staticjson.json b/packages/docusaurus-mdx-loader/src/remark/transformLinks/__tests__/__fixtures__/static/static-json.json
similarity index 100%
rename from packages/docusaurus-mdx-loader/src/remark/transformLinks/__tests__/__fixtures__/static/staticjson.json
rename to packages/docusaurus-mdx-loader/src/remark/transformLinks/__tests__/__fixtures__/static/static-json.json
diff --git a/packages/docusaurus-mdx-loader/src/remark/transformLinks/__tests__/__snapshots__/index.test.ts.snap b/packages/docusaurus-mdx-loader/src/remark/transformLinks/__tests__/__snapshots__/index.test.ts.snap
index 1c27e176dc..baa694b156 100644
--- a/packages/docusaurus-mdx-loader/src/remark/transformLinks/__tests__/__snapshots__/index.test.ts.snap
+++ b/packages/docusaurus-mdx-loader/src/remark/transformLinks/__tests__/__snapshots__/index.test.ts.snap
@@ -52,6 +52,6 @@ exports[`transformAsset plugin transform md links to 1`] = `
/node_modules/file-loader/dist/cjs.js?name=assets/files/[name]-[contenthash].[ext]!./data.json').default}>json
-/node_modules/file-loader/dist/cjs.js?name=assets/files/[name]-[contenthash].[ext]!./static/staticjson.json').default}>static json
+/node_modules/file-loader/dist/cjs.js?name=assets/files/[name]-[contenthash].[ext]!./static/static-json.json').default}>static json
"
`;
diff --git a/packages/docusaurus-migrate/src/__tests__/frontMatter.test.ts b/packages/docusaurus-migrate/src/__tests__/frontMatter.test.ts
index 35de9e01cb..c75d885f34 100644
--- a/packages/docusaurus-migrate/src/__tests__/frontMatter.test.ts
+++ b/packages/docusaurus-migrate/src/__tests__/frontMatter.test.ts
@@ -13,6 +13,7 @@ describe('shouldQuotifyFrontMatter', () => {
expect(
shouldQuotifyFrontMatter([
'title',
+ // cSpell:ignore sàáâãäåçèéêëìíîïðòóôõöùúûüýÿ
"Some title front matter with allowed special chars like sàáâãäåçèéêëìíîïðòóôõöùúûüýÿ!;,=+-_?'`&#()[]§%€$",
]),
).toBe(false);
diff --git a/packages/docusaurus-plugin-client-redirects/src/__tests__/__snapshots__/redirectValidation.test.ts.snap b/packages/docusaurus-plugin-client-redirects/src/__tests__/__snapshots__/redirectValidation.test.ts.snap
index 62b3059d0e..0153b77a23 100644
--- a/packages/docusaurus-plugin-client-redirects/src/__tests__/__snapshots__/redirectValidation.test.ts.snap
+++ b/packages/docusaurus-plugin-client-redirects/src/__tests__/__snapshots__/redirectValidation.test.ts.snap
@@ -8,4 +8,4 @@ exports[`validateRedirect throw for bad redirects 3`] = `"{\\"from\\":\\"/fromSo
exports[`validateRedirect throw for bad redirects 4`] = `"{\\"from\\":null,\\"to\\":\\"/toSomePath?queryString=xyz\\"} => Validation error: \\"from\\" must be a string"`;
-exports[`validateRedirect throw for bad redirects 5`] = `"{\\"from\\":[\\"heyho\\"],\\"to\\":\\"/toSomePath?queryString=xyz\\"} => Validation error: \\"from\\" must be a string"`;
+exports[`validateRedirect throw for bad redirects 5`] = `"{\\"from\\":[\\"hey\\"],\\"to\\":\\"/toSomePath?queryString=xyz\\"} => Validation error: \\"from\\" must be a string"`;
diff --git a/packages/docusaurus-plugin-client-redirects/src/__tests__/collectRedirects.test.ts b/packages/docusaurus-plugin-client-redirects/src/__tests__/collectRedirects.test.ts
index e1f24e5949..2b7d12f1aa 100644
--- a/packages/docusaurus-plugin-client-redirects/src/__tests__/collectRedirects.test.ts
+++ b/packages/docusaurus-plugin-client-redirects/src/__tests__/collectRedirects.test.ts
@@ -226,7 +226,7 @@ describe('collectRedirects', () => {
`${removeTrailingSlash(routePath)}/some/other/path/suffix2`,
],
},
- ['/', '/testpath', '/otherPath.html'],
+ ['/', '/testPath', '/otherPath.html'],
),
undefined,
),
@@ -241,12 +241,12 @@ describe('collectRedirects', () => {
},
{
- from: '/testpath/some/path/suffix1',
- to: '/testpath',
+ from: '/testPath/some/path/suffix1',
+ to: '/testPath',
},
{
- from: '/testpath/some/other/path/suffix2',
- to: '/testpath',
+ from: '/testPath/some/other/path/suffix2',
+ to: '/testPath',
},
{
@@ -272,7 +272,7 @@ describe('collectRedirects', () => {
return undefined;
},
},
- ['/', '/testpath', '/otherPath.html'],
+ ['/', '/testPath', '/otherPath.html'],
),
undefined,
),
diff --git a/packages/docusaurus-plugin-client-redirects/src/__tests__/redirectValidation.test.ts b/packages/docusaurus-plugin-client-redirects/src/__tests__/redirectValidation.test.ts
index 727fd11842..2d357985ba 100644
--- a/packages/docusaurus-plugin-client-redirects/src/__tests__/redirectValidation.test.ts
+++ b/packages/docusaurus-plugin-client-redirects/src/__tests__/redirectValidation.test.ts
@@ -60,7 +60,7 @@ describe('validateRedirect', () => {
expect(() =>
validateRedirect({
- from: ['heyho'] as unknown as string,
+ from: ['hey'] as unknown as string,
to: '/toSomePath?queryString=xyz',
}),
).toThrowErrorMatchingSnapshot();
diff --git a/packages/docusaurus-plugin-content-blog/src/__tests__/__snapshots__/pluginOptionSchema.test.ts.snap b/packages/docusaurus-plugin-content-blog/src/__tests__/__snapshots__/pluginOptionSchema.test.ts.snap
index dd55a4cd1d..c598236fd0 100644
--- a/packages/docusaurus-plugin-content-blog/src/__tests__/__snapshots__/pluginOptionSchema.test.ts.snap
+++ b/packages/docusaurus-plugin-content-blog/src/__tests__/__snapshots__/pluginOptionSchema.test.ts.snap
@@ -1,5 +1,5 @@
// Jest Snapshot v1, https://goo.gl/fbAQLP
-exports[`blog plugin options schema throws Error in case of invalid feedtype 1`] = `[ValidationError: "feedOptions.type" does not match any of the allowed types]`;
+exports[`blog plugin options schema throws Error in case of invalid feed type 1`] = `[ValidationError: "feedOptions.type" does not match any of the allowed types]`;
exports[`blog plugin options schema throws Error in case of invalid options 1`] = `[ValidationError: "postsPerPage" must be greater than or equal to 1]`;
diff --git a/packages/docusaurus-plugin-content-blog/src/__tests__/blogFrontMatter.test.ts b/packages/docusaurus-plugin-content-blog/src/__tests__/blogFrontMatter.test.ts
index 7622034b09..b8d7d9047f 100644
--- a/packages/docusaurus-plugin-content-blog/src/__tests__/blogFrontMatter.test.ts
+++ b/packages/docusaurus-plugin-content-blog/src/__tests__/blogFrontMatter.test.ts
@@ -15,7 +15,7 @@ function testField(params: {
fieldName: keyof BlogPostFrontMatter;
validFrontMatters: BlogPostFrontMatter[];
convertibleFrontMatter?: [
- ConvertableFrontMatter: Record,
+ ConvertibleFrontMatter: Record,
ConvertedFrontMatter: BlogPostFrontMatter,
][];
invalidFrontMatters?: [
diff --git a/packages/docusaurus-plugin-content-blog/src/__tests__/blogUtils.test.ts b/packages/docusaurus-plugin-content-blog/src/__tests__/blogUtils.test.ts
index 027979ba52..c7d638771c 100644
--- a/packages/docusaurus-plugin-content-blog/src/__tests__/blogUtils.test.ts
+++ b/packages/docusaurus-plugin-content-blog/src/__tests__/blogUtils.test.ts
@@ -74,16 +74,16 @@ const transform = async (
describe('truncate', () => {
it('truncates texts', () => {
expect(
- truncate('aaa\n\nbbb\nccc', //),
+ truncate('aaa\n\nbbb\n ccc', //),
).toBe('aaa\n');
- expect(truncate('\n\nbbb\nccc', //)).toBe(
- '\n',
- );
+ expect(
+ truncate('\n\nbbb\n ccc', //),
+ ).toBe('\n');
});
it('leaves texts without markers', () => {
- expect(truncate('aaa\nbbb\nccc', //)).toBe(
- 'aaa\nbbb\nccc',
+ expect(truncate('aaa\nbbb\n ccc', //)).toBe(
+ 'aaa\nbbb\n ccc',
);
expect(truncate('', //)).toBe('');
});
@@ -165,12 +165,12 @@ describe('parseBlogFileName', () => {
it('parses nested folder tree respecting date convention', () => {
expect(
parseBlogFileName(
- '2021/05/12/announcing-docusaurus-two-beta/subfolder/subfile.md',
+ '2021/05/12/announcing-docusaurus-two-beta/subfolder/file.md',
),
).toEqual({
date: new Date('2021-05-12Z'),
- text: 'announcing-docusaurus-two-beta/subfolder/subfile',
- slug: '/2021/05/12/announcing-docusaurus-two-beta/subfolder/subfile',
+ text: 'announcing-docusaurus-two-beta/subfolder/file',
+ slug: '/2021/05/12/announcing-docusaurus-two-beta/subfolder/file',
});
});
diff --git a/packages/docusaurus-plugin-content-blog/src/__tests__/pluginOptionSchema.test.ts b/packages/docusaurus-plugin-content-blog/src/__tests__/pluginOptionSchema.test.ts
index 49fa16a21f..5aa55c3535 100644
--- a/packages/docusaurus-plugin-content-blog/src/__tests__/pluginOptionSchema.test.ts
+++ b/packages/docusaurus-plugin-content-blog/src/__tests__/pluginOptionSchema.test.ts
@@ -63,7 +63,7 @@ describe('blog plugin options schema', () => {
expect(error).toMatchSnapshot();
});
- it('throws Error in case of invalid feedtype', () => {
+ it('throws Error in case of invalid feed type', () => {
const {error} = PluginOptionSchema.validate({
feedOptions: {
type: 'none',
diff --git a/packages/docusaurus-plugin-content-docs/src/__tests__/__fixtures__/simple-site/docs/foo/baz.md b/packages/docusaurus-plugin-content-docs/src/__tests__/__fixtures__/simple-site/docs/foo/baz.md
index 95d0486704..3407ccd1b0 100644
--- a/packages/docusaurus-plugin-content-docs/src/__tests__/__fixtures__/simple-site/docs/foo/baz.md
+++ b/packages/docusaurus-plugin-content-docs/src/__tests__/__fixtures__/simple-site/docs/foo/baz.md
@@ -70,6 +70,6 @@ Term 2 ~ Definition 2a ~ Definition 2b
This is HTML abbreviation example.
-It converts "HTML", but keep intact partial entries like "xxxHTMLyyy" and so on.
+It converts "HTML", but keep intact partial entries like "xxxHTMLxxx" and so on.
\*[HTML]: Hyper Text Markup Language
diff --git a/packages/docusaurus-plugin-content-docs/src/__tests__/__fixtures__/simple-site/wrong-sidebars.json b/packages/docusaurus-plugin-content-docs/src/__tests__/__fixtures__/simple-site/wrong-sidebars.json
index 6f56ce2c0b..37dd625354 100644
--- a/packages/docusaurus-plugin-content-docs/src/__tests__/__fixtures__/simple-site/wrong-sidebars.json
+++ b/packages/docusaurus-plugin-content-docs/src/__tests__/__fixtures__/simple-site/wrong-sidebars.json
@@ -1,7 +1,7 @@
{
"docs": {
"Test": [
- "goku"
+ "nonExistent"
]
}
}
diff --git a/packages/docusaurus-plugin-content-docs/src/__tests__/__snapshots__/index.test.ts.snap b/packages/docusaurus-plugin-content-docs/src/__tests__/__snapshots__/index.test.ts.snap
index 7e1365f46d..11e6478de7 100644
--- a/packages/docusaurus-plugin-content-docs/src/__tests__/__snapshots__/index.test.ts.snap
+++ b/packages/docusaurus-plugin-content-docs/src/__tests__/__snapshots__/index.test.ts.snap
@@ -19,7 +19,7 @@ Object {
exports[`sidebar site with wrong sidebar content 1`] = `
"Invalid sidebar file at \\"packages/docusaurus-plugin-content-docs/src/__tests__/__fixtures__/simple-site/wrong-sidebars.json\\".
These sidebar document ids do not exist:
-- goku
+- nonExistent
Available document ids are:
- doc with space
diff --git a/packages/docusaurus-plugin-content-docs/src/__tests__/docFrontMatter.test.ts b/packages/docusaurus-plugin-content-docs/src/__tests__/docFrontMatter.test.ts
index 727861d7d6..5f8aa9d787 100644
--- a/packages/docusaurus-plugin-content-docs/src/__tests__/docFrontMatter.test.ts
+++ b/packages/docusaurus-plugin-content-docs/src/__tests__/docFrontMatter.test.ts
@@ -13,7 +13,7 @@ function testField(params: {
prefix: string;
validFrontMatters: DocFrontMatter[];
convertibleFrontMatter?: [
- ConvertableFrontMatter: Record,
+ ConvertibleFrontMatter: Record,
ConvertedFrontMatter: DocFrontMatter,
][];
invalidFrontMatters?: [
diff --git a/packages/docusaurus-plugin-content-docs/src/__tests__/docs.test.ts b/packages/docusaurus-plugin-content-docs/src/__tests__/docs.test.ts
index 1fcffb05e7..eed15f0576 100644
--- a/packages/docusaurus-plugin-content-docs/src/__tests__/docs.test.ts
+++ b/packages/docusaurus-plugin-content-docs/src/__tests__/docs.test.ts
@@ -502,14 +502,14 @@ describe('simple site', () => {
const docs = await readVersionDocs(versionsMetadata[0], options);
docs.push(
createFakeDocFile({
- source: 'hehe',
+ source: 'bad',
frontMatter: {pagination_prev: 'nonexistent'},
}),
);
await expect(
defaultTestUtils.generateNavigation(docs),
).rejects.toThrowErrorMatchingInlineSnapshot(
- `"Error when loading hehe in .: the pagination_prev front matter points to a non-existent ID nonexistent."`,
+ `"Error when loading bad in .: the pagination_prev front matter points to a non-existent ID nonexistent."`,
);
});
});
diff --git a/packages/docusaurus-plugin-content-docs/src/__tests__/index.test.ts b/packages/docusaurus-plugin-content-docs/src/__tests__/index.test.ts
index b2e1ed440e..4d62b47700 100644
--- a/packages/docusaurus-plugin-content-docs/src/__tests__/index.test.ts
+++ b/packages/docusaurus-plugin-content-docs/src/__tests__/index.test.ts
@@ -201,15 +201,11 @@ describe('empty/no docs website', () => {
pluginContentDocs(
context,
normalizePluginOptions(OptionsSchema, {
- path: `path/doesnt/exist`,
+ path: `path/does/not/exist`,
}),
),
- ).rejects.toThrowError(
- `The docs folder does not exist for version "current". A docs folder is expected to be found at ${
- process.platform === 'win32'
- ? 'path\\doesnt\\exist'
- : 'path/doesnt/exist'
- }.`,
+ ).rejects.toThrowErrorMatchingInlineSnapshot(
+ `"The docs folder does not exist for version \\"current\\". A docs folder is expected to be found at path/does/not/exist."`,
);
});
});
diff --git a/packages/docusaurus-plugin-content-docs/src/__tests__/slug.test.ts b/packages/docusaurus-plugin-content-docs/src/__tests__/slug.test.ts
index eed2abde2c..f9f774b693 100644
--- a/packages/docusaurus-plugin-content-docs/src/__tests__/slug.test.ts
+++ b/packages/docusaurus-plugin-content-docs/src/__tests__/slug.test.ts
@@ -167,11 +167,11 @@ describe('getSlug', () => {
expect(
getSlug({
baseID: 'any',
- source: '@site/docs/unslashedDir/doc.md',
- sourceDirName: 'unslashedDir',
+ source: '@site/docs/nonSlashedDir/doc.md',
+ sourceDirName: 'nonSlashedDir',
frontMatterSlug: 'abc/def',
}),
- ).toBe('/unslashedDir/abc/def');
+ ).toBe('/nonSlashedDir/abc/def');
expect(
getSlug({
baseID: 'any',
@@ -207,7 +207,7 @@ describe('getSlug', () => {
expect(
getSlug({
baseID: 'any',
- source: '@site/docs/dir/subdirdoc.md',
+ source: '@site/docs/dir/subdirDoc.md',
sourceDirName: '/dir/subdir',
frontMatterSlug: '../../../../../abc/../def',
}),
diff --git a/packages/docusaurus-plugin-content-docs/src/__tests__/versions.test.ts b/packages/docusaurus-plugin-content-docs/src/__tests__/versions.test.ts
index 1da8d27514..9a4aacb873 100644
--- a/packages/docusaurus-plugin-content-docs/src/__tests__/versions.test.ts
+++ b/packages/docusaurus-plugin-content-docs/src/__tests__/versions.test.ts
@@ -290,7 +290,7 @@ describe('versioned site, pluginId=default', () => {
versionClassName: 'docs-version-1.0.0',
};
- const vwithSlugs: VersionMetadata = {
+ const vWithSlugs: VersionMetadata = {
contentPath: path.join(
versionedSiteDir,
'versioned_docs/version-withSlugs',
@@ -321,12 +321,12 @@ describe('versioned site, pluginId=default', () => {
vCurrent,
v101,
v100,
- vwithSlugs,
+ vWithSlugs,
};
}
it('readVersionsMetadata versioned site', async () => {
- const {defaultOptions, defaultContext, vCurrent, v101, v100, vwithSlugs} =
+ const {defaultOptions, defaultContext, vCurrent, v101, v100, vWithSlugs} =
await loadSite();
const versionsMetadata = await readVersionsMetadata({
@@ -334,11 +334,11 @@ describe('versioned site, pluginId=default', () => {
context: defaultContext,
});
- expect(versionsMetadata).toEqual([vCurrent, v101, v100, vwithSlugs]);
+ expect(versionsMetadata).toEqual([vCurrent, v101, v100, vWithSlugs]);
});
it('readVersionsMetadata versioned site with includeCurrentVersion=false', async () => {
- const {defaultOptions, defaultContext, v101, v100, vwithSlugs} =
+ const {defaultOptions, defaultContext, v101, v100, vWithSlugs} =
await loadSite();
const versionsMetadata = await readVersionsMetadata({
@@ -350,12 +350,12 @@ describe('versioned site, pluginId=default', () => {
// vCurrent removed
v101,
v100,
- vwithSlugs,
+ vWithSlugs,
]);
});
it('readVersionsMetadata versioned site with version options', async () => {
- const {defaultOptions, defaultContext, vCurrent, v101, v100, vwithSlugs} =
+ const {defaultOptions, defaultContext, vCurrent, v101, v100, vWithSlugs} =
await loadSite();
const versionsMetadata = await readVersionsMetadata({
@@ -404,12 +404,12 @@ describe('versioned site, pluginId=default', () => {
versionPath: '/docs',
versionBanner: 'unreleased',
},
- vwithSlugs,
+ vWithSlugs,
]);
});
it('readVersionsMetadata versioned site with editUrl', async () => {
- const {defaultOptions, defaultContext, vCurrent, v101, v100, vwithSlugs} =
+ const {defaultOptions, defaultContext, vCurrent, v101, v100, vWithSlugs} =
await loadSite();
const versionsMetadata = await readVersionsMetadata({
@@ -443,7 +443,7 @@ describe('versioned site, pluginId=default', () => {
'https://github.com/facebook/docusaurus/edit/main/website/i18n/en/docusaurus-plugin-content-docs/version-1.0.0',
},
{
- ...vwithSlugs,
+ ...vWithSlugs,
versionEditUrl:
'https://github.com/facebook/docusaurus/edit/main/website/versioned_docs/version-withSlugs',
versionEditUrlLocalized:
@@ -453,7 +453,7 @@ describe('versioned site, pluginId=default', () => {
});
it('readVersionsMetadata versioned site with editUrl and editCurrentVersion=true', async () => {
- const {defaultOptions, defaultContext, vCurrent, v101, v100, vwithSlugs} =
+ const {defaultOptions, defaultContext, vCurrent, v101, v100, vWithSlugs} =
await loadSite();
const versionsMetadata = await readVersionsMetadata({
@@ -488,7 +488,7 @@ describe('versioned site, pluginId=default', () => {
'https://github.com/facebook/docusaurus/edit/main/website/i18n/en/docusaurus-plugin-content-docs/current',
},
{
- ...vwithSlugs,
+ ...vWithSlugs,
versionEditUrl:
'https://github.com/facebook/docusaurus/edit/main/website/docs',
versionEditUrlLocalized:
@@ -498,18 +498,18 @@ describe('versioned site, pluginId=default', () => {
});
it('readVersionsMetadata versioned site with onlyIncludeVersions option', async () => {
- const {defaultOptions, defaultContext, v101, vwithSlugs} = await loadSite();
+ const {defaultOptions, defaultContext, v101, vWithSlugs} = await loadSite();
const versionsMetadata = await readVersionsMetadata({
options: {
...defaultOptions,
// Order reversed on purpose: should not have any impact
- onlyIncludeVersions: [vwithSlugs.versionName, v101.versionName],
+ onlyIncludeVersions: [vWithSlugs.versionName, v101.versionName],
},
context: defaultContext,
});
- expect(versionsMetadata).toEqual([v101, vwithSlugs]);
+ expect(versionsMetadata).toEqual([v101, vWithSlugs]);
});
it('readVersionsMetadata versioned site with disableVersioning', async () => {
diff --git a/packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/__snapshots__/generator.test.ts.snap b/packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/__snapshots__/generator.test.ts.snap
index 3338aa1cd5..91902a834a 100644
--- a/packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/__snapshots__/generator.test.ts.snap
+++ b/packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/__snapshots__/generator.test.ts.snap
@@ -49,9 +49,9 @@ Array [
],
"label": "SubGuides (metadata file label)",
"link": Object {
- "description": "subguides-description",
- "slug": "subguides-generated-index-slug",
- "title": "subguides-title",
+ "description": "subGuides-description",
+ "slug": "subGuides-generated-index-slug",
+ "title": "subGuides-title",
"type": "generated-index",
},
"type": "category",
diff --git a/packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/generator.test.ts b/packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/generator.test.ts
index 3b383756f2..a80aee0433 100644
--- a/packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/generator.test.ts
+++ b/packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/generator.test.ts
@@ -131,9 +131,9 @@ describe('DefaultSidebarItemsGenerator', () => {
label: 'SubGuides (metadata file label)',
link: {
type: 'generated-index',
- slug: 'subguides-generated-index-slug',
- title: 'subguides-title',
- description: 'subguides-description',
+ slug: 'subGuides-generated-index-slug',
+ title: 'subGuides-title',
+ description: 'subGuides-description',
},
},
},
diff --git a/packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/index.test.ts b/packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/index.test.ts
index 89fc1696cb..b57a044bae 100644
--- a/packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/index.test.ts
+++ b/packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/index.test.ts
@@ -43,7 +43,7 @@ describe('loadSidebars', () => {
expect(result).toMatchSnapshot();
});
- it('sidebars shorthand and longform lead to exact same sidebar', async () => {
+ it('sidebars shorthand and longhand lead to exact same sidebar', async () => {
const sidebarPath1 = path.join(fixtureDir, 'sidebars-category.js');
const sidebarPath2 = path.join(
fixtureDir,
@@ -81,8 +81,8 @@ describe('loadSidebars', () => {
expect(result).toMatchSnapshot();
});
- it('unexisting path', async () => {
- await expect(loadSidebars('badpath', params)).resolves.toEqual(
+ it('nonexistent path', async () => {
+ await expect(loadSidebars('bad/path', params)).resolves.toEqual(
DisabledSidebars,
);
});
diff --git a/packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/normalization.test.ts b/packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/normalization.test.ts
index 3dcf930be0..66a27886d0 100644
--- a/packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/normalization.test.ts
+++ b/packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/normalization.test.ts
@@ -83,6 +83,7 @@ describe('normalization', () => {
sidebar: 'item',
}),
).toThrowErrorMatchingInlineSnapshot(
+ // cSpell:ignore msidebar
`"Invalid sidebar items collection [36m\`\\"item\\"\`[39m in sidebar [34m[1msidebar[22m[39m: it must either be an array of sidebar items or a shorthand notation (which doesn't contain a [36m\`type\`[39m property). See [36m[4mhttps://docusaurus.io/docs/sidebar/items[24m[39m for all valid syntaxes."`,
);
});
diff --git a/packages/docusaurus-plugin-sitemap/src/__tests__/createSitemap.test.ts b/packages/docusaurus-plugin-sitemap/src/__tests__/createSitemap.test.ts
index 3c3fa1172f..c041bff79b 100644
--- a/packages/docusaurus-plugin-sitemap/src/__tests__/createSitemap.test.ts
+++ b/packages/docusaurus-plugin-sitemap/src/__tests__/createSitemap.test.ts
@@ -38,7 +38,7 @@ describe('createSitemap', () => {
{
url: 'https://example.com',
} as DocusaurusConfig,
- ['/', '/404.html', '/mypage'],
+ ['/', '/404.html', '/my-page'],
{
changefreq: EnumChangefreq.DAILY,
priority: 0.7,
diff --git a/packages/docusaurus-remark-plugin-npm2yarn/src/__tests__/__snapshots__/index.test.ts.snap b/packages/docusaurus-remark-plugin-npm2yarn/src/__tests__/__snapshots__/index.test.ts.snap
index 82db48b367..9b3a2be47c 100644
--- a/packages/docusaurus-remark-plugin-npm2yarn/src/__tests__/__snapshots__/index.test.ts.snap
+++ b/packages/docusaurus-remark-plugin-npm2yarn/src/__tests__/__snapshots__/index.test.ts.snap
@@ -24,7 +24,7 @@ import TabItem from '@theme/TabItem';
"
`;
-exports[`npm2yarn plugin tdoes not re-import tabs components when already imported below 1`] = `
+exports[`npm2yarn plugin does not re-import tabs components when already imported below 1`] = `
"
diff --git a/packages/docusaurus-remark-plugin-npm2yarn/src/__tests__/index.test.ts b/packages/docusaurus-remark-plugin-npm2yarn/src/__tests__/index.test.ts
index c33e7452cc..c8425b874f 100644
--- a/packages/docusaurus-remark-plugin-npm2yarn/src/__tests__/index.test.ts
+++ b/packages/docusaurus-remark-plugin-npm2yarn/src/__tests__/index.test.ts
@@ -49,7 +49,7 @@ describe('npm2yarn plugin', () => {
expect(result).toMatchSnapshot();
});
- it('tdoes not re-import tabs components when already imported below', async () => {
+ it('does not re-import tabs components when already imported below', async () => {
const result = await processFixture('import-tabs-below');
expect(result).toMatchSnapshot();
diff --git a/packages/docusaurus-theme-classic/src/__tests__/validateThemeConfig.test.ts b/packages/docusaurus-theme-classic/src/__tests__/validateThemeConfig.test.ts
index 44cb618bd3..1b0abbe7bb 100644
--- a/packages/docusaurus-theme-classic/src/__tests__/validateThemeConfig.test.ts
+++ b/packages/docusaurus-theme-classic/src/__tests__/validateThemeConfig.test.ts
@@ -38,7 +38,7 @@ describe('themeConfig', () => {
additionalLanguages: ['kotlin', 'java'],
},
announcementBar: {
- id: 'supportus',
+ id: 'supports',
content: 'pls support',
backgroundColor: '#fff',
textColor: '#000',
@@ -206,7 +206,7 @@ describe('themeConfig', () => {
{
type: 'joke',
position: 'left',
- label: 'haha',
+ label: 'hahaha',
},
],
},
diff --git a/packages/docusaurus-theme-common/src/utils/__tests__/__snapshots__/codeBlockUtils.test.ts.snap b/packages/docusaurus-theme-common/src/utils/__tests__/__snapshots__/codeBlockUtils.test.ts.snap
index cf5493e481..40f7d68143 100644
--- a/packages/docusaurus-theme-common/src/utils/__tests__/__snapshots__/codeBlockUtils.test.ts.snap
+++ b/packages/docusaurus-theme-common/src/utils/__tests__/__snapshots__/codeBlockUtils.test.ts.snap
@@ -3,7 +3,7 @@
exports[`parseLines does not parse content with metastring 1`] = `
Object {
"code": "aaaaa
-bbbbb",
+nnnnn",
"highlightLines": Array [
0,
],
diff --git a/packages/docusaurus-theme-common/src/utils/__tests__/codeBlockUtils.test.ts b/packages/docusaurus-theme-common/src/utils/__tests__/codeBlockUtils.test.ts
index efc84c6de6..bc4e77b0d1 100644
--- a/packages/docusaurus-theme-common/src/utils/__tests__/codeBlockUtils.test.ts
+++ b/packages/docusaurus-theme-common/src/utils/__tests__/codeBlockUtils.test.ts
@@ -68,7 +68,7 @@ describe('parseLanguage', () => {
describe('parseLines', () => {
it('does not parse content with metastring', () => {
- expect(parseLines('aaaaa\nbbbbb', '{1}', 'js')).toMatchSnapshot();
+ expect(parseLines('aaaaa\nnnnnn', '{1}', 'js')).toMatchSnapshot();
expect(
parseLines(
`// highlight-next-line
diff --git a/packages/docusaurus-theme-common/src/utils/__tests__/docsUtils.test.tsx b/packages/docusaurus-theme-common/src/utils/__tests__/docsUtils.test.tsx
index 04929a76f4..8c76436c9c 100644
--- a/packages/docusaurus-theme-common/src/utils/__tests__/docsUtils.test.tsx
+++ b/packages/docusaurus-theme-common/src/utils/__tests__/docsUtils.test.tsx
@@ -270,7 +270,7 @@ describe('isActiveSidebarItem', () => {
label: 'Label',
};
- expect(isActiveSidebarItem(item, '/unexistingPath')).toBe(false);
+ expect(isActiveSidebarItem(item, '/nonexistentPath')).toBe(false);
expect(isActiveSidebarItem(item, '/itemPath')).toBe(true);
@@ -286,7 +286,7 @@ describe('isActiveSidebarItem', () => {
href: '/itemPath',
});
- expect(isActiveSidebarItem(item, '/unexistingPath')).toBe(false);
+ expect(isActiveSidebarItem(item, '/nonexistentPath')).toBe(false);
expect(isActiveSidebarItem(item, '/itemPath')).toBe(true);
@@ -319,7 +319,7 @@ describe('isActiveSidebarItem', () => {
],
});
- expect(isActiveSidebarItem(item, '/unexistingPath')).toBe(false);
+ expect(isActiveSidebarItem(item, '/nonexistentPath')).toBe(false);
expect(isActiveSidebarItem(item, '/category-path')).toBe(true);
expect(isActiveSidebarItem(item, '/sub-link-path')).toBe(true);
diff --git a/packages/docusaurus-theme-common/src/utils/__tests__/regexpUtils.test.ts b/packages/docusaurus-theme-common/src/utils/__tests__/regexpUtils.test.ts
index 2101c647e9..9d65d74a7a 100644
--- a/packages/docusaurus-theme-common/src/utils/__tests__/regexpUtils.test.ts
+++ b/packages/docusaurus-theme-common/src/utils/__tests__/regexpUtils.test.ts
@@ -13,9 +13,10 @@ describe('isRegexpStringMatch', () => {
expect(isRegexpStringMatch('bar', undefined)).toBe(false);
expect(isRegexpStringMatch('foo', 'bar')).toBe(false);
expect(isRegexpStringMatch('foo', 'foo')).toBe(true);
+ // cSpell:ignore fooooooooooo
expect(isRegexpStringMatch('fooooooooooo', 'foo')).toBe(false);
- expect(isRegexpStringMatch('foo', 'fooooooo')).toBe(true);
- expect(isRegexpStringMatch('f.*o', 'fggo')).toBe(true);
+ expect(isRegexpStringMatch('foo', 'fooooooooooo')).toBe(true);
+ expect(isRegexpStringMatch('f.*o', 'fooooooooooo')).toBe(true);
expect(isRegexpStringMatch('FOO', 'foo')).toBe(true);
});
});
diff --git a/packages/docusaurus-theme-common/src/utils/__tests__/tagUtils.test.ts b/packages/docusaurus-theme-common/src/utils/__tests__/tagUtils.test.ts
index 495adad67b..2de931f7e0 100644
--- a/packages/docusaurus-theme-common/src/utils/__tests__/tagUtils.test.ts
+++ b/packages/docusaurus-theme-common/src/utils/__tests__/tagUtils.test.ts
@@ -24,7 +24,7 @@ describe('listTagsByLetters', () => {
permalink: '/tag2',
count: 11,
};
- const tagzxy: Tag = {
+ const tagZxy: Tag = {
name: 'zxy',
permalink: '/zxy',
count: 987,
@@ -34,34 +34,34 @@ describe('listTagsByLetters', () => {
permalink: '/abc',
count: 123,
};
- const tagdef: Tag = {
+ const tagDef: Tag = {
name: 'def',
permalink: '/def',
count: 1,
};
- const tagaaa: Tag = {
+ const tagAaa: Tag = {
name: 'aaa',
permalink: '/aaa',
count: 10,
};
const expectedResult: Result = [
- {letter: 'A', tags: [tagaaa, tagAbc]},
- {letter: 'D', tags: [tagdef]},
+ {letter: 'A', tags: [tagAaa, tagAbc]},
+ {letter: 'D', tags: [tagDef]},
{letter: 'T', tags: [tag1, tag2]},
- {letter: 'Z', tags: [tagzxy]},
+ {letter: 'Z', tags: [tagZxy]},
];
// Input order shouldn't matter, output is always consistently sorted
expect(
- listTagsByLetters([tag1, tag2, tagzxy, tagAbc, tagdef, tagaaa]),
+ listTagsByLetters([tag1, tag2, tagZxy, tagAbc, tagDef, tagAaa]),
).toEqual(expectedResult);
expect(
- listTagsByLetters([tagzxy, tagdef, tagaaa, tag2, tagAbc, tag1]),
+ listTagsByLetters([tagZxy, tagDef, tagAaa, tag2, tagAbc, tag1]),
).toEqual(expectedResult);
expect(
listTagsByLetters(
- _.shuffle([tagzxy, tagdef, tagaaa, tag2, tagAbc, tag1]),
+ _.shuffle([tagZxy, tagDef, tagAaa, tag2, tagAbc, tag1]),
),
).toEqual(expectedResult);
});
diff --git a/packages/docusaurus-theme-live-codeblock/src/__tests__/validateThemeConfig.test.ts b/packages/docusaurus-theme-live-codeblock/src/__tests__/validateThemeConfig.test.ts
index a855ccba3a..33fe017f0f 100644
--- a/packages/docusaurus-theme-live-codeblock/src/__tests__/validateThemeConfig.test.ts
+++ b/packages/docusaurus-theme-live-codeblock/src/__tests__/validateThemeConfig.test.ts
@@ -31,7 +31,7 @@ describe('validateThemeConfig', () => {
});
});
- it('unexist config', () => {
+ it('nonexistent config', () => {
expect(testValidateThemeConfig({})).toEqual({
liveCodeBlock: {
...DEFAULT_CONFIG,
diff --git a/packages/docusaurus-theme-translations/src/__tests__/index.test.ts b/packages/docusaurus-theme-translations/src/__tests__/index.test.ts
index 5d7bb1199b..980fa83d87 100644
--- a/packages/docusaurus-theme-translations/src/__tests__/index.test.ts
+++ b/packages/docusaurus-theme-translations/src/__tests__/index.test.ts
@@ -67,7 +67,7 @@ describe('readDefaultCodeTranslationMessages', () => {
);
});
- it('for unexisting locale', async () => {
+ it('for nonexistent locale', async () => {
await expect(
readDefaultCodeTranslationMessages({
locale: 'es',
diff --git a/packages/docusaurus-utils/src/__tests__/dataFileUtils.test.ts b/packages/docusaurus-utils/src/__tests__/dataFileUtils.test.ts
index 689e338f6c..251a1f6dbe 100644
--- a/packages/docusaurus-utils/src/__tests__/dataFileUtils.test.ts
+++ b/packages/docusaurus-utils/src/__tests__/dataFileUtils.test.ts
@@ -172,7 +172,7 @@ describe('findFolderContainingFile', () => {
it('find appropriate folder', async () => {
await expect(
findFolderContainingFile(
- ['/abcdef', '/gehij', __dirname, '/klmn'],
+ ['/foo', '/baz', __dirname, '/bar'],
'dataFileUtils.test.ts',
),
).resolves.toEqual(__dirname);
@@ -180,7 +180,7 @@ describe('findFolderContainingFile', () => {
it('return undefined if no folder contain such file', async () => {
await expect(
- findFolderContainingFile(['/abcdef', '/gehij', '/klmn'], 'index.test.ts'),
+ findFolderContainingFile(['/foo', '/bar', '/baz'], 'index.test.ts'),
).resolves.toBeUndefined();
});
});
@@ -189,7 +189,7 @@ describe('getFolderContainingFile', () => {
it('get appropriate folder', async () => {
await expect(
getFolderContainingFile(
- ['/abcdef', '/gehij', __dirname, '/klmn'],
+ ['/foo', '/baz', __dirname, '/bar'],
'dataFileUtils.test.ts',
),
).resolves.toEqual(__dirname);
@@ -198,14 +198,14 @@ describe('getFolderContainingFile', () => {
it('throw if no folder contain such file', async () => {
await expect(
getFolderContainingFile(
- ['/abcdef', '/gehij', '/klmn'],
+ ['/foo', '/bar', '/baz'],
'dataFileUtils.test.ts',
),
).rejects.toThrowErrorMatchingInlineSnapshot(`
"File \\"dataFileUtils.test.ts\\" does not exist in any of these folders:
- - /abcdef
- - /gehij
- - /klmn]"
+ - /foo
+ - /bar
+ - /baz"
`);
});
});
diff --git a/packages/docusaurus-utils/src/__tests__/i18nUtils.test.ts b/packages/docusaurus-utils/src/__tests__/i18nUtils.test.ts
index b5321520b6..e33207afc6 100644
--- a/packages/docusaurus-utils/src/__tests__/i18nUtils.test.ts
+++ b/packages/docusaurus-utils/src/__tests__/i18nUtils.test.ts
@@ -83,7 +83,7 @@ describe('getPluginI18nPath', () => {
}).replace(__dirname, ''),
).toMatchInlineSnapshot(`"/i18n/zh-Hans/plugin-content-docs/foo"`);
});
- it('gets correct path when no subpaths', () => {
+ it('gets correct path when no sub-paths', () => {
expect(
getPluginI18nPath({
siteDir: __dirname,
diff --git a/packages/docusaurus-utils/src/__tests__/jsUtils.test.ts b/packages/docusaurus-utils/src/__tests__/jsUtils.test.ts
index b9646927c0..1092e85ff7 100644
--- a/packages/docusaurus-utils/src/__tests__/jsUtils.test.ts
+++ b/packages/docusaurus-utils/src/__tests__/jsUtils.test.ts
@@ -34,7 +34,7 @@ describe('removePrefix', () => {
expect(removePrefix('abcdef', '')).toBe('abcdef');
});
it('removes prefix', () => {
- expect(removePrefix('abcdef', 'ab')).toBe('cdef');
+ expect(removePrefix('prefix', 'pre')).toBe('fix');
});
});
diff --git a/packages/docusaurus-utils/src/__tests__/markdownParser.test.ts b/packages/docusaurus-utils/src/__tests__/markdownParser.test.ts
index 661591f5e5..bc565f7550 100644
--- a/packages/docusaurus-utils/src/__tests__/markdownParser.test.ts
+++ b/packages/docusaurus-utils/src/__tests__/markdownParser.test.ts
@@ -116,7 +116,7 @@ describe('createExcerpt', () => {
export function ItemCol(props) { return