atom-engine-compiler

0.4.4 verified Fri May 01 auth: no javascript

Compiler for .atom template files used in atom-native environment. Current version 0.4.4, released sporadically. It extends vip-server-renderer with native <style> support for server-side rendering. Differentiates by offering Atom template compilation with native style handling, similar to Vigi server renderer but adapted for Atom engine.

Common errors

error SyntaxError: Unexpected token 'export' ↓

cause Using require() in a CommonJS file when package is ESM-only

fix

Use import syntax or rename file to .mjs and use import()

error TypeError: compile is not a function ↓

cause Importing default export instead of named export compile

fix

Change to import { compile } from 'atom-engine-compiler'

error Error: Cannot find module 'vip-server-renderer' ↓

cause Missing peer dependency

fix

npm install vip-server-renderer

Warnings

breaking ESM-only since v0.4.0, requires Node >=12 with "type": "module" or .mjs extension ↓

fix Use import/export syntax and set "type": "module" in package.json

gotcha compile function returns an object, not a string ↓

fix Access result.html or result.css for output

deprecated vip-server-renderer dependency may be deprecated; check for updates ↓

fix Monitor vip-server-renderer deprecation notices

Install

npm install atom-engine-compiler

yarn add atom-engine-compiler

pnpm add atom-engine-compiler

Imports

compile

wrong

const compile = require('atom-engine-compiler').compile

correct

import { compile } from 'atom-engine-compiler'

ESM-only since v0.4.x

default

wrong

const compiler = require('atom-engine-compiler')

correct

import compiler from 'atom-engine-compiler'

default export is an object with compile function

compileFile

wrong

import compileFile from 'atom-engine-compiler'

correct

import { compileFile } from 'atom-engine-compiler'

named export, not default

Quickstart

Compile a .atom template string using the compile function imported from atom-engine-compiler.

import { compile } from 'atom-engine-compiler';
const template = '.atom { color: red; }';
const result = compile(template);
console.log(result);