Coralite Scripts (Deprecated)
The coralite-scripts package is deprecated. Its responsibilities — the development server, the production build pipeline, project configuration, and the coralite CLI — have been consolidated into the primary coralite package. Remove coralite-scripts from your package.json and adopt the unified coralite commands instead.
Migration Mapping #
Every notion documented on this page maps onto the current coralite API:
| coralite-scripts (deprecated) | coralite (current) |
|---|---|
npm install --save-dev coralite-scripts |
npm install coralite |
coralite-scripts dev |
coralite dev |
coralite-scripts build |
coralite build |
import { defineConfig } from 'coralite-scripts' |
import { defineConfig } from 'coralite' |
templates directory key |
components directory key |
styles.type: 'scss' + styles.input (string) |
styles: { input: [...], processors: { scss, postcss } } |
Before and After #
Legacy coralite-scripts configuration:
import { defineConfig } from 'coralite-scripts'
export default defineConfig({
output: 'dist',
public: 'public',
pages: 'src/pages',
templates: 'src/components',
styles: {
type: 'scss',
input: './src/scss'
}
})
Equivalent current coralite configuration:
import { defineConfig } from 'coralite'
export default defineConfig({
output: 'dist',
public: 'public',
pages: 'src/pages',
components: 'src/components',
styles: {
input: ['src/scss'],
processors: {
postcss: {
plugins: []
}
}
}
})
Where This Documentation Moved #
-
CLI commands —
coralite dev,coralite build,coralite test, and thevalidate-*/check/fixcommands are documented in the Coralite CLI reference. -
Configuration — the complete
coralite.config.jsoption reference lives in the Configuration reference. -
Project setup — scaffolding with
create-coraliteand manual installation are covered in the Quick Start. - Build modes — SSG, hybrid, and SPA build modes are covered in the Building Applications guide.