Skip to content

Latest commit

 

History

History
59 lines (39 loc) · 2.48 KB

swc.md

File metadata and controls

59 lines (39 loc) · 2.48 KB
Raw

SWC Extension

Task Definitions: 'swc:init'
Template Definitions: 'assert'
Batcher Definitions: 'swc'

Performs a single-file SWC compilation using the SWC CLI.

SWC Template

Template Options

  • auto-install (Boolean, default: true): Whether to automatically install @swc/core and @swc/cli with npm if not present (using the npm extension). The global npm extension auto-install option will take precedence here if not otherwise set.
  • config-file (String): Custom SWC configuration file to use.
  • source-maps (Boolean, default true): Whether to output a source map for each compiled file.
  • swc-rc (Boolean, default: false): Whether to use the .swcrc project configuration file. Will be created if it does not exist with recommended SWC defaults.
  • ...config (Record): Custom SWC configurations provided by dotted property names (eg 'jsc.target = 'es2019').

Example

chompfile.toml

version = 0.1

extensions = ['[email protected]:swc']

[[task]]
name = 'build:swc'
target = 'lib/##.js'
dep = 'src/##.ts'
template = 'swc'
[task.template-options]
source-maps = false
'jsc.parser.tsx' = true
'jsc.minify' = true
'jsc.target' = 'es2017'

Ejection

When ejecting the template, only the SWC compilation CLI command will be ejected, without any .swcrc, auto-installation or intitialization tasks.

SWC Init Task

The experimental swc:init task uses the Deno engine to provide the ability to configure SWC through a command prompt interface, simplifying configuration setup for SWC.

This init command will rewrite the local chompfile.toml with the template options selected.

Try calling chomp swc:init from any project with the extension present to add an SWC task or reconfigure and existing SWC task.

SWC Batcher

SWC provides a simple batcher as an implementation detail for .swcrc construction to handle deduplication of this task.

Roadmap

As the primary recommended JS compilation workflow the SWC template should be relatively well-maintained.

The batcher should be extended to support batching of SWC compilations into a single SWC call. This will provide a significant performance improvement, at least while SWC is still implemented in Node.js and has the cost of the Node.js runtime initialization overhead. The SWC CLI does naturally support multiple files listed in the compilation by repeated -o flags so this should be relatively simple to implement.