Skip to content

Commit 294ed32

Browse files
committed
clean up formatting and fix typos in markdowns
1 parent b11b421 commit 294ed32

File tree

8 files changed

+18
-21
lines changed

8 files changed

+18
-21
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,14 @@ A clear and concise description of what you expected to happen.
2929
If applicable, add screenshots to help explain your problem.
3030

3131
**System (please complete the following information):**
32-
- OS: [e.g. Windows]
33-
- IDE: [e.g. VSCode, Atom]
34-
- Plugin/Package: [e.g. "Svelte for VSCode", or `svelte-language-server`, `svelte-check`, or `svelte2tsx` if you use one of the npm packages directly]
32+
33+
- OS: [e.g. Windows]
34+
- IDE: [e.g. VSCode, Atom]
35+
- Plugin/Package: [e.g. "Svelte for VSCode", or `svelte-language-server`, `svelte-check`, or `svelte2tsx` if you use one of the npm packages directly]
3536

3637
**Additional context**
3738
Add any other context about the problem here.
3839

3940
<!-- Want to help us out? Read this to get started:
4041
https://github.com/sveltejs/language-tools#development
41-
-->
42+
-->

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,4 @@ Add any other context or screenshots about the feature request here.
2121

2222
<!-- Want to help us out? Read this to get started:
2323
https://github.com/sveltejs/language-tools#development
24-
-->
24+
-->

.github/ISSUE_TEMPLATE/something-else.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,3 @@ labels: ''
66
assignees: ''
77

88
---
9-
10-

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<p>
22
<a href="https://svelte.dev">
3-
<img alt="Cybernetically enhanced web apps: Svelte" src="https://user-images.githubusercontent.com/49038/76711598-f0b39180-66e7-11ea-9501-37f6e1edf8a6.png">
3+
<img alt="Cybernetically enhanced web apps: Svelte" src="https://user-images.githubusercontent.com/49038/76711598-f0b39180-66e7-11ea-9501-37f6e1edf8a6.png">
44
</a>
55

66
<a href="https://www.npmjs.com/package/svelte">

docs/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ LSP-compatible editors, you can use an HTML comment with the `@component` tag:
4747

4848
The VS Code extension comes with its own syntax highlighting grammar which defines special scopes. If your syntax highlighting seems to be not working for Svelte components or you feel that some colors are wrong, you can add something like the following to your `settings.json`:
4949

50-
```
50+
```json
5151
{
5252
"editor.tokenColorCustomizations": {
5353
"[<Name of your theme>]": {
@@ -80,7 +80,7 @@ You need to save the file to see the changes. If the problem persists after savi
8080

8181
```json
8282
"files.watcherExclude": {
83-
"**/*": true,
83+
"**/*": true,
8484
}
8585
```
8686

@@ -94,13 +94,13 @@ If you have the `Babel Javascript` plugin installed, this may be the cause. Disa
9494

9595
Your default formatter for Svelte files may be wrong.
9696

97-
- Mabye it's set to the old Svelte extension, if so, remove the setting
97+
- Maybe it's set to the old Svelte extension, if so, remove the setting
9898
- Maybe you set all files to be formatted by the prettier extension. Then you have two options: Either install `prettier-plugin-svelte` from npm, or tell VSCode to format the code with the `Svelte for VSCode extension`:
9999

100100
```json
101-
"[svelte]": {
101+
"[svelte]": {
102102
"editor.defaultFormatter": "svelte.svelte-vscode"
103-
},
103+
},
104104
```
105105

106106
## Internals

docs/preprocessors/typescript.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -108,10 +108,9 @@ At the moment, you cannot. Only `script`/`style` tags are preprocessed/transpile
108108

109109
You may need to set `baseUrl` in `tsconfig.json` at the project root to include (restart the language server to see this take effect):
110110

111-
```
111+
```json
112112
"compilerOptions": {
113113
"baseUrl": "."
114-
}
115114
}
116115
```
117116

@@ -140,7 +139,7 @@ Then make sure that `d.ts` file is referenced in your `tsconfig.json`. If it rea
140139

141140
You are most likely extending from Svelte's `@tsconfig/svelte` base config in your `tsconfig.json`, or you did set `"types": [..]` in your `tsconfig`. In both cases, a `"types": [..]` property is present. This makes TypeScript prevent all ambient types which are not listed in that `types`-array from getting picked up. The solution is to enhance/add a `types` section to your `tsconfig.json`:
142141

143-
```
142+
```json
144143
{
145144
"compilerOptions": {
146145
// ..

packages/language-server/README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,6 @@ Update:
9393
javascript: { /* .. */ },
9494
prettierConfig: { /* .. */ },
9595
// ...
96-
}
9796
}
9897
```
9998

packages/svelte-vscode/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ If you have previously installed the old "Svelte" extension by James Birtles, un
1313

1414
This extension comes bundled with a formatter for Svelte files. To let this extension format Svelte files, adjust your VS Code settings:
1515

16-
```
17-
"[svelte]": {
18-
"editor.defaultFormatter": "svelte.svelte-vscode"
19-
},
16+
```json
17+
"[svelte]": {
18+
"editor.defaultFormatter": "svelte.svelte-vscode"
19+
},
2020
```
2121

2222
The formatter is a [Prettier](https://prettier.io/) [plugin](https://prettier.io/docs/en/plugins.html), which means some formatting options of Prettier apply. There are also Svelte specific settings like the sort order of scripts, markup, styles. More info about them and how to configure it can be found [here](https://github.com/sveltejs/prettier-plugin-svelte).

0 commit comments

Comments
 (0)