Skip to content

Commit

Permalink
Use yarn/npm commands for CONTRIBUTING.md & README.md
Browse files Browse the repository at this point in the history 
* Updates all commands to match the scripts written to `package.json` by the blueprint
* Aligns the format for interpolating yarn vs npm to reduce duplication and simplify future updates
  • Loading branch information
@elwayman02 @locks
elwayman02 authored and locks committed Apr 19, 2022
1 parent 1915d79 commit bfc245a
Show file tree
Hide file tree
Showing 8 changed files with 31 additions and 31 deletions.
12 changes: 6 additions & 6 deletions blueprints/addon/files/CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,18 @@

## Linting

* `<% if (yarn) { %>yarn lint<% } else { %>npm run lint<% } %>`
* `<% if (yarn) { %>yarn lint:fix<% } else { %>npm run lint:fix<% } %>`
* `<% if (yarn) { %>yarn<% } else { %>npm run<% } %> lint`
* `<% if (yarn) { %>yarn<% } else { %>npm run<% } %> lint:fix`

## Running tests

* `ember test` – Runs the test suite on the current Ember version
* `ember test --server` – Runs the test suite in "watch mode"
* `ember try:each` – Runs the test suite against multiple Ember versions
* `<% if (yarn) { %>yarn<% } else { %>npm run<% } %> test:ember` – Runs the test suite on the current Ember version
* `<% if (yarn) { %>yarn<% } else { %>npm run<% } %> test:ember --server` – Runs the test suite in "watch mode"
* `<% if (yarn) { %>yarn<% } else { %>npm run<% } %> test:ember-compatibility` – Runs the test suite against multiple Ember versions

## Running the dummy application

* `ember serve`
* `<% if (yarn) { %>yarn<% } else { %>npm<% } %> start`
* Visit the dummy application at [http://localhost:4200](http://localhost:4200).

For more information on using ember-cli, visit [https://cli.emberjs.com/release/](https://cli.emberjs.com/release/).
10 changes: 5 additions & 5 deletions blueprints/app/files/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ You will need the following things properly installed on your computer.

## Running / Development

* `ember serve`
* `<% if (yarn) { %>yarn<% } else { %>npm<% } %> start`
* Visit your app at [http://localhost:4200](http://localhost:4200).
* Visit your tests at [http://localhost:4200/tests](http://localhost:4200/tests).

Expand All @@ -31,13 +31,13 @@ Make use of the many generators for code, try `ember help generate` for more det

### Running Tests

* `ember test`
* `ember test --server`
* `<% if (yarn) { %>yarn<% } else { %>npm run<% } %> test:ember`
* `<% if (yarn) { %>yarn<% } else { %>npm run<% } %> test:ember --server`

### Linting

* `<% if (yarn) { %>yarn lint<% } else { %>npm run lint<% } %>`
* `<% if (yarn) { %>yarn lint:fix<% } else { %>npm run lint:fix<% } %>`
* `<% if (yarn) { %>yarn<% } else { %>npm run<% } %> lint`
* `<% if (yarn) { %>yarn<% } else { %>npm run<% } %> lint:fix`

### Building

Expand Down
8 changes: 4 additions & 4 deletions tests/fixtures/addon/defaults/CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@

## Running tests

* `ember test` – Runs the test suite on the current Ember version
* `ember test --server` – Runs the test suite in "watch mode"
* `ember try:each` – Runs the test suite against multiple Ember versions
* `npm run test:ember` – Runs the test suite on the current Ember version
* `npm run test:ember --server` – Runs the test suite in "watch mode"
* `npm run test:ember-compatibility` – Runs the test suite against multiple Ember versions

## Running the dummy application

* `ember serve`
* `npm start`
* Visit the dummy application at [http://localhost:4200](http://localhost:4200).

For more information on using ember-cli, visit [https://cli.emberjs.com/release/](https://cli.emberjs.com/release/).
8 changes: 4 additions & 4 deletions tests/fixtures/addon/yarn/CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@

## Running tests

* `ember test` – Runs the test suite on the current Ember version
* `ember test --server` – Runs the test suite in "watch mode"
* `ember try:each` – Runs the test suite against multiple Ember versions
* `yarn test:ember` – Runs the test suite on the current Ember version
* `yarn test:ember --server` – Runs the test suite in "watch mode"
* `yarn test:ember-compatibility` – Runs the test suite against multiple Ember versions

## Running the dummy application

* `ember serve`
* `yarn start`
* Visit the dummy application at [http://localhost:4200](http://localhost:4200).

For more information on using ember-cli, visit [https://cli.emberjs.com/release/](https://cli.emberjs.com/release/).
6 changes: 3 additions & 3 deletions tests/fixtures/app/defaults/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ You will need the following things properly installed on your computer.

## Running / Development

* `ember serve`
* `npm start`
* Visit your app at [http://localhost:4200](http://localhost:4200).
* Visit your tests at [http://localhost:4200/tests](http://localhost:4200/tests).

Expand All @@ -30,8 +30,8 @@ Make use of the many generators for code, try `ember help generate` for more det

### Running Tests

* `ember test`
* `ember test --server`
* `npm run test:ember`
* `npm run test:ember --server`

### Linting

Expand Down
6 changes: 3 additions & 3 deletions tests/fixtures/app/npm/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ You will need the following things properly installed on your computer.

## Running / Development

* `ember serve`
* `npm start`
* Visit your app at [http://localhost:4200](http://localhost:4200).
* Visit your tests at [http://localhost:4200/tests](http://localhost:4200/tests).

Expand All @@ -30,8 +30,8 @@ Make use of the many generators for code, try `ember help generate` for more det

### Running Tests

* `ember test`
* `ember test --server`
* `npm run test:ember`
* `npm run test:ember --server`

### Linting

Expand Down
6 changes: 3 additions & 3 deletions tests/fixtures/app/with-blueprint-override-lint-fail/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ You will need the following things properly installed on your computer.

## Running / Development

* `ember serve`
* `npm start`
* Visit your app at [http://localhost:4200](http://localhost:4200).
* Visit your tests at [http://localhost:4200/tests](http://localhost:4200/tests).

Expand All @@ -30,8 +30,8 @@ Make use of the many generators for code, try `ember help generate` for more det

### Running Tests

* `ember test`
* `ember test --server`
* `npm run test:ember`
* `npm run test:ember --server`

### Linting

Expand Down
6 changes: 3 additions & 3 deletions tests/fixtures/app/yarn/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ You will need the following things properly installed on your computer.

## Running / Development

* `ember serve`
* `yarn start`
* Visit your app at [http://localhost:4200](http://localhost:4200).
* Visit your tests at [http://localhost:4200/tests](http://localhost:4200/tests).

Expand All @@ -31,8 +31,8 @@ Make use of the many generators for code, try `ember help generate` for more det

### Running Tests

* `ember test`
* `ember test --server`
* `yarn test:ember`
* `yarn test:ember --server`

### Linting

Expand Down

0 comments on commit bfc245a

Please sign in to comment.