File tree Expand file tree Collapse file tree 10 files changed +60
-28
lines changed Expand file tree Collapse file tree 10 files changed +60
-28
lines changed Original file line number Diff line number Diff line change @@ -29,7 +29,10 @@ export const vitestGlobals = {
2929 afterEach : 'writable' ,
3030 onTestFailed : 'writable' ,
3131 onTestFinished : 'writable' ,
32- } as const satisfies Linter . Globals
32+ } as const satisfies Linter . Globals satisfies Record <
33+ keyof typeof vitest ,
34+ Extract < Linter . GlobalConf , 'writable' >
35+ >
3336
3437/**
3538 * An object that specifies which global
Original file line number Diff line number Diff line change @@ -9,7 +9,7 @@ import { flatESLintConfig } from './shareableConfigs.js'
99 * It's made mainly to provide intellisense and eliminate
1010 * the need for manual type annotations using JSDoc comments.
1111 *
12- * @param additionalOverrides - **Optional** additional overrides to apply to the configuration.
12+ * @param [ additionalOverrides] - **Optional** additional overrides to apply to the configuration.
1313 * @returns An augmented version of the default {@linkcode flatESLintConfig}, incorporating any provided overrides.
1414 *
1515 * @example
Original file line number Diff line number Diff line change @@ -32,7 +32,7 @@ import type { Config } from 'prettier'
3232 * @public
3333 * @since 0.0.3
3434 */
35- export const prettierConfig : Config = {
35+ export const prettierConfig = {
3636 semi : false ,
3737 singleQuote : true ,
38- }
38+ } as const satisfies Config
Original file line number Diff line number Diff line change @@ -7,7 +7,7 @@ import { prettierConfig } from './defaults.js'
77 * It's made mainly to provide intellisense and eliminate
88 * the need for manual type annotations using JSDoc comments.
99 *
10- * @param additionalOverrides - Optional additional overrides to apply to the configuration.
10+ * @param [ additionalOverrides] - ** Optional** additional overrides to apply to the configuration.
1111 * @returns An augmented version of the default {@linkcode prettierConfig}, incorporating any provided overrides.
1212 *
1313 * @example
Original file line number Diff line number Diff line change 1- import type { UserWorkspaceConfig , ViteUserConfig } from 'vitest/config '
1+ import type { UserWorkspaceConfig , ViteUserConfig } from './external.js '
22import { plugins } from './plugins.js'
33
44/**
@@ -19,7 +19,7 @@ export const vitestProjectDefaults = {
1919 } ,
2020
2121 /**
22- * @default [tsconfigPaths({ projects : ['./ tsconfig.json'], configNames : ['tsconfig.json'] })]
22+ * @default [tsconfigPaths({ configNames : ['tsconfig.json'], projects : ['./ tsconfig.json'] })]
2323 */
2424 plugins,
2525
@@ -89,11 +89,11 @@ export const vitestConfigDefaults = {
8989 } ,
9090
9191 /**
92- * @default process.env.GITHUB_ACTIONS ? [['verbose ', { summary: false }], ['github-actions']] : [['verbose ']]
92+ * @default process.env.GITHUB_ACTIONS ? [['default ', { summary: false }], ['github-actions']] : [['default ']]
9393 */
9494 reporters : process . env . GITHUB_ACTIONS
95- ? ( [ [ 'verbose ' , { summary : false } ] , [ 'github-actions' ] ] as const )
96- : ( [ [ 'verbose ' ] ] as const ) ,
95+ ? ( [ [ 'default ' , { summary : false } ] , [ 'github-actions' ] ] as const )
96+ : ( [ [ 'default ' ] ] as const ) ,
9797
9898 /**
9999 * @default false
Original file line number Diff line number Diff line change 1+ import tsconfigPaths from 'vite-tsconfig-paths'
2+ export type { PluginOptions } from 'vite-tsconfig-paths'
3+ export { defineConfig , defineProject , mergeConfig } from 'vitest/config'
4+ export type { Plugin , UserWorkspaceConfig , ViteUserConfig } from 'vitest/config'
5+ export { tsconfigPaths }
Original file line number Diff line number Diff line change 1- export { default as tsconfigPaths } from 'vite-tsconfig-paths'
2- export type { PluginOptions } from 'vite-tsconfig-paths'
31export { vitestConfigDefaults , vitestProjectDefaults } from './defaults.js'
4- export { plugins } from './plugins.js'
2+ export {
3+ defineConfig ,
4+ defineProject ,
5+ mergeConfig ,
6+ tsconfigPaths ,
7+ } from './external.js'
8+ export type {
9+ Plugin ,
10+ PluginOptions ,
11+ UserWorkspaceConfig ,
12+ ViteUserConfig ,
13+ } from './external.js'
14+ export { plugins , tsconfigPathsOptions } from './plugins.js'
515export { vitestConfig , vitestProject } from './shareableConfigs.js'
616export { createVitestConfig , createVitestProject } from './utils.js'
Original file line number Diff line number Diff line change 1- import tsconfigPaths from 'vite-tsconfig-paths '
2- import type { Plugin } from 'vitest/config '
1+ import type { Plugin , PluginOptions } from './external.js '
2+ import { tsconfigPaths } from './external.js '
33
4- export const plugins : [ Plugin ] = [
5- /* @__PURE__ */ tsconfigPaths ( {
6- projects : [ './tsconfig.json' ] ,
7- configNames : [ 'tsconfig.json' ] ,
8- } ) ,
4+ /**
5+ * Default configuration for {@linkcode tsconfigPaths}.
6+ *
7+ * @since 0.0.5
8+ * @public
9+ */
10+ export const tsconfigPathsOptions = {
11+ configNames : [ 'tsconfig.json' ] ,
12+ projects : [ './tsconfig.json' ] ,
13+ } as const satisfies PluginOptions
14+
15+ /**
16+ * plugins for {@linkcode vitestProjectDefaults}.
17+ *
18+ * @since 0.0.5
19+ * @public
20+ */
21+ export const plugins = [
22+ /* @__PURE__ */ tsconfigPaths ( tsconfigPathsOptions ) ,
923] as const satisfies [ Plugin ]
Original file line number Diff line number Diff line change 1- import type { UserWorkspaceConfig , ViteUserConfig } from 'vitest/config'
2- import { defineConfig , defineProject } from 'vitest/config'
31import { vitestConfigDefaults } from './defaults.js'
2+ import type { UserWorkspaceConfig , ViteUserConfig } from './external.js'
3+ import { defineConfig , defineProject } from './external.js'
44
55/**
6- * Shareable ** {@link https://vitest.dev | Vitest}**
6+ * Shareable {@link https://vitest.dev | ** Vitest**}
77 * configuration tailored for projects using TypeScript.
88 *
99 * @example
@@ -49,7 +49,7 @@ export const vitestConfig: ViteUserConfig =
4949 /* @__PURE__ */ defineConfig ( vitestConfigDefaults )
5050
5151/**
52- * Shareable ** {@link https://vitest.dev | Vitest}**
52+ * Shareable {@link https://vitest.dev | ** Vitest**}
5353 * configuration tailored for projects using TypeScript.
5454 *
5555 * @example
Original file line number Diff line number Diff line change 1- import type { UserWorkspaceConfig , ViteUserConfig } from 'vitest/config '
2- import { mergeConfig } from 'vitest/config '
1+ import type { UserWorkspaceConfig , ViteUserConfig } from './external.js '
2+ import { mergeConfig } from './external.js '
33import { vitestConfig , vitestProject } from './shareableConfigs.js'
44
55/**
66 * A function that returns {@linkcode vitestConfig}
77 * along with optional additional overrides.
88 *
9- * @param additionalOverrides - Optional additional overrides to apply to the configuration.
9+ * @param [ additionalOverrides] - ** Optional** additional overrides to apply to the configuration.
1010 * @returns An augmented version of the default {@linkcode vitestConfig}, incorporating any provided overrides.
1111 *
1212 * @example
@@ -77,7 +77,7 @@ export const createVitestConfig = (
7777 * A function that returns {@linkcode vitestProject}
7878 * along with optional additional overrides.
7979 *
80- * @param additionalOverrides - Optional additional overrides to apply to the configuration.
80+ * @param [ additionalOverrides] - ** Optional** additional overrides to apply to the configuration.
8181 * @returns An augmented version of the default {@linkcode vitestProject}, incorporating any provided overrides.
8282 *
8383 * @example
You can’t perform that action at this time.
0 commit comments