create-stylelint 0.4.0 → 0.6.0

package/README.md

@@ -3,11 +3,13 @@
 [![npm version](https://img.shields.io/npm/v/create-stylelint)](https://www.npmjs.com/package/create-stylelint)
 [![Testing](https://github.com/stylelint/create-stylelint/actions/workflows/testing.yml/badge.svg)](https://github.com/stylelint/create-stylelint/actions/workflows/testing.yml)
 
-The [`npm init`](https://docs.npmjs.com/cli/v9/commands/npm-init) script for [Stylelint](https://github.com/stylelint/stylelint).
+The [`create`](https://docs.npmjs.com/cli/commands/npm-init) script for [Stylelint](https://github.com/stylelint/stylelint).
 
 ## Usage
 
-Run `npm init stylelint`
+Run `npm create stylelint`
+
+(Also compatible with the Bun, pnpm, and Yarn package managers.)
 
 ## Contributing
 

package/package.json

@@ -1,16 +1,22 @@
 {
   "name": "create-stylelint",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "description": "The npm init script for Stylelint.",
   "keywords": [
     "stylelint",
     "npm init"
   ],
   "repository": "stylelint/create-stylelint",
-  "funding": {
-    "type": "opencollective",
-    "url": "https://opencollective.com/stylelint"
-  },
+  "funding": [
+    {
+      "type": "opencollective",
+      "url": "https://opencollective.com/stylelint"
+    },
+    {
+      "type": "github",
+      "url": "https://github.com/sponsors/stylelint"
+    }
+  ],
   "license": "MIT",
   "author": "stylelint",
   "main": "create-stylelint.mjs",
@@ -24,7 +30,7 @@
     "format": "prettier . --write --cache",
     "lint": "npm-run-all --parallel --continue-on-error lint:*",
     "lint:formatting": "prettier . --check --cache",
-    "lint:js": "eslint . --cache --max-warnings=0 --ext .js,.mjs",
+    "lint:js": "eslint",
     "lint:md": "remark . --quiet --frail",
     "lint:packagejson": "npmPkgJsonLint .",
     "lint:types": "tsc",
@@ -34,12 +40,6 @@
     "release": "np --no-release-draft"
   },
   "prettier": "@stylelint/prettier-config",
-  "eslintConfig": {
-    "extends": [
-      "stylelint"
-    ],
-    "root": true
-  },
   "npmpackagejsonlint": {
     "extends": "@stylelint/npm-package-json-lint-config"
   },
@@ -49,28 +49,35 @@
     ]
   },
   "dependencies": {
+    "@inquirer/confirm": "^5.1.16",
     "cosmiconfig": "^9.0.0",
-    "execa": "^8.0.1",
-    "ora": "^7.0.1",
-    "picocolors": "^1.0.0",
-    "semver": "^7.5.4",
+    "execa": "^9.6.0",
+    "ora": "^8.1.1",
+    "picocolors": "^1.1.1",
+    "semver": "^7.7.2",
     "strip-indent": "^4.0.0",
     "which-pm-runs": "^1.1.0"
   },
   "devDependencies": {
-    "@stylelint/npm-package-json-lint-config": "^4.0.0",
+    "@stylelint/npm-package-json-lint-config": "^5.1.0",
     "@stylelint/prettier-config": "^3.0.0",
-    "@stylelint/remark-preset": "^5.0.0",
+    "@stylelint/remark-preset": "^5.1.1",
     "@types/which-pm-runs": "^1.0.2",
-    "eslint": "^8.55.0",
-    "eslint-config-stylelint": "^20.0.0",
-    "np": "^9.1.0",
+    "eslint": "^9.34.0",
+    "eslint-config-stylelint": "^25.0.0",
+    "np": "^10.2.0",
     "npm-run-all": "^4.1.5",
-    "remark-cli": "^12.0.0",
-    "typescript": "^5.3.3",
-    "vitest": "^1.0.2"
+    "prettier": "^3.6.2",
+    "remark-cli": "^12.0.1",
+    "typescript": "^5.9.2",
+    "vitest": "^3.2.4"
+  },
+  "optionalDependencies": {
+    "@rollup/rollup-darwin-x64": "*",
+    "@rollup/rollup-linux-x64-gnu": "*",
+    "@rollup/rollup-win32-x64-msvc": "*"
   },
   "engines": {
-    "node": ">=18.12.0"
+    "node": ">=20.19.0"
   }
 }

package/src/index.mjs

@@ -5,19 +5,27 @@ import * as fs from 'node:fs';
 import * as path from 'node:path';
 import process from 'node:process';
 
-import { cosmiconfigSync } from 'cosmiconfig';
+import confirm from '@inquirer/confirm';
+import { cosmiconfig } from 'cosmiconfig';
 import detectPackageManager from 'which-pm-runs';
 import { execa } from 'execa';
 import ora from 'ora';
-import picocolors from 'picocolors';
+import pc from 'picocolors';
 import stripIndent from 'strip-indent';
 
-const DEFAULT_CONFIG_FILE = '.stylelintrc.json';
+const DEFAULT_CONFIG_FILE = 'stylelint.config.mjs';
+const DEFAULT_CONFIG_CONTENT = `/** @type {import("stylelint").Config} */
+export default {
+  "extends": ["stylelint-config-standard"]
+};`;
 
-function getExistingConfigInDirectory() {
-	const explorer = cosmiconfigSync('stylelint');
+const ADD_COMMAND = 'add -D stylelint stylelint-config-standard';
 
-	return explorer.search();
+async function getExistingConfigInDirectory() {
+	const explorer = cosmiconfig('stylelint');
+	const result = await explorer.search();
+
+	return result;
 }
 
 /**
@@ -27,78 +35,162 @@ function directoryHasPackageJson(dir) {
 	return fs.readdirSync(dir).some((file) => file === 'package.json');
 }
 
+/**
+ * @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`);
+	}
+}
+
+/**
+ * @param {string} errorMessage
+ */
+function cancelSetup(errorMessage = '') {
+	console.error(
+		stripIndent(`
+			${pc.red(pc.bold('Setup canceled!'))}
+		`),
+	);
+
+	if (errorMessage) {
+		console.error(
+			stripIndent(`${errorMessage}
+			`),
+		);
+	}
+
+	process.exit(1);
+}
+
 /**
  * @param {string} pkgManager
  */
-function getInstallCommand(pkgManager) {
-	return pkgManager === 'npm' ? 'install' : 'add';
+async function showPrompt(pkgManager) {
+	console.info(
+		stripIndent(`
+			We'll create a ${pc.cyan(DEFAULT_CONFIG_FILE)} file containing:
+		`),
+	);
+
+	console.info(
+		pc.dim(
+			DEFAULT_CONFIG_CONTENT.split('\n')
+				.map((line) => `  ${line}`)
+				.join('\n'),
+		),
+	);
+
+	console.info(
+		stripIndent(`
+			Then add the related dependencies using:
+
+			  ${pc.dim(`${pkgManager} ${ADD_COMMAND}`)}
+		`),
+	);
+
+	let proceed;
+
+	try {
+		proceed = await confirm({
+			message: 'Continue?',
+		});
+	} catch (error) {
+		if (error instanceof Error && error.name === 'ExitPromptError') {
+			// silence
+		} else {
+			throw error;
+		}
+	}
+
+	if (!proceed) {
+		cancelSetup();
+	}
 }
 
 /**
  * @param {string} cwd
  * @param {string} pkgManager
  */
-function createConfig(cwd, pkgManager) {
+async function createConfig(cwd, pkgManager) {
 	const spinner = ora('Creating config...').start();
-	const existingConfig = getExistingConfigInDirectory();
+	const existingConfig = await getExistingConfigInDirectory();
 
 	if (existingConfig !== null) {
 		const basename = path.basename(existingConfig.filepath);
 		const failureMessage =
 			basename === 'package.json'
-				? 'The "stylelint" config in "package.json" already exists.'
-				: `The "${basename}" config already exists.`;
+				? 'A "stylelint" config in "package.json" already exists.'
+				: `A "${basename}" config already exists.`;
 
-		spinner.fail(`Failed to create config:\n${failureMessage} Remove it and then try again.`);
-		process.exit(1);
+		spinner.fail();
+		cancelSetup(`${failureMessage} Remove it and then try again.`);
 	}
 
 	if (!directoryHasPackageJson(cwd)) {
-		spinner.fail(
-			`Failed to create config:\npackage.json was not found. Run "${pkgManager} init" and then try again.`,
-		);
-		process.exit(1);
+		spinner.fail();
+		cancelSetup(`A "package.json" was not found. Run "${pkgManager} init" and then try again.`);
 	}
 
 	try {
-		fs.writeFileSync(DEFAULT_CONFIG_FILE, '{ "extends": ["stylelint-config-standard"] }');
+		fs.writeFileSync(DEFAULT_CONFIG_FILE, `${DEFAULT_CONFIG_CONTENT}\n`);
 	} catch (error) {
-		spinner.fail(`Failed to create config:\n${error}`);
-		process.exit(1);
+		spinner.fail();
+		cancelSetup(error instanceof Error ? error.message : String(error));
 	}
 
-	spinner.succeed(`Created ${DEFAULT_CONFIG_FILE}.`);
+	spinner.succeed('Created config file');
 }
 
 /**
  * @param {string} cwd
  * @param {string} pkgManager
  */
-async function installPackages(cwd, pkgManager) {
-	const spinner = ora('Installing packages...').start();
+async function addDependencies(cwd, pkgManager) {
+	const spinner = ora('Adding dependencies...').start();
 
 	try {
-		await execa(
-			pkgManager,
-			[`${getInstallCommand(pkgManager)}`, '-D', 'stylelint', 'stylelint-config-standard'],
-			{ cwd },
-		);
+		await execa(pkgManager, [...ADD_COMMAND.split(' ')], {
+			cwd,
+		});
 	} catch (error) {
-		spinner.fail(`Failed to install packages:\n${error}`);
-		process.exit(1);
+		spinner.fail();
+		cancelSetup(error instanceof Error ? error.message : String(error));
 	}
 
-	spinner.succeed('Installed packages.');
+	spinner.succeed('Added dependencies');
 }
 
-function showNextSteps() {
-	console.log(
+/**
+ * @param {string} pkgManager
+ */
+function showNextSteps(pkgManager) {
+	console.info(
 		stripIndent(`
-			${picocolors.green(`You can now lint your CSS files using:
-			npx stylelint "**/*.css"`)}
+			${pc.green(pc.bold('Setup complete!'))}
+
+			Lint your CSS files with:
+
+			  ${pc.dim(`${getExecuteCommand(pkgManager)} stylelint "**/*.css"`)}
+
+			Next steps? Customize your config: ${pc.underline(
+				pc.blue('https://stylelint.io/user-guide/customize'),
+			)}
+
+			If you benefit from Stylelint, please consider sponsoring the project at:
 
-			${picocolors.dim(`We recommend customizing Stylelint:
-			https://stylelint.io/user-guide/customize/`)}
+			- ${pc.underline(pc.blue('https://github.com/sponsors/stylelint'))}
+			- ${pc.underline(pc.blue('https://opencollective.com/stylelint'))}
 		`),
 	);
 }
@@ -107,7 +199,8 @@ export async function main() {
 	const pkgManager = detectPackageManager()?.name ?? 'npm';
 	const cwd = './';
 
-	createConfig(cwd, pkgManager);
-	await installPackages(cwd, pkgManager);
-	showNextSteps();
+	await showPrompt(pkgManager);
+	await createConfig(cwd, pkgManager);
+	await addDependencies(cwd, pkgManager);
+	showNextSteps(pkgManager);
 }