Skip to content

Commit 8a6d2cc

Browse files
committed
fix: resolve remark/prettier conflict on README.md
Remark normalizes list markers to `*` while Prettier normalizes to `-`. This caused README.md to be modified during lint-staged on every commit, blocking `np` version bumps with a dirty working tree error. - Remove `*.md` from Prettier glob in `.lintstagedrc` - Add `*.md` rule to `.lintstagedrc` that runs `remark -qfo` - Add `*.md` to `.prettierignore`
1 parent b53eda2 commit 8a6d2cc

3 files changed

Lines changed: 77 additions & 73 deletions

File tree

.lintstagedrc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
{
2-
"*.{js,json,md,yml,yaml}": [
2+
"*.{js,json,yml,yaml}": [
33
"prettier --write"
44
],
55
"*.js": [
66
"xo --fix"
7+
],
8+
"*.md": [
9+
"remark -qfo"
710
]
811
}

.prettierignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
*.md

README.md

Lines changed: 72 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -76,119 +76,119 @@ This server exposes the complete [Forward Email API](https://forwardemail.net/em
7676

7777
### Account
7878

79-
- `getAccount` - Get your account details
80-
- `updateAccount` - Update your account
79+
* `getAccount` - Get your account details
80+
* `updateAccount` - Update your account
8181

8282
### Logs
8383

84-
- `downloadLogs` - Download email delivery logs
84+
* `downloadLogs` - Download email delivery logs
8585

8686
### Contacts (CardDAV)
8787

88-
- `listContacts` - List all contacts
89-
- `createContact` - Create a contact
90-
- `getContact` - Get a contact by ID
91-
- `updateContact` - Update a contact
92-
- `deleteContact` - Delete a contact
88+
* `listContacts` - List all contacts
89+
* `createContact` - Create a contact
90+
* `getContact` - Get a contact by ID
91+
* `updateContact` - Update a contact
92+
* `deleteContact` - Delete a contact
9393

9494
### Calendars (CalDAV)
9595

96-
- `listCalendars` - List all calendars
97-
- `createCalendar` - Create a calendar
98-
- `getCalendar` - Get a calendar by ID
99-
- `updateCalendar` - Update a calendar
100-
- `deleteCalendar` - Delete a calendar
96+
* `listCalendars` - List all calendars
97+
* `createCalendar` - Create a calendar
98+
* `getCalendar` - Get a calendar by ID
99+
* `updateCalendar` - Update a calendar
100+
* `deleteCalendar` - Delete a calendar
101101

102102
### Calendar Events (CalDAV)
103103

104-
- `listCalendarEvents` - List all calendar events
105-
- `createCalendarEvent` - Create a calendar event
106-
- `getCalendarEvent` - Get a calendar event by ID
107-
- `updateCalendarEvent` - Update a calendar event
108-
- `deleteCalendarEvent` - Delete a calendar event
104+
* `listCalendarEvents` - List all calendar events
105+
* `createCalendarEvent` - Create a calendar event
106+
* `getCalendarEvent` - Get a calendar event by ID
107+
* `updateCalendarEvent` - Update a calendar event
108+
* `deleteCalendarEvent` - Delete a calendar event
109109

110110
### Domains
111111

112-
- `listDomains` - List all domains
113-
- `createDomain` - Create a new domain
114-
- `getDomain` - Get a domain by ID or name
115-
- `updateDomain` - Update a domain
116-
- `deleteDomain` - Delete a domain
117-
- `verifyDomainRecords` - Verify domain DNS records
118-
- `verifySmtpRecords` - Verify domain SMTP records
119-
- `testS3Connection` - Test custom S3 connection for a domain
112+
* `listDomains` - List all domains
113+
* `createDomain` - Create a new domain
114+
* `getDomain` - Get a domain by ID or name
115+
* `updateDomain` - Update a domain
116+
* `deleteDomain` - Delete a domain
117+
* `verifyDomainRecords` - Verify domain DNS records
118+
* `verifySmtpRecords` - Verify domain SMTP records
119+
* `testS3Connection` - Test custom S3 connection for a domain
120120

121121
### Domain Catch-All Passwords
122122

123-
- `listCatchAllPasswords` - List domain-wide catch-all passwords
124-
- `createCatchAllPassword` - Create a domain-wide catch-all password
125-
- `deleteCatchAllPassword` - Remove a domain-wide catch-all password
123+
* `listCatchAllPasswords` - List domain-wide catch-all passwords
124+
* `createCatchAllPassword` - Create a domain-wide catch-all password
125+
* `deleteCatchAllPassword` - Remove a domain-wide catch-all password
126126

127127
### Domain Invites
128128

129-
- `acceptDomainInvite` - Accept a domain invite
130-
- `createDomainInvite` - Invite a user to a domain
131-
- `removeDomainInvite` - Remove a domain invite
129+
* `acceptDomainInvite` - Accept a domain invite
130+
* `createDomainInvite` - Invite a user to a domain
131+
* `removeDomainInvite` - Remove a domain invite
132132

133133
### Domain Members
134134

135-
- `updateDomainMember` - Update a domain member role
136-
- `removeDomainMember` - Remove a member from a domain
135+
* `updateDomainMember` - Update a domain member role
136+
* `removeDomainMember` - Remove a member from a domain
137137

138138
### Aliases
139139

140-
- `listAliases` - List aliases for a domain
141-
- `createAlias` - Create a new alias
142-
- `getAlias` - Get an alias by ID
143-
- `updateAlias` - Update an alias
144-
- `deleteAlias` - Delete an alias
145-
- `generateAliasPassword` - Generate or set a password for an alias
140+
* `listAliases` - List aliases for a domain
141+
* `createAlias` - Create a new alias
142+
* `getAlias` - Get an alias by ID
143+
* `updateAlias` - Update an alias
144+
* `deleteAlias` - Delete an alias
145+
* `generateAliasPassword` - Generate or set a password for an alias
146146

147147
### Sieve Scripts
148148

149-
- `listSieveScripts` - List Sieve scripts for an alias
150-
- `createSieveScript` - Create a Sieve script for an alias
151-
- `getSieveScript` - Get a Sieve script by ID
152-
- `updateSieveScript` - Update a Sieve script
153-
- `deleteSieveScript` - Delete a Sieve script
154-
- `activateSieveScript` - Activate a Sieve script
149+
* `listSieveScripts` - List Sieve scripts for an alias
150+
* `createSieveScript` - Create a Sieve script for an alias
151+
* `getSieveScript` - Get a Sieve script by ID
152+
* `updateSieveScript` - Update a Sieve script
153+
* `deleteSieveScript` - Delete a Sieve script
154+
* `activateSieveScript` - Activate a Sieve script
155155

156156
### Sieve Scripts (Alias Auth)
157157

158-
- `listSieveScriptsAliasAuth` - List Sieve scripts (alias auth)
159-
- `createSieveScriptAliasAuth` - Create a Sieve script (alias auth)
160-
- `getSieveScriptAliasAuth` - Get a Sieve script (alias auth)
161-
- `updateSieveScriptAliasAuth` - Update a Sieve script (alias auth)
162-
- `deleteSieveScriptAliasAuth` - Delete a Sieve script (alias auth)
163-
- `activateSieveScriptAliasAuth` - Activate a Sieve script (alias auth)
158+
* `listSieveScriptsAliasAuth` - List Sieve scripts (alias auth)
159+
* `createSieveScriptAliasAuth` - Create a Sieve script (alias auth)
160+
* `getSieveScriptAliasAuth` - Get a Sieve script (alias auth)
161+
* `updateSieveScriptAliasAuth` - Update a Sieve script (alias auth)
162+
* `deleteSieveScriptAliasAuth` - Delete a Sieve script (alias auth)
163+
* `activateSieveScriptAliasAuth` - Activate a Sieve script (alias auth)
164164

165165
### Emails (Outbound SMTP)
166166

167-
- `listEmails` - List outbound SMTP emails
168-
- `sendEmail` - Send an email via outbound SMTP
169-
- `getEmailLimit` - Get outbound SMTP email sending limit
170-
- `getEmail` - Get an outbound SMTP email by ID
171-
- `deleteEmail` - Delete an outbound SMTP email
167+
* `listEmails` - List outbound SMTP emails
168+
* `sendEmail` - Send an email via outbound SMTP
169+
* `getEmailLimit` - Get outbound SMTP email sending limit
170+
* `getEmail` - Get an outbound SMTP email by ID
171+
* `deleteEmail` - Delete an outbound SMTP email
172172

173173
### Messages (IMAP)
174174

175-
- `listMessages` - List and search messages in a folder
176-
- `createMessage` - Create a new message (draft)
177-
- `getMessage` - Get a message by ID
178-
- `updateMessage` - Update a message
179-
- `deleteMessage` - Delete a message
175+
* `listMessages` - List and search messages in a folder
176+
* `createMessage` - Create a new message (draft)
177+
* `getMessage` - Get a message by ID
178+
* `updateMessage` - Update a message
179+
* `deleteMessage` - Delete a message
180180

181181
### Folders (IMAP)
182182

183-
- `listFolders` - List all folders
184-
- `createFolder` - Create a new folder
185-
- `getFolder` - Get a folder by ID
186-
- `updateFolder` - Update a folder
187-
- `deleteFolder` - Delete a folder
183+
* `listFolders` - List all folders
184+
* `createFolder` - Create a new folder
185+
* `getFolder` - Get a folder by ID
186+
* `updateFolder` - Update a folder
187+
* `deleteFolder` - Delete a folder
188188

189189
### Encrypt
190190

191-
- `encryptRecord` - Encrypt a plaintext Forward Email TXT record
191+
* `encryptRecord` - Encrypt a plaintext Forward Email TXT record
192192

193193
## Development
194194

@@ -205,7 +205,7 @@ pnpm test
205205

206206
## Links
207207

208-
- [Forward Email](https://forwardemail.net)
209-
- [Forward Email API Docs](https://forwardemail.net/email-api)
210-
- [MCP Specification](https://github.com/modelcontextprotocol/specification)
211-
- [MCP Landing Page](https://forwardemail.net/mcp)
208+
* [Forward Email](https://forwardemail.net)
209+
* [Forward Email API Docs](https://forwardemail.net/email-api)
210+
* [MCP Specification](https://github.com/modelcontextprotocol/specification)
211+
* [MCP Landing Page](https://forwardemail.net/mcp)

0 commit comments

Comments
 (0)