Skip to content

Commit 62bfaf5

Browse files
ckerrMarshallOfSound
authored andcommitted
chore: remove the cli.js development utility (#151)
* chore: remove the cli.js development utility Also, add a `CONTRIBUTING.md` file to document. This is primarily to document how devs can run the code locally (`node bin/dist.js ...`). * chore: 'yarn remove rimraf' removed because vendor/fetch-docs.js was our only use of it * docs: fix the docs-parser invocation * fix: remove oops * fixup! fix: remove oops
1 parent b81bb04 commit 62bfaf5

File tree

4 files changed

+42
-92
lines changed

4 files changed

+42
-92
lines changed

CONTRIBUTING.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Contributing to electron-typescript-definitions
2+
3+
## Code of Conduct
4+
5+
This project adheres to Electron's [code of conduct](https://github.com/electron/electron/blob/master/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].
6+
7+
## Developing Locally
8+
9+
Building locally to try out changes can be done this way:
10+
11+
```sh
12+
$ git clone [email protected]:electron/typescript-definitions.git
13+
$ cd typescript-definitions
14+
$ yarn install
15+
$ # make your changes...
16+
$ yarn build
17+
```
18+
19+
To run it, first you'll need a `electron-api.json` file. There are a few common ways to get this:
20+
21+
From a [electron/docs-parser](https://github.com/electron/docs-parser) repo (since working on this often goes hand-in-hand wth typescript-definitions):
22+
23+
```sh
24+
$ cd docs-parser
25+
$ yarn install
26+
$ yarn build && node dist/bin.js --dir /path/to/electron-gn/src/electron
27+
```
28+
29+
From a [electron/electron](https://github.com/electron/electron/) repo:
30+
31+
```sh
32+
$ cd /path/to/electron-gn/src/electron
33+
$ npm install
34+
$ npm run create-api-json
35+
```
36+
37+
Either way, once you have `electron-api.json`, run it through the typescript generator:
38+
39+
```sh
40+
$ cd typescript-definitions
41+
$ yarn build && node dist/bin.js --api /path/to/electron-api.json
42+
```

cli.js

Lines changed: 0 additions & 62 deletions
This file was deleted.

package.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,6 @@
4646
"mkdirp": "^0.5.1",
4747
"ora": "^3.4.0",
4848
"pretty-ms": "^5.0.0",
49-
"rimraf": "^2.5.4",
5049
"typescript": "^3.4.5"
5150
},
5251
"repository": {

vendor/fetch-docs.js

Lines changed: 0 additions & 29 deletions
This file was deleted.

0 commit comments

Comments
 (0)