Skip to content

Commit e14b456

Browse files
docs(delorean): update docs with new "externals" configuration
1 parent 7b1fc30 commit e14b456

File tree

1 file changed

+18
-4
lines changed

1 file changed

+18
-4
lines changed

docs/misc/delorean.md

+18-4
Original file line numberDiff line numberDiff line change
@@ -121,11 +121,14 @@ point to **this** folder as the sources root (see [configuration](#configuration
121121
### `--revert, -r`
122122
Reverts the changes made to the configuration files.
123123
124+
### `--config, -c`
125+
Path to the config file to use, defaults to `./.deloreanrc.json`
126+
124127
### `--help, -h`
125128
Show the **help** screen.
126129
127130
## Configuration
128-
#### `.deloreanrc.json`
131+
### `.deloreanrc.json`
129132
The configuration file required by **delorean**.
130133
Contains options for setting JSON-keys available with Sencha's Ext JS `package.json` / `app.json` that should be used
131134
for determining the JavaScript-source files for transpiling.
@@ -141,8 +144,12 @@ for determining the JavaScript-source files for transpiling.
141144
"toolkits": [
142145
"modern", "classic"
143146
],
144-
"build": [
147+
"builds": [
145148
"desktop", "shared"
149+
],
150+
"externals": [
151+
"./node_modules/@lib/externalpackage",
152+
"./packages/local/math"
146153
]
147154
}
148155
```
@@ -164,14 +171,21 @@ Holds the values that should be used when evaluating strings containing template
164171
With `toolkits` set to `["modern", "classic"]`, the directories `modern/src` and `classic/src` will be considered
165172
when collecting source files for transpiling.
166173

167-
#### `build`
174+
#### `builds`
168175
- Type: `Array`
169176

170177
Holds the values that should be used when evaluating strings containing templates, such as `app/${build.id}/overrides`.
171178
With `build` set to `["desktop", "shared"]`, the directories `app/desktop/overrides` and `app/shared/overrides` will be considered
172179
when collecting source files for transpiling.
173180

174-
#### `.babelrc`
181+
#### `externals`
182+
- Type: `Array`
183+
184+
Paths to external packages that should be processed with this run of **delorean**. This is useful if you have a project
185+
consisting of additional external Ext JS packages that require transpilation before they get merged into a build. Please
186+
note, that the external packages need to have **delorean** installed and configured.
187+
188+
### `.babelrc`
175189
The configuration file required by **Babel**
176190
The `.babelrc` is the configuration file for **Babel** and has default options known to
177191
work with Sencha Ext JS projects >= 7.4. Adjust to your needs. See [the documentation](https://babeljs.io/)

0 commit comments

Comments
 (0)