Skip to content

Commit

Permalink
Update dependencies
Browse files Browse the repository at this point in the history
  • Loading branch information
mengdaming committed Sep 24, 2024
1 parent fd85b2c commit 3b239f8
Show file tree
Hide file tree
Showing 5 changed files with 248 additions and 24 deletions.
2 changes: 1 addition & 1 deletion java/gradle/wrapper/gradle-wrapper.properties
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-8.10.1-bin.zip
distributionUrl=https\://services.gradle.org/distributions/gradle-8.10.2-bin.zip
networkTimeout=10000
validateDistributionUrl=true
zipStoreBase=GRADLE_USER_HOME
Expand Down
2 changes: 1 addition & 1 deletion python/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
pytest == 7.0.1; python_version < '3.7'
pytest == 7.4.4; python_version in '3.7'
pytest == 8.3.2; python_version >= '3.8'
pytest == 8.3.3; python_version >= '3.8'
pytest-parametrization == 2022.2.1
mypy == 0.971; python_version < '3.7'
mypy == 1.4.1; python_version in '3.7'
Expand Down
242 changes: 233 additions & 9 deletions typescript/GETTING_STARTED.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,11 @@ cd Kata-MarsRover/typescript

### 3 - Download dependencies

The kata uses `corepack` when configuring `yarn` as
the package manager to be used. You may need to run the
following command beforehand to enable it:
The kata uses `corepack` when configuring `yarn` as the package manager to be used.
You may need to run the following command beforehand to enable it:

> ***Note***: depending on your environment you may need to run this command
> as an administrator (Windows) or with sudo (Linux and macOS)
```shell
corepack enable
Expand All @@ -49,27 +51,33 @@ You can run the kata from the command line or from your IDE of choice.

You may also run it using [TCR](../tcr/TCR.md) if you want to add a bit of spice.

- [From a terminal with Yarn](#running-the-kata-from-a-terminal-with-yarn)
- [From a terminal](#running-the-kata-from-a-terminal)
- [From a terminal with TCR](#running-the-kata-from-a-terminal-with-tcr)
- [From WebStorm](#running-the-kata-from-webstorm)
- [From WebStorm with TCR](#running-the-kata-from-webstorm-with-tcr)
- [From IntelliJ](#running-the-kata-from-intellij)
- [From IntelliJ with TCR](#running-the-kata-from-intellij-with-tcr)
- [From Visual Studio Code](#running-the-kata-from-visual-studio-code)
- [From Visual Studio Code with TCR](#running-the-kata-from-visual-studio-code-with-tcr)

<a name="running-the-kata-from-a-terminal-with-yarn"/></a>
<a name="running-the-kata-from-a-terminal"/></a>

### Running the kata from a terminal with Yarn
### Running the kata from a terminal

> ***Reminder***: the command below should be run from [Kata-MarsRover/typescript](.) directory
The kata comes with a Yarn test target pre-configured. Just type the following to run it.
To run the tests:

```shell
yarn test
yarn jest
```

<a name="running-the-kata-from-a-terminal-with-tcr"/></a>

### Running the kata from a terminal with TCR

> ***Note to Windows users***
>
>
> Use a **git bash** terminal for running the command below.
> _Windows CMD and PowerShell are not supported_
Expand All @@ -81,6 +89,222 @@ Type the following to start TCR:

Refer to [Using TCR](#using-tcr) section for additional details about TCR and available options.

<a name="running-the-kata-from-webstorm"/></a>

### Running the kata from WebStorm

Open WebStorm and select:

`File` > `Open` > `Kata-MarsRover` > `typescript`

Run all the tests in the project.

The "**Run**" tool window should display all the executed tests.

<a name="running-the-kata-from-webstorm-with-tcr"/></a>

### Running the kata from WebStorm with TCR

TCR is provided as a command line utility running in a terminal.
You can run it from WebStorm directly, through leveraging on its built-in terminal.

#### 1. Open the kata

Open WebStorm and select:

`File` > `Open` > `Kata-MarsRover` > `typescript`

#### 2. Turn off auto-save

TCR is constantly watching the filesystem for changes.
For this reason you need to turn off WebStorm's auto-save in order for it to behave as expected.

`File` > `Settings` > `Appearance & Behavior` > `System Settings`

Under `Autosave` section, uncheck the 2 following options:

- [ ] Save files if the IDE is idle for ___ seconds
- [ ] Save files when switching to a different application or a built-in terminal

#### 3. Configure the built-in terminal to run git bash

> ***Windows Only***
>
> Skip this step if you're on macOS or Linux
WebStorm for Windows is usually set up to run PowerShell by default in its built-in terminal.
TCR does not run in PowerShell.

`File` > `Settings` > `Tools` > `Terminal`

Under `Application Settings` section, set the `Shell path` to `C:\Program Files\Git\bin\bash.exe`

The above path is for a default git installation location. You may need to adjust it in case you have installed git at a
different location.

#### 4. Open a built-in terminal

`View` > `Tool Windows` > `Terminal`

#### 5. Launch TCR

> ***Reminder***: the command below should be run from [Kata-MarsRover/typescript](.) directory
From the built-in terminal:

```shell
./tcrw
```

Refer to [Using TCR](#using-tcr) section for additional details about TCR and available options.

<a name="running-the-kata-from-intellij"/></a>

### Running the kata from IntelliJ

> ***Important***: This requires to have `IntelliJ IDEA Ultimate` edition.
>
> IntelliJ's Javascript and Typescript plugin is not available with the Community edition.
> You can still use it as an editor for Typescript files, but you will not
> be able to use the benefits brought by the Javascript and Typescript plugin, such as syntax highlighting,
> code refactoring or integration with IntelliJ's test navigator.
Open IntelliJ and select:

`File` > `Open` > `Kata-MarsRover` > `typescript`

Run all the tests in the project.

The "**Run**" tool window should display all the executed tests.

<a name="running-the-kata-from-intellij-with-tcr"/></a>

### Running the kata from IntelliJ with TCR

> ***Important***: This requires to have `IntelliJ IDEA Ultimate` edition.
>
> IntelliJ's Javascript and Typescript plugin is not available with the Community edition.
> You can still use it as an editor for Typescript files, but you will not
> be able to use the benefits brought by the Javascript and Typescript plugin, such as syntax highlighting,
> code refactoring or integration with IntelliJ's test navigator.
TCR is provided as a command line utility running in a terminal.
You can run it from IntelliJ directly, through leveraging on its built-in terminal.

#### 1. Open the kata

Open IntelliJ and select:

`File` > `Open` > `Kata-MarsRover` > `typescript`

#### 2. Turn off auto-save

TCR is constantly watching the filesystem for changes.
For this reason you need to turn off IntelliJ's auto-save in order for it to behave as expected.

`File` > `Settings` > `Appearance & Behavior` > `System Settings`

Under `Autosave` section, uncheck the 2 following options:

- [ ] Save files if the IDE is idle for ___ seconds
- [ ] Save files when switching to a different application or a built-in terminal

#### 3. Configure the built-in terminal to run git bash

> ***Windows Only***
>
> Skip this step if you're on macOS or Linux
IntelliJ for Windows is usually set up to run PowerShell by default in its built-in terminal.
TCR does not run in PowerShell.

`File` > `Settings` > `Tools` > `Terminal`

Under `Application Settings` section, set the `Shell path` to `C:\Program Files\Git\bin\bash.exe`

The above path is for a default git installation location. You may need to adjust it in case you have installed git at a
different location.

#### 4. Open a built-in terminal

`View` > `Tool Windows` > `Terminal`

#### 5. Launch TCR

> ***Reminder***: the command below should be run from [Kata-MarsRover/typescript](.) directory
From the built-in terminal:

```shell
./tcrw
```

Refer to [Using TCR](#using-tcr) section for additional details about TCR and available options.

<a name="running-the-kata-from-visual-studio-code"/></a>

### Running the kata from Visual Studio Code

Open Visual Studio Code, choose `Open Folder`, navigate to `Kata-MarsRover` / `typescript`
then click `Select Folder`.

In order to run the tests, select `View` > `Testing`, then click on the `Play` button.

<a name="running-the-kata-from-visual-studio-code-with-tcr"/></a>

### Running the kata from Visual Studio Code with TCR

TCR is provided as a command line utility running in a terminal.
You can run it from Visual Studio Code directly, through leveraging on its built-in terminal.

#### 1. Open the kata

Open Visual Studio Code, choose `Open Folder`, navigate to `Kata-MarsRover` / `typescript`
then click `Select Folder`.

#### 2. Turn off auto-save

TCR is constantly watching the filesystem for changes.
For this reason you need to make sure that Visual Studio Code's auto-save is turned off
in order for TCR to behave as expected.

`File` > `Preferences` > `Settings`

In `Text Editor` > `Files` section, make sure that `Auto Save` setting is set to `off`

#### 3. Configure the built-in terminal to run git bash

> ***Windows Only***
>
> Skip this step if you're on macOS or Linux
Visual Studio Code for Windows is usually set up to run PowerShell by default in its built-in terminal.
TCR does not run in PowerShell.

`File` > `Preferences` > `Settings`

In `Features` > `Terminal` section, set `External: Windows Exec`
to `C:\Program Files\Git\bin\bash.exe`

The above path is for a default git installation location. You may need to adjust it in case you have installed git at a
different location.

#### 4. Open a built-in terminal

`Terminal` > `New Terminal`

#### 5. Launch TCR

> ***Reminder***: the command below should be run from [Kata-MarsRover/typescript](.) directory
From the built-in terminal:

```shell
./tcrw
```

Refer to [Using TCR](#using-tcr) section for additional details about TCR and available options.

<a name="using-tcr"/></a>

## Using TCR
Expand Down
2 changes: 1 addition & 1 deletion typescript/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,5 @@
"jest-junit": {
"outputDirectory": "./test_results"
},
"packageManager": "yarn@4.4.1"
"packageManager": "yarn@4.5.0"
}
24 changes: 12 additions & 12 deletions typescript/yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -842,21 +842,21 @@ __metadata:
linkType: hard

"@types/jest@npm:*":
version: 29.5.12
resolution: "@types/jest@npm:29.5.12"
version: 29.5.13
resolution: "@types/jest@npm:29.5.13"
dependencies:
expect: "npm:^29.0.0"
pretty-format: "npm:^29.0.0"
checksum: 10c0/25fc8e4c611fa6c4421e631432e9f0a6865a8cb07c9815ec9ac90d630271cad773b2ee5fe08066f7b95bebd18bb967f8ce05d018ee9ab0430f9dfd1d84665b6f
checksum: 10c0/9c31af0b155387b9860908830de63c6b79011d7c87c8b61b39da124e26e55423dd51b006749aafe4f0ef3a065016619a1f93ef4b055157d43727f448e67824b7
languageName: node
linkType: hard

"@types/node@npm:*":
version: 22.5.4
resolution: "@types/node@npm:22.5.4"
version: 22.6.1
resolution: "@types/node@npm:22.6.1"
dependencies:
undici-types: "npm:~6.19.2"
checksum: 10c0/b445daa7eecd761ad4d778b882d6ff7bcc3b4baad2086ea9804db7c5d4a4ab0298b00d7f5315fc640a73b5a1d52bbf9628e09c9fec0cf44dbf9b4df674a8717d
checksum: 10c0/79fdb14f268070eb21d25f3e81811b73c10dfcc65a638a6546fd97aa3e7dfe473f31a547fd21c43b8559a435b6ab26057066a47b5453bd1b1cdffe14430ac399
languageName: node
linkType: hard

Expand Down Expand Up @@ -1185,9 +1185,9 @@ __metadata:
linkType: hard

"caniuse-lite@npm:^1.0.30001646":
version: 1.0.30001660
resolution: "caniuse-lite@npm:1.0.30001660"
checksum: 10c0/d28900b56c597176d515c3175ca75c454f2d30cb2c09a44d7bdb009bb0c4d8a2557905adb77642889bbe9feb85fbfe9d974c8b8e53521fb4b50ee16ab246104e
version: 1.0.30001663
resolution: "caniuse-lite@npm:1.0.30001663"
checksum: 10c0/6508e27bf7fdec657f26f318b1ab64ace6e1208ef9fedaf0975bc89046e0c683bfba837f108840ada1686ff09b8ffd01e05ac791dcf598b8f16eefb636875cf2
languageName: node
linkType: hard

Expand Down Expand Up @@ -1410,9 +1410,9 @@ __metadata:
linkType: hard

"electron-to-chromium@npm:^1.5.4":
version: 1.5.20
resolution: "electron-to-chromium@npm:1.5.20"
checksum: 10c0/d119ccebcb415dc6341072b4a2bd0c9052d94eccf93776d47f5781b9c28393407f9e30718380ee59cb2a280db6b2e36943ffe4a7cdac9e432246380a24f48fa1
version: 1.5.28
resolution: "electron-to-chromium@npm:1.5.28"
checksum: 10c0/6e2f4150ba03ce53ca128955c7d2da071d3774362a10c68848a85b71c29857915e2256cb53cd2de17fdbf0f56bf76ec174d24965abef7430d8c414ec733030b2
languageName: node
linkType: hard

Expand Down

0 comments on commit 3b239f8

Please sign in to comment.