Skip to content
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
5 changes: 5 additions & 0 deletions .changeset/safe-configs-smile.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@sveltejs/kit': patch
---

fix: recommend safe include and exclude patterns in tsconfig warning
4 changes: 3 additions & 1 deletion packages/kit/src/core/sync/write_tsconfig/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,9 @@ export function write_tsconfig(kit, root) {
types,
exclusions: [kit.files.serviceWorker],
example: {
extends: '$app/tsconfig'
extends: '$app/tsconfig',
include: ['src', 'test', '*'],
exclude: ['src/service-worker']
}
});

Expand Down
46 changes: 46 additions & 0 deletions packages/kit/src/core/sync/write_tsconfig/index.spec.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
import fs from 'node:fs';
import os from 'node:os';
import path from 'node:path';
import { afterEach, expect, test, vi } from 'vitest';
import { process_config, validate_config } from '../../config/index.js';
import { write_tsconfig } from './index.js';

/** @type {string[]} */
const dirs = [];

afterEach(() => {
vi.restoreAllMocks();

for (const dir of dirs) {
fs.rmSync(dir, { recursive: true, force: true });
}

dirs.length = 0;
});

test('warns with a safe root tsconfig', () => {
const root = fs.mkdtempSync(path.join(os.tmpdir(), 'svelte-kit-tsconfig-'));
dirs.push(root);

fs.writeFileSync(
path.join(root, 'tsconfig.json'),
JSON.stringify({ extends: './.svelte-kit/tsconfig.json' })
);

const warn = vi.spyOn(console, 'warn').mockImplementation(() => {});
const config = process_config(validate_config({}), root);
write_tsconfig(config, root);

expect(warn).toHaveBeenNthCalledWith(
2,
JSON.stringify(
{
extends: '$app/tsconfig',
include: ['src', 'test', '*'],
exclude: ['src/service-worker']
},
null,
' '
)
);
});
Loading