diff --git a/src/core/models/icons/defaultIcon.ts b/src/core/models/icons/defaultIcon.ts index 460dc24a3b..2fb5961e98 100644 --- a/src/core/models/icons/defaultIcon.ts +++ b/src/core/models/icons/defaultIcon.ts @@ -1,6 +1,6 @@ export type DefaultIcon = { /** - * Name of the icon, e.g. 'src' + * Name of the icon, e.g. `src` */ name: string; diff --git a/src/core/models/icons/files/fileIcon.ts b/src/core/models/icons/files/fileIcon.ts index b3984d7d1b..bc0f5d2390 100644 --- a/src/core/models/icons/files/fileIcon.ts +++ b/src/core/models/icons/files/fileIcon.ts @@ -5,19 +5,19 @@ import type { Patterns } from '../patterns/patterns'; type BasicFileIcon = { /** - * Name of the icon, e.g. 'javascript' + * Name of the icon, e.g. `javascript` */ name: string; /** * Define the file extensions that should use this icon. - * E.g. ['js'] + * E.g. `['js']` */ fileExtensions?: string[]; /** * Define if there are some static file names that should apply this icon. - * E.g. ['sample.js'] + * E.g. `['sample.js']` */ fileNames?: string[]; @@ -53,7 +53,7 @@ type BasicFileIcon = { }; /** - * Type for a FileIcon. In addition to the `name` property, either a `fileExtensions` or `fileNames` property is required. + * Type for a `FileIcon`. In addition to the `name` property, either a `fileExtensions` or `fileNames` property is required. */ export type FileIcon = RequireAtLeastOne< BasicFileIcon, diff --git a/src/core/models/icons/folders/folderIcon.ts b/src/core/models/icons/folders/folderIcon.ts index 4052a8b7cc..a55dfed126 100644 --- a/src/core/models/icons/folders/folderIcon.ts +++ b/src/core/models/icons/folders/folderIcon.ts @@ -3,13 +3,13 @@ import type { IconPack } from '../iconPack'; export type FolderIcon = { /** - * Name of the icon, e.g. 'src' + * Name of the icon, e.g. `src` */ name: string; /** * Define the folder names that should apply the icon. - * E.g. ['src', 'source'] + * E.g. `['src', 'source']` */ folderNames: string[]; diff --git a/src/core/models/icons/languages/languageIdentifier.ts b/src/core/models/icons/languages/languageIdentifier.ts index aa34b8acbf..66fbeb0b6b 100644 --- a/src/core/models/icons/languages/languageIdentifier.ts +++ b/src/core/models/icons/languages/languageIdentifier.ts @@ -8,7 +8,7 @@ export type LanguageIcon = { icon: DefaultIcon; /** - * Language ID, e.g. 'javascript' + * Language ID, e.g. `javascript` * * According to official VS Code documentation: * https://code.visualstudio.com/docs/languages/identifiers diff --git a/src/core/models/icons/patterns/patterns.ts b/src/core/models/icons/patterns/patterns.ts index 83537c4ab8..45bcb0c3ca 100644 --- a/src/core/models/icons/patterns/patterns.ts +++ b/src/core/models/icons/patterns/patterns.ts @@ -10,7 +10,7 @@ export enum FileNamePattern { /** Adds the following extensions to the file name: `js`, `mjs`, `cjs`, `ts`, `mts`, `cts`, `json`, `jsonc`, `json5`, `yaml`, `yml`, `toml`. */ NodeEcosystem = 'nodeEcosystem', - /** It adjusts the name with the following patterns: '.fileNamerc', '.config/fileNamerc', 'fileName.config' and combines that with the pattern NodeEcosystem */ + /** It adjusts the name with the following patterns: `.fileNamerc`, `.config/fileNamerc`, `fileName.config` and combines that with the pattern `NodeEcosystem` */ Cosmiconfig = 'cosmiconfig', }