API Reference
Configuration File Winnetoujs package Constructos Mutables State Management Mutations Select Methods Winnetou Fx Router Translations Color Themes WBR Compiler
Docs Change Log Git Hub Pull Requests Guidelines Get in touch

Configuration File


∯ Purpose

Define all file locations and settings of WinnetouJs applications.

∯ Type

json file

File name

win.config.json

Location

Root folder project

∯ Example

win.config.json

{
    "$schema": "./node_modules/winnetoujs/schemas/win.config.schema.json",
    "constructosPath": "./constructos",
    "constructosOut": "./src/constructos",
    "publicPath": "/",
    "apps": [
        {
            "entry": "./src/app.js",
            "out": "../Public/home/js"
        }
    ],
    "sass": [
        {
            "entryFolder": "./sass",
            "outFolder": "../Public/home/css"
        },
        {
            "entryFolder": "./sass_docs",
            "outFolder": "../Public/docs/css"
        }
    ]
}
      

serverPort

Type: number

Port for WinnetouJs Server VSCode Extension, default 3197.

constructosPath

Type: string

The path of constructos html files. Required.

constructosOut

Type: string

The path of constructos js file output. When you run node wbr, WinnetouJs get yours html constructos files and transpile it to js files with same names, in order to you can import constructos as classes in your js app. This property will define where this transpiled js files will be placed. Required.

apps

Type: array

Array of apps to be compiled in Webpack (Available since 1.19.0). Required.

entry

Type: string | object

Deprecated since 1.19.0, use apps instead.

out

Type: string | object

Deprecated since 1.19.0, use apps instead.

sass

Type: array

The path of SASS files to be compiled and watched.

defaultLang

Type: string

Initial language, default is 'en-us'.

publicPath

Type: string

Relative path address to the translations folder.

icons

Type: string

The path of icons.