diff --git a/.github/workflows/website.yml b/.github/workflows/website.yml index 940088257..ec00f83e8 100644 --- a/.github/workflows/website.yml +++ b/.github/workflows/website.yml @@ -8,6 +8,8 @@ jobs: build: name: Build & Deploy runs-on: ubuntu-20.04 + permissions: + contents: write steps: # checkout code - uses: actions/checkout@v2 diff --git a/website/docs/commonjs-vs-native-ecmascript-modules.md b/website/docs/commonjs-vs-native-ecmascript-modules.md index b433438dd..4804c96fa 100644 --- a/website/docs/commonjs-vs-native-ecmascript-modules.md +++ b/website/docs/commonjs-vs-native-ecmascript-modules.md @@ -50,7 +50,7 @@ If you must keep `"module": "ESNext"` for `tsc`, webpack, or another build tool, ## Native ECMAScript modules -[Node's ESM loader hooks](https://nodejs.org/api/esm.html#esm_experimental_loaders) are [**experimental**](https://nodejs.org/api/documentation.html#documentation_stability_index) and subject to change. ts-node's ESM support is as stable as possible, but it relies on APIs which node can *and will* break in new versions of node. Thus it is not recommended for production. +[Node's ESM loader hooks](https://nodejs.org/api/esm.html#loaders) are [**experimental**](https://nodejs.org/api/documentation.html#documentation_stability_index) and subject to change. ts-node's ESM support is as stable as possible, but it relies on APIs which node can *and will* break in new versions of node. Thus it is not recommended for production. For complete usage, limitations, and to provide feedback, see [#1007](https://github.com/TypeStrong/ts-node/issues/1007). diff --git a/website/docs/performance.md b/website/docs/performance.md index e5940e6aa..a54979a84 100644 --- a/website/docs/performance.md +++ b/website/docs/performance.md @@ -6,7 +6,7 @@ These tricks will make ts-node faster. ## Skip typechecking -It is often better to typecheck as part of your tests or linting. You can run `tsc --noEmit` to do this. In these cases, ts-node can skip typechecking, making it much faster. +It is often better to typecheck as part of your tests or linting. You can use `tsc --noEmit` to do this. In these cases, ts-node can skip typechecking making it much faster. To skip typechecking in ts-node, do one of the following: @@ -16,7 +16,7 @@ To skip typechecking in ts-node, do one of the following: ## With typechecking -If you absolutely must typecheck in ts-node: +If you absolutely must use ts-node for typechecking: * Avoid dynamic `require()` which may trigger repeated typechecking; prefer `import` * Try with and without `--files`; one may be faster depending on your project