Skip to content

Commit

Permalink
fix: spellchecker issues
Browse files Browse the repository at this point in the history
  • Loading branch information
shyim committed Jan 20, 2025
1 parent ad90911 commit a366bcb
Showing 10 changed files with 35 additions and 23 deletions.
14 changes: 13 additions & 1 deletion .wordlist.txt
Original file line number Diff line number Diff line change
@@ -6,6 +6,7 @@ ADRs
AOF
API's
APIs
AUR
AbstractCaptcha
AbstractStockUpdateFilter
AccountEditOrderPage
@@ -45,6 +46,7 @@ AllowHtml
AlwaysValidRule
Analytics
AndRule
Anonymizing
ApiAware
ApiContext
ApiController
@@ -55,6 +57,7 @@ AppRefundHandler
AppScripts
AppServer
AppSystem
Archlinux
ArrayFacade
AsyncPaymentTransactionStruct
AsynchronousPaymentHandlerInterface
@@ -91,6 +94,7 @@ Blockquote
Blockquotes
BoolField
BottleJS
Browserlist
BusinessEvent
BusinessEventCollector
CDN
@@ -158,6 +162,7 @@ ClientInterface
Cloudflare
Cmd
CmsPage
Codespaces
Codestyle
CommercialB
CommercialBundle
@@ -351,6 +356,7 @@ Flysystem
Fontawesome
FooterPagelet
FrameworkBundle
FriendsOfShopware
FroshDevelopmentHelper
FroshPluginUploader
Fullstack
@@ -683,6 +689,7 @@ Readonly
RecipientsAware
RecipientsStorer
RecurringPaymentHandlerInterface
RedHat
Redict
RedirectResponse
ReferenceVersion
@@ -906,6 +913,7 @@ WCAG
WSL
WarehouseGroup
WarehouseGroups
WebAssembly
WebKit
WebSocket
Webhook
@@ -949,6 +957,7 @@ anonymized
antipattern
api
apiKey
apk
appVersion
args
arrayfacade
@@ -1102,6 +1111,7 @@ dataset
datasets
datepicker
datetime
ddev
de
debounce
decoratable
@@ -1168,6 +1178,7 @@ equalsAny
errored
errorsfacade
erros
esbuild
eslint
et
everytime
@@ -1440,6 +1451,7 @@ pageloader
parallelize
param
params
parsable
parsers
paypal
pcre
@@ -1460,6 +1472,7 @@ phpunitx
pluginlogger
png
pnpm
polyfill
pos
positionID
positionIDs
@@ -1482,7 +1495,6 @@ preselection
prettierrc
previewComponent
previewable
previewable
pricecollectionfacade
pricefacade
pricefactory
10 changes: 5 additions & 5 deletions products/cli/extension-commands/build.md
Original file line number Diff line number Diff line change
@@ -42,22 +42,22 @@ build:
name: Foo
```

## Using ESBuild for JavaScript Bundling
## Using esbuild for JavaScript Bundling

::: warning
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.
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 necessary 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
build:
zip:
assets:
# Use ESBuild for Administration
# Use esbuild for Administration
enable_es_build_for_admin: true
# Use ESBuild for Storefront
# Use esbuild for Storefront
enable_es_build_for_storefront: true
```

2 changes: 1 addition & 1 deletion products/cli/extension-commands/extract-meta-data.md
Original file line number Diff line number Diff line change
@@ -29,4 +29,4 @@ shopware-cli extension get-changelog <path>

The path can be absolute or relative to the current working directory. The command will output the changelog of the extension.

It will output always the english changelog.
It will output always the English changelog.
8 changes: 4 additions & 4 deletions products/cli/extension-commands/validation.md
Original file line number Diff line number Diff line change
@@ -17,15 +17,15 @@ To validate an extension, you can use the following command:
shopware-cli extension validate <path>
```

The path can be absolute or relative to the directory containg the extension or the zip file. The command exists with a non-zero exit code if the validation fails with a error level message.
The path can be absolute or relative to the directory containing the extension or the zip file. The command exists with a non-zero exit code if the validation fails with a error level message.

Check warning on line 20 in products/cli/extension-commands/validation.md

GitHub Actions / LanguageTool

[LanguageTool] products/cli/extension-commands/validation.md#L20

Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’. (EN_A_VS_AN) Suggestions: `an` URL: https://languagetool.org/insights/post/indefinite-articles/ Rule: https://community.languagetool.org/rule/show/EN_A_VS_AN?lang=en-US Category: MISC
Raw output
products/cli/extension-commands/validation.md:20:170: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’. (EN_A_VS_AN)
 Suggestions: `an`
 URL: https://languagetool.org/insights/post/indefinite-articles/ 
 Rule: https://community.languagetool.org/rule/show/EN_A_VS_AN?lang=en-US
 Category: MISC

## What is validated?

- The composer.json has an `shopware/core` requirement and constraint is parseable
- The composer.json has an `shopware/core` requirement and constraint is parsable
- The extension metadata is filled:
- `name`
- `label` (german and english)
- `description` (german and english) and longer than 150 characters and shorter than 185 characters
- `label` (German and English)
- `description` (German and English) and longer than 150 characters and shorter than 185 characters
- Translations have equality translated in the given languages
- PHP can be correctly linted with the minimum PHP version
- The theme.json can be parsed and included assets can be found

Check warning on line 31 in products/cli/extension-commands/validation.md

GitHub Actions / LanguageTool

[LanguageTool] products/cli/extension-commands/validation.md#L31

Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE_2[4]) Suggestions: `, and` URL: https://languagetool.org/insights/post/types-of-sentences/#compound-sentence Rule: https://community.languagetool.org/rule/show/COMMA_COMPOUND_SENTENCE_2?lang=en-US&subId=4 Category: PUNCTUATION
Raw output
products/cli/extension-commands/validation.md:31:30: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE_2[4])
 Suggestions: `, and`
 URL: https://languagetool.org/insights/post/types-of-sentences/#compound-sentence 
 Rule: https://community.languagetool.org/rule/show/COMMA_COMPOUND_SENTENCE_2?lang=en-US&subId=4
 Category: PUNCTUATION
4 changes: 2 additions & 2 deletions products/cli/project-commands/build.md
Original file line number Diff line number Diff line change
@@ -21,7 +21,7 @@ shopware-cli project ci <path>

- It runs `composer install` (by default only installs the production dependencies, use `--with-dev-dependencies` to install also the dev dependencies)
- Looks for missing assets of extensions and only compiles the missing assets to speed up the build process
- Deletes unnessessary files like `node_modules` and many more to save disk space
- Deletes unnecessary files like `node_modules` and many more to save disk space
- Deletes source code of compiled assets to save disk space
- Merges snippets of extensions to speed up Administration

@@ -35,7 +35,7 @@ For more information, see the [Composer documentation](https://getcomposer.org/d

## Reducing JavaScript in Storefront

Shopware's default Browserlist still supports older Browsers like Internet Explorer 11. If you want to reduce JavaScript polyfills and CSS prefixes, you can adjust the Browserlist configuration in the `.shopware-project.yml` file.
Shopware's default Browserlist still supports older Browsers like Internet Explorer 11. If you want to reduce JavaScript polyfill and CSS prefixes, you can adjust the Browserlist configuration in the `.shopware-project.yml` file.

```yaml
build:
6 changes: 3 additions & 3 deletions products/cli/project-commands/remote-extension-managment.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
---
nav:
title: Remote Extension Managment
title: Remote Extension Management
position: 4

---

# Remote Extension Managment
# Remote Extension Management

Shopware-CLI has an extension manager to install and manage extensions in your Shopware project through the Shopware API. Kinda like the Extension Manager in the Shopware 6 Administration Panel, but for the CLI.

::: info
This functionality was designed for Shopware SaaS and should not be used for self-hosted installations. [The recommandation is to use the Deployment Helper and install all plugins via Composer.](../../../guides/hosting/installation-updates/deployments/deployment-helper.md)
This functionality was designed for Shopware SaaS and should not be used for self-hosted installations. [The recommendation is to use the Deployment Helper and install all plugins via Composer.](../../../guides/hosting/installation-updates/deployments/deployment-helper.md)
:::

To use the extension manager, you need a `.shopware-project.yml`, this can be created with the command `shopware-cli project config init`.
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
nav:
title: Authentification
title: Authentication
position: 1

---

# Authentification
# Authentication

To interact with the Shopware Account API, you need to authenticate yourself.

Original file line number Diff line number Diff line change
@@ -15,7 +15,7 @@ First, make sure you have access to the given Shop in Shopware Account. You can
shopware-cli account merchant shop list
```

If you don't see the shop you want to use, you need to switch to the correct company with the following command. Check the [Authentification](./authentification.md) guide for more information.
If you don't see the shop you want to use, you need to switch to the correct company with the following command. Check the [Authentication](./authentication.md) guide for more information.

To create a `auth.json` file with the Composer repository configuration, you can use the following command:

Original file line number Diff line number Diff line change
@@ -9,7 +9,7 @@ nav:

## Prerequisites

- You are logged into the Shopware Store. Checkout the [Authentification](./authentification.md) guide for more information.
- You are logged into the Shopware Store. Checkout the [Authentication](./authentication.md) guide for more information.
- You have a Zip file of your extensions with all assets. Checkout the [Creating a Zip](../extension-commands/build.md) guide for more information.
- The Zip file contains a `CHANGELOG*.md` file with an Changelog entry for the new version. Having a German Changelog is optional.

Check warning on line 14 in products/cli/shopware-account-commands/releasing-extension-to-shopware-store.md

GitHub Actions / LanguageTool

[LanguageTool] products/cli/shopware-account-commands/releasing-extension-to-shopware-store.md#L14

Use “a” instead of ‘an’ if the following word doesn’t start with a vowel sound, e.g. ‘a sentence’, ‘a university’. (EN_A_VS_AN) Suggestions: `a` URL: https://languagetool.org/insights/post/indefinite-articles/ Rule: https://community.languagetool.org/rule/show/EN_A_VS_AN?lang=en-US Category: MISC
Raw output
products/cli/shopware-account-commands/releasing-extension-to-shopware-store.md:14:52: Use “a” instead of ‘an’ if the following word doesn’t start with a vowel sound, e.g. ‘a sentence’, ‘a university’. (EN_A_VS_AN)
 Suggestions: `a`
 URL: https://languagetool.org/insights/post/indefinite-articles/ 
 Rule: https://community.languagetool.org/rule/show/EN_A_VS_AN?lang=en-US
 Category: MISC
- You have validated the zip file with `shopware-cli extension validate <zip-path>`, see [Validating the zip](../extension-commands/validation.md) for more information.
6 changes: 3 additions & 3 deletions products/cli/shopware-account-commands/updating-store-page.md
Original file line number Diff line number Diff line change
@@ -11,11 +11,11 @@ You can use Shopware-CLI to versioning your Store Page representation of your ex

## Prerequisites

- You are logged into the Shopware Store. Checkout the [Authentification](./authentification.md) guide for more information.
- You are logged into the Shopware Store. Checkout the [Authentication](./authentication.md) guide for more information.

## Fetching the current Store Page

It's recommanded to start with the current Store Page and update only the parts you want to change. You can fetch the current Store Page with the following command:
It's recommended to start with the current Store Page and update only the parts you want to change. You can fetch the current Store Page with the following command:

```bash
shopware-cli account producer extension info pull <path-to-extension-folder>
@@ -39,7 +39,7 @@ This will upload all images and metadata to the Store Page.

Images can be uploaded in two ways:

Explictly defined in the configuration like this:
Explicitly defined in the configuration like this:

```yaml
store:

0 comments on commit a366bcb

Please sign in to comment.