Skip to content

Latest commit

 

History

History
174 lines (143 loc) · 6.01 KB

config.json.md

File metadata and controls

174 lines (143 loc) · 6.01 KB
Raw

Configuration

A basic config.json file is generated when the project's installed:

{
    "yourProject1Name": {
        "appURL": "yourApplicationURL",
        "srcFolder": "yourSrcFolder",
        "distFolder": "yourDistFolder"
    },
    "yourProject2Name": {
        "appURL": "yourApplicationURL",
        "srcFolder": "yourSrcFolder",
        "distFolder": "yourDistFolder"
    }
}

It needs to be configured to each one of your projects. Example:

{
    "sandbox": {
        "appURL": "https://apex.oracle.com/pls/apex/f?p=10344:101",
        "srcFolder": "C:\\APEX\\sandbox\\src",
        "distFolder": "C:\\APEX\\sandbox\\dist"
    }
}

Both srcFolder and distFolder can be written as a relative path as well.

It is only mandatory to fill out the appURL in config.json. The rest is optional and will be substituted from default.json:

{
    "appURL": "",
    "srcFolder": "src",
    "distFolder": "dist",
    "jsConcat": {
        "enabled": false,
        "finalName": "app"
    },
    "cssConcat": {
        "enabled": false,
        "finalName": "app"
    },
    "sass": {
        "enabled": false,
        "includePath": ""
    },
    "less": {
        "enabled": false,
        "includePath": ""
    },
    "browsersync": {
        "enabled": true,
        "port": 3000,
        "uiPort": 3001,
        "weinrePort": 8080,
        "notify": true
    },
    "themeroller":{
        "enabled": false,
        "finalName": "themeroller",
        "files" : []
    },
    "header": {
        "enabled": false,
        "packageJsonPath": ""
    },
    "rtl": {
        "enabled": false
    },
    "imageOptimization": {
       "enabled": false
    }
}

Read below for more information about each fields.

Global

Name | Type | Default | Description --- | --- | -- | appURL | string | | This is the URL to your APEX application homepage. srcFolder | string | src | This is the path to your application src folder. If nothing is filled, the current repository will be used with the /src/ folder. This is the URL to your APEX application homepage. distFolder | string | dist | This is the path to your application dist folder. If nothing is filled, the current repository will be used with the /dist/ folder.

Header

Name Type Default Description
header.enabled boolean false Turns on and off the automatic header comment block feature.
header.packageJsonPath string Represents the path to your project's package.json file. Only applies if header.enabled is true.

Will output a standardized comment block at the start of js and css files.
Example:

/*!
 * apex-frontend-boost - Enhance your productivity with a complete Front-End Stack for Oracle APEX development
 * @author OraOpenSource
 * @version v2.2
 * @link https://github.com/OraOpenSource/apex-frontend-boost
 * @license MIT
 */

Javascript Concatenation

Name Type Default Description
jsConcat.enabled boolean false Turns on and off the javascript concatenation feature.
jsConcat.finalName string app Represents the name of the final file, after concatenation. Only applies if jsConcat.enabled is true. Will become app.js and app.min.js

CSS Concatenation

Name Type Default Description
cssConcat.enabled boolean false Turns on and off the javascript concatenation feature.
cssConcat.finalName string app Represents the name of the final file, after concatenation. Only applies if cssConcat.enabled is true. Will become app.css and app.min.css

Sass

Name Type Default Description
sass.enabled boolean false Turns on and off the sass parsing feature.
sass.includePath string Include a path to an external sass folder. Allows to use the @import feature from within that folder.

When using Sass, please ensure that Less is turned off.

Less

Name Type Default Description
less.enabled boolean false Turns on and off the less parsing feature.
less.includePath string Include a path to an external less folder. Allows to use the @import feature from within that folder.

When using Less, please ensure that Sass is turned off.

Browsersync

Name Type Default Description
browsersync.enabled boolean false Turns on and off the browsersync feature.
browsersync.port int 3000 This is the port that browsersync uses to serve your static files.
browsersync.uiPort int 3001 Browsersync includes a user-interface that is accessed via a separate port.
browsersync.weinrePort int 8080 This is the weinre port that browsersync uses.
browsersync.notify boolean true This option makes browsersync alert you when a file is dynamically injected to you browser.

Useful for Javascript & CSS development, as you won't have to manually refresh your browser.

Theme Roller

Name Type Default Description
themeroller.enabled boolean false Turns on and off the Theme Roller feature. This will generate a less file that you can import into your application theme style. It will add editable variables to theme roller.
themeroller.finalName string themeroller Represents the name of the final less file, after concatenation from the array themeroller.paths. Only applies if themeroller.enabled is true. themeroller.paths

RTLCSS

Name Type Default Description
rtl.enabled boolean false Turns on and off automatic css transformation from Left-To-Right (LTR) to Right-To-Left (RTL) languages.

Produces a .rtl version of your css files Example: app.css also produces app.rtl.css

Image Optimization

Name Type Default Description
imageOptimization.enabled boolean false Turns on and off automatic image lossless optimizers.

Minifies images in the /img/ folder.