create-stylelint 0.1.1

package/README.md

@@ -0,0 +1,17 @@
+# create-stylelint
+
+The [`npm init`](https://docs.npmjs.com/cli/v9/commands/npm-init) script for [Stylelint](https://github.com/stylelint/stylelint).
+
+## Usage
+
+Run `npm init stylelint`
+
+## Contributing
+
+- `npm install`
+- `node create-stylelint.mjs` to run locally
+- `npm run watch` to test with [Vitest](https://vitest.dev/)
+
+## Acknowledgments
+
+Inspired by [create-astro](https://github.com/withastro/astro/blob/main/packages/create-astro).

package/create-stylelint.mjs

@@ -0,0 +1,23 @@
+#!/usr/bin/env node
+/* eslint-disable no-process-exit */
+/* eslint-disable no-console */
+'use strict';
+
+const currentVersion = process.versions.node;
+
+import { fileURLToPath } from 'node:url';
+import fs from 'node:fs';
+import path from 'node:path';
+import semver from 'semver';
+
+const dirname = path.dirname(fileURLToPath(import.meta.url));
+const pkg = JSON.parse(fs.readFileSync(path.join(dirname, 'package.json').toString()));
+
+if (!semver.satisfies(currentVersion, pkg.engines.node)) {
+	console.error(`Unsupported Node.js version (v${currentVersion})`);
+	console.error(`Install a Node.js version within "${pkg.engines.node}" and then try again.`);
+	process.exit(1);
+}
+
+// eslint-disable-next-line node/no-unsupported-features/es-syntax
+import('./src/index.mjs').then(({ main }) => main());

package/package.json

@@ -0,0 +1,80 @@
+{
+  "name": "create-stylelint",
+  "version": "0.1.1",
+  "description": "The npm init script for Stylelint.",
+  "keywords": [
+    "stylelint",
+    "npm init"
+  ],
+  "repository": "stylelint/create-stylelint",
+  "funding": {
+    "type": "opencollective",
+    "url": "https://opencollective.com/stylelint"
+  },
+  "license": "MIT",
+  "author": "stylelint",
+  "main": "create-stylelint.mjs",
+  "bin": {
+    "create-stylelint": "./create-stylelint.mjs"
+  },
+  "files": [
+    "src"
+  ],
+  "scripts": {
+    "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:md": "remark . --quiet --frail",
+    "lint:packagejson": "npmPkgJsonLint .",
+    "lint:types": "tsc",
+    "pretest": "npm run lint",
+    "test": "vitest run",
+    "watch": "vitest watch",
+    "release": "np"
+  },
+  "prettier": "@stylelint/prettier-config",
+  "eslintConfig": {
+    "settings": {
+      "jest": {
+        "version": "latest"
+      }
+    },
+    "extends": [
+      "stylelint"
+    ],
+    "root": true
+  },
+  "npmpackagejsonlint": {
+    "extends": "@stylelint/npm-package-json-lint-config"
+  },
+  "remarkConfig": {
+    "plugins": [
+      "@stylelint/remark-preset"
+    ]
+  },
+  "dependencies": {
+    "execa": "^6.1.0",
+    "ora": "^6.1.2",
+    "picocolors": "^1.0.0",
+    "semver": "^7.3.8",
+    "strip-indent": "^4.0.0",
+    "which-pm-runs": "^1.1.0"
+  },
+  "devDependencies": {
+    "@stylelint/npm-package-json-lint-config": "^3.0.0",
+    "@stylelint/prettier-config": "^2.0.0",
+    "@stylelint/remark-preset": "^4.0.0",
+    "@types/which-pm-runs": "^1.0.0",
+    "eslint": "^8.28.0",
+    "eslint-config-stylelint": "^17.1.0",
+    "np": "^7.6.3",
+    "npm-run-all": "^4.1.5",
+    "remark-cli": "^11.0.0",
+    "typescript": "^4.9.5",
+    "vitest": "^0.28.4"
+  },
+  "engines": {
+    "node": "^14.13.1 || >=16.0.0 || >=18.0.0"
+  }
+}

package/src/index.mjs

@@ -0,0 +1,119 @@
+/* eslint-disable no-process-exit */
+/* eslint no-console: 'off' */
+
+import detectPackageManager from 'which-pm-runs';
+import { execa } from 'execa';
+import fs from 'fs';
+import ora from 'ora';
+import picocolors from 'picocolors';
+import stripIndent from 'strip-indent';
+
+const DEFAULT_CONFIG_FILE = '.stylelintrc.json';
+
+const STYLELINT_CONFIG_PATHS = new Set([
+	'.stylelintrc',
+	'.stylelintrc.cjs',
+	'.stylelintrc.json',
+	'.stylelintrc.yaml',
+	'.stylelintrc.yml',
+	'.stylelintrc.js',
+	'stylelint.config.js',
+	'stylelint.config.cjs',
+]);
+
+/**
+ * @param {fs.PathLike} dir
+ */
+function getExistingConfigsInDirectory(dir) {
+	return fs.readdirSync(dir).filter((file) => STYLELINT_CONFIG_PATHS.has(file));
+}
+
+/**
+ * @param {fs.PathLike} dir
+ */
+function directoryHasPackageJson(dir) {
+	return fs.readdirSync(dir).some((file) => file === 'package.json');
+}
+
+/**
+ * @param {string} pkgManager
+ */
+function getInstallCommand(pkgManager) {
+	return pkgManager === 'npm' ? 'install' : 'add';
+}
+
+/**
+ * @param {string} cwd
+ * @param {string} pkgManager
+ */
+function createConfig(cwd, pkgManager) {
+	const spinner = ora('Creating config...').start();
+	const existingConfigs = getExistingConfigsInDirectory(cwd);
+
+	if (existingConfigs.length > 0) {
+		spinner.fail(
+			`Failed to create config:\nThe ${existingConfigs.join(
+				', ',
+			)} config(s) already exist. Remove them and then try again.`,
+		);
+		process.exit(1);
+	}
+
+	if (!directoryHasPackageJson(cwd)) {
+		spinner.fail(
+			`Failed to create config:\npackage.json was not found. Run "${pkgManager} init" and then try again.`,
+		);
+		process.exit(1);
+	}
+
+	try {
+		fs.writeFileSync(DEFAULT_CONFIG_FILE, '{ "extends": ["stylelint-config-standard"] }');
+	} catch (error) {
+		spinner.fail(`Failed to create config:\n${error}`);
+		process.exit(1);
+	}
+
+	spinner.succeed(`Created ${DEFAULT_CONFIG_FILE}.`);
+}
+
+/**
+ * @param {string} cwd
+ * @param {string} pkgManager
+ */
+async function installPackages(cwd, pkgManager) {
+	const spinner = ora('Installing packages...').start();
+
+	try {
+		await execa(
+			pkgManager,
+			[`${getInstallCommand(pkgManager)}`, '-D', 'stylelint', 'stylelint-config-standard'],
+			{ cwd },
+		);
+	} catch (error) {
+		spinner.fail(`Failed to install packages:\n${error}`);
+		process.exit(1);
+	}
+
+	spinner.succeed('Installed packages.');
+}
+
+function showNextSteps() {
+	console.log(
+		stripIndent(`
+			${picocolors.green(`You can now lint your CSS files using:
+			npx stylelint "**/*.css"`)}
+
+			${picocolors.dim(`We recommend customizing Stylelint:
+			https://stylelint.io/user-guide/customize/`)}
+		`),
+	);
+}
+
+export async function main() {
+	const pkgManager = detectPackageManager()?.name ?? 'npm';
+	const cwd = './';
+
+	createConfig(cwd, pkgManager);
+	await installPackages(cwd, pkgManager);
+	showNextSteps();
+}