Backtrack on .gitignore modification, add instructions to readme

This commit is contained in:
Michael Frank 2021-04-30 00:01:06 +12:00
parent eec46c7577
commit fb304675d8
4 changed files with 493 additions and 468 deletions

2
.gitignore vendored
View file

@ -1,4 +1,2 @@
.vscode .vscode
node_modules node_modules
package.json
package-lock.json

View file

@ -6,12 +6,41 @@ There will eventually be a suggested order of completion, but at this time since
2. Repeat String 2. Repeat String
3. Reverse String 3. Reverse String
## How To Use These Exercises ## Setting Up
Before you start you should have a few things installed on your machine: Before you start you should have a few things installed on your machine:
1. NPM. To check if you have NPM installed, type `npm --version` in your terminal. If you get back `Command 'npm' not found, but can be installed with:`, do NOT follow the instructions in the terminal to install with `apt-get`. (This causes permission issues.) Instead, install Node with NVM by following the instructions [here](https://github.com/TheOdinProject/curriculum/blob/master/foundations/installations/installing_node.md). 1. NPM. To check if you have NPM installed, type `npm --version` in your terminal. If you get back `Command 'npm' not found, but can be installed with:`, do NOT follow the instructions in the terminal to install with `apt-get`. (This causes permission issues.) Instead, install Node with NVM by following the instructions [here](https://github.com/TheOdinProject/curriculum/blob/master/foundations/installations/installing_node.md).
2. Jest. Jest is a testing framework for JavaScript. To install it, type `npm install --save-dev jest`. We use `--save-dev` here to specify this module is for development purposes only. 2. A copy of this repository. Copies of repositories on your machine are called clones. If you need help cloning, you can learn how [here](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository).
3. A copy of this repository. Copies of repositories on your machine are called clones. If you need help cloning, you can learn how [here](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository). 3. Jest. Jest is a testing framework for JavaScript. To install it, navigate to your local copy of the repository and type `npm install --save-dev jest`. We use `--save-dev` here to specify this module is for development purposes only.
Once Jest has been installed, you should see a few additional files and folders appear in your repository:
* :file_folder: node_modules
* :page_facing_up: package-lock.json
* :page_facing_up: package.json
Open the `package.json` file in your text editor, and add the following code:
```json
"scripts": {
"test": "jest"
}
```
So that the end result looks something like this (don't worry if your jest version is different):
```json
{
"devDependencies": {
"jest": "^26.6.3"
}, <-- take note of the comma here
"scripts": {
"test": "jest"
}
}
```
That's it! Jest should be fully functional now. Onto the next section where we learn how to use it.
## How To Use These Exercises
Each exercise includes 3 files: a markdown file with a description of the task, an empty (or mostly empty) JavaScript file, and a set of tests. To complete an exercise, you'll need to go to the exercise directory with `cd exerciseName` in the terminal and run `npm test exerciseName.spec.js`. This should run the test file and show you the output. When you first run a test, it will fail. This is by design! You must open the exercise file and write the code needed to get the test to pass. Some of the exercises have test conditions defined in their spec file that are defined as 'test.skip' compared to 'test'. This is purposeful. After you pass your first 'test', you will change the next 'test.skip' to an 'test' and test your code again. You'll do this until all conditions are satisfied. Each exercise includes 3 files: a markdown file with a description of the task, an empty (or mostly empty) JavaScript file, and a set of tests. To complete an exercise, you'll need to go to the exercise directory with `cd exerciseName` in the terminal and run `npm test exerciseName.spec.js`. This should run the test file and show you the output. When you first run a test, it will fail. This is by design! You must open the exercise file and write the code needed to get the test to pass. Some of the exercises have test conditions defined in their spec file that are defined as 'test.skip' compared to 'test'. This is purposeful. After you pass your first 'test', you will change the next 'test.skip' to an 'test' and test your code again. You'll do this until all conditions are satisfied.
**Note**: Due to the way Jest handles failed tests, it will return an exit code of 1 if any tests fail. NPM will interpret this as an error and you may see some `npm ERR!` messages after Jest runs. You can ignore these, or run your test with `npm test exerciseName.spec.js --silent` to supress the errors. **Note**: Due to the way Jest handles failed tests, it will return an exit code of 1 if any tests fail. NPM will interpret this as an error and you may see some `npm ERR!` messages after Jest runs. You can ignore these, or run your test with `npm test exerciseName.spec.js --silent` to supress the errors.

919
package-lock.json generated

File diff suppressed because it is too large Load diff

View file

@ -1,9 +1,8 @@
{ {
"devDependencies": { "devDependencies": {
"jest": "^26.6.3", "jest": "^26.6.3"
"jest-cli": "^26.6.3"
}, },
"scripts": { "scripts": {
"test": "jest" "test": "jest"
} }
} }