feat: add shopware-cli documentation #4602
shyimmarkdown-style-check.yml
on: pull_request
Documentation Markdown Linter
9s
Annotations
33 warnings
|
Documentation Markdown Linter
ubuntu-latest pipelines will use ubuntu-24.04 soon. For more details, see https://github.com/actions/runner-images/issues/10636
|
|
[LanguageTool] products/cli/extension-commands/admin-watcher.md#L14:
products/cli/extension-commands/admin-watcher.md#L14
Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE[1])
Suggestions: `, and`
URL: https://languagetool.org/insights/post/types-of-sentences/#compound-sentence
Rule: https://community.languagetool.org/rule/show/COMMA_COMPOUND_SENTENCE?lang=en-US&subId=1
Category: PUNCTUATION
|
|
[LanguageTool] products/cli/extension-commands/admin-watcher.md#L15:
products/cli/extension-commands/admin-watcher.md#L15
A comma may be missing after the conjunctive/linking adverb ‘Therefore’. (SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA[1])
Suggestions: `Therefore,`
URL: https://languagetool.org/insights/post/linking-words/
Rule: https://community.languagetool.org/rule/show/SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA?lang=en-US&subId=1
Category: PUNCTUATION
|
|
[LanguageTool] products/cli/extension-commands/admin-watcher.md#L26:
products/cli/extension-commands/admin-watcher.md#L26
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
|
|
[LanguageTool] products/cli/extension-commands/admin-watcher.md#L28:
products/cli/extension-commands/admin-watcher.md#L28
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
|
|
[LanguageTool] products/cli/extension-commands/build.md#L28:
products/cli/extension-commands/build.md#L28
Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE[1])
Suggestions: `, and`
URL: https://languagetool.org/insights/post/types-of-sentences/#compound-sentence
Rule: https://community.languagetool.org/rule/show/COMMA_COMPOUND_SENTENCE?lang=en-US&subId=1
Category: PUNCTUATION
|
|
[LanguageTool] products/cli/extension-commands/build.md#L139:
products/cli/extension-commands/build.md#L139
Did you mean “extracting”? Or maybe you should add a pronoun? In active voice, ‘allow’ + ‘to’ takes an object, usually a pronoun. (ALLOW_TO[1])
Suggestions: `extracting`
URL: http://www.ef.com/english-resources/english-grammar/gerund-equals-infinitive/
Rule: https://community.languagetool.org/rule/show/ALLOW_TO?lang=en-US&subId=1
Category: GRAMMAR
|
|
[LanguageTool] products/cli/extension-commands/build.md#L144:
products/cli/extension-commands/build.md#L144
Add a space between sentences. (SENTENCE_WHITESPACE)
Suggestions: ` Commits`
Rule: https://community.languagetool.org/rule/show/SENTENCE_WHITESPACE?lang=en-US
Category: TYPOGRAPHY
|
|
[LanguageTool] products/cli/extension-commands/build.md#L144:
products/cli/extension-commands/build.md#L144
Add a space between sentences. (SENTENCE_WHITESPACE)
Suggestions: ` Message`
Rule: https://community.languagetool.org/rule/show/SENTENCE_WHITESPACE?lang=en-US
Category: TYPOGRAPHY
|
|
[LanguageTool] products/cli/extension-commands/build.md#L144:
products/cli/extension-commands/build.md#L144
Add a space between sentences. (SENTENCE_WHITESPACE)
Suggestions: ` Variables`
Rule: https://community.languagetool.org/rule/show/SENTENCE_WHITESPACE?lang=en-US
Category: TYPOGRAPHY
|
|
[LanguageTool] products/cli/extension-commands/build.md#L148:
products/cli/extension-commands/build.md#L148
Did you mean “extracting”? Or maybe you should add a pronoun? In active voice, ‘allow’ + ‘to’ takes an object, usually a pronoun. (ALLOW_TO[1])
Suggestions: `extracting`
URL: http://www.ef.com/english-resources/english-grammar/gerund-equals-infinitive/
Rule: https://community.languagetool.org/rule/show/ALLOW_TO?lang=en-US&subId=1
Category: GRAMMAR
|
|
[LanguageTool] products/cli/extension-commands/extract-meta-data.md#L10:
products/cli/extension-commands/extract-meta-data.md#L10
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
|
|
[LanguageTool] products/cli/extension-commands/extract-meta-data.md#L32:
products/cli/extension-commands/extract-meta-data.md#L32
The adverb ‘always’ is usually put before the verb ‘output’. (ADVERB_WORD_ORDER[8])
Suggestions: `always output`
URL: https://staff.washington.edu/marynell/grammar/AdverbPl.html
Rule: https://community.languagetool.org/rule/show/ADVERB_WORD_ORDER?lang=en-US&subId=8
Category: STYLE
|
|
[LanguageTool] products/cli/extension-commands/validation.md#L10:
products/cli/extension-commands/validation.md#L10
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
|
|
[LanguageTool] products/cli/extension-commands/validation.md#L20:
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
|
|
[LanguageTool] products/cli/extension-commands/validation.md#L31:
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
|
|
[LanguageTool] products/cli/index.md#L10:
products/cli/index.md#L10
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
|
|
[LanguageTool] products/cli/index.md#L18:
products/cli/index.md#L18
Two determiners in a row. Choose either “the” or “each”. (DT_DT[1])
Suggestions: `the`, `each`
Rule: https://community.languagetool.org/rule/show/DT_DT?lang=en-US&subId=1
Category: GRAMMAR
|
|
[LanguageTool] products/cli/installation.md#L59:
products/cli/installation.md#L59
The official name of this software platform is spelled with a capital “H”. (GITHUB[1])
Suggestions: `GitHub`
URL: https://en.wikipedia.org/wiki/GitHub
Rule: https://community.languagetool.org/rule/show/GITHUB?lang=en-US&subId=1
Category: CASING
|
|
[LanguageTool] products/cli/installation.md#L69:
products/cli/installation.md#L69
The official name of this software platform is spelled with a capital “H”. (GITHUB[1])
Suggestions: `GitHub`
URL: https://en.wikipedia.org/wiki/GitHub
Rule: https://community.languagetool.org/rule/show/GITHUB?lang=en-US&subId=1
Category: CASING
|
|
[LanguageTool] products/cli/installation.md#L71:
products/cli/installation.md#L71
The official name of this software platform is spelled with a capital “H”. (GITHUB[1])
Suggestions: `GitHub`
URL: https://en.wikipedia.org/wiki/GitHub
Rule: https://community.languagetool.org/rule/show/GITHUB?lang=en-US&subId=1
Category: CASING
|
|
[LanguageTool] products/cli/project-commands/build.md#L103:
products/cli/project-commands/build.md#L103
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
|
|
[LanguageTool] products/cli/project-commands/helper-commands.md#L67:
products/cli/project-commands/helper-commands.md#L67
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
|
|
[LanguageTool] products/cli/project-commands/mysql-dump.md#L36:
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
|
|
[LanguageTool] products/cli/project-commands/mysql-dump.md#L36:
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
|
|
[LanguageTool] products/cli/project-commands/project-config-sync.md#L52:
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
|
|
[LanguageTool] products/cli/project-commands/project-config-sync.md#L58:
products/cli/project-commands/project-config-sync.md#L58
The plural noun “criteria” cannot be used with the article “a”. Did you mean “a criterion” or “criteria”? (A_NNS[3])
Suggestions: `a criterion`, `criteria`
Rule: https://community.languagetool.org/rule/show/A_NNS?lang=en-US&subId=3
Category: GRAMMAR
|
|
[LanguageTool] products/cli/shopware-account-commands/authentification.md#L12:
products/cli/shopware-account-commands/authentification.md#L12
Did you mean the verb “log in” instead of the noun ‘login’? (LOG_IN[4])
Suggestions: `log in`
URL: https://grammarist.com/spelling/log-in-login/
Rule: https://community.languagetool.org/rule/show/LOG_IN?lang=en-US&subId=4
Category: CONFUSED_WORDS
|
|
[LanguageTool] products/cli/shopware-account-commands/authentification.md#L39:
products/cli/shopware-account-commands/authentification.md#L39
This abbreviation for “identification” is spelled all-uppercase. (ID_CASING[2])
Suggestions: `ID`
Rule: https://community.languagetool.org/rule/show/ID_CASING?lang=en-US&subId=2
Category: CASING
|
|
[LanguageTool] products/cli/shopware-account-commands/releasing-extension-to-shopware-store.md#L14:
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
|
|
[LanguageTool] products/cli/shopware-account-commands/releasing-extension-to-shopware-store.md#L27:
products/cli/shopware-account-commands/releasing-extension-to-shopware-store.md#L27
Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE[1])
Suggestions: `, and`
URL: https://languagetool.org/insights/post/types-of-sentences/#compound-sentence
Rule: https://community.languagetool.org/rule/show/COMMA_COMPOUND_SENTENCE?lang=en-US&subId=1
Category: PUNCTUATION
|
|
[LanguageTool] products/cli/shopware-account-commands/updating-store-page.md#L54:
products/cli/shopware-account-commands/updating-store-page.md#L54
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
|
|
[LanguageTool] products/cli/shopware-account-commands/updating-store-page.md#L54:
products/cli/shopware-account-commands/updating-store-page.md#L54
Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE)
Suggestions: `preview`
Rule: https://community.languagetool.org/rule/show/ENGLISH_WORD_REPEAT_RULE?lang=en-US
Category: MISC
|