migration-guide.md

Migration Guide

• From v3 to v4
  • Prepending content to scss
  • Executing some function before preprocessing
  • Defining preprocessor properties
  • Type-checking components
• From v5 to v6

From v3 to v4

Prepending content to scss

In v3, it was possible to prepend some content for the scss language through the data property.

import sveltePreprocess from 'svelte-preprocess';

sveltePreprocess({
  scss: {
    data: '// prepended content',
  },
});

In v4, not only scss, but every language preprocessor accepts the new prependData property. The data property is no longer supported.

import sveltePreprocess from 'svelte-preprocess';

sveltePreprocess({
  scss: {
    prependData: '// prepended content for scss',
  },
  typescript: {
    prependData: '// prepended content for ts',
  },
});

Executing some function before preprocessing

The previously onBefore property was removed. Instead, enqueue a custom preprocessor before svelte-preprocess.

// v3

{
  preprocess: sveltePreprocess({
    onBefore({ content, filename }) {
      return content.replace('foo', 'bar');
    },
  });
}

// v4
const myPreprocessor = {
  markup({ content }) {
    return { code: content.replace('foo', 'bar') };
  },
};

// later in your config
{
  preprocess: [myPreprocessor, sveltePreprocess()];
}

Defining preprocessor properties

The previously transformers property was removed. Instead, define your preprocessor options in the root object of svelte-preprocess auto-preprocessor.

import sveltePreprocess from 'svelte-preprocess';

sveltePreprocess({
-  transformers: {
     scss: { ... }
-  }
});

Type-checking components

In v3, svelte-preprocess was able to type-check Svelte components. However, giving the specifics of the structure of a Svelte component and how the script and markup contents are related, type-checking was sub-optimal.

In v4, your TypeScript code will only be transpiled into JavaScript, with no type-checking whatsoever. We're moving the responsibility of type-checking to tools better fit to handle it, such as svelte-check, for CLI and CI usage, and the VS Code extension, for type-checking while developing.

From v5 to v6

• Svelte 4 or higher is required now
• Node 18 or higher is required now
• When using TypeScript, the minimum required version is now 5.0
• When using TypeScript, "verbatimModuleSyntax": true is now required in your tsconfig.json (instead of the deprecated preserveValueImports and importsNotUsedAsValues options). As a consequence, the mixed imports transpiler (handleMixedImports) was removed from the TypeScript preprocessor. This means that you now need to specify for each import if it's a type or value import. For example instead of import { value, Type } from 'somewhere' you now need to write import { value, type Type } from 'somewhere'
• The preserve option was removed as it's obsolete
• The default export is deprecated in favor of its new named export:

- import sveltePreprocess from 'svelte-preprocess';
+ import { sveltePreprocess } from 'svelte-preprocess';