Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Copilot <[email protected]>
  • Loading branch information
shyim and Copilot authored Jan 17, 2025
1 parent 829509f commit 11a15c8
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion products/cli/extension-commands/admin-watcher.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,4 @@ The listing port of the Admin Watcher can be changed with `--listen :<port>`.

## Usage behind a proxy

If you want to use the Standalone Admin Watcher behind a proxy to have example SSL, you should set `--external-url` to the URL where the Admin Watcher will be reachable in the Browser.
If you want to use the Standalone Admin Watcher behind a proxy to have, for example, SSL, you should set `--external-url` to the URL where the Admin Watcher will be reachable in the Browser.
6 changes: 3 additions & 3 deletions products/cli/extension-commands/build.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ nav:

# Building extensions and creating archives

Extensions consists of PHP Changes, JavaScript and CSS. To release an extension to the Shopware Store or upload it to an Shopware 6 instance without having to rebuild Storefront and Administration your extension needs to provide the compiled assets.
Extensions consists of PHP Changes, JavaScript and CSS. To release an extension to the Shopware Store or upload it to a Shopware 6 instance without having to rebuild Storefront and Administration your extension needs to provide the compiled assets.

## Building an extension

Expand Down Expand Up @@ -48,7 +48,7 @@ build:
Building with ESBuild works completely standalone without the Shopware Codebase. This means if you import files from Shopware, you have to copy it to your extension.
:::

It's possible to use ESBuild for JavaScript bundling. This is way faster than the usual Shopware bundling as Shopware itself is not nessessary to build the assets.
It's possible to use ESBuild for JavaScript bundling. This is way faster than the usual Shopware bundling as Shopware itself is not necessary to build the assets.

```yaml
# .shopware-extension.yml
Expand Down Expand Up @@ -119,7 +119,7 @@ This skips unnecessary `npm install` and `npm ci` commands and only installs the

### Release mode

If you are building an archive for distrubution, you can enable the release mode with the flag `--release`. This will remove the App secret from the `manifest.xml` and generate changelog files if enabled.
If you are building an archive for distribution, you can enable the release mode with the flag `--release`. This will remove the App secret from the `manifest.xml` and generate changelog files if enabled.

The changelog generation can be enabled with the configuration:

Expand Down
2 changes: 1 addition & 1 deletion products/cli/project-commands/build.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ nav:
Usually when you want to deploy your Project you want to run `composer install` and want to compile the assets of the project. Shopware-CLI provides a single command which does all of this for you.

::: warning
This command modifies the given directory and deletes files. Make sure you have commited all your changes before running this command.
This command modifies the given directory and deletes files. Make sure you have committed all your changes before running this command.
:::

```bash
Expand Down
4 changes: 2 additions & 2 deletions products/cli/project-commands/mysql-dump.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,13 @@ It's possible to customize the anonymization process by using the `dump.rewrite`
dump:
rewrite:
<table-name>:
# Rewrite column content new value
# Rewrite column content to new value
<column-name>: "'new-value'"
# Use go-faker to generate data
<column-name>: "faker.Internet().Email()" # See https://github.com/jaswdr/faker for all available functions

Check warning on line 36 in products/cli/project-commands/mysql-dump.md

View workflow job for this annotation

GitHub Actions / LanguageTool

[LanguageTool] products/cli/project-commands/mysql-dump.md#L36

Add a space between sentences. (SENTENCE_WHITESPACE) Suggestions: ` Internet` Rule: https://community.languagetool.org/rule/show/SENTENCE_WHITESPACE?lang=en-US Category: TYPOGRAPHY
Raw output
products/cli/project-commands/mysql-dump.md:36:28: Add a space between sentences. (SENTENCE_WHITESPACE)
 Suggestions: ` Internet`
 Rule: https://community.languagetool.org/rule/show/SENTENCE_WHITESPACE?lang=en-US
 Category: TYPOGRAPHY

Check warning on line 36 in products/cli/project-commands/mysql-dump.md

View workflow job for this annotation

GitHub Actions / LanguageTool

[LanguageTool] products/cli/project-commands/mysql-dump.md#L36

Add a space between sentences. (SENTENCE_WHITESPACE) Suggestions: ` Email` Rule: https://community.languagetool.org/rule/show/SENTENCE_WHITESPACE?lang=en-US Category: TYPOGRAPHY
Raw output
products/cli/project-commands/mysql-dump.md:36:39: Add a space between sentences. (SENTENCE_WHITESPACE)
 Suggestions: ` Email`
 Rule: https://community.languagetool.org/rule/show/SENTENCE_WHITESPACE?lang=en-US
 Category: TYPOGRAPHY
```
## Ignoreing table content
## Ignoring table content
Some tables are not relevant for dumps, like log tables. To ignore some default tables, use the `--clean` flag. This will ignore the content of the following tables:

Expand Down
2 changes: 1 addition & 1 deletion products/cli/project-commands/project-config-sync.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ This example synchronizes a new tax entity with the name `Tax` and the tax rate

The further synchronizations will create the same entity again, you may want to fix the entity ID to avoid duplicates.

You can also add an existence check, so it will be only created if an entity has been found:
The further synchronizations will create the same entity again, you may want to fixed the entity ID to avoid duplicates.

Check warning on line 52 in products/cli/project-commands/project-config-sync.md

View workflow job for this annotation

GitHub Actions / LanguageTool

[LanguageTool] products/cli/project-commands/project-config-sync.md#L52

It appears that the verb form is incorrect or a word is missing. (HAS_TO_APPROVED_BY[4]) Suggestions: `fix` Rule: https://community.languagetool.org/rule/show/HAS_TO_APPROVED_BY?lang=en-US&subId=4 Category: GRAMMAR
Raw output
products/cli/project-commands/project-config-sync.md:52:80: It appears that the verb form is incorrect or a word is missing. (HAS_TO_APPROVED_BY[4])
 Suggestions: `fix`
 Rule: https://community.languagetool.org/rule/show/HAS_TO_APPROVED_BY?lang=en-US&subId=4
 Category: GRAMMAR

```yaml
sync:
Expand Down

0 comments on commit 11a15c8

Please sign in to comment.