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.

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

Improved hint comments #2496

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion src/core/models/icons/defaultIcon.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
export type DefaultIcon = {
/**
* Name of the icon, e.g. 'src'
* Name of the icon, e.g. `src`
*/
name: string;

Expand Down
8 changes: 4 additions & 4 deletions src/core/models/icons/files/fileIcon.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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[];

Expand Down Expand Up @@ -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,
Expand Down
4 changes: 2 additions & 2 deletions src/core/models/icons/folders/folderIcon.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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[];

Expand Down
2 changes: 1 addition & 1 deletion src/core/models/icons/languages/languageIdentifier.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/core/models/icons/patterns/patterns.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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',
}

Expand Down