-
Notifications
You must be signed in to change notification settings - Fork 8.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
128 changed files
with
6,695 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -36,3 +36,5 @@ selenium | |
ui_framework/doc_site/build | ||
!ui_framework/doc_site/build/index.html | ||
yarn.lock | ||
.vscode/ | ||
ts-tmp/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
# New platform | ||
|
||
## Dev setup | ||
|
||
``` | ||
npm run ts:start | ||
``` | ||
|
||
This builds the code into `./ts-tmp/` for now. | ||
|
||
**NB** This will show a couple type errors, e.g. something like: | ||
|
||
``` | ||
platform/server/elasticsearch/Cluster.ts(28,17): error TS2339: Property 'close' does not exist on type 'Client'. | ||
platform/server/elasticsearch/Cluster.ts(29,23): error TS2339: Property 'close' does not exist on type 'Client'. | ||
platform/server/http/SslConfig.ts(28,28): error TS2339: Property 'constants' does not exist on type 'typeof "crypto"'. | ||
``` | ||
|
||
This is expected (for now), and it's related to some third-party types. | ||
|
||
## VSCode | ||
|
||
If you want to see what it looks like with fantastic editor support. | ||
|
||
``` | ||
$ cat ~/.vscode/settings.json | ||
// Place your settings in this file to overwrite default and user settings. | ||
{ | ||
"typescript.tsdk": "./node_modules/typescript/lib", | ||
"typescript.referencesCodeLens.enabled": true | ||
} | ||
``` | ||
|
||
## Running code | ||
|
||
(Make sure to build the code first, e.g. `npm run ts:build` or `npm run ts:start`) | ||
|
||
Start the server and plugins: | ||
|
||
``` | ||
node scripts/platform.js | ||
``` | ||
|
||
If you update `config/kibana.yml` to e.g. contain `pid.file: ./kibana.pid` | ||
you'll also see it write the PID file. (You can do this while running and just | ||
send a SIGHUP.) | ||
|
||
With failure: | ||
|
||
``` | ||
node scripts/platform.js -c ./config/kibana.dev.yml --port "test" | ||
``` | ||
|
||
## Running tests | ||
|
||
Run Jest: | ||
|
||
``` | ||
node scripts/jest.js | ||
``` | ||
|
||
(add `--watch` for re-running on change) |
Oops, something went wrong.