Skip to content

Commit 4d9809b

Browse files
committed
docs: Add Typescript instructions to Contributing guide
1 parent a929019 commit 4d9809b

File tree

4 files changed

+10
-2
lines changed

4 files changed

+10
-2
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,14 @@ To run the integration tests, you will need a valid mongodb running on your loca
6464

6565
Use `npm run integration` in order to run the integration tests. If you have the vscode Jasmine extension installed (as recommended), you can run your tests by clicking the *Run* or the *Debug* lens that appears near by the test.
6666

67+
#### TypeScript Types tests
68+
69+
Those tests are located in [/types/tests](/types/tests) and are responsible for ensure types generated for each class is behaving as expected.
70+
71+
Types must be generated using `npm run build:types` and should not be manually changed. These types are `.d.ts` files located in [/types](/types).
72+
73+
Use `npm run test:types` in order to run types tests against generated `.d.ts` files.
74+
6775
### Pull Requests
6876

6977
We actively welcome your pull requests. When we get one, we'll run some Parse-specific integration tests on it first. From here, we'll need to get a core member to sign off on the changes and then merge the pull request. For API changes we may need to fix internal uses, which could cause some delay. We'll do our best to provide updates and feedback throughout the process.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@
105105
"posttest:mongodb": "mongodb-runner stop --all",
106106
"lint": "eslint --cache src/ integration/",
107107
"lint:fix": "eslint --fix --cache src/ integration/",
108-
"test:types": "eslint --cache types/tests.ts -c eslint.config.test.mjs",
108+
"test:types": "eslint --cache types/tests/ -c eslint.config.test.mjs",
109109
"watch": "cross-env PARSE_BUILD=${PARSE_BUILD} gulp watch",
110110
"watch:browser": "cross-env PARSE_BUILD=browser npm run watch",
111111
"watch:node": "cross-env PARSE_BUILD=node npm run watch",
File renamed without changes.

types/tsconfig.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,6 @@
2020
}
2121
},
2222
"include": [
23-
"tests.ts"
23+
"tests/*.ts"
2424
]
2525
}

0 commit comments

Comments
 (0)