Skip to content

Commit

Permalink
Merge pull request #10446 from bertdeblock/format-md-files-in-addon-b…
Browse files Browse the repository at this point in the history
…lueprint-with-prettier

[ENHANCEMENT] Format markdown files in blueprints with Prettier
  • Loading branch information
Bert De Block committed Mar 7, 2024
2 parents a73ad42 + 5403bb6 commit b6e0e87
Show file tree
Hide file tree
Showing 19 changed files with 246 additions and 277 deletions.
20 changes: 10 additions & 10 deletions blueprints/addon/files/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,24 @@

## Installation

* `git clone <repository-url>`
* `cd <%= addonDirectory %>`
* `<% if (pnpm) { %>pnpm<% } else if (yarn) { %>yarn<% } else { %>npm<% } %> install`
- `git clone <repository-url>`
- `cd <%= addonDirectory %>`
- `<% if (pnpm) { %>pnpm<% } else if (yarn) { %>yarn<% } else { %>npm<% } %> install`

## Linting

* `<%= invokeScriptPrefix %> lint`
* `<%= invokeScriptPrefix %> lint:fix`
- `<%= invokeScriptPrefix %> lint`
- `<%= invokeScriptPrefix %> lint:fix`

## Running tests

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

## Running the dummy application

* `<%= invokeScriptPrefix %> start`
* Visit the dummy application at [http://localhost:4200](http://localhost:4200).
- `<%= invokeScriptPrefix %> 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/).
11 changes: 3 additions & 8 deletions blueprints/addon/files/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,31 +2,26 @@

[Short description of the addon.]


## Compatibility

* Ember.js v4.12 or above
* Ember CLI v4.12 or above
* Node.js v18 or above

- Ember.js v4.12 or above
- Ember CLI v4.12 or above
- Node.js v18 or above

## Installation

```
ember install <%= addonName %>
```


## Usage

[Longer description of how to use the addon in apps.]


## Contributing

See the [Contributing](CONTRIBUTING.md) guide for details.


## License

This project is licensed under the [MIT License](LICENSE.md).
46 changes: 23 additions & 23 deletions blueprints/app/files/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,52 +7,52 @@ A short introduction of this app could easily go here.

You will need the following things properly installed on your computer.

* [Git](https://git-scm.com/)
* [Node.js](https://nodejs.org/)<% if (pnpm) { %>
* [pnpm](https://pnpm.io/)<% } else if (yarn) { %>
* [Yarn](https://yarnpkg.com/)<% } else { %> (with npm)<% } %>
* [Ember CLI](https://cli.emberjs.com/release/)
* [Google Chrome](https://google.com/chrome/)
- [Git](https://git-scm.com/)
- [Node.js](https://nodejs.org/)<% if (pnpm) { %>
- [pnpm](https://pnpm.io/)<% } else if (yarn) { %>
- [Yarn](https://yarnpkg.com/)<% } else { %> (with npm)<% } %>
- [Ember CLI](https://cli.emberjs.com/release/)
- [Google Chrome](https://google.com/chrome/)

## Installation

* `git clone <repository-url>` this repository
* `cd <%= appDirectory %>`
* `<% if (pnpm) { %>pnpm<% } else if (yarn) { %>yarn<% } else { %>npm<% } %> install`
- `git clone <repository-url>` this repository
- `cd <%= appDirectory %>`
- `<% if (pnpm) { %>pnpm<% } else if (yarn) { %>yarn<% } else { %>npm<% } %> install`

## Running / Development

* `<%= invokeScriptPrefix %> start`
* Visit your app at [http://localhost:4200](http://localhost:4200).
* Visit your tests at [http://localhost:4200/tests](http://localhost:4200/tests).
- `<%= invokeScriptPrefix %> start`
- Visit your app at [http://localhost:4200](http://localhost:4200).
- Visit your tests at [http://localhost:4200/tests](http://localhost:4200/tests).

### Code Generators

Make use of the many generators for code, try `ember help generate` for more details

### Running Tests

* `<%= invokeScriptPrefix %> test`
* `<%= invokeScriptPrefix %> test:ember <% if (npm) { %>-- <% } %>--server`
- `<%= invokeScriptPrefix %> test`
- `<%= invokeScriptPrefix %> test:ember <% if (npm) { %>-- <% } %>--server`

### Linting

* `<%= invokeScriptPrefix %> lint`
* `<%= invokeScriptPrefix %> lint:fix`
- `<%= invokeScriptPrefix %> lint`
- `<%= invokeScriptPrefix %> lint:fix`

### Building

* `<%= execBinPrefix %> ember build` (development)
* `<%= invokeScriptPrefix %> build` (production)
- `<%= execBinPrefix %> ember build` (development)
- `<%= invokeScriptPrefix %> build` (production)

### Deploying

Specify what it takes to deploy your app.

## Further Reading / Useful Links

* [ember.js](https://emberjs.com/)
* [ember-cli](https://cli.emberjs.com/release/)
* Development Browser Extensions
* [ember inspector for chrome](https://chrome.google.com/webstore/detail/ember-inspector/bmdblncegkenkacieihfhpjfppoconhi)
* [ember inspector for firefox](https://addons.mozilla.org/en-US/firefox/addon/ember-inspector/)
- [ember.js](https://emberjs.com/)
- [ember-cli](https://cli.emberjs.com/release/)
- Development Browser Extensions
- [ember inspector for chrome](https://chrome.google.com/webstore/detail/ember-inspector/bmdblncegkenkacieihfhpjfppoconhi)
- [ember inspector for firefox](https://addons.mozilla.org/en-US/firefox/addon/ember-inspector/)
4 changes: 2 additions & 2 deletions tests/acceptance/new-test.js
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ describe('Acceptance: ember new', function () {
it('ember new generates the correct directory name in `README.md` for scoped package names', async function () {
await ember(['new', '@foo/bar', '--skip-npm', '--skip-git']);

expect(file('README.md')).to.match(/\* `cd foo-bar`/);
expect(file('README.md')).to.match(/- `cd foo-bar`/);
});

// ember new foo --lang
Expand Down Expand Up @@ -392,7 +392,7 @@ describe('Acceptance: ember new', function () {
it('ember addon generates the correct directory name in `CONTRIBUTING.md` for scoped package names', async function () {
await ember(['addon', '@foo/bar', '--skip-npm', '--skip-git']);

expect(file('CONTRIBUTING.md')).to.match(/\* `cd foo-bar`/);
expect(file('CONTRIBUTING.md')).to.match(/- `cd foo-bar`/);
});

if (!isExperimentEnabled('CLASSIC')) {
Expand Down
20 changes: 10 additions & 10 deletions tests/fixtures/addon/defaults-travis/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,24 @@

## Installation

* `git clone <repository-url>`
* `cd foo`
* `npm install`
- `git clone <repository-url>`
- `cd foo`
- `npm install`

## Linting

* `npm run lint`
* `npm run lint:fix`
- `npm run lint`
- `npm run lint:fix`

## Running tests

* `npm run test` – 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
- `npm run test` – 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

* `npm start`
* Visit the dummy application at [http://localhost:4200](http://localhost:4200).
- `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/).
29 changes: 9 additions & 20 deletions tests/fixtures/addon/defaults-travis/README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,27 @@
foo
==============================================================================
# foo

[Short description of the addon.]

## Compatibility

Compatibility
------------------------------------------------------------------------------
- Ember.js v4.12 or above
- Ember CLI v4.12 or above
- Node.js v18 or above

* Ember.js v4.12 or above
* Ember CLI v4.12 or above
* Node.js v18 or above


Installation
------------------------------------------------------------------------------
## Installation

```
ember install foo
```


Usage
------------------------------------------------------------------------------
## Usage

[Longer description of how to use the addon in apps.]


Contributing
------------------------------------------------------------------------------
## Contributing

See the [Contributing](CONTRIBUTING.md) guide for details.


License
------------------------------------------------------------------------------
## License

This project is licensed under the [MIT License](LICENSE.md).
20 changes: 10 additions & 10 deletions tests/fixtures/addon/defaults/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,24 @@

## Installation

* `git clone <repository-url>`
* `cd foo`
* `npm install`
- `git clone <repository-url>`
- `cd foo`
- `npm install`

## Linting

* `npm run lint`
* `npm run lint:fix`
- `npm run lint`
- `npm run lint:fix`

## Running tests

* `npm run test` – 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
- `npm run test` – 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

* `npm run start`
* Visit the dummy application at [http://localhost:4200](http://localhost:4200).
- `npm run 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/).
11 changes: 3 additions & 8 deletions tests/fixtures/addon/defaults/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,31 +2,26 @@

[Short description of the addon.]


## Compatibility

* Ember.js v4.12 or above
* Ember CLI v4.12 or above
* Node.js v18 or above

- Ember.js v4.12 or above
- Ember CLI v4.12 or above
- Node.js v18 or above

## Installation

```
ember install foo
```


## Usage

[Longer description of how to use the addon in apps.]


## Contributing

See the [Contributing](CONTRIBUTING.md) guide for details.


## License

This project is licensed under the [MIT License](LICENSE.md).
20 changes: 10 additions & 10 deletions tests/fixtures/addon/pnpm/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,24 @@

## Installation

* `git clone <repository-url>`
* `cd foo`
* `pnpm install`
- `git clone <repository-url>`
- `cd foo`
- `pnpm install`

## Linting

* `pnpm lint`
* `pnpm lint:fix`
- `pnpm lint`
- `pnpm lint:fix`

## Running tests

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

## Running the dummy application

* `pnpm start`
* Visit the dummy application at [http://localhost:4200](http://localhost:4200).
- `pnpm 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/).
11 changes: 3 additions & 8 deletions tests/fixtures/addon/pnpm/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,31 +2,26 @@

[Short description of the addon.]


## Compatibility

* Ember.js v4.12 or above
* Ember CLI v4.12 or above
* Node.js v18 or above

- Ember.js v4.12 or above
- Ember CLI v4.12 or above
- Node.js v18 or above

## Installation

```
ember install foo
```


## Usage

[Longer description of how to use the addon in apps.]


## Contributing

See the [Contributing](CONTRIBUTING.md) guide for details.


## License

This project is licensed under the [MIT License](LICENSE.md).

0 comments on commit b6e0e87

Please sign in to comment.