Skip to content

Commit 5ce5ba3

Browse files
chore: apply automated fixes
1 parent f5d8346 commit 5ce5ba3

File tree

4 files changed

+13
-13
lines changed

4 files changed

+13
-13
lines changed

src/_parse.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ export interface Block {
3030

3131
/**
3232
* Searches a markdown document for special sections that `automd` can update.
33-
*
33+
*
3434
* @param md - The markdown document as a string.
3535
* @returns an array of blocks that can be updated automatically. {@link Block}
3636
*/
@@ -63,7 +63,7 @@ export function findBlocks(md: string): Block[] {
6363

6464
/**
6565
* Checks if a markdown document contains sections that can be automatically updated.
66-
*
66+
*
6767
* @param md - The markdown document as a string.
6868
* @returns true if there are `automd` sections, false otherwise.
6969
*/
@@ -74,12 +74,12 @@ export function containsAutomd(md: string) {
7474
/**
7575
* Converts a string of raw arguments to an object.
7676
* Each argument is separated by spaces. Arguments can be key-value pairs separated by '='.
77-
* If an argument starts with "no-", the key is set to false.
77+
* If an argument starts with "no-", the key is set to false.
7878
* Otherwise it sets the key to true. Keys are converted to camelCase.
7979
* Values are processed to determine their actual type (e.g. string, boolean).
80-
*
80+
*
8181
* @param {string} rawArgs - The string of arguments to parse.
82-
* @return {Object} - An object with keys derived from the arguments.
82+
* @return {Object} - An object with keys derived from the arguments.
8383
* Keys are in camelCase. Values are true, false, or strings.
8484
*/
8585
export function parseRawArgs(rawArgs: string) {

src/automd.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,13 +38,13 @@ export interface AutomdReturn {
3838
}
3939

4040
/**
41-
* Scans a markdown file looking for special comments.
41+
* Scans a markdown file looking for special comments.
4242
* These comments tell the function to add or update certain parts of the file automatically.
4343
* You can change how this works by giving it different settings in the `_config` option.
44-
*
44+
*
4545
* @param _config - The settings to use for the update process. See {@link Config}.
4646
* @returns - An object containing the results of the update, including any changes made and any problems found. See {@link AutomdReturn}.
47-
*
47+
*
4848
* @see https://automd.unjs.io/guide
4949
*/
5050
export async function automd(_config: Config = {}): Promise<AutomdReturn> {

src/config.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ export interface Config {
2020
/**
2121
* Name or path of the output files. If not provided, the input file will be overwritten.
2222
*
23-
* @default input
23+
* @default input
2424
*/
2525
output?: string;
2626

src/transform.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,14 +25,14 @@ export interface TransformResult {
2525
*/
2626
updates: {
2727
/**
28-
* The specific part of the document that has been transformed.
29-
*/
28+
* The specific part of the document that has been transformed.
29+
*/
3030
block: Block;
3131

3232
/**
3333
* What the transform has done to this part of the document.
3434
*/
35-
result: GenerateResult
35+
result: GenerateResult;
3636
}[];
3737

3838
/**
@@ -43,7 +43,7 @@ export interface TransformResult {
4343

4444
/**
4545
* Edits a markdown document based on certain rules and configurations.
46-
*
46+
*
4747
* @param contents - The text of the markdown document you want to edit.
4848
* @param _config - Optional. The settings that affect how the document will be edited. See {@link Config}.
4949
* @param url - Optional. The URL associated with the document, if any.

0 commit comments

Comments
 (0)