@upleveled/preflight 1.23.8 → 2.1.0-0

package/src/checks/stylelint.ts

@@ -0,0 +1,48 @@
+import { sep } from 'node:path';
+import { execaCommand } from 'execa';
+import { LintResult } from 'stylelint';
+
+const errorKey = 'errored' as const;
+
+export const supportedStylelintFileExtensions = [
+  'css',
+  'sass',
+  'scss',
+  'less',
+  'js',
+  'tsx',
+  'jsx',
+];
+
+export const title = 'Stylelint';
+
+export default async function stylelintCheck() {
+  try {
+    await execaCommand(
+      `pnpm stylelint **/*.{${supportedStylelintFileExtensions.join(
+        ',',
+      )}} --max-warnings 0 --formatter json`,
+    );
+  } catch (error) {
+    const { stdout } = error as { stdout: string };
+
+    // If no Stylelint errors detected, throw the error
+    if (!new RegExp(`"${errorKey}":`).test(stdout)) {
+      throw error;
+    }
+
+    throw new Error(
+      `Stylelint problems found in the following files:
+        ${(JSON.parse(stdout) as LintResult[])
+          .filter((stylelintResult) => stylelintResult[errorKey] === true)
+          // Make paths relative to the project:
+          // before: /home/projects/random-color-generator-react-app/src/index.css
+          // after: src/index.css
+          .map(({ source }) => source!.replace(`${process.cwd()}${sep}`, ''))
+          .join('\n')}
+
+        Open these files in your editor - there should be problems to fix
+      `,
+    );
+  }
+}

package/src/checks/stylelintConfigIsValid.ts

@@ -0,0 +1,92 @@
+import { promises as fs } from 'node:fs';
+import { createRequire } from 'node:module';
+import { execaCommand } from 'execa';
+import readdirp from 'readdirp';
+import semver from 'semver';
+import { supportedStylelintFileExtensions } from './stylelint';
+
+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 older than the latest version ${remoteVersion} - upgrade by running:
+
+      pnpm add 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 delete the file if it exists and reinstall the config using the instructions on https://www.npmjs.com/package/eslint-config-upleveled
+      `,
+    );
+  }
+
+  if (!stylelintConfigMatches) {
+    throw new Error(
+      `Your stylelint.config.cjs file does not match the configuration file template - please delete the file and 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: supportedStylelintFileExtensions.map(
+      (fileExtension) => `*.${fileExtension}`,
+    ),
+  })) {
+    const fileContents = await fs.readFile(path, 'utf-8');
+    if (fileContents.includes('stylelint-disable')) {
+      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
+      `,
+    );
+  }
+}

package/src/checks/useSinglePackageManager.ts

@@ -4,11 +4,13 @@ import commandExample from '../util/commandExample';
 export const title = 'Use single package manager';
 
 export default async function useSinglePackageManager() {
-  const { stdout } = await execaCommand('git ls-files package-lock.json');
+  const { stdout } = await execaCommand(
+    'git ls-files package-lock.json yarn.lock',
+  );
 
   if (stdout !== '') {
     throw new Error(
-      `package-lock.json file committed to Git. Remove it with:
+      `package-lock.json or yarn.lock file committed to Git. Remove it with:
 
         ${commandExample('git rm --cached <filename>')}
 
@@ -16,9 +18,9 @@ export default async function useSinglePackageManager() {
 
         ${commandExample('rm <filename>')}
 
-        The presence of this file indicates that npm was incorrectly used in addition to Yarn (eg. an "npm install" command was run). In order to avoid issues with the state of the yarn.lock file, we suggest also forcing regeneration this file with the following command:
+        The presence of this file indicates that another package manager was used in addition to pnpm (eg. "npm install" or "yarn add" was run). In order to avoid issues with the state of the pnpm-lock.yaml file, we suggest also forcing regeneration this file with the following command:
 
-        ${commandExample('yarn --force')}
+        ${commandExample('pnpm install --force')}
       `,
     );
   }

package/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 stylelint from './checks/stylelint.js';
+import * as stylelintConfigIsValid from './checks/stylelintConfigIsValid.js';
 import * as useSinglePackageManager from './checks/useSinglePackageManager.js';
 import { CtxParam } from './types/CtxParam.js';
 import { TaskParam } from './types/TaskParam.js';
@@ -20,6 +22,8 @@ import {
   projectPackageJson,
 } from './util/packageJson.js';
 
+const projectDependencies = projectPackageJson.dependencies || {};
+
 console.log(`🚀 UpLeveled Preflight v${preflightPackageJson.version}`);
 
 const listrTasks = [
@@ -42,8 +46,7 @@ const listrTasks = [
     title: 'No dependency problems',
     task: (ctx: CtxParam, task: TaskParam): Listr =>
       task.newListr([
-        ...(!projectPackageJson.dependencies ||
-        !Object.keys(projectPackageJson.dependencies).includes('next')
+        ...(!Object.keys(projectDependencies).includes('next')
           ? []
           : [
               {
@@ -67,10 +70,22 @@ const listrTasks = [
 
   // Linting
   eslint,
+  ...(!(
+    '@upleveled/react-scripts' in projectDependencies ||
+    'next' in projectDependencies
+  )
+    ? []
+    : [stylelint]),
   prettier,
 
   // Version and configuration checks
   eslintConfigIsValid,
+  ...(!(
+    '@upleveled/react-scripts' in projectDependencies ||
+    'next' in projectDependencies
+  )
+    ? []
+    : [stylelintConfigIsValid]),
   preflightIsLatestVersion,
 ].map((module) => {
   if ('task' in module) return module;

package/src/util/preflightBinPath.ts

@@ -2,7 +2,7 @@ import { dirname } from 'node:path';
 import { fileURLToPath } from 'node:url';
 import { execaCommand } from 'execa';
 
-const { stdout: preflightBinPath } = await execaCommand(`yarn bin`, {
+const { stdout: preflightBinPath } = await execaCommand(`pnpm bin`, {
   cwd: dirname(fileURLToPath(import.meta.url)),
 });
 

package/dist/__tests__/fixtures/__temp/react-passing/script.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/__tests__/fixtures/__temp/react-passing/src/App.d.ts

@@ -1,2 +0,0 @@
-export default App;
-declare function App(): JSX.Element;

package/dist/__tests__/fixtures/__temp/react-passing/src/App.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/__tests__/fixtures/__temp/react-passing/src/index.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/__tests__/fixtures/__temp/react-passing/src/reportWebVitals.d.ts

@@ -1,2 +0,0 @@
-export default reportWebVitals;
-declare function reportWebVitals(onPerfEntry: import('web-vitals').ReportCallback | undefined): void;

package/dist/__tests__/fixtures/__temp/react-passing/src/setupTests.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/bin/preflight.d.ts

@@ -1,2 +0,0 @@
-#!/usr/bin/env node
-export {};