From bbadb57baeb7d78d67fb4e90e3d068275cc8d4c0 Mon Sep 17 00:00:00 2001 From: Bence Markus <23279421+mrksbnc@users.noreply.github.com> Date: Wed, 14 Jan 2026 22:27:50 +0100 Subject: [PATCH 01/18] docs: availasble languages update --- package.json | 2 +- packages/cspell-filetypes/src/filetypes.ts | 2 ++ packages/cspell-filetypes/src/index.ts | 1 + pnpm-lock.yaml | 3 +++ .../docs/dictionaries/available-languages.mdx | 27 +++++++++++++++++++ website/package.json | 1 + 6 files changed, 35 insertions(+), 1 deletion(-) create mode 100644 website/docs/dictionaries/available-languages.mdx diff --git a/package.json b/package.json index d788e0b9851b..7f7daff9e2ba 100644 --- a/package.json +++ b/package.json @@ -9,7 +9,7 @@ "cspell": "bin.mjs", "cspell-tools": "cspell-tools.mjs" }, - "packageManager": "pnpm@10.27.0+sha512.72d699da16b1179c14ba9e64dc71c9a40988cbdc65c264cb0e489db7de917f20dcf4d64d8723625f2969ba52d4b7e2a1170682d9ac2a5dcaeaab732b7e16f04a", + "packageManager": "pnpm@10.28.0", "private": true, "scripts": { "bp": "pnpm build:prod", diff --git a/packages/cspell-filetypes/src/filetypes.ts b/packages/cspell-filetypes/src/filetypes.ts index c651ece3eed1..2c9e55943f02 100644 --- a/packages/cspell-filetypes/src/filetypes.ts +++ b/packages/cspell-filetypes/src/filetypes.ts @@ -22,6 +22,8 @@ export const generatedFiles: Set = new Set([ export const languageIds: FileTypeId[] = definitions.map(({ id }) => id); +export const programmingLangDefinitions: FileTypeDefinitions = definitions; + const mapExtensionToSetOfLanguageIds: ExtensionToFileTypeIdMapSet = buildLanguageExtensionMapSet(definitions); const mapExtensionToLanguageIds: ExtensionToFileTypeIdMap = buildExtensionToLanguageIdMap(mapExtensionToSetOfLanguageIds); diff --git a/packages/cspell-filetypes/src/index.ts b/packages/cspell-filetypes/src/index.ts index 550edcf11e54..3918469eb2f5 100644 --- a/packages/cspell-filetypes/src/index.ts +++ b/packages/cspell-filetypes/src/index.ts @@ -7,5 +7,6 @@ export { isFileTypeGenerated, isGeneratedExt, isGeneratedFile, + programmingLangDefinitions, } from './filetypes.js'; export type { FileTypeId } from './types.js'; diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 2452365d2ada..df5d83f4723d 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -1418,6 +1418,9 @@ importers: website: dependencies: + '@cspell/filetypes': + specifier: workspace:* + version: link:../packages/cspell-filetypes '@docusaurus/core': specifier: ^3.9.2 version: 3.9.2(@mdx-js/react@3.1.1(@types/react@19.2.8)(react@19.2.3))(@swc/core@1.7.26)(esbuild@0.27.2)(react-dom@19.2.3(react@19.2.3))(react@19.2.3)(typescript@5.9.3) diff --git a/website/docs/dictionaries/available-languages.mdx b/website/docs/dictionaries/available-languages.mdx new file mode 100644 index 000000000000..77665a6355a3 --- /dev/null +++ b/website/docs/dictionaries/available-languages.mdx @@ -0,0 +1,27 @@ +--- +title: 'Available Languages' +categories: docs +# parent: Docs +sidebar_position: 5 +sidebar_label: Available Languages +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import { programmingLangDefinitions } from "@cspell/filetypes"; + +# Available Languages & Triggers + +This page lists all supported programming languages and file types with their corresponding file extensions that triggers +the given language check in CSpell. + +## Programming Languages + +{programmingLangDefinitions.map((lang) => ( +
+

{lang.id}

+ {lang.description &&

{lang.description}

} +

File Extensions:

+ 
{[...lang.extensions, ...(lang.filenames || [])].join(', ') || 'No specific extensions'}
+
+))} diff --git a/website/package.json b/website/package.json index ea8d89d1b9d5..5f6a320850e5 100644 --- a/website/package.json +++ b/website/package.json @@ -19,6 +19,7 @@ "typecheck": "tsc" }, "dependencies": { + "@cspell/filetypes": "workspace:*", "@docusaurus/core": "^3.9.2", "@docusaurus/plugin-client-redirects": "^3.9.2", "@docusaurus/preset-classic": "^3.9.2", From d709d8a2ef14baf4e4684cc29a7752258f7a0e0a Mon Sep 17 00:00:00 2001 From: Bence Markus <23279421+mrksbnc@users.noreply.github.com> Date: Wed, 14 Jan 2026 22:39:24 +0100 Subject: [PATCH 02/18] new docu page createdfor prog lang dictionaries --- .../docs/dictionaries/available-languages.mdx | 27 ++++++++++++------- 1 file changed, 18 insertions(+), 9 deletions(-) diff --git a/website/docs/dictionaries/available-languages.mdx b/website/docs/dictionaries/available-languages.mdx index 77665a6355a3..4dced521cc8c 100644 --- a/website/docs/dictionaries/available-languages.mdx +++ b/website/docs/dictionaries/available-languages.mdx @@ -1,27 +1,36 @@ --- -title: 'Available Languages' +title: 'Programming language dictionaries' categories: docs # parent: Docs sidebar_position: 5 -sidebar_label: Available Languages +sidebar_label: Programming language dictionaries --- - import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; import { programmingLangDefinitions } from "@cspell/filetypes"; -# Available Languages & Triggers +# Programming language dictionaries -This page lists all supported programming languages and file types with their corresponding file extensions that triggers -the given language check in CSpell. +This page lists all supported programming languages and file types with their corresponding file extensions +that triggers a language check in CSpell. ## Programming Languages {programmingLangDefinitions.map((lang) => (
-

{lang.id}

+

{lang.id}

{lang.description &&

{lang.description}

} -

File Extensions:

- 
{[...lang.extensions, ...(lang.filenames || [])].join(', ') || 'No specific extensions'}
+ {(lang.filenames || []).length > 0 && ( + <> +
Filenames:
+ 
{(lang.filenames || []).join('\n') || 'No filename specified'}
+ + )} + {(lang.extensions || []).length > 0 && ( + <> +
File Extensions:
+ 
{(lang.extensions || []).join('\n') || 'No file extension specified'}
+ + )}
))} From 10f798c3bca06a90e377da71234b4764aa30be83 Mon Sep 17 00:00:00 2001 From: Bence Markus <23279421+mrksbnc@users.noreply.github.com> Date: Sun, 18 Jan 2026 14:35:27 +0100 Subject: [PATCH 03/18] feat: new table component --- .../docs/dictionaries/available-languages.mdx | 51 +++---- website/src/components/LanguagesTable.tsx | 68 +++++++++ website/src/components/languages-table.scss | 130 ++++++++++++++++++ 3 files changed, 217 insertions(+), 32 deletions(-) create mode 100644 website/src/components/LanguagesTable.tsx create mode 100644 website/src/components/languages-table.scss diff --git a/website/docs/dictionaries/available-languages.mdx b/website/docs/dictionaries/available-languages.mdx index 4dced521cc8c..df3b8fbff9a6 100644 --- a/website/docs/dictionaries/available-languages.mdx +++ b/website/docs/dictionaries/available-languages.mdx @@ -1,36 +1,23 @@ --- -title: 'Programming language dictionaries' +title: 'Available Languages' categories: docs # parent: Docs -sidebar_position: 5 -sidebar_label: Programming language dictionaries +sidebar_position: 4 +sidebar_label: Available Languages --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -import { programmingLangDefinitions } from "@cspell/filetypes"; - -# Programming language dictionaries - -This page lists all supported programming languages and file types with their corresponding file extensions -that triggers a language check in CSpell. - -## Programming Languages - -{programmingLangDefinitions.map((lang) => ( -
-

{lang.id}

- {lang.description &&

{lang.description}

} - {(lang.filenames || []).length > 0 && ( - <> -
Filenames:
- 
{(lang.filenames || []).join('\n') || 'No filename specified'}
- - )} - {(lang.extensions || []).length > 0 && ( - <> -
File Extensions:
- 
{(lang.extensions || []).join('\n') || 'No file extension specified'}
- - )} -
-))} + +import { LanguagesTable } from '@site/src/components/LanguagesTable'; + +# Available Languages & Triggers + +This page lists all supported programming languages and file types with their corresponding file extensions that triggers +the given language check in CSpell. + +## Overview + +CSpell automatically detects the programming language based on file extensions and applies the appropriate spell checking rules. The table below shows all supported languages and their associated file patterns. + +## Supported Languages + + + diff --git a/website/src/components/LanguagesTable.tsx b/website/src/components/LanguagesTable.tsx new file mode 100644 index 000000000000..2395c78f003e --- /dev/null +++ b/website/src/components/LanguagesTable.tsx @@ -0,0 +1,68 @@ +import React, { useState, useMemo } from 'react'; +import { programmingLangDefinitions } from '@cspell/filetypes'; +import './languages-table.scss'; + +export const LanguagesTable: React.FC = () => { + const [searchTerm, setSearchTerm] = useState(''); + + const filteredLanguages = useMemo(() => { + if (!searchTerm) return programmingLangDefinitions; + + const term = searchTerm.toLowerCase(); + return programmingLangDefinitions.filter((lang) => { + const extensions = [...lang.extensions, ...(lang.filenames || [])].join(' ').toLowerCase(); + return ( + lang.id.toLowerCase().includes(term) || + (lang.description && lang.description.toLowerCase().includes(term)) || + extensions.includes(term) + ); + }); + }, [searchTerm]); + + return ( +
+
+ setSearchTerm(e.target.value)} + className="search-input" + /> +
+ +
+
+
Language ID
+
Description
+
File Extensions & Filenames
+
+ +
+ {filteredLanguages.map((lang, index) => ( +
+
+ {lang.id} +
+
{lang.description || '-'}
+
+ + {[...lang.extensions, ...(lang.filenames || [])].join(', ') || + 'No specific extensions'} + +
+
+ ))} +
+
+ + {filteredLanguages.length === 0 && ( +

No languages found matching "{searchTerm}"

+ )} + +

+ Total: {filteredLanguages.length} language{filteredLanguages.length !== 1 ? 's' : ''} +

+
+ ); +}; diff --git a/website/src/components/languages-table.scss b/website/src/components/languages-table.scss new file mode 100644 index 000000000000..85fa5f1fdb21 --- /dev/null +++ b/website/src/components/languages-table.scss @@ -0,0 +1,130 @@ +.languages-table-container { + width: 100%; + + .search-box { + margin-bottom: 1.5rem; + + .search-input { + width: 100%; + padding: 0.75rem; + font-size: 1rem; + border: 1px solid var(--ifm-color-emphasis-300); + border-radius: 0.5rem; + background-color: var(--ifm-background-color); + color: var(--ifm-font-color-base); + transition: border-color 0.2s ease; + + &:focus { + outline: none; + border-color: var(--ifm-color-primary); + } + + &::placeholder { + color: var(--ifm-color-emphasis-600); + } + } + } + + .table-wrapper { + width: 100%; + border: 1px solid var(--ifm-color-emphasis-500); + border-radius: 0.5rem; + overflow: hidden; + } + + .table-header { + display: grid; + grid-template-columns: 200px 1fr 2fr; + background-color: var(--ifm-table-head-background); + font-weight: bold; + + .table-cell { + padding: 0.75rem 1rem; + border-right: 1px solid var(--ifm-color-emphasis-500); + + &:last-child { + border-right: none; + } + } + } + + .table-body { + .table-row { + display: grid; + grid-template-columns: 200px 1fr 2fr; + border-top: 1px solid var(--ifm-color-emphasis-500); + + &.striped { + background-color: var(--ifm-table-stripe-background); + } + + .table-cell { + padding: 0.75rem 1rem; + border-right: 1px solid var(--ifm-color-emphasis-500); + + &:last-child { + border-right: none; + } + + code { + &.extensions { + white-space: pre-wrap; + word-break: break-word; + } + } + } + } + } + + .no-results { + text-align: center; + padding: 2rem; + color: var(--ifm-color-emphasis-600); + } + + .total-count { + margin-top: 1.5rem; + font-size: 0.9rem; + color: var(--ifm-color-emphasis-600); + } +} + +@media (max-width: 768px) { + .languages-table-container { + .table-header, + .table-body .table-row { + grid-template-columns: 150px 1fr 1.5fr; + } + } +} + +@media (max-width: 576px) { + .languages-table-container { + .table-header, + .table-body .table-row { + grid-template-columns: 1fr; + + .table-cell { + border-right: none; + border-bottom: 1px solid var(--ifm-color-emphasis-400); + + &:last-child { + border-bottom: none; + } + } + } + + .table-body .table-row { + padding: 0.5rem 0; + + .table-cell { + &:before { + content: attr(data-label); + font-weight: bold; + display: block; + margin-bottom: 0.25rem; + } + } + } + } +} From faaaf3d346526a2934d1ce8fdd4ca0413440c596 Mon Sep 17 00:00:00 2001 From: "autofix-ci[bot]" <114827586+autofix-ci[bot]@users.noreply.github.com> Date: Sun, 18 Jan 2026 13:38:51 +0000 Subject: [PATCH 04/18] [autofix.ci] apply automated fixes --- website/src/components/LanguagesTable.tsx | 105 +++++++++++----------- 1 file changed, 51 insertions(+), 54 deletions(-) diff --git a/website/src/components/LanguagesTable.tsx b/website/src/components/LanguagesTable.tsx index 2395c78f003e..0a1e7c7e4df1 100644 --- a/website/src/components/LanguagesTable.tsx +++ b/website/src/components/LanguagesTable.tsx @@ -3,66 +3,63 @@ import { programmingLangDefinitions } from '@cspell/filetypes'; import './languages-table.scss'; export const LanguagesTable: React.FC = () => { - const [searchTerm, setSearchTerm] = useState(''); + const [searchTerm, setSearchTerm] = useState(''); - const filteredLanguages = useMemo(() => { - if (!searchTerm) return programmingLangDefinitions; + const filteredLanguages = useMemo(() => { + if (!searchTerm) return programmingLangDefinitions; - const term = searchTerm.toLowerCase(); - return programmingLangDefinitions.filter((lang) => { - const extensions = [...lang.extensions, ...(lang.filenames || [])].join(' ').toLowerCase(); - return ( - lang.id.toLowerCase().includes(term) || - (lang.description && lang.description.toLowerCase().includes(term)) || - extensions.includes(term) - ); - }); - }, [searchTerm]); + const term = searchTerm.toLowerCase(); + return programmingLangDefinitions.filter((lang) => { + const extensions = [...lang.extensions, ...(lang.filenames || [])].join(' ').toLowerCase(); + return ( + lang.id.toLowerCase().includes(term) || + (lang.description && lang.description.toLowerCase().includes(term)) || + extensions.includes(term) + ); + }); + }, [searchTerm]); - return ( -
-
- setSearchTerm(e.target.value)} - className="search-input" - /> -
+ return ( +
+
+ setSearchTerm(e.target.value)} + className="search-input" + /> +
-
-
-
Language ID
-
Description
-
File Extensions & Filenames
-
+
+
+
Language ID
+
Description
+
File Extensions & Filenames
+
-
- {filteredLanguages.map((lang, index) => ( -
-
- {lang.id} -
-
{lang.description || '-'}
-
- - {[...lang.extensions, ...(lang.filenames || [])].join(', ') || - 'No specific extensions'} - -
-
- ))} -
+
+ {filteredLanguages.map((lang, index) => ( +
+
+ {lang.id} +
+
{lang.description || '-'}
+
+ + {[...lang.extensions, ...(lang.filenames || [])].join(', ') || 'No specific extensions'} + +
+ ))} +
+
- {filteredLanguages.length === 0 && ( -

No languages found matching "{searchTerm}"

- )} + {filteredLanguages.length === 0 &&

No languages found matching "{searchTerm}"

} -

- Total: {filteredLanguages.length} language{filteredLanguages.length !== 1 ? 's' : ''} -

-
- ); +

+ Total: {filteredLanguages.length} language{filteredLanguages.length !== 1 ? 's' : ''} +

+
+ ); }; From 7ba27b3248e9cb220b572646157f671d6645d05a Mon Sep 17 00:00:00 2001 From: Bence Markus <23279421+mrksbnc@users.noreply.github.com> Date: Mon, 19 Jan 2026 17:56:58 +0100 Subject: [PATCH 05/18] chore: PR comment update --- packages/cspell-filetypes/src/filetypes.ts | 2 +- packages/cspell-filetypes/src/index.ts | 2 +- website/src/components/LanguagesTable.tsx | 6 +++--- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/packages/cspell-filetypes/src/filetypes.ts b/packages/cspell-filetypes/src/filetypes.ts index 2c9e55943f02..43c7471b2737 100644 --- a/packages/cspell-filetypes/src/filetypes.ts +++ b/packages/cspell-filetypes/src/filetypes.ts @@ -22,7 +22,7 @@ export const generatedFiles: Set = new Set([ export const languageIds: FileTypeId[] = definitions.map(({ id }) => id); -export const programmingLangDefinitions: FileTypeDefinitions = definitions; +export const fileTypeDefinitions: FileTypeDefinitions = definitions; const mapExtensionToSetOfLanguageIds: ExtensionToFileTypeIdMapSet = buildLanguageExtensionMapSet(definitions); const mapExtensionToLanguageIds: ExtensionToFileTypeIdMap = diff --git a/packages/cspell-filetypes/src/index.ts b/packages/cspell-filetypes/src/index.ts index 3918469eb2f5..7b0e795e91c3 100644 --- a/packages/cspell-filetypes/src/index.ts +++ b/packages/cspell-filetypes/src/index.ts @@ -7,6 +7,6 @@ export { isFileTypeGenerated, isGeneratedExt, isGeneratedFile, - programmingLangDefinitions, + fileTypeDefinitions, } from './filetypes.js'; export type { FileTypeId } from './types.js'; diff --git a/website/src/components/LanguagesTable.tsx b/website/src/components/LanguagesTable.tsx index 0a1e7c7e4df1..1b275732c3ca 100644 --- a/website/src/components/LanguagesTable.tsx +++ b/website/src/components/LanguagesTable.tsx @@ -1,15 +1,15 @@ import React, { useState, useMemo } from 'react'; -import { programmingLangDefinitions } from '@cspell/filetypes'; +import { fileTypeDefinitions } from '@cspell/filetypes'; import './languages-table.scss'; export const LanguagesTable: React.FC = () => { const [searchTerm, setSearchTerm] = useState(''); const filteredLanguages = useMemo(() => { - if (!searchTerm) return programmingLangDefinitions; + if (!searchTerm) return fileTypeDefinitions; const term = searchTerm.toLowerCase(); - return programmingLangDefinitions.filter((lang) => { + return fileTypeDefinitions.filter((lang) => { const extensions = [...lang.extensions, ...(lang.filenames || [])].join(' ').toLowerCase(); return ( lang.id.toLowerCase().includes(term) || From 51853f5a966ffa1e79b51b207922d63b858118c9 Mon Sep 17 00:00:00 2001 From: Bence Markus <23279421+mrksbnc@users.noreply.github.com> Date: Mon, 19 Jan 2026 17:57:40 +0100 Subject: [PATCH 06/18] chore: PR comment update --- website/docs/dictionaries/available-languages.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/website/docs/dictionaries/available-languages.mdx b/website/docs/dictionaries/available-languages.mdx index df3b8fbff9a6..d9efa05f2a90 100644 --- a/website/docs/dictionaries/available-languages.mdx +++ b/website/docs/dictionaries/available-languages.mdx @@ -1,5 +1,5 @@ --- -title: 'Available Languages' +title: 'Known File Types' categories: docs # parent: Docs sidebar_position: 4 @@ -15,7 +15,7 @@ the given language check in CSpell. ## Overview -CSpell automatically detects the programming language based on file extensions and applies the appropriate spell checking rules. The table below shows all supported languages and their associated file patterns. +CSpell automatically detects the file type based on file extensions and applies the appropriate spell checking rules. The table below shows the known file types and their associated file extensions and patterns. ## Supported Languages From c3364ea0673aeb7ff79d6ce5a77e8ac374528651 Mon Sep 17 00:00:00 2001 From: Bence Markus <23279421+mrksbnc@users.noreply.github.com> Date: Mon, 19 Jan 2026 17:58:20 +0100 Subject: [PATCH 07/18] chore: PR comment update --- website/docs/dictionaries/available-languages.mdx | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/website/docs/dictionaries/available-languages.mdx b/website/docs/dictionaries/available-languages.mdx index d9efa05f2a90..ea36d37bee8a 100644 --- a/website/docs/dictionaries/available-languages.mdx +++ b/website/docs/dictionaries/available-languages.mdx @@ -3,15 +3,14 @@ title: 'Known File Types' categories: docs # parent: Docs sidebar_position: 4 -sidebar_label: Available Languages +sidebar_label: File Types --- import { LanguagesTable } from '@site/src/components/LanguagesTable'; # Available Languages & Triggers -This page lists all supported programming languages and file types with their corresponding file extensions that triggers -the given language check in CSpell. +This page lists the programming languages and file types with their associated file extensions. ## Overview From a2f365a2275d116796945b1e795d1fc7d78ed832 Mon Sep 17 00:00:00 2001 From: Bence Markus <23279421+mrksbnc@users.noreply.github.com> Date: Mon, 19 Jan 2026 18:00:13 +0100 Subject: [PATCH 08/18] chore: pnpm version update & available languages --- package.json | 2 +- website/docs/dictionaries/available-languages.mdx | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/package.json b/package.json index 8a9bc05fa862..0b31d563bf6e 100644 --- a/package.json +++ b/package.json @@ -9,7 +9,7 @@ "cspell": "bin.mjs", "cspell-tools": "cspell-tools.mjs" }, - "packageManager": "pnpm@10.28.0", + "packageManager": "pnpm@10.28.1", "private": true, "scripts": { "bp": "pnpm build:prod", diff --git a/website/docs/dictionaries/available-languages.mdx b/website/docs/dictionaries/available-languages.mdx index ea36d37bee8a..e1854d62bd11 100644 --- a/website/docs/dictionaries/available-languages.mdx +++ b/website/docs/dictionaries/available-languages.mdx @@ -8,7 +8,7 @@ sidebar_label: File Types import { LanguagesTable } from '@site/src/components/LanguagesTable'; -# Available Languages & Triggers +# File Types and Extensions This page lists the programming languages and file types with their associated file extensions. @@ -16,7 +16,7 @@ This page lists the programming languages and file types with their associated f CSpell automatically detects the file type based on file extensions and applies the appropriate spell checking rules. The table below shows the known file types and their associated file extensions and patterns. -## Supported Languages +## File Types From 71b383800a06d75945896004289eafee804ddd9c Mon Sep 17 00:00:00 2001 From: "autofix-ci[bot]" <114827586+autofix-ci[bot]@users.noreply.github.com> Date: Mon, 19 Jan 2026 17:03:51 +0000 Subject: [PATCH 09/18] [autofix.ci] apply automated fixes --- packages/cspell-filetypes/src/index.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/cspell-filetypes/src/index.ts b/packages/cspell-filetypes/src/index.ts index 7b0e795e91c3..05161ff8d8a1 100644 --- a/packages/cspell-filetypes/src/index.ts +++ b/packages/cspell-filetypes/src/index.ts @@ -1,4 +1,5 @@ export { + fileTypeDefinitions, findMatchingFileTypes as findMatchingFileTypes, getFileTypesForExt, isBinaryExt, @@ -7,6 +8,5 @@ export { isFileTypeGenerated, isGeneratedExt, isGeneratedFile, - fileTypeDefinitions, } from './filetypes.js'; export type { FileTypeId } from './types.js'; From c82e7e217645f4328965a48047659e73c3553bd5 Mon Sep 17 00:00:00 2001 From: Bence Markus <23279421+mrksbnc@users.noreply.github.com> Date: Mon, 19 Jan 2026 19:50:51 +0100 Subject: [PATCH 10/18] component and doc rework --- .vscode/settings.json | 16 +-- .../docs/dictionaries/available-languages.mdx | 82 ++++++++++++-- website/src/components/FileTypeTable.tsx | 100 ++++++++++++++++++ website/src/components/LanguagesTable.tsx | 65 ------------ ...guages-table.scss => file-type-table.scss} | 68 +++++++++++- 5 files changed, 249 insertions(+), 82 deletions(-) create mode 100644 website/src/components/FileTypeTable.tsx delete mode 100644 website/src/components/LanguagesTable.tsx rename website/src/components/{languages-table.scss => file-type-table.scss} (62%) diff --git a/.vscode/settings.json b/.vscode/settings.json index f2a1dc88612e..2abc9f9b4aac 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -1,8 +1,12 @@ { - "json.schemas": [{ - "fileMatch": [ - "cspell.json", ".cspell.json", "cSpell.json" - ], - "url": "./cspell.schema.json" - }] + "json.schemas": [ + { + "fileMatch": [ + "cspell.json", + ".cspell.json", + "cSpell.json" + ], + "url": "./cspell.schema.json" + } + ] } diff --git a/website/docs/dictionaries/available-languages.mdx b/website/docs/dictionaries/available-languages.mdx index e1854d62bd11..669d6f8dbf09 100644 --- a/website/docs/dictionaries/available-languages.mdx +++ b/website/docs/dictionaries/available-languages.mdx @@ -1,22 +1,90 @@ --- -title: 'Known File Types' +title: 'File Types and Extensions' categories: docs # parent: Docs sidebar_position: 4 sidebar_label: File Types --- -import { LanguagesTable } from '@site/src/components/LanguagesTable'; +import { FileTypeTable } from '@site/src/components/FileTypeTable'; # File Types and Extensions -This page lists the programming languages and file types with their associated file extensions. +This page provides a reference for how CSpell associates file extensions with file type IDs (also called `languageId` in configuration files for historical reasons). -## Overview +## Understanding File Type Ids -CSpell automatically detects the file type based on file extensions and applies the appropriate spell checking rules. The table below shows the known file types and their associated file extensions and patterns. +:::info Terminology Note +In CSpell configuration files, the field is called `languageId` for historical reasons (to match VSCode's convention). However, this refers to **file types** (like `javascript`, `python`, `markdown`), not spoken languages (like English or Spanish). +::: -## File Types +## How CSpell Determines File Types - +CSpell uses file extensions and filenames to determine the file type, which then influences: +1. Which dictionaries are enabled +2. Which patterns and rules apply +3. Whether the file should be spell-checked +## Usage Examples + +### Using Overrides + +Force a specific file type for certain file patterns: + +```yaml +overrides: + - filename: "**/*.xyz" + languageId: javascript # Treat .xyz files as JavaScript +``` + +Or in JSON format: + +```json +{ + "overrides": [ + { + "filename": "**/*.xyz", + "languageId": "javascript" + } + ] +} +``` + +### Using Language Settings + +Apply specific settings based on file type: + +```yaml +languageSettings: + - languageId: python,javascript + caseSensitive: true + dictionaries: + - python + - node +``` + +Or in JSON format: + +```json +{ + "languageSettings": [ + { + "languageId": "python,javascript", + "caseSensitive": true, + "dictionaries": ["python", "node"] + } + ] +} +``` + +## Related Documentation + +- [Language Settings](../Configuration/language-settings.mdx) - Configure settings per file type +- [Overrides](../Configuration/overrides.md) - Override settings for specific files +- [Searching Dictionaries](./searching-dictionaries.md) - Find which dictionaries contain words + +## Supported File Types + +The table below shows the mapping between file extensions/filenames and their associated file type Ids. + + diff --git a/website/src/components/FileTypeTable.tsx b/website/src/components/FileTypeTable.tsx new file mode 100644 index 000000000000..1afcabebd524 --- /dev/null +++ b/website/src/components/FileTypeTable.tsx @@ -0,0 +1,100 @@ +import React, { useState, useMemo } from 'react'; +import { fileTypeDefinitions, isBinaryFileType } from '@cspell/filetypes'; + +import './file-type-table.scss'; + +export const FileTypeTable = () => { + const [searchTerm, setSearchTerm] = useState(''); + const [showBinary, setShowBinary] = useState(false); + + const filteredFileTypes = useMemo(() => { + let filtered = fileTypeDefinitions; + + if (!showBinary) { + filtered = filtered.filter((f) => !isBinaryFileType(f.id)); + } + + if (searchTerm) { + const term = searchTerm.toLowerCase(); + filtered = filtered.filter((f) => { + const extensions = [...f.extensions, ...(f.filenames || [])].join(' ').toLowerCase(); + return ( + f.id.toLowerCase().includes(term) || + (f.description && f.description.toLowerCase().includes(term)) || + extensions.includes(term) + ); + }); + } + + return filtered; + }, [searchTerm, showBinary]); + + const binaryCount = fileTypeDefinitions.filter((f) => isBinaryFileType(f.id)).length; + const textCount = fileTypeDefinitions.length - binaryCount; + + return ( +
+
+ setSearchTerm(e.target.value)} + className="search-input" + /> +
+ +
+ + + Showing {filteredFileTypes.length} of {showBinary ? fileTypeDefinitions.length : textCount} file + types + +
+ +
+
+
File Type ID
+
Description
+
Filenames
+
Extensions
+
+ +
+ {filteredFileTypes.map((m, index) => ( +
+
+ {m.id} + {m.format === 'Binary' && Binary} +
+
{m.description || '-'}
+
+ {m.filenames && {m.filenames.join(', ')}} + {!m.filenames && <>-} +
+
+ {m.extensions && {m.extensions.join(', ')}} + {!m.extensions && <>-} +
+
+ ))} +
+
+ + {filteredFileTypes.length === 0 && ( +

No file types found matching "{searchTerm}"

+ )} + +

+ Total: {filteredFileTypes.length} file type{filteredFileTypes.length !== 1 ? 's' : ''} +

+
+ ); +}; diff --git a/website/src/components/LanguagesTable.tsx b/website/src/components/LanguagesTable.tsx deleted file mode 100644 index 1b275732c3ca..000000000000 --- a/website/src/components/LanguagesTable.tsx +++ /dev/null @@ -1,65 +0,0 @@ -import React, { useState, useMemo } from 'react'; -import { fileTypeDefinitions } from '@cspell/filetypes'; -import './languages-table.scss'; - -export const LanguagesTable: React.FC = () => { - const [searchTerm, setSearchTerm] = useState(''); - - const filteredLanguages = useMemo(() => { - if (!searchTerm) return fileTypeDefinitions; - - const term = searchTerm.toLowerCase(); - return fileTypeDefinitions.filter((lang) => { - const extensions = [...lang.extensions, ...(lang.filenames || [])].join(' ').toLowerCase(); - return ( - lang.id.toLowerCase().includes(term) || - (lang.description && lang.description.toLowerCase().includes(term)) || - extensions.includes(term) - ); - }); - }, [searchTerm]); - - return ( -
-
- setSearchTerm(e.target.value)} - className="search-input" - /> -
- -
-
-
Language ID
-
Description
-
File Extensions & Filenames
-
- -
- {filteredLanguages.map((lang, index) => ( -
-
- {lang.id} -
-
{lang.description || '-'}
-
- - {[...lang.extensions, ...(lang.filenames || [])].join(', ') || 'No specific extensions'} - -
-
- ))} -
-
- - {filteredLanguages.length === 0 &&

No languages found matching "{searchTerm}"

} - -

- Total: {filteredLanguages.length} language{filteredLanguages.length !== 1 ? 's' : ''} -

-
- ); -}; diff --git a/website/src/components/languages-table.scss b/website/src/components/file-type-table.scss similarity index 62% rename from website/src/components/languages-table.scss rename to website/src/components/file-type-table.scss index 85fa5f1fdb21..3cbd3f0a8a92 100644 --- a/website/src/components/languages-table.scss +++ b/website/src/components/file-type-table.scss @@ -1,5 +1,6 @@ .languages-table-container { width: 100%; + box-sizing: border-box; .search-box { margin-bottom: 1.5rem; @@ -25,6 +26,33 @@ } } + .filter-controls { + display: flex; + justify-content: space-between; + align-items: center; + margin-bottom: 1rem; + padding: 0.75rem; + background-color: var(--ifm-color-emphasis-100); + border-radius: 0.5rem; + + .checkbox-label { + display: flex; + align-items: center; + gap: 0.5rem; + cursor: pointer; + font-size: 0.95rem; + + input[type='checkbox'] { + cursor: pointer; + } + } + + .info-text { + font-size: 0.9rem; + color: var(--ifm-color-emphasis-700); + } + } + .table-wrapper { width: 100%; border: 1px solid var(--ifm-color-emphasis-500); @@ -34,12 +62,17 @@ .table-header { display: grid; - grid-template-columns: 200px 1fr 2fr; + grid-template-columns: 200px 250px 1fr 1fr; background-color: var(--ifm-table-head-background); font-weight: bold; .table-cell { + min-width: 0; + display: flex; + overflow: hidden; + align-items: center; padding: 0.75rem 1rem; + justify-content: center; border-right: 1px solid var(--ifm-color-emphasis-500); &:last-child { @@ -51,15 +84,19 @@ .table-body { .table-row { display: grid; - grid-template-columns: 200px 1fr 2fr; + grid-template-columns: 200px 250px 1fr 1fr; border-top: 1px solid var(--ifm-color-emphasis-500); &.striped { - background-color: var(--ifm-table-stripe-background); + background-color: var(--ifm-table-head-background); } .table-cell { + display: flex; + overflow: hidden; + align-items: center; padding: 0.75rem 1rem; + min-width: 0; // Allow content to shrink border-right: 1px solid var(--ifm-color-emphasis-500); &:last-child { @@ -67,7 +104,13 @@ } code { + display: flex; + align-items: center; + max-width: fit-content; + justify-content: center; + &.extensions { + display: block; white-space: pre-wrap; word-break: break-word; } @@ -93,7 +136,7 @@ .languages-table-container { .table-header, .table-body .table-row { - grid-template-columns: 150px 1fr 1.5fr; + grid-template-columns: 150px 200px 1fr 1fr; } } } @@ -128,3 +171,20 @@ } } } + + +// Badge styles +.badge { + display: inline-block; + margin-left: 0.5rem; + padding: 0.125rem 0.5rem; + font-size: 0.75rem; + font-weight: 600; + border-radius: 0.25rem; + vertical-align: middle; + + &.binary-badge { + background-color: var(--ifm-color-warning-contrast-background); + color: var(--ifm-color-warning-contrast-foreground); + } +} From b1cfc883235d15212bbde8aa7e85efafa3ce8c85 Mon Sep 17 00:00:00 2001 From: "autofix-ci[bot]" <114827586+autofix-ci[bot]@users.noreply.github.com> Date: Mon, 19 Jan 2026 18:52:14 +0000 Subject: [PATCH 11/18] [autofix.ci] apply automated fixes --- website/src/components/FileTypeTable.tsx | 155 ++++++++++---------- website/src/components/file-type-table.scss | 1 - 2 files changed, 74 insertions(+), 82 deletions(-) diff --git a/website/src/components/FileTypeTable.tsx b/website/src/components/FileTypeTable.tsx index 1afcabebd524..3f39b2e54884 100644 --- a/website/src/components/FileTypeTable.tsx +++ b/website/src/components/FileTypeTable.tsx @@ -4,97 +4,90 @@ import { fileTypeDefinitions, isBinaryFileType } from '@cspell/filetypes'; import './file-type-table.scss'; export const FileTypeTable = () => { - const [searchTerm, setSearchTerm] = useState(''); - const [showBinary, setShowBinary] = useState(false); + const [searchTerm, setSearchTerm] = useState(''); + const [showBinary, setShowBinary] = useState(false); - const filteredFileTypes = useMemo(() => { - let filtered = fileTypeDefinitions; + const filteredFileTypes = useMemo(() => { + let filtered = fileTypeDefinitions; - if (!showBinary) { - filtered = filtered.filter((f) => !isBinaryFileType(f.id)); - } + if (!showBinary) { + filtered = filtered.filter((f) => !isBinaryFileType(f.id)); + } - if (searchTerm) { - const term = searchTerm.toLowerCase(); - filtered = filtered.filter((f) => { - const extensions = [...f.extensions, ...(f.filenames || [])].join(' ').toLowerCase(); - return ( - f.id.toLowerCase().includes(term) || - (f.description && f.description.toLowerCase().includes(term)) || - extensions.includes(term) - ); - }); - } + if (searchTerm) { + const term = searchTerm.toLowerCase(); + filtered = filtered.filter((f) => { + const extensions = [...f.extensions, ...(f.filenames || [])].join(' ').toLowerCase(); + return ( + f.id.toLowerCase().includes(term) || + (f.description && f.description.toLowerCase().includes(term)) || + extensions.includes(term) + ); + }); + } - return filtered; - }, [searchTerm, showBinary]); + return filtered; + }, [searchTerm, showBinary]); - const binaryCount = fileTypeDefinitions.filter((f) => isBinaryFileType(f.id)).length; - const textCount = fileTypeDefinitions.length - binaryCount; + const binaryCount = fileTypeDefinitions.filter((f) => isBinaryFileType(f.id)).length; + const textCount = fileTypeDefinitions.length - binaryCount; - return ( -
-
- setSearchTerm(e.target.value)} - className="search-input" - /> -
+ return ( +
+
+ setSearchTerm(e.target.value)} + className="search-input" + /> +
-
- - - Showing {filteredFileTypes.length} of {showBinary ? fileTypeDefinitions.length : textCount} file - types - -
+
+ + + Showing {filteredFileTypes.length} of {showBinary ? fileTypeDefinitions.length : textCount} file types + +
-
-
-
File Type ID
-
Description
-
Filenames
-
Extensions
-
+
+
+
File Type ID
+
Description
+
Filenames
+
Extensions
+
-
- {filteredFileTypes.map((m, index) => ( -
-
- {m.id} - {m.format === 'Binary' && Binary} -
-
{m.description || '-'}
-
- {m.filenames && {m.filenames.join(', ')}} - {!m.filenames && <>-} -
-
- {m.extensions && {m.extensions.join(', ')}} - {!m.extensions && <>-} -
-
- ))} -
+
+ {filteredFileTypes.map((m, index) => ( +
+
+ {m.id} + {m.format === 'Binary' && Binary} +
+
{m.description || '-'}
+
+ {m.filenames && {m.filenames.join(', ')}} + {!m.filenames && <>-} +
+
+ {m.extensions && {m.extensions.join(', ')}} + {!m.extensions && <>-} +
+ ))} +
+
- {filteredFileTypes.length === 0 && ( -

No file types found matching "{searchTerm}"

- )} + {filteredFileTypes.length === 0 &&

No file types found matching "{searchTerm}"

} -

- Total: {filteredFileTypes.length} file type{filteredFileTypes.length !== 1 ? 's' : ''} -

-
- ); +

+ Total: {filteredFileTypes.length} file type{filteredFileTypes.length !== 1 ? 's' : ''} +

+
+ ); }; diff --git a/website/src/components/file-type-table.scss b/website/src/components/file-type-table.scss index 3cbd3f0a8a92..446ed8e2e924 100644 --- a/website/src/components/file-type-table.scss +++ b/website/src/components/file-type-table.scss @@ -172,7 +172,6 @@ } } - // Badge styles .badge { display: inline-block; From e0a10af0cf463362a6dcbda9374f910c2f6b0aa4 Mon Sep 17 00:00:00 2001 From: Bence Markus <23279421+mrksbnc@users.noreply.github.com> Date: Mon, 19 Jan 2026 20:32:05 +0100 Subject: [PATCH 12/18] chore: typo update --- website/docs/dictionaries/available-languages.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/dictionaries/available-languages.mdx b/website/docs/dictionaries/available-languages.mdx index 669d6f8dbf09..f07c6ef9f5dd 100644 --- a/website/docs/dictionaries/available-languages.mdx +++ b/website/docs/dictionaries/available-languages.mdx @@ -15,7 +15,7 @@ This page provides a reference for how CSpell associates file extensions with fi ## Understanding File Type Ids :::info Terminology Note -In CSpell configuration files, the field is called `languageId` for historical reasons (to match VSCode's convention). However, this refers to **file types** (like `javascript`, `python`, `markdown`), not spoken languages (like English or Spanish). +In CSpell configuration files, the field is called `languageId` for historical reasons (to match VSCode's convention). However, this refers to **file types** (like `javascript`, `python`, `markdown`), not spoken languages (like English, German or Spanish). ::: ## How CSpell Determines File Types From c1b84a7519cb986d8bd762139f43a30b199930cf Mon Sep 17 00:00:00 2001 From: Jason Dent Date: Tue, 20 Jan 2026 07:21:05 +0100 Subject: [PATCH 13/18] Update package.json Now that the website directly references the rest of the packages, we need to build them first. --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 0b31d563bf6e..9d63a55518c1 100644 --- a/package.json +++ b/package.json @@ -61,7 +61,7 @@ "test:bin-spell-cache-metadata": "node ./bin.mjs -c cspell.test.json --cache --cache-strategy metadata --cache-location temp/.cspellcache-meta", "test:bin-trace": "node ./bin.mjs trace test", "test:prep": "cspell-tools btrie node_modules/@cspell/dict-en_us/en_US.trie.gz", - "test-build-docs": "cd website && pnpm run build:site", + "test-build-docs": "pnpm run build:prod && cd website && pnpm run build:site", "test-integrations": "cd ./integration-tests && pnpm run integration-tests", "test-schema": "node ./test-packages/cspell-types/validate-schema/validate-schema.mjs", "test:deno": "deno run -A ./bin.mjs lint rfc packages/cspell/src", From 79566a4c0e87bb402dab4088c552fd3f3474c822 Mon Sep 17 00:00:00 2001 From: Jason Dent Date: Tue, 20 Jan 2026 08:18:40 +0100 Subject: [PATCH 14/18] Add tabbed cofnig --- .../docs/dictionaries/available-languages.mdx | 90 ++++++++++--------- 1 file changed, 50 insertions(+), 40 deletions(-) diff --git a/website/docs/dictionaries/available-languages.mdx b/website/docs/dictionaries/available-languages.mdx index f07c6ef9f5dd..7a4d912d71b4 100644 --- a/website/docs/dictionaries/available-languages.mdx +++ b/website/docs/dictionaries/available-languages.mdx @@ -6,6 +6,9 @@ sidebar_position: 4 sidebar_label: File Types --- +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + import { FileTypeTable } from '@site/src/components/FileTypeTable'; # File Types and Extensions @@ -31,51 +34,58 @@ CSpell uses file extensions and filenames to determine the file type, which then Force a specific file type for certain file patterns: -```yaml -overrides: - - filename: "**/*.xyz" - languageId: javascript # Treat .xyz files as JavaScript -``` - -Or in JSON format: - -```json -{ - "overrides": [ - { - "filename": "**/*.xyz", - "languageId": "javascript" - } - ] -} -``` + + + ```yaml + overrides: + - filename: "**/*.xyz" + languageId: javascript # Treat .xyz files as JavaScript + ``` + + + ```json + { + "overrides": [ + { + "filename": "**/*.xyz", + "languageId": "javascript" + } + ] + } + ``` + + + ### Using Language Settings Apply specific settings based on file type: -```yaml -languageSettings: - - languageId: python,javascript - caseSensitive: true - dictionaries: - - python - - node -``` - -Or in JSON format: - -```json -{ - "languageSettings": [ - { - "languageId": "python,javascript", - "caseSensitive": true, - "dictionaries": ["python", "node"] - } - ] -} -``` + + + + ```yaml + languageSettings: + - languageId: python,javascript + dictionaries: + - html + - lorem-ipsum + ``` + + + ```json + { + "languageSettings": [ + { + "languageId": "python,javascript", + "dictionaries": ["html", "lorem-ipsum"] + } + ] + } + ``` + + + ## Related Documentation From 5ca6c1c9f7a2cb49c7dfd24d44eb7a9f5e9f965a Mon Sep 17 00:00:00 2001 From: Jason Dent Date: Tue, 20 Jan 2026 08:43:31 +0100 Subject: [PATCH 15/18] Make sure the site will build when deployed --- .github/workflows/deploy-website.yml | 4 ++-- .github/workflows/website-lint.yml | 3 +++ .github/workflows/website-test.yml | 2 ++ 3 files changed, 7 insertions(+), 2 deletions(-) diff --git a/.github/workflows/deploy-website.yml b/.github/workflows/deploy-website.yml index 00c23126ce60..1b14c33edea9 100644 --- a/.github/workflows/deploy-website.yml +++ b/.github/workflows/deploy-website.yml @@ -27,12 +27,12 @@ jobs: - name: Setup Node and Pnpm uses: ./.github/actions/setup-node with: - node-version: 20.x + node-version: 'lts/*' - name: Build website run: | pnpm i - pnpm run build + pnpm run build:prod cd website pnpm run build:site diff --git a/.github/workflows/website-lint.yml b/.github/workflows/website-lint.yml index 3bd788764cb6..775590d39c9f 100644 --- a/.github/workflows/website-lint.yml +++ b/.github/workflows/website-lint.yml @@ -24,6 +24,9 @@ jobs: - name: Setup uses: ./.github/actions/setup + with: + node-version: 'lts/*' + - run: pnpm run build:prod - run: pnpm run install-website - run: pnpm run website-lint diff --git a/.github/workflows/website-test.yml b/.github/workflows/website-test.yml index 27a4d86f9a60..48981c3b5622 100644 --- a/.github/workflows/website-test.yml +++ b/.github/workflows/website-test.yml @@ -28,6 +28,8 @@ jobs: - name: Setup uses: ./.github/actions/setup + with: + node-version: 'lts/*' - name: Build website run: | From 160505cdffcb65cdea18455637472e19d2e06e9b Mon Sep 17 00:00:00 2001 From: Jason Dent Date: Tue, 20 Jan 2026 08:48:43 +0100 Subject: [PATCH 16/18] Rename to file-types --- .../available-languages.mdx => Configuration/file-types.mdx} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename website/docs/{dictionaries/available-languages.mdx => Configuration/file-types.mdx} (100%) diff --git a/website/docs/dictionaries/available-languages.mdx b/website/docs/Configuration/file-types.mdx similarity index 100% rename from website/docs/dictionaries/available-languages.mdx rename to website/docs/Configuration/file-types.mdx From 8b5e692ac81af86b668623287fb2524b76825292 Mon Sep 17 00:00:00 2001 From: Jason Dent Date: Tue, 20 Jan 2026 08:55:49 +0100 Subject: [PATCH 17/18] Update file-types.mdx --- website/docs/Configuration/file-types.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/website/docs/Configuration/file-types.mdx b/website/docs/Configuration/file-types.mdx index 7a4d912d71b4..4f67b911feea 100644 --- a/website/docs/Configuration/file-types.mdx +++ b/website/docs/Configuration/file-types.mdx @@ -89,9 +89,9 @@ Apply specific settings based on file type: ## Related Documentation -- [Language Settings](../Configuration/language-settings.mdx) - Configure settings per file type -- [Overrides](../Configuration/overrides.md) - Override settings for specific files -- [Searching Dictionaries](./searching-dictionaries.md) - Find which dictionaries contain words +- [Language Settings](./language-settings.mdx) - Configure settings per file type +- [Overrides](./overrides.md) - Override settings for specific files +- [Searching Dictionaries](../dictionaries/searching-dictionaries.md) - Find which dictionaries contain words ## Supported File Types From 431c7c80c9b6315c5698b958e5f6f728efb1f2f2 Mon Sep 17 00:00:00 2001 From: Jason Dent Date: Tue, 20 Jan 2026 09:29:37 +0100 Subject: [PATCH 18/18] Re-order the sidebar under configuration --- website/_scripts/extract-properties.mjs | 2 ++ website/docs/Configuration/auto_properties.md | 2 ++ website/docs/Configuration/document-settings.md | 5 ++--- website/docs/Configuration/file-types.mdx | 4 +--- website/docs/Configuration/githubaction.md | 9 +++++---- website/docs/Configuration/imports.md | 8 ++------ website/docs/Configuration/language-settings.mdx | 6 ++---- website/docs/Configuration/overrides.md | 6 ++---- website/docs/Configuration/patterns.md | 8 ++------ 9 files changed, 20 insertions(+), 30 deletions(-) diff --git a/website/_scripts/extract-properties.mjs b/website/_scripts/extract-properties.mjs index 58c81a57b0a4..c5cb8d8a5f47 100644 --- a/website/_scripts/extract-properties.mjs +++ b/website/_scripts/extract-properties.mjs @@ -27,6 +27,8 @@ async function run() { title: Properties slug: properties toc_max_heading_level: 5 + sidebar_position: 1 + sidebar_label: Properties format: md --- diff --git a/website/docs/Configuration/auto_properties.md b/website/docs/Configuration/auto_properties.md index 187f6128d99c..0f8d7f384fad 100644 --- a/website/docs/Configuration/auto_properties.md +++ b/website/docs/Configuration/auto_properties.md @@ -4,6 +4,8 @@ title: Properties slug: properties toc_max_heading_level: 5 +sidebar_position: 1 +sidebar_label: Properties format: md --- diff --git a/website/docs/Configuration/document-settings.md b/website/docs/Configuration/document-settings.md index 0e2295c858d1..b322412ed937 100644 --- a/website/docs/Configuration/document-settings.md +++ b/website/docs/Configuration/document-settings.md @@ -1,8 +1,7 @@ --- title: 'Document Settings' -categories: configuration -parent: Configuration -nav_order: 11 +sidebar_position: 1 +sidebar_label: Document Settings --- # Inline Document Settings diff --git a/website/docs/Configuration/file-types.mdx b/website/docs/Configuration/file-types.mdx index 4f67b911feea..ead5dccbe728 100644 --- a/website/docs/Configuration/file-types.mdx +++ b/website/docs/Configuration/file-types.mdx @@ -1,8 +1,6 @@ --- title: 'File Types and Extensions' -categories: docs -# parent: Docs -sidebar_position: 4 +sidebar_position: 12 sidebar_label: File Types --- diff --git a/website/docs/Configuration/githubaction.md b/website/docs/Configuration/githubaction.md index 977630bbaf69..4a7a4a570e79 100644 --- a/website/docs/Configuration/githubaction.md +++ b/website/docs/Configuration/githubaction.md @@ -1,13 +1,14 @@ --- title: 'Github Action Settings' -categories: configuration -parent: Configuration -nav_order: 11 +sidebar_position: 20 +sidebar_label: cspell-action --- # Github Action Settings -## Github Job Settings +Settings for [cspell-action](https://github.com/streetsidesoftware/cspell-action). + +## Github Workflow Job Settings - `files` -- Define glob patterns to filter the files to be checked. Use a new line between patterns to define multiple patterns. The default is to check ALL files that were changed in in the pull_request or push. Note: `ignorePaths` defined in cspell.json still apply. - `check_dot_files` -- Check files and directories starting with `.`. diff --git a/website/docs/Configuration/imports.md b/website/docs/Configuration/imports.md index 1d44149109e7..680c06ea29a2 100644 --- a/website/docs/Configuration/imports.md +++ b/website/docs/Configuration/imports.md @@ -1,13 +1,9 @@ --- -layout: default title: Importing / Extending Configuration -categories: configuration -parent: Configuration -nav_order: 11 +sidebar_position: 3 +sidebar_label: Importing Configuration --- - - # Importing Configuration By default the spell checker searches the current directory and up the hierarchy for the following files: diff --git a/website/docs/Configuration/language-settings.mdx b/website/docs/Configuration/language-settings.mdx index 1b3dd31ee5e2..6d81bee7e5e0 100644 --- a/website/docs/Configuration/language-settings.mdx +++ b/website/docs/Configuration/language-settings.mdx @@ -1,9 +1,7 @@ --- -layout: default title: Language Settings -categories: configuration -parent: Configuration -nav_order: 11 +sidebar_position: 8 +sidebar_label: Language Settings --- # Language Settings diff --git a/website/docs/Configuration/overrides.md b/website/docs/Configuration/overrides.md index 68f9a321ea7b..c07af57feea3 100644 --- a/website/docs/Configuration/overrides.md +++ b/website/docs/Configuration/overrides.md @@ -1,9 +1,7 @@ --- -layout: default title: Overrides -categories: configuration -parent: Configuration -nav_order: 11 +sidebar_position: 8 +sidebar_label: Overrides --- diff --git a/website/docs/Configuration/patterns.md b/website/docs/Configuration/patterns.md index 9ec996b069e0..a50c432e096a 100644 --- a/website/docs/Configuration/patterns.md +++ b/website/docs/Configuration/patterns.md @@ -1,13 +1,9 @@ --- -layout: default title: Exclude / Include Patterns -categories: configuration -parent: Configuration -nav_order: 11 +sidebar_position: 9 +sidebar_label: Exclude / Include --- - - # Exclude / Include Patterns **Covers:**