Skip to content

Commit c7057b1

Browse files
committed
prettier updates
1 parent 5773981 commit c7057b1

5 files changed

Lines changed: 42 additions & 44 deletions

File tree

packages/b2c-tooling-sdk/.c8rc.json

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,7 @@
11
{
22
"all": true,
33
"src": ["src"],
4-
"exclude": [
5-
"src/clients/*.generated.ts",
6-
"test/**",
7-
"**/*.d.ts",
8-
"src/**/*types.ts"
9-
],
4+
"exclude": ["src/clients/*.generated.ts", "test/**", "**/*.d.ts", "src/**/*types.ts"],
105
"reporter": ["text", "text-summary", "html", "lcov"],
116
"report-dir": "coverage",
127
"check-coverage": true,
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,5 @@
11
*.generated.ts
2+
dist
3+
coverage
4+
data
5+
specs

packages/b2c-tooling-sdk/README.md

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ npm install @salesforce/b2c-tooling-sdk
2020
Use `resolveConfig()` to load configuration from project files (dw.json) and create a B2C instance:
2121

2222
```typescript
23-
import { resolveConfig } from '@salesforce/b2c-tooling-sdk/config';
23+
import {resolveConfig} from '@salesforce/b2c-tooling-sdk/config';
2424

2525
// Load configuration, override secrets from environment
2626
const config = resolveConfig({
@@ -36,8 +36,8 @@ await instance.webdav.mkcol('Cartridges/v1');
3636
await instance.webdav.put('Cartridges/v1/app.zip', zipBuffer);
3737

3838
// Use typed OCAPI client (openapi-fetch)
39-
const { data, error } = await instance.ocapi.GET('/sites', {
40-
params: { query: { select: '(**)' } },
39+
const {data, error} = await instance.ocapi.GET('/sites', {
40+
params: {query: {select: '(**)'}},
4141
});
4242
```
4343

@@ -46,16 +46,16 @@ const { data, error } = await instance.ocapi.GET('/sites', {
4646
For advanced use cases, you can construct a B2CInstance directly:
4747

4848
```typescript
49-
import { B2CInstance } from '@salesforce/b2c-tooling-sdk';
49+
import {B2CInstance} from '@salesforce/b2c-tooling-sdk';
5050

5151
const instance = new B2CInstance(
52-
{ hostname: 'your-sandbox.demandware.net', codeVersion: 'v1' },
52+
{hostname: 'your-sandbox.demandware.net', codeVersion: 'v1'},
5353
{
5454
oauth: {
5555
clientId: 'your-client-id',
56-
clientSecret: 'your-client-secret'
57-
}
58-
}
56+
clientSecret: 'your-client-secret',
57+
},
58+
},
5959
);
6060
```
6161

@@ -89,24 +89,24 @@ The OCAPI client uses [openapi-fetch](https://openapi-ts.dev/openapi-fetch/) wit
8989

9090
```typescript
9191
// List sites
92-
const { data, error } = await instance.ocapi.GET('/sites', {
93-
params: { query: { select: '(**)' } },
92+
const {data, error} = await instance.ocapi.GET('/sites', {
93+
params: {query: {select: '(**)'}},
9494
});
9595

9696
// Activate a code version
97-
const { data, error } = await instance.ocapi.PATCH('/code_versions/{code_version_id}', {
98-
params: { path: { code_version_id: 'v1' } },
99-
body: { active: true },
97+
const {data, error} = await instance.ocapi.PATCH('/code_versions/{code_version_id}', {
98+
params: {path: {code_version_id: 'v1'}},
99+
body: {active: true},
100100
});
101101
```
102102

103103
### Code Deployment
104104

105105
```typescript
106-
import { findAndDeployCartridges, activateCodeVersion } from '@salesforce/b2c-tooling-sdk/operations/code';
106+
import {findAndDeployCartridges, activateCodeVersion} from '@salesforce/b2c-tooling-sdk/operations/code';
107107

108108
// Deploy cartridges
109-
await findAndDeployCartridges(instance, './cartridges', { reload: true });
109+
await findAndDeployCartridges(instance, './cartridges', {reload: true});
110110

111111
// Activate code version
112112
await activateCodeVersion(instance, 'v1');
@@ -115,7 +115,7 @@ await activateCodeVersion(instance, 'v1');
115115
### Job Execution
116116

117117
```typescript
118-
import { executeJob, waitForJob, siteArchiveImport } from '@salesforce/b2c-tooling-sdk/operations/jobs';
118+
import {executeJob, waitForJob, siteArchiveImport} from '@salesforce/b2c-tooling-sdk/operations/jobs';
119119

120120
// Run a job and wait for completion
121121
const execution = await executeJob(instance, 'my-job-id');
@@ -129,32 +129,32 @@ await siteArchiveImport(instance, './site-data.zip');
129129

130130
The SDK provides subpath exports for tree-shaking and organization:
131131

132-
| Export | Description |
133-
|--------|-------------|
134-
| `@salesforce/b2c-tooling-sdk` | Main entry point with all exports |
135-
| `@salesforce/b2c-tooling-sdk/config` | Configuration resolution (resolveConfig) |
136-
| `@salesforce/b2c-tooling-sdk/auth` | Authentication strategies (OAuth, Basic, API Key) |
137-
| `@salesforce/b2c-tooling-sdk/instance` | B2CInstance class |
138-
| `@salesforce/b2c-tooling-sdk/clients` | Low-level API clients (WebDAV, OCAPI, SLAS, ODS, MRT) |
139-
| `@salesforce/b2c-tooling-sdk/operations/code` | Code deployment operations |
140-
| `@salesforce/b2c-tooling-sdk/operations/jobs` | Job execution and site import/export |
141-
| `@salesforce/b2c-tooling-sdk/operations/sites` | Site management |
142-
| `@salesforce/b2c-tooling-sdk/discovery` | Workspace type detection (PWA Kit, SFRA, etc.) |
143-
| `@salesforce/b2c-tooling-sdk/cli` | CLI utilities (BaseCommand, table rendering) |
144-
| `@salesforce/b2c-tooling-sdk/logging` | Structured logging utilities |
132+
| Export | Description |
133+
| ---------------------------------------------- | ----------------------------------------------------- |
134+
| `@salesforce/b2c-tooling-sdk` | Main entry point with all exports |
135+
| `@salesforce/b2c-tooling-sdk/config` | Configuration resolution (resolveConfig) |
136+
| `@salesforce/b2c-tooling-sdk/auth` | Authentication strategies (OAuth, Basic, API Key) |
137+
| `@salesforce/b2c-tooling-sdk/instance` | B2CInstance class |
138+
| `@salesforce/b2c-tooling-sdk/clients` | Low-level API clients (WebDAV, OCAPI, SLAS, ODS, MRT) |
139+
| `@salesforce/b2c-tooling-sdk/operations/code` | Code deployment operations |
140+
| `@salesforce/b2c-tooling-sdk/operations/jobs` | Job execution and site import/export |
141+
| `@salesforce/b2c-tooling-sdk/operations/sites` | Site management |
142+
| `@salesforce/b2c-tooling-sdk/discovery` | Workspace type detection (PWA Kit, SFRA, etc.) |
143+
| `@salesforce/b2c-tooling-sdk/cli` | CLI utilities (BaseCommand, table rendering) |
144+
| `@salesforce/b2c-tooling-sdk/logging` | Structured logging utilities |
145145

146146
## Logging
147147

148148
Configure logging for debugging HTTP requests:
149149

150150
```typescript
151-
import { configureLogger } from '@salesforce/b2c-tooling-sdk/logging';
151+
import {configureLogger} from '@salesforce/b2c-tooling-sdk/logging';
152152

153153
// Enable debug logging (shows HTTP request summaries)
154-
configureLogger({ level: 'debug' });
154+
configureLogger({level: 'debug'});
155155

156156
// Enable trace logging (shows full request/response with headers and bodies)
157-
configureLogger({ level: 'trace' });
157+
configureLogger({level: 'trace'});
158158
```
159159

160160
## Documentation

packages/b2c-tooling-sdk/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -195,8 +195,8 @@
195195
"build:cjs": "tsc -p tsconfig.cjs.json && echo '{\"type\":\"commonjs\"}' > dist/cjs/package.json",
196196
"clean": "shx rm -rf dist",
197197
"lint": "eslint",
198-
"format": "prettier --write src scripts",
199-
"format:check": "prettier --check src scripts",
198+
"format": "prettier --write .",
199+
"format:check": "prettier --check .",
200200
"pretest": "tsc --noEmit -p test",
201201
"test": "c8 mocha --forbid-only \"test/**/*.test.ts\"",
202202
"test:ci": "c8 mocha --forbid-only --reporter json --reporter-option output=test-results.json \"test/**/*.test.ts\"",

packages/b2c-tooling-sdk/test/cli/mrt-command.integration.test.ts

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -76,10 +76,9 @@ describe('MrtCommand integration', () => {
7676

7777
it('reports hasMrtCredentials false when no api-key provided', async () => {
7878
// Use --credentials-file to isolate from developer's ~/.mobify
79-
const {error, result} = await runCommand<TestMrtResult>(
80-
['test-mrt', '--credentials-file', '/dev/null', '--json'],
81-
{root: fixtureRoot},
82-
);
79+
const {error, result} = await runCommand<TestMrtResult>(['test-mrt', '--credentials-file', '/dev/null', '--json'], {
80+
root: fixtureRoot,
81+
});
8382

8483
expect(error).to.be.undefined;
8584
expect(result?.hasApiKey).to.be.false;

0 commit comments

Comments
 (0)