Skip to content

Commit 3bc927c

Browse files
committed
chore: format readme
1 parent e5a744d commit 3bc927c

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Code Format
22

3-
Format a selection of code using the `code-format:format-code` command.
3+
Format a selection of code using the `code-format:format-code` command.
44
(Also accessible via context menu, or "Edit > Text > Format Code").
55

66
When no selection is provided, the entire file is formatted.
@@ -12,15 +12,14 @@ Code Format also provides APIs to:
1212
- format code as you type
1313
- format code on save (after you press save but before writing to disk).
1414

15-
You can enable format-on-save using plain range/file providers from the
16-
"atom-ide-code-format" section in the `atom-ide-ui` package settings.
15+
You can enable format-on-save using plain range/file providers from the atom-ide-code-format's settings
1716

1817
## Service API
1918

20-
Provide code format [Atom services](http://flight-manual.atom.io/behind-atom/sections/interacting-with-other-packages-via-services/) by adding one or more of these to your `package.json`:
19+
Provide code format [Atom services](http://flight-manual.atom.io/behind-atom/sections/interacting-with-other-packages-via-services/) by adding one or more of these to your `package.json`:
2120
(Only the ones that you want to use; you don't need all of them!)
2221

23-
```
22+
```json
2423
"providedServices": {
2524
"code-format.range": {
2625
"versions": {
@@ -47,12 +46,12 @@ Provide code format [Atom services](http://flight-manual.atom.io/behind-atom/sec
4746

4847
Then, in your package entry point:
4948

50-
```
49+
```ts
5150
export function provideRangeCodeFormat(): RangeCodeFormatProvider {}
5251
export function provideFileCodeFormat(): FileCodeFormatProvider {}
5352
export function provideOnTypeCodeFormat(): OnTypeCodeFormatProvider {}
5453
export function provideOnSaveCodeFormat(): OnSaveCodeFormatProvider {}
5554
```
5655

5756
The various provider types are described in
58-
[`atom-ide-code-format/lib/types.js`](../modules/atom-ide-ui/pkg/atom-ide-code-format/lib/types.js).
57+
[`atom-ide-code-format/lib/types.js`](./src/types.ts).

0 commit comments

Comments
 (0)