Skip to content

Commit ed7472b

Browse files
refactor: devScripts update (#496)
* chore: updates from devScripts * chore(lint): flag naming conventions * chore: deps bump --------- Co-authored-by: mshanemc <[email protected]>
1 parent e6e4aa1 commit ed7472b

File tree

12 files changed

+227
-251
lines changed

12 files changed

+227
-251
lines changed

messages/main.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,31 +6,31 @@ generate the command reference guide located
66

77
generate the command reference guide located
88

9-
# pluginFlagSummary
9+
# flags.plugins.summary
1010

1111
comma separated list of plugin names to be part of the generation. Defaults to the oclif plugin in the current working directory
1212

13-
# allFlagSummary
13+
# flags.all.summary
1414

1515
include all relevant plugins in the generation
1616

17-
# hiddenFlagSummary
17+
# flags.hidden.summary
1818

1919
show hidden commands
2020

21-
# outputdirFlagSummary
21+
# flags.output-dir.summary
2222

2323
output directory to put generated files
2424

25-
# erroronwarningFlagSummary
25+
# flags.error-on-warnings.summary
2626

2727
fail the command if there are any warnings
2828

29-
# ditamapSuffixFlagSummary
29+
# flags.ditamap-suffix.summary
3030

3131
unique suffix to append to generated ditamap
3232

33-
# configPathFlagSummary
33+
# flags.config-path.summary
3434

3535
A path to the directory containing a plugin or cli
3636

package.json

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"bugs": "https://github.com/salesforcecli/plugin-command-reference/issues",
77
"dependencies": {
88
"@oclif/core": "^2.15.0",
9-
"@salesforce/core": "^5.3.10",
9+
"@salesforce/core": "^5.3.16",
1010
"@salesforce/kit": "^3.0.15",
1111
"@salesforce/sf-plugins-core": "^3.1.28",
1212
"@salesforce/ts-types": "^2.0.9",
@@ -17,22 +17,22 @@
1717
"devDependencies": {
1818
"@oclif/plugin-help": "^5.2.20",
1919
"@salesforce/dev-config": "^4.1.0",
20-
"@salesforce/dev-scripts": "^5.11.0",
20+
"@salesforce/dev-scripts": "^5.12.2",
2121
"@salesforce/plugin-auth": "^2.8.25",
2222
"@salesforce/prettier-config": "^0.0.3",
2323
"@types/debug": "^4.1.10",
2424
"@types/ejs": "^3.1.4",
2525
"@typescript-eslint/eslint-plugin": "^5.62.0",
2626
"@typescript-eslint/parser": "^5.61.0",
2727
"chai": "^4.3.10",
28-
"eslint": "^8.51.0",
28+
"eslint": "^8.52.0",
2929
"eslint-config-prettier": "^8.10.0",
3030
"eslint-config-salesforce": "^2.0.2",
3131
"eslint-config-salesforce-license": "^0.2.0",
32-
"eslint-config-salesforce-typescript": "^1.1.2",
32+
"eslint-config-salesforce-typescript": "^2.0.0",
3333
"eslint-plugin-header": "^3.1.1",
3434
"eslint-plugin-import": "^2.29.0",
35-
"eslint-plugin-jsdoc": "^44.2.7",
35+
"eslint-plugin-jsdoc": "^46.8.2",
3636
"eslint-plugin-sf-plugin": "^1.16.9",
3737
"husky": "^8.0.3",
3838
"mocha": "^10.2.0",
@@ -43,7 +43,7 @@
4343
"shx": "^0.3.3",
4444
"sinon": "10.0.0",
4545
"ts-node": "^10.0.0",
46-
"typescript": "^4.9.5",
46+
"typescript": "^5.2.2",
4747
"wireit": "^0.14.1"
4848
},
4949
"engines": {

src/commands/commandreference/generate.ts

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
66
*/
77

8-
import * as os from 'os';
9-
import { resolve } from 'path';
8+
import * as os from 'node:os';
9+
import { resolve } from 'node:path';
1010
import { Flags, SfCommand } from '@salesforce/sf-plugins-core';
1111
// eslint-disable-next-line sf-plugin/no-oclif-flags-command-import
1212
import { Command, Config, Interfaces } from '@oclif/core';
@@ -34,35 +34,35 @@ export default class CommandReferenceGenerate extends SfCommand<CommandReference
3434
public static readonly flags = {
3535
'output-dir': Flags.string({
3636
char: 'd',
37-
summary: messages.getMessage('outputdirFlagSummary'),
37+
summary: messages.getMessage('flags.output-dir.summary'),
3838
aliases: ['outputdir'],
3939
deprecateAliases: true,
4040
default: './tmp/root',
4141
}),
4242
plugins: Flags.string({
4343
char: 'p',
44-
summary: messages.getMessage('pluginFlagSummary'),
44+
summary: messages.getMessage('flags.plugins.summary'),
4545
multiple: true,
4646
exclusive: ['all'],
4747
}),
4848
all: Flags.boolean({
4949
char: 'a',
50-
summary: messages.getMessage('allFlagSummary'),
50+
summary: messages.getMessage('flags.all.summary'),
5151
exclusive: ['plugins'],
5252
}),
5353
'ditamap-suffix': Flags.string({
5454
char: 's',
55-
summary: messages.getMessage('ditamapSuffixFlagSummary'),
55+
summary: messages.getMessage('flags.ditamap-suffix.summary'),
5656
default: Ditamap.SUFFIX,
5757
}),
58-
hidden: Flags.boolean({ summary: messages.getMessage('hiddenFlagSummary') }),
58+
hidden: Flags.boolean({ summary: messages.getMessage('flags.hidden.summary') }),
5959
'error-on-warnings': Flags.boolean({
60-
summary: messages.getMessage('erroronwarningFlagSummary'),
60+
summary: messages.getMessage('flags.error-on-warnings.summary'),
6161
aliases: ['erroronwarnings'],
6262
deprecateAliases: true,
6363
}),
6464
'config-path': Flags.directory({
65-
summary: messages.getMessage('configPathFlagSummary'),
65+
summary: messages.getMessage('flags.config-path.summary'),
6666
char: 'c',
6767
}),
6868
};

src/ditamap/command.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
66
*/
77

8-
import { join } from 'path';
8+
import { join } from 'node:path';
99
import { asString, Dictionary, ensureObject, ensureString } from '@salesforce/ts-types';
1010
import { CommandClass, CommandData, CommandParameterData, punctuate, replaceConfigVariables } from '../utils';
1111
import { Ditamap } from './ditamap';

src/ditamap/ditamap.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
66
*/
77

8-
import { dirname, join } from 'path';
9-
import * as fs from 'fs/promises';
8+
import { dirname, join } from 'node:path';
9+
import * as fs from 'node:fs/promises';
1010
import * as debugCreator from 'debug';
1111
import * as hb from 'handlebars';
1212
import { HelperOptions } from 'handlebars';

src/ditamap/topic-commands.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
66
*/
77

8-
import { join } from 'path';
8+
import { join } from 'node:path';
99
import { SfTopic } from '../utils';
1010
import { Ditamap } from './ditamap';
1111

src/ditamap/topic-ditamap.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
66
*/
77

8-
import { join } from 'path';
8+
import { join } from 'node:path';
99
import { Ditamap } from './ditamap';
1010

1111
export class TopicDitamap extends Ditamap {

src/docs.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
66
*/
77

8-
import * as fs from 'fs/promises';
8+
import * as fs from 'node:fs/promises';
99
import { AnyJson, ensureString } from '@salesforce/ts-types';
1010
import * as chalk from 'chalk';
1111
import { BaseDitamap } from './ditamap/base-ditamap';

src/utils.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
66
*/
77

8-
import { EventEmitter } from 'events';
9-
import { EOL } from 'os';
8+
import { EventEmitter } from 'node:events';
9+
import { EOL } from 'node:os';
1010
import { Command, Interfaces } from '@oclif/core';
1111
import { AnyJson } from '@salesforce/ts-types';
1212

test/unit/endtoend.test.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
66
*/
77

8-
import { access, rm } from 'fs/promises';
9-
import { readFileSync } from 'fs';
10-
import { join } from 'path';
8+
import { access, rm } from 'node:fs/promises';
9+
import { readFileSync } from 'node:fs';
10+
import { join } from 'node:path';
1111
import { expect } from 'chai';
1212

1313
/**

0 commit comments

Comments
 (0)