@nemigo/configs 1.0.1 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -8,46 +8,47 @@ export { includeIgnoreFile, convertIgnorePatternToMinimatch as convertIgnorePatt
8
8
  */
9
9
  export interface EslintConfigOptions {
10
10
  /**
11
- * Конфиг свелта для его линтига
11
+ * Конфиг Svelte для его линтинга
12
12
  *
13
13
  * @see https://sveltejs.github.io/eslint-plugin-svelte
14
14
  */
15
15
  svelte?: Config;
16
16
  /**
17
- * Использование strict-правил tslint
17
+ * Использование strict-правил typescript-eslint
18
18
  *
19
+ * @default false
19
20
  * @see https://typescript-eslint.io/users/configs/#strict
20
21
  */
21
22
  strict?: boolean;
22
23
  /**
23
- * Путь к проекту (`import.meta.dirname`) для более сложного линтинга типов (TypeChecked)
24
+ * Путь к проекту (`import.meta.dirname`) для typed linting
24
25
  *
25
26
  * @see https://typescript-eslint.io/getting-started/typed-linting
26
27
  */
27
28
  service?: string;
28
29
  /**
29
- * Путь к иному .eslint.ignore
30
+ * Путь к альтернативному файлу `.eslint.ignore`
30
31
  *
31
32
  * @see https://github.com/eslint/rewrite/tree/main/packages/compat#readme
32
33
  */
33
34
  ignore?: string;
34
35
  }
35
36
  /**
36
- * Готовый flat-конфиг для `eslint`
37
+ * Создает готовый flat-конфиг для **ESLint**
37
38
  *
38
39
  * Включает в себя:
40
+ * - Конфигурацию из `.eslint.ignore`
41
+ * - Глобальные переменные для браузера и Node.js (globals)
42
+ * - Рекомендованные правила из `@eslint/js`
43
+ * - Рекомендованные или strict правила из `typescript-eslint`
44
+ * - Опционально: конфигурацию для Svelte
39
45
  *
40
- * - .eslint.ignore
41
- * - Globals
42
- * - Javascript
43
- * - Typescript
44
- * - Svelte (опционально)
46
+ * Отключены различные правила TypeScript, которые только мешают.
45
47
  *
46
- * Отключено много раздражающих бессмысленных правил
48
+ * @param {EslintConfigOptions} [options] - Опции конфигурации
49
+ * @param {...ConfigWithExtendsArray} [rest] - Дополнительные конфигурации ESLint для расширения
50
+ * @returns {Linter.Config[]} Массив flat-конфигов ESLint
47
51
  *
48
- * @param {EslintConfigOptions} [options]
49
- * @param {...ConfigWithExtendsArray} [rest]
50
- * @returns {Linter.Config[]}
51
52
  * @see https://eslint.org/docs/latest/use/configure/configuration-files
52
53
  */
53
54
  export declare const defineEslintConfig: (options?: EslintConfigOptions, ...rest: ConfigWithExtendsArray) => Linter.Config[];
@@ -7,21 +7,21 @@ import { join } from "node:path";
7
7
  import tslint from "typescript-eslint";
8
8
  export { includeIgnoreFile, convertIgnorePatternToMinimatch as convertIgnorePattern };
9
9
  /**
10
- * Готовый flat-конфиг для `eslint`
10
+ * Создает готовый flat-конфиг для **ESLint**
11
11
  *
12
12
  * Включает в себя:
13
+ * - Конфигурацию из `.eslint.ignore`
14
+ * - Глобальные переменные для браузера и Node.js (globals)
15
+ * - Рекомендованные правила из `@eslint/js`
16
+ * - Рекомендованные или strict правила из `typescript-eslint`
17
+ * - Опционально: конфигурацию для Svelte
13
18
  *
14
- * - .eslint.ignore
15
- * - Globals
16
- * - Javascript
17
- * - Typescript
18
- * - Svelte (опционально)
19
+ * Отключены различные правила TypeScript, которые только мешают.
19
20
  *
20
- * Отключено много раздражающих бессмысленных правил
21
+ * @param {EslintConfigOptions} [options] - Опции конфигурации
22
+ * @param {...ConfigWithExtendsArray} [rest] - Дополнительные конфигурации ESLint для расширения
23
+ * @returns {Linter.Config[]} Массив flat-конфигов ESLint
21
24
  *
22
- * @param {EslintConfigOptions} [options]
23
- * @param {...ConfigWithExtendsArray} [rest]
24
- * @returns {Linter.Config[]}
25
25
  * @see https://eslint.org/docs/latest/use/configure/configuration-files
26
26
  */
27
27
  export const defineEslintConfig = (options, ...rest) => defineConfig(includeIgnoreFile(options?.ignore || join(import.meta.dirname, "../../.eslint.ignore"), "@nemigo/configs/.eslint.ignore"), jslint.configs.recommended, ...(options?.strict
@@ -5,4 +5,8 @@ export type ExtendsElement = SimpleExtendsElement | InfiniteArray<Linter.Config>
5
5
  export interface ConfigWithExtends extends Linter.Config {
6
6
  extends?: ExtendsElement[];
7
7
  }
8
+ /**
9
+ * Взято из @eslint/config-helpers/types (0.3.1), т.к. нужный тип (ConfigWithExtendsArray) не экспортируется пакетом.
10
+ * Представляется собой массив flat-конфигов ESLint
11
+ */
8
12
  export type ConfigWithExtendsArray = InfiniteArray<ConfigWithExtends>[];
@@ -1,2 +1 @@
1
- // Взято из @eslint/config-helpers/types (0.3.1), т.к. нужный тип (ConfigWithExtendsArray) не экспортируется пакетом
2
1
  export {};
@@ -1,9 +1,11 @@
1
1
  import type { Config, Options } from "prettier";
2
- import type { Options as JSDocPrettier } from "prettier-plugin-jsdoc";
3
2
  import type { MultilineArrayOptions } from "prettier-plugin-multiline-arrays";
4
3
  import type { PluginConfig as SveltePrettier } from "prettier-plugin-svelte";
5
4
  import type { PluginOptions as TailwindPrettier } from "prettier-plugin-tailwindcss";
6
- export type PrettierConfig = TailwindPrettier & Config & JSDocPrettier & Partial<MultilineArrayOptions> & SveltePrettier;
5
+ /**
6
+ * Объединенный тип конфигурации `prettier`, включающий настройки всех используемых плагинов
7
+ */
8
+ export type PrettierConfig = TailwindPrettier & Config & Partial<MultilineArrayOptions> & SveltePrettier;
7
9
  /**
8
10
  * Опции конфигурации для {@link definePrettierConfig}
9
11
  */
@@ -12,9 +14,7 @@ export interface PrettierConfigOptions {
12
14
  * Порог длины для переноса массивов
13
15
  *
14
16
  * @default 3
15
- *
16
17
  * @alias MultilineArrayOptions.multilineArraysWrapThreshold
17
- *
18
18
  * @see https://www.npmjs.com/package/prettier-plugin-multiline-arrays
19
19
  */
20
20
  arraysWrapThreshold?: number;
@@ -23,52 +23,66 @@ export interface PrettierConfigOptions {
23
23
  *
24
24
  * @see https://www.npmjs.com/package/prettier-plugin-tailwindcss
25
25
  */
26
- tailwind: {
26
+ tailwind?: {
27
27
  /**
28
- * Путь к конфигу Tailwind V4 (`./src/tailwind.css`)
28
+ * Путь к конфигу Tailwind V4 (например, `./src/tailwind.css`)
29
29
  *
30
30
  * @alias TailwindPrettier.tailwindStylesheet
31
- *
32
31
  * @see https://www.npmjs.com/package/prettier-plugin-tailwindcss
33
32
  */
34
33
  stylesheet?: string;
35
34
  };
36
35
  /**
37
- * Переопределение конфига
38
- *
39
- * @see https://prettier.io/docs/options
40
- * @see https://www.npmjs.com/package/prettier-plugin-tailwindcss
36
+ * Переопределение конфига Prettier
41
37
  */
42
- override?: PrettierConfig;
38
+ overload?: PrettierConfig;
43
39
  }
44
40
  /**
45
- * Готовый конфиг для `prettier`
41
+ * Создает готовый конфиг для **Prettier**
46
42
  *
47
43
  * Включает в себя плагины:
44
+ * - `prettier-plugin-svelte` - поддержка Svelte
45
+ * - `prettier-plugin-css-order` - сортировка CSS свойств
46
+ * - `prettier-plugin-multiline-arrays` - форматирование массивов
47
+ * - `prettier-plugin-tailwindcss` - сортировка классов Tailwind CSS
48
48
  *
49
- * - Prettier-plugin-svelte
50
- * - Prettier-plugin-css-order
51
- * - Prettier-plugin-multiline-arrays
52
- * - Prettier-plugin-jsdoc
53
- * - Prettier-plugin-tailwindcss
54
- *
55
- * Используются:
56
- *
57
- * - Табы длинной 2
49
+ * Основные настройки:
50
+ * - Ширина таба: 2 пробела
51
+ * - Использование табов: true
52
+ * - Ширина строки: 150 символов
58
53
  * - Двойные кавычки
54
+ * - Запятые в конце (es5)
55
+ * - Теги в одной строке с элементами
56
+ *
57
+ * @param {PrettierConfigOptions} [options] - Опции конфигурации
58
+ * @returns {PrettierConfig} Готовый конфиг Prettier
59
59
  *
60
- * @param {PrettierConfigOptions} [options]
61
- * @returns {PrettierConfig}
62
60
  * @see https://prettier.io
63
61
  */
64
62
  export declare const definePrettierConfig: (options?: PrettierConfigOptions) => PrettierConfig;
65
63
  /**
66
- * Форматирование с помощью `prettier` по сборке из {@link definePrettierConfig}
64
+ * Форматирование кода с помощью **Prettier** используя конфиг из {@link definePrettierConfig}
67
65
  *
68
- * @param {string} content
69
- * @param {Options["parser"]} parser
70
- * @param {PrettierConfigOptions} [options]
71
- * @returns {Promise<string>}
72
- * @see https://prettier.io
66
+ * @example
67
+ * ```typescript
68
+ * // Форматирование TypeScript кода
69
+ * const formatted = await pretty(`const x=1`, 'typescript');
70
+ *
71
+ * // Форматирование Svelte компонента
72
+ * const formatted = await pretty(`<div>hello</div>`, 'svelte');
73
+ *
74
+ * // Форматирование с кастомными опциями
75
+ * const formatted = await pretty(`const x=1`, 'typescript', {
76
+ * arraysWrapThreshold: 5,
77
+ * tailwind: { stylesheet: './src/tailwind.css' }
78
+ * });
79
+ * ```
80
+ *
81
+ * @param {string} content - Исходный код для форматирования
82
+ * @param {Options["parser"]} parser - Парсер для определения типа кода
83
+ * @param {PrettierConfigOptions} [options] - Дополнительные опции конфигурации
84
+ * @returns {Promise<string>} Отформатированный код
85
+ *
86
+ * @see https://prettier.io/docs/api#format
73
87
  */
74
88
  export declare const pretty: (content: string, parser: Options["parser"], options?: PrettierConfigOptions) => Promise<string>;
@@ -1,28 +1,29 @@
1
1
  import { format } from "prettier";
2
2
  // noinspection TypeScriptCheckImport (у пакета нет типов)
3
3
  import * as css from "prettier-plugin-css-order";
4
- import * as jsdoc from "prettier-plugin-jsdoc";
5
4
  import * as arrays from "prettier-plugin-multiline-arrays";
6
5
  import * as svelte from "prettier-plugin-svelte";
7
6
  import * as tailwind from "prettier-plugin-tailwindcss";
8
7
  /**
9
- * Готовый конфиг для `prettier`
8
+ * Создает готовый конфиг для **Prettier**
10
9
  *
11
10
  * Включает в себя плагины:
11
+ * - `prettier-plugin-svelte` - поддержка Svelte
12
+ * - `prettier-plugin-css-order` - сортировка CSS свойств
13
+ * - `prettier-plugin-multiline-arrays` - форматирование массивов
14
+ * - `prettier-plugin-tailwindcss` - сортировка классов Tailwind CSS
12
15
  *
13
- * - Prettier-plugin-svelte
14
- * - Prettier-plugin-css-order
15
- * - Prettier-plugin-multiline-arrays
16
- * - Prettier-plugin-jsdoc
17
- * - Prettier-plugin-tailwindcss
18
- *
19
- * Используются:
20
- *
21
- * - Табы длинной 2
16
+ * Основные настройки:
17
+ * - Ширина таба: 2 пробела
18
+ * - Использование табов: true
19
+ * - Ширина строки: 150 символов
22
20
  * - Двойные кавычки
21
+ * - Запятые в конце (es5)
22
+ * - Теги в одной строке с элементами
23
+ *
24
+ * @param {PrettierConfigOptions} [options] - Опции конфигурации
25
+ * @returns {PrettierConfig} Готовый конфиг Prettier
23
26
  *
24
- * @param {PrettierConfigOptions} [options]
25
- * @returns {PrettierConfig}
26
27
  * @see https://prettier.io
27
28
  */
28
29
  export const definePrettierConfig = (options) => ({
@@ -38,7 +39,6 @@ export const definePrettierConfig = (options) => ({
38
39
  svelte,
39
40
  css,
40
41
  arrays,
41
- jsdoc,
42
42
  tailwind,
43
43
  ],
44
44
  overrides: [
@@ -47,26 +47,39 @@ export const definePrettierConfig = (options) => ({
47
47
  options: { parser: "svelte" },
48
48
  },
49
49
  ],
50
- tsdoc: true,
51
- tailwindStylesheet: options?.tailwind.stylesheet,
52
- jsdocCommentLineStrategy: "multiline",
53
- ...(options?.override ?? {}),
50
+ tailwindStylesheet: options?.tailwind?.stylesheet,
51
+ ...(options?.overload ?? {}),
54
52
  });
55
- //...
56
53
  const config = definePrettierConfig();
57
54
  /**
58
- * Форматирование с помощью `prettier` по сборке из {@link definePrettierConfig}
55
+ * Форматирование кода с помощью **Prettier** используя конфиг из {@link definePrettierConfig}
59
56
  *
60
- * @param {string} content
61
- * @param {Options["parser"]} parser
62
- * @param {PrettierConfigOptions} [options]
63
- * @returns {Promise<string>}
64
- * @see https://prettier.io
57
+ * @example
58
+ * ```typescript
59
+ * // Форматирование TypeScript кода
60
+ * const formatted = await pretty(`const x=1`, 'typescript');
61
+ *
62
+ * // Форматирование Svelte компонента
63
+ * const formatted = await pretty(`<div>hello</div>`, 'svelte');
64
+ *
65
+ * // Форматирование с кастомными опциями
66
+ * const formatted = await pretty(`const x=1`, 'typescript', {
67
+ * arraysWrapThreshold: 5,
68
+ * tailwind: { stylesheet: './src/tailwind.css' }
69
+ * });
70
+ * ```
71
+ *
72
+ * @param {string} content - Исходный код для форматирования
73
+ * @param {Options["parser"]} parser - Парсер для определения типа кода
74
+ * @param {PrettierConfigOptions} [options] - Дополнительные опции конфигурации
75
+ * @returns {Promise<string>} Отформатированный код
76
+ *
77
+ * @see https://prettier.io/docs/api#format
65
78
  */
66
79
  export const pretty = (content, parser, options) => format(content, {
67
80
  ...config,
68
81
  parser,
69
82
  multilineArraysWrapThreshold: options?.arraysWrapThreshold ?? 3,
70
- tailwindStylesheet: options?.tailwind.stylesheet,
71
- ...(options?.override ?? {}),
83
+ tailwindStylesheet: options?.tailwind?.stylesheet,
84
+ ...(options?.overload ?? {}),
72
85
  });
@@ -7,7 +7,6 @@ export interface SvelteConfigOptions {
7
7
  * Адаптер серверной платформы
8
8
  *
9
9
  * @alias Config.kit.adapter
10
- *
11
10
  * @see https://svelte.dev/docs/kit/adapters
12
11
  */
13
12
  adapter: Adapter;
@@ -17,7 +16,6 @@ export interface SvelteConfigOptions {
17
16
  * @default true
18
17
  *
19
18
  * @alias Config.compilerOptions.runes
20
- *
21
19
  * @see https://svelte.dev/docs/svelte/what-are-runes
22
20
  */
23
21
  runes?: boolean;
@@ -27,7 +25,6 @@ export interface SvelteConfigOptions {
27
25
  * Отключить, если нужна возможность обращения с локалки на прод-приложения
28
26
  *
29
27
  * @alias Config.kit.csrf.checkOrigin
30
- *
31
28
  * @see https://svelte.dev/docs/kit/configuration#csrf
32
29
  * @see https://developer.mozilla.org/en-US/docs/Web/Security/Types_of_attacks#cross-site_request_forgery_csrf
33
30
  */
@@ -36,7 +33,6 @@ export interface SvelteConfigOptions {
36
33
  * Алиасы путей
37
34
  *
38
35
  * @alias Config.kit.alias
39
- *
40
36
  * @see https://svelte.dev/docs/kit/configuration#alias
41
37
  */
42
38
  alias?: Record<string, string>;
@@ -50,7 +46,6 @@ export interface SvelteConfigOptions {
50
46
  * Путь к директории со статическими файлами
51
47
  *
52
48
  * @alias Config.kit.files.assets
53
- *
54
49
  * @see https://svelte.dev/docs/kit/configuration#files
55
50
  */
56
51
  assets?: string;
@@ -58,7 +53,6 @@ export interface SvelteConfigOptions {
58
53
  * Путь к главному `app.html` приложения
59
54
  *
60
55
  * @alias Config.kit.files.appTemplate
61
- *
62
56
  * @see https://svelte.dev/docs/kit/configuration#files
63
57
  */
64
58
  app_html?: string;
@@ -66,7 +60,6 @@ export interface SvelteConfigOptions {
66
60
  * Путь к `error.html` приложения
67
61
  *
68
62
  * @alias Config.kit.files.errorTemplate
69
- *
70
63
  * @see https://svelte.dev/docs/kit/configuration#files
71
64
  */
72
65
  error_html?: string;
@@ -75,7 +68,6 @@ export interface SvelteConfigOptions {
75
68
  * Глобусы включений для tsconfig-а
76
69
  *
77
70
  * @alias Config.kit.typescript.config.include
78
- *
79
71
  * @see @https://svelte.dev/docs/kit/configuration#typescript
80
72
  * @see https://www.typescriptlang.org/tsconfig/#include
81
73
  */
@@ -84,14 +76,13 @@ export interface SvelteConfigOptions {
84
76
  * Глобусы исключений для tsconfig-а
85
77
  *
86
78
  * @alias Config.kit.typescript.config.exclude
87
- *
88
79
  * @see @https://svelte.dev/docs/kit/configuration#typescript
89
80
  * @see https://www.typescriptlang.org/tsconfig/#exclude
90
81
  */
91
82
  exclude?: string[];
92
83
  }
93
84
  /**
94
- * Реструктурированная конфигурация приложений на `@sveltejs/kit`
85
+ * Реструктурированная конфигурация приложений на **SvelteKit**
95
86
  *
96
87
  * - По умолчанию **только** руны
97
88
  * - Подключён VitePreprocess (@sveltejs/vite-plugin-svelte)
@@ -99,6 +90,7 @@ export interface SvelteConfigOptions {
99
90
  *
100
91
  * @param {SvelteConfigOptions} options
101
92
  * @returns {Config}
93
+ *
102
94
  * @see https://svelte.dev/docs/kit/introduction
103
95
  * @see https://svelte.dev/docs/kit/integrations#vitePreprocess
104
96
  * @see https://www.typescriptlang.org/tsconfig
@@ -5,7 +5,7 @@ const getOptionalObject = (value) => (isObject(value) ? value : {});
5
5
  const getOptionalArray = (value) => (Array.isArray(value) ? value : []);
6
6
  const setifyArray = (array) => Array.from(new Set(array));
7
7
  /**
8
- * Реструктурированная конфигурация приложений на `@sveltejs/kit`
8
+ * Реструктурированная конфигурация приложений на **SvelteKit**
9
9
  *
10
10
  * - По умолчанию **только** руны
11
11
  * - Подключён VitePreprocess (@sveltejs/vite-plugin-svelte)
@@ -13,6 +13,7 @@ const setifyArray = (array) => Array.from(new Set(array));
13
13
  *
14
14
  * @param {SvelteConfigOptions} options
15
15
  * @returns {Config}
16
+ *
16
17
  * @see https://svelte.dev/docs/kit/introduction
17
18
  * @see https://svelte.dev/docs/kit/integrations#vitePreprocess
18
19
  * @see https://www.typescriptlang.org/tsconfig
@@ -7,9 +7,7 @@ export interface SveltePackageConfigOptions {
7
7
  * Только руны
8
8
  *
9
9
  * @default true
10
- *
11
10
  * @alias Config.compilerOptions.runes
12
- *
13
11
  * @see https://svelte.dev/docs/svelte/what-are-runes
14
12
  */
15
13
  runes?: boolean;
@@ -17,9 +15,7 @@ export interface SveltePackageConfigOptions {
17
15
  * Добавляет алиас `{ "#": "src" }`
18
16
  *
19
17
  * @default true
20
- *
21
18
  * @alias Config.kit.alias
22
- *
23
19
  * @see https://svelte.dev/docs/kit/configuration#alias
24
20
  */
25
21
  isolate?: boolean;
@@ -27,7 +23,6 @@ export interface SveltePackageConfigOptions {
27
23
  * Алиасы путей
28
24
  *
29
25
  * @alias Config.kit.alias
30
- *
31
26
  * @see https://svelte.dev/docs/kit/configuration#alias
32
27
  */
33
28
  alias?: Record<string, string>;
@@ -36,13 +31,12 @@ export interface SveltePackageConfigOptions {
36
31
  *
37
32
  * @default "./src"
38
33
  * @alias Config.kit.files.lib
39
- *
40
34
  * @see https://svelte.dev/docs/kit/configuration#files
41
35
  */
42
36
  path?: string;
43
37
  }
44
38
  /**
45
- * Реструктурированная конфигурация для `@sveltejs/package`
39
+ * Реструктурированная конфигурация для **@sveltejs/package**
46
40
  *
47
41
  * - По умолчанию **только** руны.
48
42
  * - Подключён VitePreprocess (@sveltejs/vite-plugin-svelte).
@@ -1,6 +1,6 @@
1
1
  import { vitePreprocess } from "@sveltejs/vite-plugin-svelte";
2
2
  /**
3
- * Реструктурированная конфигурация для `@sveltejs/package`
3
+ * Реструктурированная конфигурация для **@sveltejs/package**
4
4
  *
5
5
  * - По умолчанию **только** руны.
6
6
  * - Подключён VitePreprocess (@sveltejs/vite-plugin-svelte).
@@ -38,7 +38,7 @@ export const defineSveltePackageConfig = (options) => ({
38
38
  lib: options?.path ?? "./src",
39
39
  },
40
40
  alias: {
41
- ...(options?.isolate ? { "#": "src" } : {}),
41
+ ...(!options?.isolate ? {} : { "#": "src" }),
42
42
  ...(options?.alias ?? {}),
43
43
  },
44
44
  },
@@ -5,12 +5,10 @@ import type { ViteUserConfig } from "vitest/config";
5
5
  */
6
6
  export interface ViteConfigOptions {
7
7
  /**
8
- * Путь к директории, где читает .env-файлы. Отключено, т.к. файлы читаются через dotenv
8
+ * Путь к директории, где читает .env-файлы. Отключено, так как предполагается использование **dotenv**
9
9
  *
10
10
  * @default false
11
- *
12
11
  * @alias ViteUserConfig.envDir
13
- *
14
12
  * @see https://vite.dev/config/shared-options.html#envdir
15
13
  */
16
14
  env?: string | false;
@@ -52,16 +50,17 @@ export interface ViteConfigOptions {
52
50
  plugins?: PluginOption[];
53
51
  }
54
52
  /**
55
- * Реструктурированная конфигурация для `vite` через `vitest`
53
+ * Реструктурированная конфигурация для **Vite** через **Vitest**
56
54
  *
57
- * - По умолчанию отключено чтение env-файлов
58
- * - "PUBLIC_" префикс для публичных env-переменных
59
- * - Строгая конфигурация порта сервера
55
+ * - По умолчанию отключено чтение env-файлов Vite (предполагается использование **dotenv**)
56
+ * - Префикс "PUBLIC_" для публичных env-переменных
57
+ * - Строгая конфигурация порта сервера по умолчанию
60
58
  * - По умолчанию путь к тестам "./src/**_/*.{test,spec}.{ts,js}"
61
59
  *
62
60
  * @param {ViteConfigOptions} [options]
63
61
  * @param {ViteUserConfig["test"]} [test]
64
62
  * @returns {ViteUserConfig}
63
+ *
65
64
  * @see https://vite.dev/ Документация Vite
66
65
  * @see https://vitest.dev/ Документация Vitest
67
66
  */
@@ -1,15 +1,16 @@
1
1
  import { defineConfig } from "vitest/config";
2
2
  /**
3
- * Реструктурированная конфигурация для `vite` через `vitest`
3
+ * Реструктурированная конфигурация для **Vite** через **Vitest**
4
4
  *
5
- * - По умолчанию отключено чтение env-файлов
6
- * - "PUBLIC_" префикс для публичных env-переменных
7
- * - Строгая конфигурация порта сервера
5
+ * - По умолчанию отключено чтение env-файлов Vite (предполагается использование **dotenv**)
6
+ * - Префикс "PUBLIC_" для публичных env-переменных
7
+ * - Строгая конфигурация порта сервера по умолчанию
8
8
  * - По умолчанию путь к тестам "./src/**_/*.{test,spec}.{ts,js}"
9
9
  *
10
10
  * @param {ViteConfigOptions} [options]
11
11
  * @param {ViteUserConfig["test"]} [test]
12
12
  * @returns {ViteUserConfig}
13
+ *
13
14
  * @see https://vite.dev/ Документация Vite
14
15
  * @see https://vitest.dev/ Документация Vitest
15
16
  */
@@ -23,12 +23,24 @@ export interface ViteProxyConfigOptions {
23
23
  changeOrigin?: boolean;
24
24
  }
25
25
  /**
26
- * Создания прокси-конфига для `vite`
27
- *
26
+ * Создания прокси-конфига для **Vite**.
28
27
  * Используется для проксирования запросов на основной сервер у приложений
29
28
  *
29
+ * @example
30
+ * ```typescript
31
+ * export default defineConfig({
32
+ * server: {
33
+ * proxy: defineViteProxyConfig({
34
+ * domain: "http://localhost:3000",
35
+ * prefix: "/api"
36
+ * })
37
+ * }
38
+ * });
39
+ * ```
40
+ *
30
41
  * @param {ViteProxyConfigOptions} options
31
42
  * @returns {ServerOptions["proxy"]}
43
+ *
32
44
  * @see https://vite.dev/config/server-options.html#server-proxy
33
45
  */
34
46
  export declare const defineViteProxyConfig: (options: ViteProxyConfigOptions) => ServerOptions["proxy"];
@@ -1,10 +1,22 @@
1
1
  /**
2
- * Создания прокси-конфига для `vite`
3
- *
2
+ * Создания прокси-конфига для **Vite**.
4
3
  * Используется для проксирования запросов на основной сервер у приложений
5
4
  *
5
+ * @example
6
+ * ```typescript
7
+ * export default defineConfig({
8
+ * server: {
9
+ * proxy: defineViteProxyConfig({
10
+ * domain: "http://localhost:3000",
11
+ * prefix: "/api"
12
+ * })
13
+ * }
14
+ * });
15
+ * ```
16
+ *
6
17
  * @param {ViteProxyConfigOptions} options
7
18
  * @returns {ServerOptions["proxy"]}
19
+ *
8
20
  * @see https://vite.dev/config/server-options.html#server-proxy
9
21
  */
10
22
  export const defineViteProxyConfig = (options) => {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@nemigo/configs",
3
- "version": "1.0.1",
3
+ "version": "1.1.0",
4
4
  "private": false,
5
5
  "author": {
6
6
  "name": "Vlad Logvin",
@@ -85,7 +85,6 @@
85
85
  "eslint-plugin-svelte": "3.12.4",
86
86
  "globals": "16.4.0",
87
87
  "prettier-plugin-css-order": "2.1.2",
88
- "prettier-plugin-jsdoc": "1.3.3",
89
88
  "prettier-plugin-multiline-arrays": "4.0.3",
90
89
  "prettier-plugin-svelte": "3.4.0",
91
90
  "prettier-plugin-tailwindcss": "0.7.0",