@simplysf/simply-document 0.4.11 → 0.4.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/oclif.manifest.json +191 -0
- package/package.json +6 -3
package/README.md
CHANGED
|
@@ -74,7 +74,7 @@ FLAG DESCRIPTIONS
|
|
|
74
74
|
available partials.
|
|
75
75
|
```
|
|
76
76
|
|
|
77
|
-
_See code: [lib/commands/simply/document/diff.js](https://github.com/SimplySF/simply-plugins/blob/@simplysf/simply-document@0.4.
|
|
77
|
+
_See code: [lib/commands/simply/document/diff.js](https://github.com/SimplySF/simply-plugins/blob/@simplysf/simply-document@0.4.13/packages/simply-document/lib/commands/simply/document/diff.js)_
|
|
78
78
|
|
|
79
79
|
## `sf simply document generate`
|
|
80
80
|
|
|
@@ -120,7 +120,7 @@ FLAG DESCRIPTIONS
|
|
|
120
120
|
for the data shape.
|
|
121
121
|
```
|
|
122
122
|
|
|
123
|
-
_See code: [lib/commands/simply/document/generate.js](https://github.com/SimplySF/simply-plugins/blob/@simplysf/simply-document@0.4.
|
|
123
|
+
_See code: [lib/commands/simply/document/generate.js](https://github.com/SimplySF/simply-plugins/blob/@simplysf/simply-document@0.4.13/packages/simply-document/lib/commands/simply/document/generate.js)_
|
|
124
124
|
<!-- commandsstop -->
|
|
125
125
|
|
|
126
126
|
## Custom Templates
|
|
@@ -0,0 +1,191 @@
|
|
|
1
|
+
{
|
|
2
|
+
"commands": {
|
|
3
|
+
"simply:document:diff": {
|
|
4
|
+
"aliases": [],
|
|
5
|
+
"args": {},
|
|
6
|
+
"description": "Runs `git diff --name-status` between two git refs (tags, branches, or commits) in the current working directory, groups the changed files by Salesforce metadata component type, and renders a Confluence-storage-format change report suitable for pasting into a release or change-management page.",
|
|
7
|
+
"examples": [
|
|
8
|
+
"<%= config.bin %> <%= command.id %> --from-tag v1.0.0 --to-tag v1.1.0",
|
|
9
|
+
"<%= config.bin %> <%= command.id %> --from-tag v1.0.0 --to-tag v1.1.0 --output-file change-report.html",
|
|
10
|
+
"<%= config.bin %> <%= command.id %> --from-tag v1.0.0 --to-tag v1.1.0 --template-file my-change-report.hbs"
|
|
11
|
+
],
|
|
12
|
+
"flags": {
|
|
13
|
+
"json": {
|
|
14
|
+
"description": "Format output as json.",
|
|
15
|
+
"helpGroup": "GLOBAL",
|
|
16
|
+
"name": "json",
|
|
17
|
+
"allowNo": false,
|
|
18
|
+
"type": "boolean"
|
|
19
|
+
},
|
|
20
|
+
"flags-dir": {
|
|
21
|
+
"helpGroup": "GLOBAL",
|
|
22
|
+
"name": "flags-dir",
|
|
23
|
+
"summary": "Import flag values from a directory.",
|
|
24
|
+
"hasDynamicHelp": false,
|
|
25
|
+
"multiple": false,
|
|
26
|
+
"type": "option"
|
|
27
|
+
},
|
|
28
|
+
"from-tag": {
|
|
29
|
+
"name": "from-tag",
|
|
30
|
+
"required": true,
|
|
31
|
+
"summary": "The starting git ref for the diff report.",
|
|
32
|
+
"hasDynamicHelp": false,
|
|
33
|
+
"multiple": false,
|
|
34
|
+
"type": "option"
|
|
35
|
+
},
|
|
36
|
+
"to-tag": {
|
|
37
|
+
"name": "to-tag",
|
|
38
|
+
"required": true,
|
|
39
|
+
"summary": "The ending git ref for the diff report.",
|
|
40
|
+
"hasDynamicHelp": false,
|
|
41
|
+
"multiple": false,
|
|
42
|
+
"type": "option"
|
|
43
|
+
},
|
|
44
|
+
"output-file": {
|
|
45
|
+
"description": "When specified, the generated report is written to this path instead of being printed to the terminal.",
|
|
46
|
+
"name": "output-file",
|
|
47
|
+
"summary": "Path to write the generated report to.",
|
|
48
|
+
"hasDynamicHelp": false,
|
|
49
|
+
"multiple": false,
|
|
50
|
+
"type": "option"
|
|
51
|
+
},
|
|
52
|
+
"template-file": {
|
|
53
|
+
"description": "When specified, this template is rendered with the same data the built-in report template receives, and can reuse the built-in `changeTable` partial. See this package's README \"Custom Templates\" section for the data shape and available partials.",
|
|
54
|
+
"name": "template-file",
|
|
55
|
+
"summary": "Path to a custom Handlebars template to render instead of the built-in one.",
|
|
56
|
+
"hasDynamicHelp": false,
|
|
57
|
+
"multiple": false,
|
|
58
|
+
"type": "option"
|
|
59
|
+
},
|
|
60
|
+
"output-format": {
|
|
61
|
+
"description": "Currently only `html` is supported. Reserved for future formats (e.g. Markdown).",
|
|
62
|
+
"name": "output-format",
|
|
63
|
+
"summary": "Output format to render the report in.",
|
|
64
|
+
"default": "html",
|
|
65
|
+
"hasDynamicHelp": false,
|
|
66
|
+
"multiple": false,
|
|
67
|
+
"options": [
|
|
68
|
+
"html"
|
|
69
|
+
],
|
|
70
|
+
"type": "option"
|
|
71
|
+
}
|
|
72
|
+
},
|
|
73
|
+
"hasDynamicHelp": false,
|
|
74
|
+
"hiddenAliases": [],
|
|
75
|
+
"id": "simply:document:diff",
|
|
76
|
+
"pluginAlias": "@simplysf/simply-document",
|
|
77
|
+
"pluginName": "@simplysf/simply-document",
|
|
78
|
+
"pluginType": "core",
|
|
79
|
+
"strict": true,
|
|
80
|
+
"summary": "Generate a change report between two git refs.",
|
|
81
|
+
"enableJsonFlag": true,
|
|
82
|
+
"isESM": true,
|
|
83
|
+
"relativePath": [
|
|
84
|
+
"lib",
|
|
85
|
+
"commands",
|
|
86
|
+
"simply",
|
|
87
|
+
"document",
|
|
88
|
+
"diff.js"
|
|
89
|
+
],
|
|
90
|
+
"aliasPermutations": [],
|
|
91
|
+
"permutations": [
|
|
92
|
+
"simply:document:diff",
|
|
93
|
+
"document:simply:diff",
|
|
94
|
+
"document:diff:simply",
|
|
95
|
+
"simply:diff:document",
|
|
96
|
+
"diff:simply:document",
|
|
97
|
+
"diff:document:simply"
|
|
98
|
+
]
|
|
99
|
+
},
|
|
100
|
+
"simply:document:generate": {
|
|
101
|
+
"aliases": [],
|
|
102
|
+
"args": {},
|
|
103
|
+
"description": "Scans a Salesforce DX project's source directory for metadata (objects, fields, Apex, Lightning components, flows, permissions, and more) and renders a Confluence-storage-format technical design document covering the data model, security model, groups/queues/permissions, solution inventory, and custom code inventory.",
|
|
104
|
+
"examples": [
|
|
105
|
+
"<%= config.bin %> <%= command.id %> --directory force-app --output-file technical-design-document.html",
|
|
106
|
+
"<%= config.bin %> <%= command.id %> --directory force-app --output-file technical-design-document.html --template-file my-tdd-template.hbs"
|
|
107
|
+
],
|
|
108
|
+
"flags": {
|
|
109
|
+
"json": {
|
|
110
|
+
"description": "Format output as json.",
|
|
111
|
+
"helpGroup": "GLOBAL",
|
|
112
|
+
"name": "json",
|
|
113
|
+
"allowNo": false,
|
|
114
|
+
"type": "boolean"
|
|
115
|
+
},
|
|
116
|
+
"flags-dir": {
|
|
117
|
+
"helpGroup": "GLOBAL",
|
|
118
|
+
"name": "flags-dir",
|
|
119
|
+
"summary": "Import flag values from a directory.",
|
|
120
|
+
"hasDynamicHelp": false,
|
|
121
|
+
"multiple": false,
|
|
122
|
+
"type": "option"
|
|
123
|
+
},
|
|
124
|
+
"directory": {
|
|
125
|
+
"char": "d",
|
|
126
|
+
"name": "directory",
|
|
127
|
+
"required": true,
|
|
128
|
+
"summary": "Salesforce project source directory to scan.",
|
|
129
|
+
"hasDynamicHelp": false,
|
|
130
|
+
"multiple": false,
|
|
131
|
+
"type": "option"
|
|
132
|
+
},
|
|
133
|
+
"output-file": {
|
|
134
|
+
"name": "output-file",
|
|
135
|
+
"required": true,
|
|
136
|
+
"summary": "Path to write the generated document to.",
|
|
137
|
+
"hasDynamicHelp": false,
|
|
138
|
+
"multiple": false,
|
|
139
|
+
"type": "option"
|
|
140
|
+
},
|
|
141
|
+
"template-file": {
|
|
142
|
+
"description": "When specified, this template is rendered with the same scanned project data the built-in technical design document template receives, and can reuse the built-in `loud` helper. See this package's README \"Custom Templates\" section for the data shape.",
|
|
143
|
+
"name": "template-file",
|
|
144
|
+
"summary": "Path to a custom Handlebars template to render instead of the built-in one.",
|
|
145
|
+
"hasDynamicHelp": false,
|
|
146
|
+
"multiple": false,
|
|
147
|
+
"type": "option"
|
|
148
|
+
},
|
|
149
|
+
"output-format": {
|
|
150
|
+
"description": "Currently only `html` is supported. Reserved for future formats (e.g. Markdown).",
|
|
151
|
+
"name": "output-format",
|
|
152
|
+
"summary": "Output format to render the document in.",
|
|
153
|
+
"default": "html",
|
|
154
|
+
"hasDynamicHelp": false,
|
|
155
|
+
"multiple": false,
|
|
156
|
+
"options": [
|
|
157
|
+
"html"
|
|
158
|
+
],
|
|
159
|
+
"type": "option"
|
|
160
|
+
}
|
|
161
|
+
},
|
|
162
|
+
"hasDynamicHelp": false,
|
|
163
|
+
"hiddenAliases": [],
|
|
164
|
+
"id": "simply:document:generate",
|
|
165
|
+
"pluginAlias": "@simplysf/simply-document",
|
|
166
|
+
"pluginName": "@simplysf/simply-document",
|
|
167
|
+
"pluginType": "core",
|
|
168
|
+
"strict": true,
|
|
169
|
+
"summary": "Generate a technical design document for a Salesforce project.",
|
|
170
|
+
"enableJsonFlag": true,
|
|
171
|
+
"isESM": true,
|
|
172
|
+
"relativePath": [
|
|
173
|
+
"lib",
|
|
174
|
+
"commands",
|
|
175
|
+
"simply",
|
|
176
|
+
"document",
|
|
177
|
+
"generate.js"
|
|
178
|
+
],
|
|
179
|
+
"aliasPermutations": [],
|
|
180
|
+
"permutations": [
|
|
181
|
+
"simply:document:generate",
|
|
182
|
+
"document:simply:generate",
|
|
183
|
+
"document:generate:simply",
|
|
184
|
+
"simply:generate:document",
|
|
185
|
+
"generate:simply:document",
|
|
186
|
+
"generate:document:simply"
|
|
187
|
+
]
|
|
188
|
+
}
|
|
189
|
+
},
|
|
190
|
+
"version": "0.4.13"
|
|
191
|
+
}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@simplysf/simply-document",
|
|
3
3
|
"description": "Utilities for generating project documentation",
|
|
4
|
-
"version": "0.4.
|
|
4
|
+
"version": "0.4.13",
|
|
5
5
|
"author": "@ClayChipps",
|
|
6
6
|
"homepage": "https://github.com/SimplySF/simply-plugins",
|
|
7
7
|
"bugs": "https://github.com/SimplySF/simply-plugins/issues",
|
|
@@ -78,12 +78,15 @@
|
|
|
78
78
|
"fix-license": "eslint src test --fix --rule \"header/header: [2]\"",
|
|
79
79
|
"format": "wireit",
|
|
80
80
|
"lint": "wireit",
|
|
81
|
+
"postpack": "node -e \"require('node:fs').rmSync('oclif.manifest.json', { force: true })\"",
|
|
82
|
+
"prepack": "oclif manifest .",
|
|
81
83
|
"readme": "oclif readme --no-aliases",
|
|
82
84
|
"test": "wireit",
|
|
83
85
|
"test:coverage": "vitest run --coverage --project simply-document",
|
|
84
86
|
"test:nuts": "vitest run --config ../../vitest.nuts.config.ts --project simply-document",
|
|
85
87
|
"test:only": "wireit",
|
|
86
|
-
"test:watch": "vitest watch --project simply-document"
|
|
88
|
+
"test:watch": "vitest watch --project simply-document",
|
|
89
|
+
"version": "pnpm run readme"
|
|
87
90
|
},
|
|
88
91
|
"wireit": {
|
|
89
92
|
"build": {
|
|
@@ -196,5 +199,5 @@
|
|
|
196
199
|
"output": []
|
|
197
200
|
}
|
|
198
201
|
},
|
|
199
|
-
"gitHead": "
|
|
202
|
+
"gitHead": "f635096b9a61ef7eb05d49c839a8e2e49c14fdc3"
|
|
200
203
|
}
|