@adbayb/stack 0.0.0-next-711fb0a → 0.0.0-next-fd6185e

package/bin/index.js

@@ -3,6 +3,6 @@
 import { join } from "node:path";
 import { createRequire } from "node:module";
 
-const pkg = createRequire(import.meta.url)("../package.json");
+const package_ = createRequire(import.meta.url)("../package.json");
 
-import(join("..", pkg.exports["."].default));
+import(join("..", package_.exports["."].default));

package/configs/eslint/index.js

@@ -1,3 +1,4 @@
+import { config as unicornConfig } from "./presets/unicorn.js";
 import { config as uncategorizedConfig } from "./presets/uncategorized.js";
 import { config as typescriptConfig } from "./presets/typescript.js";
 import { config as testConfig } from "./presets/test.js";
@@ -24,6 +25,7 @@ export default createConfig(
 	...sonarConfig,
 	...stylisticConfig,
 	...testConfig,
+	...unicornConfig,
 	...uncategorizedConfig,
 	...overridableConfig,
 );

package/configs/eslint/presets/eslint.js

@@ -66,13 +66,16 @@ export const config = [
 			"no-regex-spaces": "error",
 			"no-restricted-syntax": [
 				"error",
-				// https://medium.com/@hbarcelos/why-i-banned-null-from-my-js-code-and-why-you-should-too-13df90323cfa
+				/*
+				 * https://medium.com/@hbarcelos/why-i-banned-null-from-my-js-code-and-why-you-should-too-13df90323cfa
+				 * https://www.youtube.com/watch?v=PSGEjv3Tqo0&t=561s
+				 */
 				{
-					message: "Use undefined instead of null",
+					message: "Use `undefined` instead of `null`.",
 					selector: "VariableDeclarator > Literal[raw='null']",
 				},
 				{
-					message: "Use undefined instead of null",
+					message: "Use `undefined` instead of `null`.",
 					selector: "AssignmentExpression > Literal[raw='null']",
 				},
 			],

package/configs/eslint/presets/import.js

@@ -17,7 +17,6 @@ export const config = [
 			"import-x/no-absolute-path": "error",
 			"import-x/no-amd": "error",
 			"import-x/no-anonymous-default-export": "error",
-			"import-x/no-commonjs": "error",
 			"import-x/no-cycle": "error",
 			"import-x/no-default-export": "error",
 			"import-x/no-deprecated": "error",

package/configs/eslint/presets/sonar.js

@@ -196,7 +196,6 @@ export const config = [
 			"sonarjs/sonar-no-misleading-character-class": "error",
 			"sonarjs/sonar-no-regex-spaces": "error",
 			// "sonarjs/sonar-no-unused-class-component-methods": "error", // Disabled since it involves `eslint-plugin-react` activation
-			"sonarjs/sonar-prefer-regexp-exec": "error",
 			"sonarjs/sql-queries": "error",
 			"sonarjs/stable-tests": "error",
 			"sonarjs/stateful-regex": "error",

package/configs/eslint/presets/unicorn.js

@@ -0,0 +1,116 @@
+import unicornPlugin from "eslint-plugin-unicorn";
+
+import { JAVASCRIPT_LIKE_EXTENSIONS } from "../constants.js";
+
+export const config = [
+	{
+		files: JAVASCRIPT_LIKE_EXTENSIONS,
+		plugins: {
+			unicorn: unicornPlugin,
+		},
+		rules: {
+			"unicorn/better-regex": "error",
+			"unicorn/catch-error-name": [
+				"error",
+				{
+					name: "error",
+				},
+			],
+			"unicorn/consistent-empty-array-spread": "error",
+			"unicorn/consistent-existence-index-check": "error",
+			"unicorn/consistent-function-scoping": "error",
+			"unicorn/custom-error-definition": "error",
+			"unicorn/error-message": "error",
+			"unicorn/escape-case": "error",
+			"unicorn/expiring-todo-comments": "error",
+			"unicorn/explicit-length-check": "error",
+			"unicorn/filename-case": [
+				"error",
+				{
+					cases: {
+						camelCase: true,
+						pascalCase: true,
+					},
+				},
+			],
+			"unicorn/new-for-builtins": "error",
+			"unicorn/no-abusive-eslint-disable": "error",
+			"unicorn/no-array-callback-reference": "error",
+			"unicorn/no-array-push-push": "error",
+			"unicorn/no-await-in-promise-methods": "error",
+			"unicorn/no-console-spaces": "error",
+			"unicorn/no-document-cookie": "error",
+			"unicorn/no-empty-file": "error",
+			"unicorn/no-for-loop": "error",
+			"unicorn/no-instanceof-array": "error",
+			"unicorn/no-invalid-fetch-options": "error",
+			"unicorn/no-invalid-remove-event-listener": "error",
+			"unicorn/no-length-as-slice-end": "error",
+			"unicorn/no-new-buffer": "error",
+			"unicorn/no-object-as-default-parameter": "error",
+			"unicorn/no-process-exit": "error",
+			"unicorn/no-single-promise-in-promise-methods": "error",
+			"unicorn/no-static-only-class": "error",
+			"unicorn/no-typeof-undefined": "error",
+			"unicorn/no-unnecessary-polyfills": "error",
+			"unicorn/no-unreadable-array-destructuring": "error",
+			"unicorn/no-unreadable-iife": "error",
+			"unicorn/no-unused-properties": "error",
+			"unicorn/no-useless-fallback-in-spread": "error",
+			"unicorn/no-useless-length-check": "error",
+			"unicorn/no-useless-promise-resolve-reject": "error",
+			"unicorn/no-useless-spread": "error",
+			"unicorn/no-zero-fractions": "error",
+			"unicorn/number-literal-case": "error",
+			"unicorn/prefer-add-event-listener": "error",
+			"unicorn/prefer-array-find": "error",
+			"unicorn/prefer-array-flat": "error",
+			"unicorn/prefer-array-flat-map": "error",
+			"unicorn/prefer-array-index-of": "error",
+			"unicorn/prefer-array-some": "error",
+			"unicorn/prefer-blob-reading-methods": "error",
+			"unicorn/prefer-code-point": "error",
+			"unicorn/prefer-date-now": "error",
+			"unicorn/prefer-dom-node-append": "error",
+			"unicorn/prefer-dom-node-remove": "error",
+			"unicorn/prefer-dom-node-text-content": "error",
+			"unicorn/prefer-event-target": "error",
+			"unicorn/prefer-export-from": "error",
+			"unicorn/prefer-global-this": "error",
+			"unicorn/prefer-includes": "error",
+			"unicorn/prefer-keyboard-event-key": "error",
+			"unicorn/prefer-logical-operator-over-ternary": "error",
+			"unicorn/prefer-math-min-max": "error",
+			"unicorn/prefer-math-trunc": "error",
+			"unicorn/prefer-modern-dom-apis": "error",
+			"unicorn/prefer-modern-math-apis": "error",
+			"unicorn/prefer-module": "error",
+			"unicorn/prefer-native-coercion-functions": "error",
+			"unicorn/prefer-negative-index": "error",
+			"unicorn/prefer-number-properties": "error",
+			"unicorn/prefer-object-from-entries": "error",
+			"unicorn/prefer-optional-catch-binding": "error",
+			"unicorn/prefer-prototype-methods": "error",
+			"unicorn/prefer-query-selector": "error",
+			"unicorn/prefer-reflect-apply": "error",
+			"unicorn/prefer-regexp-test": "error",
+			"unicorn/prefer-set-has": "error",
+			"unicorn/prefer-set-size": "error",
+			"unicorn/prefer-spread": "error",
+			"unicorn/prefer-string-raw": "error",
+			"unicorn/prefer-string-replace-all": "error",
+			"unicorn/prefer-string-slice": "error",
+			"unicorn/prefer-string-starts-ends-with": "error",
+			"unicorn/prefer-string-trim-start-end": "error",
+			"unicorn/prefer-structured-clone": "error",
+			"unicorn/prefer-switch": "error",
+			"unicorn/prefer-ternary": "error",
+			"unicorn/prefer-top-level-await": "error",
+			"unicorn/prefer-type-error": "error",
+			"unicorn/prevent-abbreviations": "error",
+			"unicorn/relative-url-style": ["error", "always"],
+			"unicorn/require-array-join-separator": "error",
+			"unicorn/require-number-to-fixed-digits-argument": "error",
+		},
+	},
+];

package/dist/index.js

@@ -96,7 +96,7 @@ const getStackCommand = (command, isNodeRuntime = true)=>{
 const hasDependency = (packageName)=>{
     return Boolean(require.resolve(packageName));
 };
-const setPkgManager = async ()=>{
+const setPackageManager = async ()=>{
     return helpers.exec("corepack enable");
 };
 const request = {
@@ -117,31 +117,30 @@ const eslint = (options)=>async (files = [])=>{
             eslintFiles.push(".");
         } else {
             eslintFiles = files.filter((file)=>{
-                return ESLINT_EXTENSIONS.some((ext)=>file.endsWith(ext));
+                return ESLINT_EXTENSIONS.some((extension)=>file.endsWith(extension));
             });
-            if (eslintFiles.length === 0) return Promise.resolve();
+            if (eslintFiles.length === 0) return;
         }
-        const args = [
+        const arguments_ = [
             ...eslintFiles
         ];
-        args.push("--cache");
-        args.push(`--cache-location ${resolveFromProjectDirectory("node_modules/.cache/.eslintcache")}`);
-        // @note: prevent errors when no matched file is found
-        args.push("--no-error-on-unmatched-pattern");
+        arguments_.push("--cache", `--cache-location ${resolveFromProjectDirectory("node_modules/.cache/.eslintcache")}`, "--no-error-on-unmatched-pattern");
         if (options.isFixMode) {
-            args.push("--fix");
+            arguments_.push("--fix");
         }
         try {
-            return await helpers.exec(`eslint ${args.join(" ")}`);
+            return await helpers.exec(`eslint ${arguments_.join(" ")}`);
         } catch (error) {
             throw createError("eslint", error);
         }
     };
-const turbo = async (command, options = {
-    hasLiveOutput: true
-})=>{
+const turbo = async (command, options = {})=>{
     try {
-        return await helpers.exec(`turbo run ${command}`, options);
+        const { hasLiveOutput = true, ...restOptions } = options;
+        return await helpers.exec(`turbo run ${command}`, {
+            ...restOptions,
+            hasLiveOutput
+        });
     } catch (error) {
         throw createError("turbo", error);
     }
@@ -168,9 +167,7 @@ const ESLINT_EXTENSIONS = [
     "mdx"
 ];
 
-var version = "0.0.0-next-711fb0a";
-
-const VERSION = version;
+var version = "0.0.0-next-fd6185e";
 
 const createWatchCommand = (program)=>{
     program.command({
@@ -286,19 +283,17 @@ const fixFormatting = async (files)=>{
             return !PRETTIER_IGNORE_FILES.some((filename)=>file.endsWith(filename)) && // The root `README.md` file is ignored to prevent error due to its symbolic link nature when specified explicitly as a file
             file !== "README.md";
         });
-        if (prettierFiles.length === 0) return Promise.resolve();
+        if (prettierFiles.length === 0) return;
     }
-    const args = [
+    const arguments_ = [
         ...prettierFiles
     ];
     if (existsSync(resolveFromProjectDirectory(".gitignore"))) {
-        args.push("--ignore-path .gitignore");
+        arguments_.push("--ignore-path .gitignore");
     }
-    args.push("--write");
-    args.push("--ignore-unknown");
-    args.push("--no-error-on-unmatched-pattern");
+    arguments_.push("--write", "--ignore-unknown", "--no-error-on-unmatched-pattern");
     try {
-        return await helpers.exec(`prettier ${args.join(" ")}`);
+        return await helpers.exec(`prettier ${arguments_.join(" ")}`);
     } catch (error) {
         throw createError("prettier", error);
     }
@@ -336,7 +331,7 @@ const createCreateCommand = (program)=>{
     }).task({
         handler () {
             botMessage({
-                title: `I'm Stack v${VERSION}, your bot assistant`,
+                title: `I'm Stack v${version}, your bot assistant`,
                 description: "I can guarantee you a project creation in under 1 minute 🚀",
                 type: "information"
             });
@@ -420,21 +415,21 @@ const createCreateCommand = (program)=>{
     }).task({
         label: label$2("Set up the package manager"),
         async handler () {
-            await setPkgManager();
+            await setPackageManager();
         }
     }).task({
         label: label$2("Install dependencies"),
         async handler ({ data }) {
-            const localDevDependencies = [
+            const localDevelopmentDependencies = [
                 "quickbundle",
                 "vitest"
             ];
-            const globalDevDependencies = [
+            const globalDevelopmentDependencies = [
                 "@adbayb/stack"
             ];
             try {
-                await helpers.exec(`pnpm add ${globalDevDependencies.join(" ")} --save-dev --ignore-workspace-root-check`);
-                await helpers.exec(`pnpm add ${localDevDependencies.join(" ")} --save-dev --filter ${data.projectName}`);
+                await helpers.exec(`pnpm add ${globalDevelopmentDependencies.join(" ")} --save-dev --ignore-workspace-root-check`);
+                await helpers.exec(`pnpm add ${localDevelopmentDependencies.join(" ")} --save-dev --filter ${data.projectName}`);
                 await helpers.exec("pnpm install");
             } catch (error) {
                 throw createError("pnpm", error);
@@ -476,7 +471,7 @@ const label$2 = (message)=>`${message} 🔨`;
     const projectRootPath = resolveFromProjectDirectory("./");
     const templateExpressionRegExp = /{{(.*?)}}/g;
     const evaluate = (content)=>{
-        return content.replace(templateExpressionRegExp, (_, key)=>dataModel[key] || "");
+        return content.replaceAll(templateExpressionRegExp, (_, key)=>dataModel[key] || "");
     };
     /** Copy the template before mutations. */ cpSync(templateRootPath, projectRootPath, {
         force: true,
@@ -489,10 +484,10 @@ const label$2 = (message)=>`${message} 🔨`;
         writeFileSync(projectFilePath, content, "utf-8");
     });
     /** Template folder mutations. */ new fdir().withBasePath().onlyDirs().filter((path)=>{
-        return Boolean(templateExpressionRegExp.exec(path));
+        return templateExpressionRegExp.test(path);
     }).crawl(projectRootPath).sync()// Re-order from longest to lowest path length to apply first renaming operations on deepest file structure
     .sort((a, b)=>b.length - a.length).forEach((templateFolderPath)=>{
-        const newPath = templateFolderPath.replace(templateExpressionRegExp, (_, dataModelKey)=>{
+        const newPath = templateFolderPath.replaceAll(templateExpressionRegExp, (_, dataModelKey)=>{
             return dataModel[dataModelKey];
         });
         renameSync(templateFolderPath, newPath);
@@ -541,7 +536,8 @@ const isDirectoryExistAndNotEmpty = (path)=>{
     return existsSync(path) && readdirSync(path).length > 0;
 };
 const retrieveIgnoredFiles = async ()=>{
-    const rawFiles = await helpers.exec(`git clean -fdXn | grep -v '${PRESERVE_FILES.join("\\|")}' | cut -c 14-`);
+    const excludedFiles = PRESERVE_FILES.join(String.raw`\|`);
+    const rawFiles = await helpers.exec(`git clean -fdXn | grep -v '${excludedFiles}' | cut -c 14-`);
     return rawFiles.split(/\n/).filter(Boolean);
 };
 const PRESERVE_FILES = [
@@ -559,25 +555,25 @@ const checkTypes = async ()=>{
 const checkPackages = async ()=>{
     const stdout = await helpers.exec("pnpm recursive ls --json");
     const checkPackagesVersionMismatch = createPackagesVersionMismatchChecker();
-    const packages = JSON.parse(stdout).map((pkg)=>{
-        const pkgPath = join(pkg.path, "package.json");
-        assert(pkg.name, ()=>createPackageError(`\`${pkgPath}\` must have a name field.`));
-        const pkgContent = require(pkgPath);
-        const peerDependencies = pkgContent.peerDependencies ?? {};
-        const devDependencies = pkgContent.devDependencies ?? {};
-        const dependencies = pkgContent.dependencies ?? {};
+    const packages = JSON.parse(stdout).map((package_)=>{
+        const packagePath = join(package_.path, "package.json");
+        assert(package_.name, ()=>createPackageError(`\`${packagePath}\` must have a name field.`));
+        const packageContent = require(packagePath);
+        const peerDependencies = packageContent.peerDependencies ?? {};
+        const devDependencies = packageContent.devDependencies ?? {};
+        const dependencies = packageContent.dependencies ?? {};
         return {
-            name: pkg.name,
+            name: package_.name,
             dependencies,
             devDependencies,
             peerDependencies
         };
     });
-    for (const pkg of packages){
+    for (const package_ of packages){
         // Check version mismatches to guarantee a single copy for a given package in the monorepo (use case: prevent singleton-like issues with React contexts)
-        checkPackagesVersionMismatch(pkg);
+        checkPackagesVersionMismatch(package_);
         // Check version range accordingly to our dependency guidelines (ie. dev dependencies must be pinned and dependencies must have caret)
-        checkPackagesVersionRange(pkg);
+        checkPackagesVersionRange(package_);
     }
 };
 const checkPackagesVersionRange = ({ name, dependencies, devDependencies, peerDependencies })=>{
@@ -587,13 +583,11 @@ const checkPackagesVersionRange = ({ name, dependencies, devDependencies, peerDe
             name: dependencyName,
             consumedBy: name
         });
-        if (version !== "workspace:*" && !/^\d/.exec(version)) throw createPackageError(`As a dev dependency, \`${dependencyName}\` version must be fixed (or set as "workspace:*" for local packages) to reduce accidental breaking change risks due to an implicit semver upgrade.`, {
+        if (version !== "workspace:*" && !/^\d/.test(version)) throw createPackageError(`As a dev dependency, \`${dependencyName}\` version must be fixed (or set as "workspace:*" for local packages) to reduce accidental breaking change risks due to an implicit semver upgrade.`, {
             name: dependencyName,
             consumedBy: name
         });
     }
-    const isPreReleaseVersion = (version)=>/\d+\.\d+\.\d+-(alpha|beta|experimental|next|rc).*/.exec(version);
-    const hasNoCaret = (version)=>!isPreReleaseVersion(version) && !/^\^/.exec(version);
     for (const dependencyName of Object.keys(dependencies)){
         const version = dependencies[dependencyName];
         assertVersion(version, {
@@ -623,12 +617,12 @@ const checkPackagesVersionRange = ({ name, dependencies, devDependencies, peerDe
 };
 const createPackagesVersionMismatchChecker = ()=>{
     const monorepoDependencies = new Map();
-    const monorepoDevDependencies = new Map();
-    const lint = (pkg, type)=>{
-        const pkgName = pkg.name;
-        const isDev = type === "development";
-        const store = isDev ? monorepoDevDependencies : monorepoDependencies;
-        const dependencies = isDev ? pkg.devDependencies : pkg.dependencies;
+    const monorepoDevelopmentDependencies = new Map();
+    const lint = (package_, type)=>{
+        const packageName = package_.name;
+        const isDevelopment = type === "development";
+        const store = isDevelopment ? monorepoDevelopmentDependencies : monorepoDependencies;
+        const dependencies = isDevelopment ? package_.devDependencies : package_.dependencies;
         for (const dependencyName of Object.keys(dependencies)){
             const depVersion = dependencies[dependencyName];
             if (!depVersion) continue;
@@ -641,14 +635,14 @@ const createPackagesVersionMismatchChecker = ()=>{
             if (!isSameMonorepoVersion) {
                 throw createPackageError(`Mismatched versions: received version \`${depVersion}\` while others use \`${storedVersion}\`. To prevent issues with singleton-like code (React contexts, ...), please make sure to update all packages to use the same \`${dependencyName}\` version (either \`${storedVersion}\` or \`${depVersion}\`.`, {
                     name: dependencyName,
-                    consumedBy: pkgName
+                    consumedBy: packageName
                 });
             }
         }
     };
-    return (pkg)=>{
-        lint(pkg, "development");
-        lint(pkg, "production");
+    return (package_)=>{
+        lint(package_, "development");
+        lint(package_, "production");
     };
 };
 const createPackageError = (message, context)=>{
@@ -660,6 +654,8 @@ function assertVersion(version, { name, consumedBy }) {
             consumedBy
         }));
 }
+const isPreReleaseVersion = (version)=>/\d+\.\d+\.\d+-(alpha|beta|experimental|next|rc).*/.exec(version);
+const hasNoCaret = (version)=>!isPreReleaseVersion(version) && !version.startsWith("^");
 
 const checkLinter = eslint({
     isFixMode: false
@@ -759,7 +755,7 @@ const createProgram = (...commandFactories)=>{
                 type: "error"
             });
         },
-        version: VERSION
+        version: version
     });
     for (const commandBuilder of commandFactories){
         commandBuilder(program);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adbayb/stack",
-  "version": "0.0.0-next-711fb0a",
+  "version": "0.0.0-next-fd6185e",
   "description": "My opinionated JavaScript-based toolchain",
   "publishConfig": {
     "access": "public"
@@ -67,6 +67,7 @@
     "eslint-plugin-react": "^7.37.2",
     "eslint-plugin-sonarjs": "^2.0.4",
     "eslint-plugin-sort-keys-custom-order": "^2.2.0",
+    "eslint-plugin-unicorn": "^56.0.0",
     "eslint": "^9.14.0",
     "fdir": "^6.4.2",
     "globals": "^15.12.0",