create-stylelint 0.7.0 → 1.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-stylelint",
-  "version": "0.7.0",
+  "version": "1.0.0",
   "description": "The npm init script for Stylelint.",
   "keywords": [
     "stylelint",
@@ -19,11 +19,13 @@
   ],
   "license": "MIT",
   "author": "stylelint",
-  "main": "create-stylelint.mjs",
+  "type": "module",
+  "exports": "./create-stylelint.mjs",
   "bin": {
     "create-stylelint": "./create-stylelint.mjs"
   },
   "files": [
+    "create-stylelint.mjs",
     "src"
   ],
   "scripts": {
@@ -48,27 +50,27 @@
     ]
   },
   "dependencies": {
-    "@inquirer/confirm": "^5.1.18",
-    "cosmiconfig": "^9.0.0",
-    "execa": "^9.6.0",
-    "ora": "^9.0.0",
+    "@clack/prompts": "^1.2.0",
+    "cosmiconfig": "^9.0.1",
+    "execa": "^9.6.1",
     "picocolors": "^1.1.1",
-    "semver": "^7.7.2",
+    "semver": "^7.7.4",
     "strip-indent": "^4.1.0",
-    "which-pm-runs": "^1.1.0"
+    "which-pm-runs": "^2.0.0"
   },
   "devDependencies": {
     "@stylelint/npm-package-json-lint-config": "^5.1.0",
-    "@stylelint/prettier-config": "^3.0.0",
+    "@stylelint/prettier-config": "^4.0.0",
     "@stylelint/remark-preset": "^5.1.1",
+    "@types/node": "^25.5.0",
     "@types/which-pm-runs": "^1.0.2",
-    "eslint": "^9.36.0",
-    "eslint-config-stylelint": "^25.0.0",
+    "eslint": "^10.1.0",
+    "eslint-config-stylelint": "^27.0.0",
     "npm-run-all": "^4.1.5",
-    "prettier": "^3.6.2",
+    "prettier": "^3.8.1",
     "remark-cli": "^12.0.1",
-    "typescript": "^5.9.2",
-    "vitest": "^3.2.4"
+    "typescript": "^6.0.2",
+    "vitest": "^4.1.1"
   },
   "optionalDependencies": {
     "@rollup/rollup-darwin-x64": "*",

package/src/index.mjs

@@ -1,17 +1,17 @@
-/* eslint no-console: 'off' */
 /* eslint n/no-process-exit: 'off' */
 
 import * as fs from 'node:fs';
 import * as path from 'node:path';
 import process from 'node:process';
 
-import confirm from '@inquirer/confirm';
+import { cancel, confirm, intro, isCancel, log, note, outro, spinner } from '@clack/prompts';
 import { cosmiconfig } from 'cosmiconfig';
-import detectPackageManager from 'which-pm-runs';
 import { execa } from 'execa';
-import ora from 'ora';
 import pc from 'picocolors';
 import stripIndent from 'strip-indent';
+// @ts-expect-error - TS2595: 'whichPMRuns' can only be imported by using a default import.
+//                    Need to wait for a `@types/which-pm-runs` new version.
+import { whichPMRuns } from 'which-pm-runs';
 
 const DEFAULT_CONFIG_FILE = 'stylelint.config.mjs';
 const DEFAULT_CONFIG_CONTENT = `/** @type {import("stylelint").Config} */
@@ -21,186 +21,140 @@ export default {
 
 const ADD_COMMAND = 'add -D stylelint stylelint-config-standard';
 
-async function getExistingConfigInDirectory() {
-	const explorer = cosmiconfig('stylelint');
-	const result = await explorer.search();
-
-	return result;
-}
-
-/**
- * @param {fs.PathLike} dir
- */
-function directoryHasPackageJson(dir) {
-	return fs.readdirSync(dir).some((file) => file === 'package.json');
-}
+export async function main() {
+	const pkgManager = whichPMRuns()?.name ?? 'npm';
+	const cwd = './';
 
-/**
- * @param {string} pkgManager
- * @return {string} The command
- */
-function getExecuteCommand(pkgManager) {
-	switch (pkgManager) {
-		case 'npm':
-			return 'npx';
-		case 'bun':
-			return 'bunx';
-		case 'pnpm':
-		case 'yarn':
-			return `${pkgManager} dlx`;
-		default:
-			throw new Error(`"${pkgManager}" package manager is not supported`);
-	}
-}
+	intro(pc.bgGreen(pc.white(' create-stylelint ')));
 
-/**
- * @param {string} errorMessage
- */
-function cancelSetup(errorMessage = '') {
-	console.error(
+	note(
 		stripIndent(`
-			${pc.red(pc.bold('Setup canceled!'))}
-		`),
-	);
+			Create a ${pc.cyan(DEFAULT_CONFIG_FILE)} file containing:
 
-	if (errorMessage) {
-		console.error(
-			stripIndent(`${errorMessage}
-			`),
-		);
-	}
+			  ${DEFAULT_CONFIG_CONTENT.split('\n').join('\n\t\t\t  ')}
 
-	process.exit(1);
-}
+			Add the related dependencies using:
 
-/**
- * @param {string} pkgManager
- */
-async function showPrompt(pkgManager) {
-	console.info(
-		stripIndent(`
-			We'll create a ${pc.cyan(DEFAULT_CONFIG_FILE)} file containing:
-		`),
+			  ${pkgManager} ${ADD_COMMAND}
+		`).trim(),
+		'This tool will:',
 	);
 
-	console.info(
-		pc.dim(
-			DEFAULT_CONFIG_CONTENT.split('\n')
-				.map((line) => `  ${line}`)
-				.join('\n'),
-		),
-	);
+	const shouldContinue = await confirm({ message: 'Continue?' });
 
-	console.info(
-		stripIndent(`
-			Then add the related dependencies using:
+	if (isCancel(shouldContinue) || !shouldContinue) {
+		cancel('Canceled');
+		process.exit(0);
+	}
 
-			  ${pc.dim(`${pkgManager} ${ADD_COMMAND}`)}
-		`),
-	);
+	const configSpinner = spinner();
 
-	let proceed;
+	configSpinner.start('Creating config');
 
 	try {
-		proceed = await confirm({
-			message: 'Continue?',
-		});
-	} catch (error) {
-		if (error instanceof Error && error.name === 'ExitPromptError') {
-			// silence
-		} else {
-			throw error;
-		}
-	}
+		const existingConfig = await getExistingConfigInDirectory();
 
-	if (!proceed) {
-		cancelSetup();
-	}
-}
+		if (existingConfig !== null) {
+			const basename = path.basename(existingConfig.filepath);
+			const failureMessage =
+				basename === 'package.json'
+					? `A ${pc.cyan('stylelint')} entry in ${pc.cyan('package.json')} already exists.`
+					: `A ${pc.cyan(basename)} file already exists.`;
 
-/**
- * @param {string} cwd
- * @param {string} pkgManager
- */
-async function createConfig(cwd, pkgManager) {
-	const spinner = ora('Creating config...').start();
-	const existingConfig = await getExistingConfigInDirectory();
-
-	if (existingConfig !== null) {
-		const basename = path.basename(existingConfig.filepath);
-		const failureMessage =
-			basename === 'package.json'
-				? 'A "stylelint" config in "package.json" already exists.'
-				: `A "${basename}" config already exists.`;
-
-		spinner.fail();
-		cancelSetup(`${failureMessage} Remove it and then try again.`);
-	}
+			throw new Error(`${failureMessage} Remove it and then try again.`);
+		}
 
-	if (!directoryHasPackageJson(cwd)) {
-		spinner.fail();
-		cancelSetup(`A "package.json" was not found. Run "${pkgManager} init" and then try again.`);
-	}
+		if (!directoryHasPackageJson(cwd)) {
+			throw new Error(
+				`A ${pc.cyan('package.json')} was not found. Run ${pc.cyan(`${pkgManager} init`)} and then try again.`,
+			);
+		}
 
-	try {
 		fs.writeFileSync(DEFAULT_CONFIG_FILE, `${DEFAULT_CONFIG_CONTENT}\n`);
+		configSpinner.stop('Created config file');
 	} catch (error) {
-		spinner.fail();
-		cancelSetup(error instanceof Error ? error.message : String(error));
+		handleError(configSpinner, error);
 	}
 
-	spinner.succeed('Created config file');
-}
+	const depsSpinner = spinner();
 
-/**
- * @param {string} cwd
- * @param {string} pkgManager
- */
-async function addDependencies(cwd, pkgManager) {
-	const spinner = ora('Adding dependencies...').start();
+	depsSpinner.start('Adding dependencies');
 
 	try {
-		await execa(pkgManager, [...ADD_COMMAND.split(' ')], {
-			cwd,
-		});
+		await execa(pkgManager, [...ADD_COMMAND.split(' ')], { cwd });
+		depsSpinner.stop('Added dependencies');
 	} catch (error) {
-		spinner.fail();
-		cancelSetup(error instanceof Error ? error.message : String(error));
+		handleError(depsSpinner, error);
 	}
 
-	spinner.succeed('Added dependencies');
-}
+	log.success('Stylelint is ready!');
 
-/**
- * @param {string} pkgManager
- */
-function showNextSteps(pkgManager) {
-	console.info(
+	note(
 		stripIndent(`
-			${pc.green(pc.bold('Setup complete!'))}
-
-			Lint your CSS files with:
+			Lint your CSS files:
 
 			  ${pc.dim(`${getExecuteCommand(pkgManager)} stylelint "**/*.css"`)}
 
-			Next steps? Customize your config: ${pc.underline(
-				pc.blue('https://stylelint.io/user-guide/customize'),
-			)}
+			Customize your config:
 
-			If you benefit from Stylelint, please consider sponsoring the project at:
+			- ${pc.underline(pc.cyan('https://stylelint.io/user-guide/customize'))}
+		`).trim(),
+		'Next steps:',
+	);
 
-			- ${pc.underline(pc.blue('https://github.com/sponsors/stylelint'))}
-			- ${pc.underline(pc.blue('https://opencollective.com/stylelint'))}
-		`),
+	log.message(
+		stripIndent(`
+			${pc.dim('Support Stylelint:')}
+
+			${pc.dim(`- ${pc.underline(pc.cyan('https://github.com/sponsors/stylelint'))}`)}
+			${pc.dim(`- ${pc.underline(pc.cyan('https://opencollective.com/stylelint'))}`)}
+		`).trim(),
 	);
+
+	outro(pc.green('Done!'));
 }
 
-export async function main() {
-	const pkgManager = detectPackageManager()?.name ?? 'npm';
-	const cwd = './';
+async function getExistingConfigInDirectory() {
+	const explorer = cosmiconfig('stylelint');
+	const result = await explorer.search();
+
+	return result;
+}
 
-	await showPrompt(pkgManager);
-	await createConfig(cwd, pkgManager);
-	await addDependencies(cwd, pkgManager);
-	showNextSteps(pkgManager);
+/**
+ * @param {fs.PathLike} dir
+ */
+function directoryHasPackageJson(dir) {
+	return fs.readdirSync(dir).some((file) => file === 'package.json');
+}
+
+/**
+ * @param {ReturnType<typeof spinner>} s
+ * @param {unknown} error
+ * @returns {never}
+ */
+function handleError(s, error) {
+	const message = error instanceof Error ? error.message : String(error);
+
+	s.error(message);
+	cancel('Canceled');
+	process.exit(1);
+}
+
+/**
+ * @param {string} pkgManager
+ * @return {string} The command
+ */
+function getExecuteCommand(pkgManager) {
+	switch (pkgManager) {
+		case 'npm':
+			return 'npx';
+		case 'bun':
+			return 'bunx';
+		case 'pnpm':
+		case 'yarn':
+			return `${pkgManager} dlx`;
+		default:
+			throw new Error(`${pc.cyan(pkgManager)} package manager is not supported`);
+	}
 }