Skip to content

Commit c21674b

Browse files
committed
added getLogPath method & code clean up
1 parent ca571f7 commit c21674b

12 files changed

Lines changed: 43 additions & 38 deletions

File tree

packages/contentstack-audit/README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ $ npm install -g @contentstack/cli-audit
1919
$ csdx COMMAND
2020
running command...
2121
$ csdx (--version|-v)
22-
@contentstack/cli-audit/1.12.2 darwin-arm64 node-v22.14.0
22+
@contentstack/cli-audit/1.13.0 darwin-arm64 node-v22.14.0
2323
$ csdx --help [COMMAND]
2424
USAGE
2525
$ csdx COMMAND
@@ -305,7 +305,7 @@ EXAMPLES
305305
$ csdx plugins
306306
```
307307

308-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.38/src/commands/plugins/index.ts)_
308+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.39/src/commands/plugins/index.ts)_
309309

310310
## `csdx plugins:add PLUGIN`
311311

@@ -379,7 +379,7 @@ EXAMPLES
379379
$ csdx plugins:inspect myplugin
380380
```
381381

382-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.38/src/commands/plugins/inspect.ts)_
382+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.39/src/commands/plugins/inspect.ts)_
383383

384384
## `csdx plugins:install PLUGIN`
385385

@@ -428,7 +428,7 @@ EXAMPLES
428428
$ csdx plugins:install someuser/someplugin
429429
```
430430

431-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.38/src/commands/plugins/install.ts)_
431+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.39/src/commands/plugins/install.ts)_
432432

433433
## `csdx plugins:link PATH`
434434

@@ -459,7 +459,7 @@ EXAMPLES
459459
$ csdx plugins:link myplugin
460460
```
461461

462-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.38/src/commands/plugins/link.ts)_
462+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.39/src/commands/plugins/link.ts)_
463463

464464
## `csdx plugins:remove [PLUGIN]`
465465

@@ -500,7 +500,7 @@ FLAGS
500500
--reinstall Reinstall all plugins after uninstalling.
501501
```
502502

503-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.38/src/commands/plugins/reset.ts)_
503+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.39/src/commands/plugins/reset.ts)_
504504

505505
## `csdx plugins:uninstall [PLUGIN]`
506506

@@ -528,7 +528,7 @@ EXAMPLES
528528
$ csdx plugins:uninstall myplugin
529529
```
530530

531-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.38/src/commands/plugins/uninstall.ts)_
531+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.39/src/commands/plugins/uninstall.ts)_
532532

533533
## `csdx plugins:unlink [PLUGIN]`
534534

@@ -572,5 +572,5 @@ DESCRIPTION
572572
Update installed plugins.
573573
```
574574

575-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.38/src/commands/plugins/update.ts)_
575+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.39/src/commands/plugins/update.ts)_
576576
<!-- commandsstop -->

packages/contentstack-export/src/commands/cm/stacks/export.ts

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
import path from 'path';
21
import { Command } from '@contentstack/cli-command';
32
import {
43
cliux,
@@ -12,11 +11,13 @@ import {
1211
sanitizePath,
1312
configHandler,
1413
v2Logger,
15-
handleAndLogError
14+
handleAndLogError,
15+
getLogPath
1616
} from '@contentstack/cli-utilities';
17+
1718
import { ModuleExporter } from '../../../export';
18-
import { setupExportConfig, writeExportMetaFile } from '../../../utils';
1919
import { Context, ExportConfig } from '../../../types';
20+
import { setupExportConfig, writeExportMetaFile } from '../../../utils';
2021

2122
export default class ExportCommand extends Command {
2223
static description: string = messageHandler.parse('Export content from a stack');
@@ -112,7 +113,7 @@ export default class ExportCommand extends Command {
112113
const { flags } = await this.parse(ExportCommand);
113114
exportConfig = await setupExportConfig(flags);
114115
// Prepare the context object
115-
const context = this.createExportContext();
116+
const context = this.createExportContext(exportConfig.apiKey);
116117
exportConfig.context = context;
117118

118119
// Assign exportConfig variables
@@ -126,22 +127,22 @@ export default class ExportCommand extends Command {
126127
writeExportMetaFile(exportConfig);
127128
}
128129
v2Logger.success(`The content of the stack ${exportConfig.apiKey} has been exported successfully!`,exportConfig.context)
129-
v2Logger.success(`The log has been stored at '${pathValidator(path.join(process.cwd(), 'logs'))}'`, exportConfig.context)
130+
v2Logger.info(`The log has been stored at '${getLogPath()}'`, exportConfig.context)
130131
} catch (error) {
131132
handleAndLogError(error, { ...exportConfig.context });
132133
}
133134
}
134135

135136
// Create export context object
136-
private createExportContext(): Context {
137+
private createExportContext(apiKey: string): Context {
137138
return {
138139
command: this.context.info.command,
139140
module: '',
140141
userId: configHandler.get('userId'),
141142
email: configHandler.get('email'),
142143
sessionId: this.context.sessionId,
143144
clientId: this.context.clientId,
144-
apiKey: configHandler.get('apiKey') || '',
145+
apiKey: apiKey || '',
145146
orgId: configHandler.get('organization_uid') || '',
146147
};
147148
}

packages/contentstack-export/src/export/modules/assets.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ import {
2020
messageHandler,
2121
} from '@contentstack/cli-utilities';
2222

23-
import { ModuleClassParams } from '../../types';
2423
import config from '../../config';
24+
import { ModuleClassParams } from '../../types';
2525
import BaseClass, { CustomPromiseHandler, CustomPromiseHandlerInput } from './base-class';
2626

2727
export default class ExportAssets extends BaseClass {

packages/contentstack-export/src/utils/common-helper.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@
44
* MIT Licensed
55
*/
66

7-
import promiseLimit from 'promise-limit';
87
import * as path from 'path';
9-
import { isAuthenticated } from '@contentstack/cli-utilities';
10-
import { ExternalConfig, ExportConfig } from '../types';
8+
import promiseLimit from 'promise-limit';
9+
import { isAuthenticated, getLogPath, sanitizePath } from '@contentstack/cli-utilities';
10+
1111
import { fsUtil } from './file-helper';
12-
import { sanitizePath } from '@contentstack/cli-utilities';
12+
import { ExternalConfig, ExportConfig } from '../types';
1313

1414
export const validateConfig = function (config: ExternalConfig) {
1515
if (!config.host || !config.cdn) {
@@ -84,7 +84,7 @@ export const executeTask = function (
8484
export const writeExportMetaFile = (exportConfig: ExportConfig, metaFilePath?: string) => {
8585
const exportMeta = {
8686
contentVersion: exportConfig.contentVersion,
87-
logsPath: path.join(process.cwd(), 'logs'),
87+
logsPath: getLogPath(),
8888
};
8989
fsUtil.writeFile(path.join(sanitizePath(metaFilePath || exportConfig.exportDir), 'export-info.json'), exportMeta);
9090
};

packages/contentstack-utilities/src/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,4 +77,4 @@ export { default as TablePrompt } from './inquirer-table-prompt';
7777

7878
export { Logger };
7979
export { default as authenticationHandler } from './authentication-handler';
80-
export {v2Logger, cliErrorHandler, handleAndLogError} from './logger/log'
80+
export {v2Logger, cliErrorHandler, handleAndLogError, getLogPath} from './logger/log'

packages/contentstack-utilities/src/logger/log.ts

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import { default as Logger } from './logger';
33
import { CLIErrorHandler } from './cliErrorHandler';
44
import { ErrorContext } from '../interfaces';
55

6-
const v2Logger = new Logger({ basePath: process.env.CS_CLI_LOG_PATH || path.join(process.cwd(), 'logs') });
6+
const v2Logger = new Logger({ basePath: getLogPath() });
77
const cliErrorHandler = new CLIErrorHandler(true); // Enable debug mode for error classification
88

99
/**
@@ -51,4 +51,9 @@ function handleAndLogError(error: unknown, context?: ErrorContext, errorMessage?
5151
}
5252
}
5353

54-
export { v2Logger, cliErrorHandler, handleAndLogError };
54+
function getLogPath(): string {
55+
return process.env.CS_CLI_LOG_PATH || path.join(process.cwd(), 'logs');
56+
}
57+
58+
59+
export { v2Logger, cliErrorHandler, handleAndLogError, getLogPath };

packages/contentstack-variants/src/export/attributes.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import omit from 'lodash/omit';
22
import { resolve as pResolve } from 'node:path';
33
import { sanitizePath, v2Logger, handleAndLogError } from '@contentstack/cli-utilities';
4-
import { formatError, fsUtil, PersonalizationAdapter, log } from '../utils';
4+
import { formatError, fsUtil, PersonalizationAdapter } from '../utils';
55
import { PersonalizeConfig, ExportConfig, AttributesConfig, AttributeStruct } from '../types';
66

77
export default class ExportAttributes extends PersonalizationAdapter<ExportConfig> {

packages/contentstack-variants/src/export/audiences.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import omit from 'lodash/omit';
22
import { resolve as pResolve } from 'node:path';
33
import { v2Logger, handleAndLogError } from '@contentstack/cli-utilities';
44

5-
import { formatError, fsUtil, PersonalizationAdapter, log } from '../utils';
5+
import { fsUtil, PersonalizationAdapter } from '../utils';
66
import { PersonalizeConfig, ExportConfig, AudienceStruct, AudiencesConfig } from '../types';
77

88
export default class ExportAudiences extends PersonalizationAdapter<ExportConfig> {

packages/contentstack-variants/src/export/experiences.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import * as path from 'path';
22
import { sanitizePath, v2Logger, handleAndLogError } from '@contentstack/cli-utilities';
33
import { PersonalizeConfig, ExportConfig, ExperienceStruct } from '../types';
4-
import { formatError, fsUtil, log, PersonalizationAdapter } from '../utils';
4+
import { fsUtil, PersonalizationAdapter } from '../utils';
55

66
export default class ExportExperiences extends PersonalizationAdapter<ExportConfig> {
77
private experiencesFolderPath: string;

packages/contentstack-variants/src/export/projects.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import * as path from 'path';
2-
import { sanitizePath, v2Logger, handleAndLogError } from '@contentstack/cli-utilities';
2+
import { sanitizePath, v2Logger } from '@contentstack/cli-utilities';
33
import { ExportConfig, PersonalizeConfig } from '../types';
4-
import { PersonalizationAdapter, log, fsUtil, formatError } from '../utils';
4+
import { PersonalizationAdapter, fsUtil, } from '../utils';
55

66
export default class ExportProjects extends PersonalizationAdapter<ExportConfig> {
77
private projectFolderPath: string;

0 commit comments

Comments
 (0)