svelte/test/validator/index.ts

import * as fs from 'fs';
import * as assert from 'assert';
import { svelte, loadConfig, tryToLoadJson } from '../helpers';

describe('validate', () => {
	fs.readdirSync(`${__dirname}/samples`).forEach(dir => {
		if (dir[0] === '.') return;

		// add .solo to a sample directory name to only run that test
		const solo = /\.solo/.test(dir);
		const skip = /\.skip/.test(dir);

		if (solo && process.env.CI) {
			throw new Error('Forgot to remove `solo: true` from test');
		}

		(solo ? it.only : skip ? it.skip : it)(dir, () => {
			const config = loadConfig(`${__dirname}/samples/${dir}/_config.js`);

			const input = fs.readFileSync(`${__dirname}/samples/${dir}/input.svelte`, 'utf-8').replace(/\s+$/, '').replace(/\r/g, '');
			const expected_warnings = tryToLoadJson(`${__dirname}/samples/${dir}/warnings.json`) || [];
			const expected_errors = tryToLoadJson(`${__dirname}/samples/${dir}/errors.json`);
			const options = tryToLoadJson(`${__dirname}/samples/${dir}/options.json`);

			let error;

			try {
				const { warnings } = svelte.compile(input, {
					dev: config.dev,
					legacy: config.legacy,
					generate: false,
					customElement: config.customElement,
					...options
				});

				assert.deepEqual(warnings.map(w => ({
					code: w.code,
					message: w.message,
					pos: w.pos,
					start: w.start,
					end: w.end
				})), expected_warnings);
			} catch (e) {
				error = e;
			}

			const expected = expected_errors && expected_errors[0];

			if (error || expected) {
				if (error && !expected) {
					throw error;
				}

				if (expected && !error) {
					throw new Error(`Expected an error: ${expected.message}`);
				}

				try {
					assert.equal(error.code, expected.code);
					assert.equal(error.message, expected.message);
					assert.deepEqual(error.start, expected.start);
					assert.deepEqual(error.end, expected.end);
					assert.equal(error.pos, expected.pos);
				} catch (e) {
					console.error(error); // eslint-disable-line no-console
					throw e;
				}
			}
		});
	});

	it('errors if options.name is illegal', () => {
		assert.throws(() => {
			svelte.compile('<div></div>', {
				name: 'not.valid',
				generate: false
			});
		}, /options\.name must be a valid identifier/);
	});

	it('warns if options.name is not capitalised', () => {
		const { warnings } = svelte.compile('<div></div>', {
			name: 'lowercase',
			generate: false
		});

		assert.deepEqual(warnings.map(w => ({
			code: w.code,
			message: w.message
		})), [{
			code: 'options-lowercase-name',
			message: 'options.name should be capitalised'
		}]);
	});

	it('does not warn if options.name begins with non-alphabetic character', () => {
		const { warnings } = svelte.compile('<div></div>', {
			name: '_',
			generate: false
		});

		assert.deepEqual(warnings, []);
	});

	it('errors if namespace is provided but unrecognised', () => {
		assert.throws(() => {
			svelte.compile('<div></div>', {
				name: 'test',
				namespace: 'svefefe'
			});
		}, /Invalid namespace 'svefefe'/);
	});

	it('errors with a hint if namespace is provided but unrecognised but close', () => {
		assert.throws(() => {
			svelte.compile('<div></div>', {
				name: 'test',
				namespace: 'foriegn'
			});
		}, /Invalid namespace 'foriegn' \(did you mean 'foreign'\?\)/);
	});

	it('does not throw error if \'this\' is bound for foreign element', () => {
		assert.doesNotThrow(() => {
			svelte.compile(`
			<script>
				let whatever;
			</script>
			<div bind:this={whatever} />`, {
				name: 'test',
				namespace: 'foreign'
			});
		});
	});
});