Add Stylelint checks and checks output consistency

__tests__/__snapshots__/e2e.test.ts.snap

@@ -2,20 +2,6 @@
 
 exports[`Passes in the react-passing test project 1`] = `
 "🚀 UpLeveled Preflight
-[COMPLETED] All changes committed to Git
-[COMPLETED] ESLint
-[COMPLETED] ESLint config is latest version
-[COMPLETED] GitHub repo has deployed project link under About
-[COMPLETED] No dependencies without types
-[COMPLETED] No dependency problems
-[COMPLETED] No extraneous files committed to Git
-[COMPLETED] No secrets committed to Git
-[COMPLETED] No unused dependencies
-[COMPLETED] Preflight is latest version
-[COMPLETED] Prettier
-[COMPLETED] Project folder name matches correct format
-[COMPLETED] Use single package manager
-[COMPLETED] node_modules/ folder ignored in Git
 [STARTED] All changes committed to Git
 [STARTED] ESLint
 [STARTED] ESLint config is latest version
@@ -28,8 +14,26 @@ exports[`Passes in the react-passing test project 1`] = `
 [STARTED] Preflight is latest version
 [STARTED] Prettier
 [STARTED] Project folder name matches correct format
+[STARTED] Stylelint
+[STARTED] Stylelint config is latest version
 [STARTED] Use single package manager
-[STARTED] node_modules/ folder ignored in Git"
+[STARTED] node_modules/ folder ignored in Git
+[SUCCESS] All changes committed to Git
+[SUCCESS] ESLint
+[SUCCESS] ESLint config is latest version
+[SUCCESS] GitHub repo has deployed project link under About
+[SUCCESS] No dependencies without types
+[SUCCESS] No dependency problems
+[SUCCESS] No extraneous files committed to Git
+[SUCCESS] No secrets committed to Git
+[SUCCESS] No unused dependencies
+[SUCCESS] Preflight is latest version
+[SUCCESS] Prettier
+[SUCCESS] Project folder name matches correct format
+[SUCCESS] Stylelint
+[SUCCESS] Stylelint config is latest version
+[SUCCESS] Use single package manager
+[SUCCESS] node_modules/ folder ignored in Git"
 `;
 
 exports[`Passes in the react-passing test project 2`] = `""`;

src/checks/stylelingConfigIsValid.ts

@@ -0,0 +1,91 @@
+import { promises as fs } from 'node:fs';
+import { createRequire } from 'node:module';
+import { execaCommand } from 'execa';
+import readdirp from 'readdirp';
+import semver from 'semver';
+
+const require = createRequire(`${process.cwd()}/`);
+
+export const title = 'Stylelint config is latest version';
+
+export default async function stylelintConfigIsValid() {
+  const { stdout: remoteVersion } = await execaCommand(
+    'npm show stylelint-config-upleveled version',
+  );
+
+  let localVersion;
+
+  try {
+    const stylelintConfigPackageJsonPath = require.resolve(
+      'stylelint-config-upleveled/package.json',
+    );
+
+    localVersion = JSON.parse(
+      await fs.readFile(stylelintConfigPackageJsonPath, 'utf-8'),
+    ).version;
+  } catch (err) {}
+
+  if (typeof localVersion === 'undefined') {
+    throw new Error(
+      `The UpLeveled Stylelint config has not been installed. Please install using the instructions on https://www.npmjs.com/package/eslint-config-upleveled
+      `,
+    );
+  }
+
+  if (semver.gt(remoteVersion, localVersion)) {
+    throw new Error(
+      `Your current version of the UpLeveled styleLint config (${localVersion}) is out of date. The latest version is ${remoteVersion}. Upgrade by running:
+
+      pnpm install stylelint-config-upleveled@${remoteVersion}`,
+    );
+  }
+
+  let stylelintConfigMatches;
+
+  try {
+    stylelintConfigMatches =
+      (await fs.readFile('./stylelint.config.cjs', 'utf-8')).trim() ===
+      `/** @type { import('stylelint').Config } */
+const config = {
+  extends: ['stylelint-config-upleveled'],
+};
+
+module.exports = config;`;
+  } catch (err) {
+    throw new Error(
+      `Error reading your stylelint.config.cjs file. Please reinstall the config using the instructions on https://www.npmjs.com/package/eslint-config-upleveled
+      `,
+    );
+  }
+
+  if (!stylelintConfigMatches) {
+    throw new Error(
+      `Your Stylelint config file stylelint.config.cjs does not match the configuration file template. Please reinstall the config using the instructions on https://www.npmjs.com/package/eslint-config-upleveled
+      `,
+    );
+  }
+
+  const stylelintDisableOccurrences = [];
+
+  for await (const { path } of readdirp('.', {
+    directoryFilter: ['!.git', '!.next', '!node_modules'],
+    fileFilter: ['*.css', '*.scss', '*.sass', '*.less', '*.js', '*.tsx'],
+  })) {
+    const fileContents = await fs.readFile(path, 'utf-8');
+    if (
+      /stylelint-disable|stylelint [a-z0-9@/-]+: (0|off)/.test(fileContents)
+    ) {
+      stylelintDisableOccurrences.push(path);
+    }
+  }
+
+  if (stylelintDisableOccurrences.length > 0) {
+    throw new Error(
+      `Stylelint has been disabled in the following files:
+        ${stylelintDisableOccurrences.join('\n')}
+
+        Remove all comments disabling or modifying Stylelint rule configuration (eg. stylelint-disable and stylelint-disable-next-line comments) and fix the problems.
+      `,
+    );
+  }
+}

src/checks/stylelint.ts

@@ -0,0 +1,40 @@
+import { execaCommand } from 'execa';
+
+export const title = 'Stylelint';
+
+export default async function stylelintCheck() {
+  try {
+    await execaCommand(
+      'pnpm stylelint **/*.{css,scss,less,js,tsx} --max-warnings 0',
+    );
+  } catch (error) {
+    const { stdout } = error as { stdout: string };
+    const lines = stdout.split('\n');
+
+    // If no Stylelint problems detected, throw the error
+    if (
+      !/^\d+ problems? \(\d+ errors?, \d+ warnings\)$/.test(
+        lines[lines.length - 2]!,
+      )
+    ) {
+      throw error;
+    }
+
+    throw new Error(
+      `Stylelint problems found in the following files:
+
+      ${lines
+        .filter((line) => {
+          return (
+            line !== '' &&
+            !line.match(/^\d+ problems? \(\d+ errors?, \d+ warnings\)|\d+:\d+/)
+          );
+        })
+        .map((line) => `${process.cwd()}/${line}`)
+        .join('\n')}
+
+        Open these files in your editor - there should be problems to fix.
+      `,
+    );
+  }
+}

src/index.ts

@@ -12,6 +12,8 @@ import * as noSecretsCommittedToGit from './checks/noSecretsCommittedToGit.js';
 import * as preflightIsLatestVersion from './checks/preflightIsLatestVersion.js';
 import * as prettier from './checks/prettier.js';
 import * as projectFolderNameMatchesCorrectFormat from './checks/projectFolderNameMatchesCorrectFormat.js';
+import * as stylelintConfigIsValid from './checks/stylelingConfigIsValid.js';
+import * as stylelint from './checks/stylelint.js';
 import * as useSinglePackageManager from './checks/useSinglePackageManager.js';
 import { CtxParam } from './types/CtxParam.js';
 import { TaskParam } from './types/TaskParam.js';
@@ -67,10 +69,12 @@ const listrTasks = [
 
   // Linting
   eslint,
+  stylelint,
   prettier,
 
   // Version and configuration checks
   eslintConfigIsValid,
+  stylelintConfigIsValid,
   preflightIsLatestVersion,
 ].map((module) => {
   if ('task' in module) return module;
@@ -87,6 +91,6 @@ await new Listr(listrTasks, {
     removeEmptyLines: false,
     formatOutput: 'wrap',
   },
-  fallbackRenderer: 'verbose',
+
   concurrent: 5,
 }).run();