@salesforce/plugin-command-reference 3.1.106 → 3.1.108

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.
Files changed (46) hide show
  1. package/README.md +7 -4
  2. package/lib/commands/commandreference/generate.d.ts +1 -0
  3. package/lib/commands/commandreference/generate.js +10 -3
  4. package/lib/commands/commandreference/generate.js.map +1 -1
  5. package/lib/ditamap/command-helpers.d.ts +25 -0
  6. package/lib/ditamap/command-helpers.js +59 -0
  7. package/lib/ditamap/command-helpers.js.map +1 -0
  8. package/lib/ditamap/command.d.ts +1 -14
  9. package/lib/ditamap/command.js +2 -44
  10. package/lib/ditamap/command.js.map +1 -1
  11. package/lib/docs.d.ts +3 -1
  12. package/lib/docs.js +29 -27
  13. package/lib/docs.js.map +1 -1
  14. package/lib/generator-factory.d.ts +46 -0
  15. package/lib/generator-factory.js +89 -0
  16. package/lib/generator-factory.js.map +1 -0
  17. package/lib/markdown/cli-reference.d.ts +10 -0
  18. package/lib/markdown/cli-reference.js +50 -0
  19. package/lib/markdown/cli-reference.js.map +1 -0
  20. package/lib/markdown/command.d.ts +17 -0
  21. package/lib/markdown/command.js +257 -0
  22. package/lib/markdown/command.js.map +1 -0
  23. package/lib/markdown/index.d.ts +7 -0
  24. package/lib/markdown/index.js +23 -0
  25. package/lib/markdown/index.js.map +1 -0
  26. package/lib/markdown/markdown-base.d.ts +10 -0
  27. package/lib/markdown/markdown-base.js +39 -0
  28. package/lib/markdown/markdown-base.js.map +1 -0
  29. package/lib/markdown/root-index.d.ts +6 -0
  30. package/lib/markdown/root-index.js +37 -0
  31. package/lib/markdown/root-index.js.map +1 -0
  32. package/lib/markdown/toc.d.ts +8 -0
  33. package/lib/markdown/toc.js +68 -0
  34. package/lib/markdown/toc.js.map +1 -0
  35. package/lib/markdown/topic-commands.d.ts +8 -0
  36. package/lib/markdown/topic-commands.js +40 -0
  37. package/lib/markdown/topic-commands.js.map +1 -0
  38. package/lib/markdown/topic-index.d.ts +9 -0
  39. package/lib/markdown/topic-index.js +80 -0
  40. package/lib/markdown/topic-index.js.map +1 -0
  41. package/lib/utils.d.ts +1 -1
  42. package/messages/main.md +5 -1
  43. package/npm-shrinkwrap.json +1418 -234
  44. package/oclif.lock +365 -104
  45. package/oclif.manifest.json +14 -2
  46. package/package.json +18 -5
package/oclif.manifest.json CHANGED
@@ -63,7 +63,7 @@
63
63
  "ditamap-suffix": {
64
64
  "char": "s",
65
65
  "name": "ditamap-suffix",
66
- "summary": "unique suffix to append to generated ditamap",
66
+ "summary": "unique suffix to append to generated DITA files",
67
67
  "default": "unified",
68
68
  "hasDynamicHelp": false,
69
69
  "multiple": false,
@@ -92,6 +92,18 @@
92
92
  "hasDynamicHelp": false,
93
93
  "multiple": false,
94
94
  "type": "option"
95
+ },
96
+ "output-format": {
97
+ "name": "output-format",
98
+ "summary": "output format for generated documentation; 'dita' (default) generates DITA XML files, 'markdown' generates Markdown files",
99
+ "default": "dita",
100
+ "hasDynamicHelp": false,
101
+ "multiple": false,
102
+ "options": [
103
+ "dita",
104
+ "markdown"
105
+ ],
106
+ "type": "option"
95
107
  }
96
108
  },
97
109
  "hasDynamicHelp": false,
@@ -169,5 +181,5 @@
169
181
  ]
170
182
  }
171
183
  },
172
- "version": "3.1.106"
184
+ "version": "3.1.108"
173
185
  }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@salesforce/plugin-command-reference",
3
3
  "description": "Generate the Salesforce CLI command reference guide",
4
- "version": "3.1.106",
4
+ "version": "3.1.108",
5
5
  "author": "Salesforce",
6
6
  "bugs": "https://github.com/salesforcecli/plugin-command-reference/issues",
7
7
  "type": "module",
@@ -9,20 +9,20 @@
9
9
  "@oclif/core": "^4",
10
10
  "@salesforce/core": "^8.31.0",
11
11
  "@salesforce/kit": "^3.2.6",
12
- "@salesforce/sf-plugins-core": "^12.2.17",
12
+ "@salesforce/sf-plugins-core": "^12.2.22",
13
13
  "@salesforce/ts-types": "^2.0.11",
14
14
  "chalk": "^5.6.2",
15
15
  "debug": "^4.4.3",
16
16
  "handlebars": "^4.7.9"
17
17
  },
18
18
  "devDependencies": {
19
- "@oclif/plugin-help": "^6.2.48",
19
+ "@oclif/plugin-help": "^6.2.50",
20
20
  "@salesforce/dev-scripts": "^11.0.4",
21
21
  "@salesforce/plugin-auth": "^3.9.26",
22
- "@salesforce/plugin-user": "^3.10.0",
22
+ "@salesforce/plugin-user": "^3.10.1",
23
23
  "@types/debug": "^4.1.13",
24
24
  "eslint-plugin-sf-plugin": "^1.20.33",
25
- "oclif": "^4.23.7",
25
+ "oclif": "^4.23.8",
26
26
  "ts-node": "^10.9.2",
27
27
  "typescript": "^5.5.4"
28
28
  },
@@ -196,6 +196,19 @@
196
196
  "messages/**/*.md"
197
197
  ],
198
198
  "output": []
199
+ },
200
+ "test:command-reference-markdown": {
201
+ "command": "node --loader ts-node/esm --no-warnings=ExperimentalWarning \"./bin/dev.js\" commandreference generate --plugins auth --plugins user --output-format markdown --output-dir test/tmp-md",
202
+ "files": [
203
+ "src/**/*.ts",
204
+ "messages/**",
205
+ "package.json"
206
+ ],
207
+ "output": [
208
+ "test/tmp-md"
209
+ ],
210
+ "clean": "if-file-deleted",
211
+ "cache": false
199
212
  }
200
213
  }
201
214
  }