Skip to content

Commit 5782fc3

Browse files
committed
Update event names and trigger template formatting
The commit makes two main changes: 1. Formats trigger event names with proper capitalization 2. Improves trigger template layout by renaming "Events" to "Run" The changes also include some automatic path updates in the VitePress configuration files.
1 parent 6ec783b commit 5782fc3

File tree

10 files changed

+93
-37
lines changed

10 files changed

+93
-37
lines changed

examples/docsify/docs/triggers/PaymentDeviceTrigger.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,5 @@
55
This trigger is used to handle the logic for the Payment Device object.
66

77
**Events**
8-
* beforeinsert
9-
* beforeupdate
8+
* Before Insert
9+
* Before Update

examples/vitepress/docs/.vitepress/cache/deps/@theme_index.js

Lines changed: 25 additions & 25 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

examples/vitepress/docs/.vitepress/cache/deps/_metadata.json

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,31 @@
11
{
2-
"hash": "38118198",
3-
"configHash": "7f7b0dad",
2+
"hash": "c8200423",
3+
"configHash": "8e537a0d",
44
"lockfileHash": "09651dfc",
5-
"browserHash": "1bd3b4f7",
5+
"browserHash": "b18c62f2",
66
"optimized": {
77
"vue": {
88
"src": "../../../../node_modules/vue/dist/vue.runtime.esm-bundler.js",
99
"file": "vue.js",
10-
"fileHash": "12c2c40e",
10+
"fileHash": "f55612ac",
1111
"needsInterop": false
1212
},
1313
"vitepress > @vue/devtools-api": {
1414
"src": "../../../../node_modules/@vue/devtools-api/dist/index.js",
1515
"file": "vitepress___@vue_devtools-api.js",
16-
"fileHash": "7b21a64c",
16+
"fileHash": "78b7bc58",
1717
"needsInterop": false
1818
},
1919
"vitepress > @vueuse/core": {
2020
"src": "../../../../node_modules/@vueuse/core/index.mjs",
2121
"file": "vitepress___@vueuse_core.js",
22-
"fileHash": "5d565a7a",
22+
"fileHash": "f7f18ce5",
2323
"needsInterop": false
2424
},
2525
"@theme/index": {
2626
"src": "../../../../node_modules/vitepress/dist/client/theme-default/index.js",
2727
"file": "@theme_index.js",
28-
"fileHash": "e4373905",
28+
"fileHash": "19a25279",
2929
"needsInterop": false
3030
}
3131
},

examples/vitepress/docs/.vitepress/sidebar.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,10 @@
1717
"text": "ParentInterface",
1818
"link": "miscellaneous/ParentInterface.md"
1919
},
20+
{
21+
"text": "PaymentDeviceTrigger",
22+
"link": "triggers/PaymentDeviceTrigger.md"
23+
},
2024
{
2125
"text": "ReferencedEnum",
2226
"link": "miscellaneous/ReferencedEnum.md"

examples/vitepress/docs/index.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,4 +93,10 @@ This description has several lines
9393
### [SampleClass](samplegroup/SampleClass)
9494

9595
aliquip ex sunt officia ullamco anim deserunt magna aliquip nisi eiusmod in sit officia veniam ex
96-
**deserunt** ea officia exercitation laboris enim in duis quis enim eiusmod eu amet cupidatat.
96+
**deserunt** ea officia exercitation laboris enim in duis quis enim eiusmod eu amet cupidatat.
97+
98+
## Triggers
99+
100+
### [PaymentDeviceTrigger](triggers/PaymentDeviceTrigger)
101+
102+
This trigger is used to handle the logic for the Payment Device object.
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: PaymentDeviceTrigger
3+
---
4+
5+
# PaymentDeviceTrigger Trigger
6+
7+
## Trigger On Payment_Device__c
8+
9+
This trigger is used to handle the logic for the Payment Device object.
10+
11+
## Namespace
12+
apexdocs
13+
14+
**Run**
15+
* Before Insert
16+
* Before Update
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
/**
2+
* This trigger is used to handle the logic for the Payment Device object.
3+
*/
4+
trigger PaymentDeviceTrigger on Payment_Device__c (before insert, before update) {}
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<?xml version='1.0' encoding='UTF-8'?>
2+
<ApexTrigger xmlns="http://soap.sforce.com/2006/04/metadata">
3+
<apiVersion>55.0</apiVersion>
4+
<status>Active</status>
5+
</ApexTrigger>

src/core/markdown/adapters/type-to-renderable.ts

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -264,6 +264,27 @@ function triggerMetadataToRenderable(
264264
linkGenerator: GetRenderableContentByTypeName,
265265
baseHeadingLevel: number = 1,
266266
): RenderableTrigger {
267+
function formatEvent(event: string): string {
268+
switch (event) {
269+
case 'beforeinsert':
270+
return 'Before Insert';
271+
case 'beforeupdate':
272+
return 'Before Update';
273+
case 'beforedelete':
274+
return 'Before Delete';
275+
case 'afterinsert':
276+
return 'After Insert';
277+
case 'afterupdate':
278+
return 'After Update';
279+
case 'afterdelete':
280+
return 'After Delete';
281+
case 'afterundelete':
282+
return 'After Undelete';
283+
default:
284+
return event;
285+
}
286+
}
287+
267288
return {
268289
doc: adaptDocumentable(
269290
{
@@ -278,7 +299,7 @@ function triggerMetadataToRenderable(
278299
headingLevel: 1,
279300
heading: triggerMetadata.name + ' Trigger',
280301
objectName: triggerMetadata.object_name,
281-
events: triggerMetadata.events,
302+
events: triggerMetadata.events.map(formatEvent),
282303
};
283304
}
284305

src/core/markdown/templates/trigger-template.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ export const triggerMarkdownTemplate = `
55
66
{{> typeDocumentation }}
77
8-
**Events**
8+
**Run**
99
{{#each events}}
1010
* {{this}}
1111
{{/each}}

0 commit comments

Comments
 (0)