@adbayb/stack 0.0.0-next-d23a669 → 0.0.0-next-912a585

package/config/eslint/README.md

@@ -1,7 +1,39 @@
 <br>
 <div align="center">
-    <h1>@adbayb/stack/eslint</h1>
+    <h1>@adbayb/stack/typescript</h1>
     <strong>My opinionated linter standards</strong>
 </div>
 <br>
 <br>
+
+## ✨ Features
+
+This package offers opinionated but extensible **[ESLint](https://eslint.org/)** configurations to align logical and stylistic rules across my projects.
+
+It allows to:
+
+- Make collaboration across my projects effective (including onboarding with a consistent look and writing patterns).
+- Include a minimum viable and required set of rules to foster maintainable, testable, secure, and green code over time.
+- Accelerate development by reusing common configuration and convention defaults.
+
+<br />
+
+## 🚀 Quick Start
+
+### 1️⃣ Installation
+
+At the root level of your project, run the following command:
+
+```bash
+pnpm add @adbayb/stack --save-dev --workspace-root
+```
+
+### 2️⃣ Usage
+
+Create a `eslint.config.js` file and include the following:
+
+```ts
+export { default } from "@adbayb/stack/eslint";
+```
+
+<br />

package/config/eslint/index.js

@@ -1,6 +1,7 @@
 import { config as uncategorizedConfig } from "./presets/uncategorized.js";
 import { config as typescriptConfig } from "./presets/typescript.js";
 import { config as testConfig } from "./presets/test.js";
+import { config as stylisticConfig } from "./presets/stylistic.js";
 import { config as sonarConfig } from "./presets/sonar.js";
 import { config as reactConfig } from "./presets/react.js";
 import { config as overridableConfig } from "./presets/overridable.js";
@@ -17,10 +18,11 @@ export default createConfig(
 	...eslintConfig,
 	...typescriptConfig,
 	...importConfig,
-	...nodeConfig,
-	...sonarConfig,
 	...jsdocConfig,
+	...nodeConfig,
 	...reactConfig,
+	...sonarConfig,
+	...stylisticConfig,
 	...testConfig,
 	...uncategorizedConfig,
 	...overridableConfig,

package/config/eslint/presets/eslint.js

@@ -5,8 +5,10 @@ import {
 
 export const config = [
 	{
-		// Specific ESLint rules for javascript-only files (as they're already handled for TypeScript files by the transpiler):
-		// This rule list is taken from https://typescript-eslint.io/users/configs/#recommended
+		/*
+		 * Specific ESLint rules for javascript-only files (as they're already handled for TypeScript files by the transpiler):
+		 * This rule list is taken from https://typescript-eslint.io/users/configs/#recommended
+		 */
 		files: JAVASCRIPT_EXTENSIONS,
 		rules: {
 			"constructor-super": "error", // ts(2335) & ts(2377)
@@ -84,54 +86,6 @@ export const config = [
 			"no-var": "error",
 			"no-with": "error",
 			"object-shorthand": ["error", "always"],
-			"padding-line-between-statements": [
-				"error",
-				{
-					blankLine: "always",
-					next: "*",
-					prev: "*",
-				},
-				{
-					blankLine: "never",
-					next: ["const", "let", "var"],
-					prev: ["const", "let", "var"],
-				},
-				{
-					blankLine: "never",
-					next: ["case", "default"],
-					prev: ["case", "default"],
-				},
-				{
-					blankLine: "always",
-					next: ["const", "let", "var"],
-					prev: ["multiline-const", "multiline-let", "multiline-var"],
-				},
-				{
-					blankLine: "always",
-					next: ["multiline-const", "multiline-let", "multiline-var"],
-					prev: ["const", "let", "var"],
-				},
-				{
-					blankLine: "any",
-					next: ["expression"],
-					prev: ["expression"],
-				},
-				{
-					blankLine: "any",
-					next: ["const", "let", "var"],
-					prev: ["cjs-import"],
-				},
-				{
-					blankLine: "any",
-					next: ["cjs-import", "import"],
-					prev: ["cjs-import", "import"],
-				},
-				{
-					blankLine: "any",
-					next: ["cjs-export", "export"],
-					prev: ["cjs-export", "export"],
-				},
-			],
 			"prefer-arrow-callback": ["error", { allowNamedFunctions: true }],
 			"prefer-const": "error",
 			"prefer-rest-params": "error",

package/config/eslint/presets/stylistic.js

@@ -1,8 +1,69 @@
-import { JAVASCRIPT_LIKE_EXTENSIONS } from "../constants";
+import stylistic from "@stylistic/eslint-plugin";
+
+import { JAVASCRIPT_LIKE_EXTENSIONS } from "../constants.js";
 
 export const config = [
 	{
 		files: JAVASCRIPT_LIKE_EXTENSIONS,
-		rules: {},
+		plugins: {
+			"@stylistic": stylistic,
+		},
+		rules: {
+			"@stylistic/lines-between-class-members": ["error", "always"],
+			"@stylistic/multiline-comment-style": ["error", "starred-block"],
+			"@stylistic/padding-line-between-statements": [
+				"error",
+				{
+					blankLine: "always",
+					next: "*",
+					prev: "*",
+				},
+				{
+					blankLine: "never",
+					next: ["const", "let", "var"],
+					prev: ["const", "let", "var"],
+				},
+				{
+					blankLine: "never",
+					next: ["case", "default"],
+					prev: ["case", "default"],
+				},
+				{
+					blankLine: "always",
+					next: ["const", "let", "var"],
+					prev: ["multiline-const", "multiline-let", "multiline-var"],
+				},
+				{
+					blankLine: "always",
+					next: ["multiline-const", "multiline-let", "multiline-var"],
+					prev: ["const", "let", "var"],
+				},
+				{
+					blankLine: "any",
+					next: ["expression"],
+					prev: ["expression"],
+				},
+				{
+					blankLine: "any",
+					next: ["const", "let", "var"],
+					prev: ["cjs-import"],
+				},
+				{
+					blankLine: "any",
+					next: ["cjs-import", "import"],
+					prev: ["cjs-import", "import"],
+				},
+				{
+					blankLine: "any",
+					next: ["cjs-export", "export"],
+					prev: ["cjs-export", "export"],
+				},
+			],
+			"@stylistic/spaced-comment": [
+				"error",
+				"always",
+				{ block: { balanced: true } },
+			],
+		},
 	},
 ];

package/config/eslint/presets/uncategorized.js

@@ -10,7 +10,6 @@ export const config = [
 			"sort-keys-custom-order": sortKeysCustomOrderPlugin,
 		},
 		rules: {
-			//#region sort-keys-custom-order
 			"sort-keys-custom-order/object-keys": [
 				"error",
 				{
@@ -23,7 +22,6 @@ export const config = [
 					orderedKeys: ["id", "key", "name", "title", "label", "description"],
 				},
 			],
-			//#endregion
 		},
 	},
 	...new FlatCompat().extends("plugin:mdx/recommended").map((mdxConfig) => ({

package/config/prettier/README.md

@@ -8,7 +8,7 @@
 
 ## ✨ Features
 
-This package offers an opinionated but extensible **[Prettier](https://prettier.io/)** configurations to align formatting rules and standards across my projects.
+This package offers opinionated but extensible **[Prettier](https://prettier.io/)** configurations to align formatting rules and standards across my projects.
 
 It allows to:
 

package/config/typescript/README.md

@@ -8,7 +8,7 @@
 
 ## ✨ Features
 
-This package offers an opinionated but extensible **[TSConfigs](https://www.typescriptlang.org/tsconfig/)** to align TypeScript configurations across my projects.
+This package offers opinionated but extensible **[TypeScript](https://www.typescriptlang.org/tsconfig/)** configurations to align type-checking and processing standards across my projects.
 
 It allows to:
 

package/dist/index.js

@@ -6,7 +6,7 @@ import { existsSync, cpSync, readFileSync, renameSync, writeFileSync, readdirSyn
 import { writeFile, chmod, mkdir, symlink } from 'node:fs/promises';
 import { fdir } from 'fdir';
 
-var version = "0.0.0-next-d23a669";
+var version = "0.0.0-next-912a585";
 
 const VERSION = version;
 
@@ -66,10 +66,11 @@ const getNpmVersion = async ()=>{
     }
 };
 const getStackCommand = (command, isNodeRuntime = true)=>{
-    // @note: `isNodeRuntime` allows executing node bin executables in a non node environment such as in git hooks context
-    // Npx is used to make executable resolution independent from the build tool (npx is the built-in Node tool)
-    // `--no` flag to prevent installation prompt and throw an error if the binary is not installed
-    return [
+    /**
+	 * `isNodeRuntime` allows executing node bin executables in a non node environment such as in git hooks context
+	 * Npx is used to make executable resolution independent from the build tool (npx is the built-in Node tool)
+	 * `--no` flag to prevent installation prompt and throw an error if the binary is not installed.
+	 */ return [
         ...isNodeRuntime ? [] : [
             "npx --no"
         ],
@@ -598,9 +599,10 @@ const createCheckCommand = (program)=>{
             await checkTypes();
         },
         skip (context, argv) {
-            return ifOnlyDefinedAndNotEqualTo("type")(context) || !hasDependency("typescript") || // For now, skip type-checking if some files are passed down
-            // @see: https://github.com/microsoft/TypeScript/issues/27379
-            argv.operands.length > 0;
+            return ifOnlyDefinedAndNotEqualTo("type")(context) || !hasDependency("typescript") || /**
+					 * For now, skip type-checking if some files are passed down.
+					 * @see https://github.com/microsoft/TypeScript/issues/27379
+					 */ argv.operands.length > 0;
         }
     }).task({
         label: label("Checking commit"),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adbayb/stack",
-  "version": "0.0.0-next-d23a669",
+  "version": "0.0.0-next-912a585",
   "description": "My opinionated JavaScript-based toolchain",
   "publishConfig": {
     "access": "public"