@salesforce/plugin-command-reference 1.3.18 → 1.3.19

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 (8) hide show
  1. package/CHANGELOG.md +6 -1
  2. package/LICENSE.txt +1 -1
  3. package/README.md +1 -1
  4. package/lib/ditamap/ditamap.js +4 -0
  5. package/lib/ditamap/ditamap.js.map +1 -1
  6. package/oclif.manifest.json +1 -1
  7. package/package.json +21 -21
  8. package/templates/command.hbs +2 -2
package/CHANGELOG.md CHANGED
@@ -2,7 +2,12 @@
2
2
 
3
3
  All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
4
4
 
5
- ### [1.3.18](https://github.com/forcedotcom/plugin-command-reference/compare/v1.3.17...v1.3.18) (2021-12-06)
5
+ ### [1.3.19](https://github.com/forcedotcom/plugin-command-reference/compare/v1.3.17...v1.3.19) (2022-05-17)
6
+
7
+ ### Bug Fixes
8
+
9
+ - add dependabot and versioning strategy ([6a13574](https://github.com/forcedotcom/plugin-command-reference/commit/6a13574724f9e317a0624bc0bb92e9f1dc7a689c))
10
+ - remove '$' in codeblocks ([79e2b7b](https://github.com/forcedotcom/plugin-command-reference/commit/79e2b7b8bb5eacfad43319e1ca7ed42d2705f419))
6
11
 
7
12
  ### [1.3.17](https://github.com/forcedotcom/plugin-command-reference/compare/v1.3.16...v1.3.17) (2021-11-19)
8
13
 
package/LICENSE.txt CHANGED
@@ -1,4 +1,4 @@
1
- Copyright (c) 2021, Salesforce.com, Inc.
1
+ Copyright (c) 2022, Salesforce.com, Inc.
2
2
  All rights reserved.
3
3
 
4
4
  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
package/README.md CHANGED
@@ -97,6 +97,6 @@ OPTIONS
97
97
  this command invocation
98
98
  ```
99
99
 
100
- _See code: [src/commands/commandreference/generate.ts](https://github.com/forcedotcom/plugin-command-reference/blob/v1.3.17/src/commands/commandreference/generate.ts)_
100
+ _See code: [src/commands/commandreference/generate.ts](https://github.com/forcedotcom/plugin-command-reference/blob/v1.3.19/src/commands/commandreference/generate.ts)_
101
101
 
102
102
  <!-- commandsstop -->
package/lib/ditamap/ditamap.js CHANGED
@@ -25,6 +25,10 @@ class Ditamap {
25
25
  handlebars_1.registerHelper('isCodeBlock', function (val, options) {
26
26
  return val.indexOf('$ sfdx') >= 0 || val.indexOf('>>') >= 0 ? options.fn(this) : options.inverse(this);
27
27
  });
28
+ /*
29
+ * Remove OS prompt in codeblocks, as per CCX style guidelines in our published docs
30
+ */
31
+ handlebars_1.registerHelper('removePrompt', (codeblock) => codeblock.substring(codeblock.indexOf('$') + 1));
28
32
  handlebars_1.registerHelper('nextVersion', (value) => parseInt(value, 2) + 1);
29
33
  this.source = path_1.join(Ditamap.templatesDir, this.getTemplateFileName());
30
34
  this.destination = path_1.join(Ditamap.outputDir, filename);
package/lib/ditamap/ditamap.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"ditamap.js","sourceRoot":"","sources":["../../src/ditamap/ditamap.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,+BAAqC;AACrC,2CAAsC;AAEtC,sCAAsC;AACtC,2CAAqD;AAErD,MAAM,KAAK,GAAG,YAAY,CAAC,kBAAkB,CAAC,CAAC;AAE/C,MAAsB,OAAO;IAkB3B,YAA2B,QAAgB,EAAY,IAAa;QAAzC,aAAQ,GAAR,QAAQ,CAAQ;QAAY,SAAI,GAAJ,IAAI,CAAS;QAClE,2BAAc,CAAC,aAAa,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC;QAC1D,2BAAc,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAEpD;;WAEG;QACH,mCAAmC;QACnC,2BAAc,CAAC,aAAa,EAAE,UAAqB,GAAG,EAAE,OAAO;YAC7D,OAAO,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACzG,CAAC,CAAC,CAAC;QAEH,2BAAc,CAAC,aAAa,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QACjE,IAAI,CAAC,MAAM,GAAG,WAAI,CAAC,OAAO,CAAC,YAAY,EAAE,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC;QACrE,IAAI,CAAC,WAAW,GAAG,WAAI,CAAC,OAAO,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IACvD,CAAC;IAEM,WAAW;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAEM,iBAAiB;QACtB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAEM,KAAK,CAAC,KAAK;QAChB,MAAM,SAAE,CAAC,MAAM,CAAC,cAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;QAC3C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAE/C,MAAM,SAAE,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IAC/C,CAAC;IAES,gBAAgB,CAAC,YAAqB;QAC9C,OAAO,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC9E,CAAC;IAED;;;;;;OAMG;IACK,KAAK,CAAC,kBAAkB;QAC9B,KAAK,CAAC,cAAc,IAAI,CAAC,WAAW,SAAS,IAAI,CAAC,mBAAmB,EAAE,EAAE,CAAC,CAAC;QAC3E,MAAM,GAAG,GAAG,MAAM,SAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACnD,MAAM,QAAQ,GAAG,oBAAO,CAAC,GAAG,CAAC,CAAC;QAC9B,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;;AAlEH,0BAqEC;AApEe,oBAAY,GAAG,WAAI,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC"}
1
+ {"version":3,"file":"ditamap.js","sourceRoot":"","sources":["../../src/ditamap/ditamap.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,+BAAqC;AACrC,2CAAsC;AAEtC,sCAAsC;AACtC,2CAAqD;AAErD,MAAM,KAAK,GAAG,YAAY,CAAC,kBAAkB,CAAC,CAAC;AAE/C,MAAsB,OAAO;IAkB3B,YAA2B,QAAgB,EAAY,IAAa;QAAzC,aAAQ,GAAR,QAAQ,CAAQ;QAAY,SAAI,GAAJ,IAAI,CAAS;QAClE,2BAAc,CAAC,aAAa,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC;QAC1D,2BAAc,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAEpD;;WAEG;QACH,mCAAmC;QACnC,2BAAc,CAAC,aAAa,EAAE,UAAqB,GAAG,EAAE,OAAO;YAC7D,OAAO,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACzG,CAAC,CAAC,CAAC;QAEH;;WAEG;QACH,2BAAc,CAAC,cAAc,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,SAAS,CAAE,SAAS,CAAC,OAAO,CAAC,GAAG,CAAY,GAAG,CAAC,CAAC,CAAC,CAAC;QAC3G,2BAAc,CAAC,aAAa,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QACjE,IAAI,CAAC,MAAM,GAAG,WAAI,CAAC,OAAO,CAAC,YAAY,EAAE,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC;QACrE,IAAI,CAAC,WAAW,GAAG,WAAI,CAAC,OAAO,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IACvD,CAAC;IAEM,WAAW;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAEM,iBAAiB;QACtB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAEM,KAAK,CAAC,KAAK;QAChB,MAAM,SAAE,CAAC,MAAM,CAAC,cAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;QAC3C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAE/C,MAAM,SAAE,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IAC/C,CAAC;IAES,gBAAgB,CAAC,YAAqB;QAC9C,OAAO,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC9E,CAAC;IAED;;;;;;OAMG;IACK,KAAK,CAAC,kBAAkB;QAC9B,KAAK,CAAC,cAAc,IAAI,CAAC,WAAW,SAAS,IAAI,CAAC,mBAAmB,EAAE,EAAE,CAAC,CAAC;QAC3E,MAAM,GAAG,GAAG,MAAM,SAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACnD,MAAM,QAAQ,GAAG,oBAAO,CAAC,GAAG,CAAC,CAAC;QAC9B,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;;AAtEH,0BAyEC;AAxEe,oBAAY,GAAG,WAAI,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC"}
package/oclif.manifest.json CHANGED
@@ -1 +1 @@
1
- {"version":"1.3.18","commands":{"commandreference:generate":{"id":"commandreference:generate","description":"generate the command reference guide located","usage":"<%= command.id %> [-d <string>] [-p <array>] [--hidden] [--erroronwarnings] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-command-reference","pluginType":"core","aliases":[],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"outputdir":{"name":"outputdir","type":"option","char":"d","description":"output directory to put generated files","default":"./tmp/root"},"plugins":{"name":"plugins","type":"option","char":"p","description":"comma separated list of plugin names to be part of the generation. Defaults to the oclif plugin in the current working directory"},"hidden":{"name":"hidden","type":"boolean","description":"show hidden commands","allowNo":false},"erroronwarnings":{"name":"erroronwarnings","type":"boolean","description":"fail the command if there are any warnings","allowNo":false}},"args":[{"name":"file"}]}}}
1
+ {"version":"1.3.19","commands":{"commandreference:generate":{"id":"commandreference:generate","description":"generate the command reference guide located","usage":"<%= command.id %> [-d <string>] [-p <array>] [--hidden] [--erroronwarnings] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-command-reference","pluginType":"core","aliases":[],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"outputdir":{"name":"outputdir","type":"option","char":"d","description":"output directory to put generated files","default":"./tmp/root"},"plugins":{"name":"plugins","type":"option","char":"p","description":"comma separated list of plugin names to be part of the generation. Defaults to the oclif plugin in the current working directory"},"hidden":{"name":"hidden","type":"boolean","description":"show hidden commands","allowNo":false},"erroronwarnings":{"name":"erroronwarnings","type":"boolean","description":"fail the command if there are any warnings","allowNo":false}},"args":[{"name":"file"}]}}}
package/package.json CHANGED
@@ -1,52 +1,52 @@
1
1
  {
2
2
  "name": "@salesforce/plugin-command-reference",
3
3
  "description": "Generate the Salesforce CLI command reference guide",
4
- "version": "1.3.18",
5
- "author": "Thomas @amphro",
4
+ "version": "1.3.19",
5
+ "author": "Salesforce",
6
6
  "bugs": "https://github.com/forcedotcom/plugin-command-reference/issues",
7
7
  "dependencies": {
8
- "@oclif/command": "^1.8.3",
9
- "@oclif/config": "^1.17.1",
8
+ "@oclif/command": "^1.8.9",
9
+ "@oclif/config": "^1.18.3",
10
10
  "@oclif/errors": "^1.3.5",
11
- "@salesforce/command": "^4.1.5",
12
- "@salesforce/core": "^2.29.0",
11
+ "@salesforce/command": "^4.2.2",
12
+ "@salesforce/core": "^2.36.4",
13
13
  "chalk": "^3.0.0",
14
14
  "handlebars": "4.7.7",
15
- "shelljs": "^0.8.4",
15
+ "shelljs": "^0.8.5",
16
16
  "tslib": "^1"
17
17
  },
18
18
  "devDependencies": {
19
- "@oclif/dev-cli": "^1.26.0",
20
- "@oclif/plugin-help": "^3.2.5",
21
- "@oclif/test": "^1.2.8",
22
- "@salesforce/dev-config": "^2.1.2",
23
- "@salesforce/dev-scripts": "^1.0.2",
19
+ "@oclif/dev-cli": "^1.26.10",
20
+ "@oclif/plugin-help": "^3.3.1",
21
+ "@oclif/test": "^1.2.9",
22
+ "@salesforce/dev-config": "^2.1.3",
23
+ "@salesforce/dev-scripts": "^1.0.4",
24
24
  "@salesforce/prettier-config": "^0.0.2",
25
25
  "@semantic-release/changelog": "^5.0.0",
26
- "@semantic-release/git": "^9.0.0",
27
- "@types/jsforce": "^1.9.35",
28
- "@types/shelljs": "^0.8.9",
26
+ "@semantic-release/git": "^9.0.1",
27
+ "@types/jsforce": "^1.9.42",
28
+ "@types/shelljs": "^0.8.11",
29
29
  "@typescript-eslint/eslint-plugin": "^4.2.0",
30
30
  "@typescript-eslint/parser": "^4.2.0",
31
- "chai": "^4.2.0",
31
+ "chai": "^4.3.6",
32
32
  "eslint": "^7.27.0",
33
33
  "eslint-config-prettier": "^6.11.0",
34
34
  "eslint-config-salesforce": "^0.1.6",
35
35
  "eslint-config-salesforce-license": "^0.1.6",
36
36
  "eslint-config-salesforce-typescript": "^0.2.7",
37
37
  "eslint-plugin-header": "^3.0.0",
38
- "eslint-plugin-import": "2.24.2",
38
+ "eslint-plugin-import": "2.26.0",
39
39
  "eslint-plugin-jsdoc": "^35.1.2",
40
40
  "eslint-plugin-prettier": "^3.1.3",
41
41
  "husky": "^7.0.4",
42
42
  "mocha": "^8.4.0",
43
43
  "nyc": "^15.1.0",
44
- "prettier": "^2.0.5",
45
- "pretty-quick": "^3.1.0",
44
+ "prettier": "^2.6.2",
45
+ "pretty-quick": "^3.1.3",
46
46
  "salesforcedx": "48.4.1",
47
- "semantic-release": "^17.0.4",
47
+ "semantic-release": "^17.4.7",
48
48
  "sinon": "10.0.0",
49
- "ts-node": "^10.4.0",
49
+ "ts-node": "^10.7.0",
50
50
  "typescript": "4.3"
51
51
  },
52
52
  "engines": {
package/templates/command.hbs CHANGED
@@ -65,7 +65,7 @@ IF YOU WANT TO CHANGE THIS CONTENT, CONTACT juliet.shackell@salesforce.com FOR D
65
65
  <section>
66
66
  <title><ph>Help for <codeph otherprops="nolang">{{id}}</codeph></ph></title>
67
67
  {{#each help}}
68
- {{#isCodeBlock this}}<codeblock otherprops="nolang">{{this}}</codeblock>{{else}}<p>{{this}}</p>{{/isCodeBlock}}
68
+ {{#isCodeBlock this}}<codeblock otherprops="nolang">{{removePrompt this}}</codeblock>{{else}}<p>{{this}}</p>{{/isCodeBlock}}
69
69
  {{/each}}
70
70
  </section>
71
71
  {{/if}}
@@ -73,7 +73,7 @@ IF YOU WANT TO CHANGE THIS CONTENT, CONTACT juliet.shackell@salesforce.com FOR D
73
73
  <section>
74
74
  <title><ph>Examples for <codeph otherprops="nolang">{{id}}</codeph></ph></title>
75
75
  {{#each examples}}
76
- {{#isCodeBlock this}}<codeblock otherprops="nolang">{{this}}</codeblock>{{else}}<p>{{this}}</p>{{/isCodeBlock}}
76
+ {{#isCodeBlock this}}<codeblock otherprops="nolang">{{removePrompt this}}</codeblock>{{else}}<p>{{this}}</p>{{/isCodeBlock}}
77
77
  {{/each}}
78
78
  </section>
79
79
  {{/if}}