Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/carbon-design-system/carbon-preprocess-svelte

Svelte preprocessors for the Carbon Design System
https://github.com/carbon-design-system/carbon-preprocess-svelte

carbon carbon-design-system carbon-preprocess preprocess svelte svelte-preprocessor

Last synced: 1 day ago
JSON representation

Svelte preprocessors for the Carbon Design System

Host: GitHub
URL: https://github.com/carbon-design-system/carbon-preprocess-svelte
Owner: carbon-design-system
License: apache-2.0
Created: 2021-05-07T21:16:59.000Z (almost 4 years ago)
Default Branch: main
Last Pushed: 2024-04-10T04:40:32.000Z (10 months ago)
Last Synced: 2024-04-14T06:07:37.663Z (10 months ago)
Topics: carbon, carbon-design-system, carbon-preprocess, preprocess, svelte, svelte-preprocessor
Language: TypeScript
Homepage:
Size: 260 KB
Stars: 64
Watchers: 9
Forks: 6
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

        # carbon-preprocess-svelte

[![NPM][npm]][npm-url]

![GitHub](https://img.shields.io/github/license/ibm/carbon-preprocess-svelte?color=262626&style=for-the-badge)

![npm downloads to date](https://img.shields.io/npm/dt/carbon-preprocess-svelte?color=262626&style=for-the-badge)

> [Svelte preprocessors](https://svelte.dev/docs/svelte-compiler#types-preprocessor) for the Carbon Design System.

## Installation

Install `carbon-preprocess-svelte` as a development dependency.

```sh

# npm

npm i -D carbon-preprocess-svelte

# pnpm

pnpm i -D carbon-preprocess-svelte

# Yarn

yarn add -D carbon-preprocess-svelte

# Bun

bun add -D carbon-preprocess-svelte

```

## Usage

- [**optimizeImports**](#optimizeimports): Svelte preprocessor that rewrites Carbon Svelte imports to their source path in the `script` block, making development compile times dramatically faster.

- [**optimizeCss**](#optimizecss): Vite/Rollup plugin that removes unused Carbon styles, resulting in smaller CSS bundles.

- [**OptimizeCssPlugin**](#optimizecssplugin): The corresponding `optimizeCss` plugin for Webpack that removes unused Carbon styles.

### `optimizeImports`

`optimizeImports` is a Svelte preprocessor that rewrites barrel imports from Carbon components/icons/pictograms packages to their source Svelte code paths. This can significantly speed up development and build compile times while preserving typeahead and autocompletion offered by integrated development environments (IDE) like VS Code.

The preprocessor optimizes imports from the following packages:

- [carbon-components-svelte](https://github.com/carbon-design-system/carbon-components-svelte)

- [carbon-icons-svelte](https://github.com/carbon-design-system/carbon-icons-svelte)

- [carbon-pictograms-svelte](https://github.com/carbon-design-system/carbon-pictograms-svelte)

```diff

- import { Button } from "carbon-components-svelte";

+ import Button from "carbon-components-svelte/src/Button/Button.svelte";

- import { Add } from "carbon-icons-svelte";

+ import Add from "carbon-icons-svelte/lib/Add.svelte";

- import { Airplane } from "carbon-pictograms-svelte";

+ import Airplane from "carbon-pictograms-svelte/lib/Airplane.svelte";

```

> [!NOTE]

> When this preprocessor was first created, there was no workaround to optimize slow cold start times with Vite in development.

> Today, [@sveltejs/vite-plugin-svelte](https://github.com/sveltejs/vite-plugin-svelte) enables [`prebundleSvelteLibraries: true`](https://github.com/sveltejs/vite-plugin-svelte/blob/ba4ac32cf5c3e9c048d1ac430c1091ca08eaa130/docs/config.md#prebundlesveltelibraries) by default.

> However, this preprocessor is still useful for non-Vite bundlers, like Rollup and Webpack. Also, it can further improve cold start development times even with `prebundleSvelteLibraries: true`.

#### SvelteKit

See [examples/sveltekit](examples/sveltekit).

```js

// svelte.config.js

import adapter from "@sveltejs/adapter-static";

import { vitePreprocess } from "@sveltejs/vite-plugin-svelte";

import { optimizeImports } from "carbon-preprocess-svelte";

/** @type {import('@sveltejs/kit').Config} */

const config = {

  preprocess: [

    // Preprocessors are run in sequence.

    // If using TypeScript, the code must be transpiled first.

    vitePreprocess(),

    optimizeImports(),

  ],

  kit: {

    adapter: adapter(),

  },

};

export default config;

```

#### Vite

See [examples/vite](examples/vite).

```js

// vite.config.js

import { svelte } from "@sveltejs/vite-plugin-svelte";

import { vitePreprocess } from "@sveltejs/vite-plugin-svelte";

import { optimizeImports } from "carbon-preprocess-svelte";

/** @type {import('vite').UserConfig} */

export default {

  plugins: [

    svelte({

      preprocess: [

        // Preprocessors are run in sequence.

        // If using TypeScript, the code must be transpiled first.

        vitePreprocess(),

        optimizeImports(),

      ],

    }),

  ],

};

```

#### Rollup

This code is abridged; see [examples/rollup](examples/rollup) for a full set-up.

```js

// rollup.config.js

import svelte from "rollup-plugin-svelte";

import { optimizeImports } from "carbon-preprocess-svelte";

export default {

  plugins: [

    svelte({

      preprocess: [optimizeImports()],

    }),

  ],

};

```

#### Webpack

This code is abridged; see [examples/webpack](examples/webpack) for a full set-up.

```js

// webpack.config.js

const { optimizeImports } = require("carbon-preprocess-svelte");

module.exports = {

  module: {

    rules: [

      {

        test: /\.svelte$/,

        use: {

          loader: "svelte-loader",

          options: {

            hotReload: !PROD,

            preprocess: [optimizeImports()],

            compilerOptions: { dev: !PROD },

          },

        },

      },

    ],

  },

};

```

### `optimizeCss`

`optimizeCss` is a Vite plugin that removes unused Carbon styles at build time. The plugin is compatible with Rollup ([Vite](https://vitejs.dev/guide/api-plugin) extends the Rollup plugin API).

```diff

$ vite build

Optimized index-CU4gbKFa.css

- Before: 606.26 kB

+ After:   53.22 kB (-91.22%)

dist/index.html                  0.34 kB │ gzip:  0.24 kB

dist/assets/index-CU4gbKFa.css  53.22 kB │ gzip:  6.91 kB

dist/assets/index-Ceijs3eO.js   53.65 kB │ gzip: 15.88 kB

```

> [!NOTE]

> This is a plugin and not a Svelte preprocessor. It should be added to the list of `vite.plugins`. For Vite set-ups, this plugin _is not run_ during development and is only executed when building the app (i.e., `vite build`). For Rollup and Webpack, you should conditionally apply the plugin to only execute when building for production.

#### SvelteKit

See [examples/sveltekit](examples/sveltekit).

```js

// vite.config.js

import { sveltekit } from "@sveltejs/kit/vite";

import { optimizeCss } from "carbon-preprocess-svelte";

import { defineConfig } from "vite";

export default defineConfig({

  plugins: [sveltekit(), optimizeCss()],

});

```

#### Vite

See [examples/vite](examples/vite).

```js

// vite.config.js

import { svelte } from "@sveltejs/vite-plugin-svelte";

import { optimizeCss } from "carbon-preprocess-svelte";

/** @type {import('vite').UserConfig} */

export default {

  plugins: [svelte(), optimizeCss()],

};

```

#### Rollup

This code is abridged; see [examples/rollup](examples/rollup) for a full set-up.

```js

// rollup.config.js

import svelte from "rollup-plugin-svelte";

import { optimizeCss } from "carbon-preprocess-svelte";

const production = !process.env.ROLLUP_WATCH;

export default {

  plugins: [

    svelte({

      preprocess: [optimizeImports()],

    }),

    // Only apply the plugin when building for production.

    production && optimizeCss(),

  ],

};

```

#### `optimizeCss` API

```ts

optimizeCss({

  /**

   * By default, the plugin will print the size

   * difference between the original and optimized CSS.

   *

   * Set to `false` to disable verbose logging.

   * @default true

   */

  verbose: false,

  /**

   * By default, pre-compiled Carbon StyleSheets ship `@font-face` rules

   * for all available IBM Plex fonts, many of which are not actually

   * used in Carbon Svelte components.

   *

   * The default behavior is to preserve the following IBM Plex fonts:

   * - IBM Plex Sans (300/400/600-weight and normal-font-style rules)

   * - IBM Plex Mono (400-weight and normal-font-style rules)

   *

   * Set to `true` to disable this behavior and

   * retain *all* IBM Plex `@font-face` rules.

   * @default false

   */

  preserveAllIBMFonts: false,

});

```

### `OptimizeCssPlugin`

For Webpack users, `OptimizeCssPlugin` is a drop-in replacement for `optimizeCss`. The plugin API is identical to that of `optimizeCss`.

This code is abridged; see [examples/webpack](examples/webpack) for a full set-up.

```js

// webpack.config.js

const { OptimizeCssPlugin } = require("carbon-preprocess-svelte");

const PROD = process.env.NODE_ENV === "production";

module.exports = {

  plugins: [

    // Only apply the plugin when building for production.

    PROD && new OptimizeCssPlugin(),

  ],

};

```

## Examples

Refer to [examples](examples) for common set-ups.

## Contributing

Refer to the [contributing guidelines](CONTRIBUTING.md).

## License

[Apache 2.0](LICENSE)

[npm]: https://img.shields.io/npm/v/carbon-preprocess-svelte.svg?color=262626&style=for-the-badge

[npm-url]: https://npmjs.com/package/carbon-preprocess-svelte