@elsikora/setup-wizard
Version:
Setup Wizard - CLI scaffolding utility
227 lines (224 loc) • 10.7 kB
JavaScript
import { LINT_STAGED_FEATURE_CONFIG } from '../../domain/constant/lint-staged-feature-config.constant.js';
import { ELintStagedFeature } from '../../domain/enum/lint-staged-feature.enum.js';
import { EModule } from '../../domain/enum/module.enum.js';
import { EPackageJsonDependencyType } from '../../domain/enum/package-json-dependency-type.enum.js';
import { NodeCommandService } from '../../infrastructure/service/node-command.service.js';
import { LINT_STAGED_CONFIG } from '../constant/lint-staged/config.constant.js';
import { LINT_STAGED_CORE_DEPENDENCIES } from '../constant/lint-staged/core-dependencies.constant.js';
import { LINT_STAGED_CONFIG_FILE_NAMES } from '../constant/lint-staged/file-names.constant.js';
import { LINT_STAGED_CONFIG_HUSKY_PRE_COMMIT_SCRIPT } from '../constant/lint-staged/husky-pre-commit-script.constant.js';
import { LINT_STAGED_CONFIG_MESSAGES } from '../constant/lint-staged/messages.constant.js';
import { PackageJsonService } from './package-json.service.js';
/**
* Service for setting up and managing lint-staged configuration.
* Provides functionality to run linters on git staged files,
* ensuring only properly formatted code is committed.
*/
class LintStagedModuleService {
/** CLI interface service for user interaction */
CLI_INTERFACE_SERVICE;
/** Command service for executing shell commands */
COMMAND_SERVICE;
/** Configuration service for managing app configuration */
CONFIG_SERVICE;
/** File system service for file operations */
FILE_SYSTEM_SERVICE;
/** Service for managing package.json */
PACKAGE_JSON_SERVICE;
/** Cached lint-staged configuration */
config = null;
/** Selected lint-staged features to configure */
selectedFeatures = [];
/**
* Initializes a new instance of the LintStagedModuleService.
* @param cliInterfaceService - Service for CLI user interactions
* @param fileSystemService - Service for file system operations
* @param configService - Service for managing app configuration
*/
constructor(cliInterfaceService, fileSystemService, configService) {
this.CLI_INTERFACE_SERVICE = cliInterfaceService;
this.FILE_SYSTEM_SERVICE = fileSystemService;
this.COMMAND_SERVICE = new NodeCommandService(cliInterfaceService);
this.PACKAGE_JSON_SERVICE = new PackageJsonService(fileSystemService, this.COMMAND_SERVICE);
this.CONFIG_SERVICE = configService;
}
/**
* Handles existing lint-staged setup.
* Checks for existing configuration files and asks if user wants to remove them.
* @returns Promise resolving to true if setup should proceed, false otherwise
*/
async handleExistingSetup() {
const existingFiles = await this.findExistingConfigFiles();
const packageJson = await this.PACKAGE_JSON_SERVICE.get();
if (packageJson["lint-staged"]) {
existingFiles.push(LINT_STAGED_CONFIG_MESSAGES.packageJsonConfig);
}
if (existingFiles.length > 0) {
const messageLines = [LINT_STAGED_CONFIG_MESSAGES.existingFilesDetected];
messageLines.push("");
for (const file of existingFiles) {
messageLines.push(`- ${file}`);
}
messageLines.push("", LINT_STAGED_CONFIG_MESSAGES.deleteFilesQuestion);
const shouldDelete = await this.CLI_INTERFACE_SERVICE.confirm(messageLines.join("\n"), true);
if (shouldDelete) {
await Promise.all(existingFiles.filter((file) => file !== LINT_STAGED_CONFIG_MESSAGES.packageJsonConfig).map((file) => this.FILE_SYSTEM_SERVICE.deleteFile(file)));
if (packageJson["lint-staged"]) {
delete packageJson["lint-staged"];
await this.PACKAGE_JSON_SERVICE.set(packageJson);
}
}
else {
this.CLI_INTERFACE_SERVICE.warn(LINT_STAGED_CONFIG_MESSAGES.existingFilesAborted);
return false;
}
}
return true;
}
/**
* Installs and configures lint-staged.
* Guides the user through selecting linting tools and setting up git hooks.
* @returns Promise resolving to the module setup result
*/
async install() {
try {
this.config = await this.CONFIG_SERVICE.getModuleConfig(EModule.LINT_STAGED);
if (!(await this.shouldInstall())) {
return { wasInstalled: false };
}
if (!(await this.handleExistingSetup())) {
return { wasInstalled: false };
}
const savedFeatures = this.config?.features ?? [];
await this.setupLintStaged(savedFeatures);
return {
customProperties: {
features: this.selectedFeatures,
},
wasInstalled: true,
};
}
catch (error) {
this.CLI_INTERFACE_SERVICE.handleError(LINT_STAGED_CONFIG_MESSAGES.failedSetupError, error);
throw error;
}
}
/**
* Determines if lint-staged should be installed.
* Asks the user if they want to set up lint-staged with Husky pre-commit hooks.
* Uses the saved config value as default if it exists.
* @returns Promise resolving to true if the module should be installed, false otherwise
*/
async shouldInstall() {
try {
return await this.CLI_INTERFACE_SERVICE.confirm(LINT_STAGED_CONFIG_MESSAGES.confirmSetup, await this.CONFIG_SERVICE.isModuleEnabled(EModule.LINT_STAGED));
}
catch (error) {
this.CLI_INTERFACE_SERVICE.handleError(LINT_STAGED_CONFIG_MESSAGES.failedConfirmation, error);
return false;
}
}
/**
* Collects all required npm dependencies for selected lint-staged features.
* @param selectedFeatures - Selected lint-staged features
* @returns Array of package names to install
*/
collectDependencies(selectedFeatures) {
const dependencies = new Set(LINT_STAGED_CORE_DEPENDENCIES);
for (const feature of selectedFeatures) {
for (const packageName of LINT_STAGED_FEATURE_CONFIG[feature].requiredPackages) {
dependencies.add(packageName);
}
}
return [...dependencies];
}
/**
* Creates the lint-staged configuration file.
* @param selectedFeatures - Array of selected lint-staged features
*/
async createConfigs(selectedFeatures) {
const config = LINT_STAGED_CONFIG.template(selectedFeatures);
await this.FILE_SYSTEM_SERVICE.writeFile("lint-staged.config.js", config, "utf8");
}
/**
* Displays a summary of the lint-staged setup results.
* Lists selected linting tools and required packages.
* @param selectedFeatures - Array of selected lint-staged features
*/
displaySetupSummary(selectedFeatures) {
const requiredPackages = [...new Set(selectedFeatures.flatMap((feature) => LINT_STAGED_FEATURE_CONFIG[feature].requiredPackages))];
const summary = [
LINT_STAGED_CONFIG_MESSAGES.configurationCreated,
"",
LINT_STAGED_CONFIG_MESSAGES.configurationFilesLabel,
"- lint-staged.config.js",
"- .husky/pre-commit",
"",
LINT_STAGED_CONFIG_MESSAGES.selectedToolsLabel,
...selectedFeatures.map((feature) => `- ${LINT_STAGED_FEATURE_CONFIG[feature].label}`),
"",
LINT_STAGED_CONFIG_MESSAGES.requiredPackagesLabel,
...requiredPackages.map((packageName) => `- ${packageName}`),
"",
LINT_STAGED_CONFIG_MESSAGES.huskyHookSetup,
];
this.CLI_INTERFACE_SERVICE.note(LINT_STAGED_CONFIG_MESSAGES.setupCompleteTitle, summary.join("\n"));
}
/**
* Finds existing lint-staged configuration files.
* @returns Promise resolving to an array of file paths for existing configuration files
*/
async findExistingConfigFiles() {
const existingFiles = [];
for (const file of LINT_STAGED_CONFIG_FILE_NAMES) {
if (await this.FILE_SYSTEM_SERVICE.isPathExists(file)) {
existingFiles.push(file);
}
}
if (await this.FILE_SYSTEM_SERVICE.isPathExists(".husky/pre-commit")) {
existingFiles.push(".husky/pre-commit");
}
return existingFiles;
}
/**
* Sets up Husky git hooks.
* Initializes Husky, adds prepare script, and creates pre-commit hook.
*/
async setupHusky() {
await this.COMMAND_SERVICE.execute("npx husky");
await this.PACKAGE_JSON_SERVICE.addScript("prepare", "husky");
await this.COMMAND_SERVICE.execute("mkdir -p .husky");
await this.FILE_SYSTEM_SERVICE.writeFile(".husky/pre-commit", LINT_STAGED_CONFIG_HUSKY_PRE_COMMIT_SCRIPT, "utf8");
await this.COMMAND_SERVICE.execute("chmod +x .husky/pre-commit");
}
/**
* Sets up lint-staged configuration.
* Guides the user through selecting linting tools and creates necessary config files.
* @param savedFeatures - Previously saved lint-staged features
*/
async setupLintStaged(savedFeatures = []) {
try {
const options = Object.entries(LINT_STAGED_FEATURE_CONFIG).map(([value, config]) => ({
label: config.label,
value,
}));
const hasValidSavedFeatures = savedFeatures.length > 0 && savedFeatures.every((feature) => Object.values(ELintStagedFeature).includes(feature));
const initialValues = hasValidSavedFeatures ? savedFeatures : [];
this.selectedFeatures = await this.CLI_INTERFACE_SERVICE.multiselect(LINT_STAGED_CONFIG_MESSAGES.selectFeaturesPrompt, options, true, initialValues);
this.CLI_INTERFACE_SERVICE.startSpinner(LINT_STAGED_CONFIG_MESSAGES.settingUpSpinner);
const dependencies = this.collectDependencies(this.selectedFeatures);
await this.PACKAGE_JSON_SERVICE.installPackages(dependencies, "latest", EPackageJsonDependencyType.DEV);
await this.createConfigs(this.selectedFeatures);
await this.setupHusky();
this.CLI_INTERFACE_SERVICE.stopSpinner(LINT_STAGED_CONFIG_MESSAGES.configurationCompleted);
this.displaySetupSummary(this.selectedFeatures);
}
catch (error) {
this.CLI_INTERFACE_SERVICE.stopSpinner(LINT_STAGED_CONFIG_MESSAGES.failedSetupSpinner);
throw error;
}
}
}
export { LintStagedModuleService };
//# sourceMappingURL=lint-staged-module.service.js.map