Skip to content

Commit

Permalink
Switches to use yarn (maybe fixes #644?)
Browse files Browse the repository at this point in the history
  • Loading branch information
eamodio committed Jul 19, 2019
1 parent 3c4461a commit f166345
Show file tree
Hide file tree
Showing 5 changed files with 7,190 additions and 10,428 deletions.
2 changes: 2 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
{
"editor.insertSpaces": true,
"eslint.packageManager": "yarn",
"files.associations": {
".eslintrc.json": "jsonc"
},
"files.trimTrailingWhitespace": true,
"npm.packageManager": "yarn",
"postcssSorting.config": {
"order": ["custom-properties", "dollar-variables", "declarations", "at-rules", "rules"],
"properties-order": "alphabetical",
Expand Down
20 changes: 10 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,39 +19,39 @@ git clone https://github.com/eamodio/vscode-gitlens.git
Prerequisites

- [Git](https://git-scm.com/)
- [NodeJS](https://nodejs.org/en/), `>= 8.9.1, <= 10.2.0`
- [npm](https://npmjs.com/), `>= 6.2.0`
- [NodeJS](https://nodejs.org/), `>= 10.11.0`
- [yarn](https://yarnpkg.com/), `>= 1.17.3`

### Dependencies

From a terminal, where you have cloned the repository, execute the following command to install the required dependencies:

```
npm install --no-save
yarn --frozen-lockfile
```

### Build

From a terminal, where you have cloned the repository, execute the following command to re-build the project from scratch:

```
npm run rebuild
yarn run rebuild
```

👉 **NOTE!** This will run a complete rebuild of the project.

Or to just run a quick build, use:

```
npm run build
yarn run build
```

### Watch

During development you can use a watcher to make builds on changes quick and easy. From a terminal, where you have cloned the repository, execute the following command:

```
npm run watch
yarn run watch
```

Or use the provided `watch` task in VS Code, execute the following from the command palette (be sure there is no `>` at the start):
Expand All @@ -68,7 +68,7 @@ This will first do an initial full build and then watch for file changes, compil

### Formatting

This project uses [prettier](https://prettier.io/) for code formatting. You can run prettier across the code by calling `npm run pretty` from a terminal.
This project uses [prettier](https://prettier.io/) for code formatting. You can run prettier across the code by calling `yarn run pretty` from a terminal.

To format the code as you make changes you can install the [Prettier - Code formatter](https://marketplace.visualstudio.com/items/esbenp.prettier-vscode) extension.

Expand All @@ -80,7 +80,7 @@ Add the following to your User Settings to run prettier:

### Linting

This project uses [ESLint](https://eslint.org/) for code linting. You can run ESLint across the code by calling `npm run lint` from a terminal. Warnings from ESLint show up in the `Errors and Warnings` quick box and you can navigate to them from inside VS Code.
This project uses [ESLint](https://eslint.org/) for code linting. You can run ESLint across the code by calling `yarn run lint` from a terminal. Warnings from ESLint show up in the `Errors and Warnings` quick box and you can navigate to them from inside VS Code.

To lint the code as you make changes you can install the [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) extension.

Expand All @@ -89,13 +89,13 @@ To lint the code as you make changes you can install the [ESLint](https://market
To generate a production bundle (without packaging) run the following from a terminal:

```
npm run bundle
yarn run bundle
```

To generate a VSIX (installation package) run the following from a terminal:

```
npm run pack
yarn run pack
```

### Debugging
Expand Down

0 comments on commit f166345

Please sign in to comment.