Merge pull request #4 from acadevmy/feat/miscellaneous-fixes

Feat/miscellaneous fixes and improvements

Author: KernelPanic92

.eslintrc.js

@@ -21,16 +21,19 @@ jobs:
       - name: Setup Corepack
         run: |
           corepack enable
-          corepack prepare npm@10.8.1 --activate
+          corepack prepare --activate
 
       - name: Install dependencies
-        run: npm install
+        run: pnpm install
 
       - name: Build project
-        run: npm run build
+        run: pnpm run build
+      
+      - name: Lint project
+        run: pnpm run lint
 
       - name: Run Semantic Release
         env:
           GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-        run: npm run release
+        run: pnpm run release

.github/workflows/release.yml

@@ -4,83 +4,65 @@ This library provides ESLint configurations with the recommended rules from the
 
 ## Installation
 
+**npm:**
 ```bash
 npm install --save-dev @devmy/eslint-plugin
 ```
 
-## Usage
+**pnpm:**
+```bash
+pnpm add -D @devmy/eslint-plugin
+```
 
-### Typescript
+**yarn**
+```bash
+yarn add --dev @devmy/eslint-plugin
+```
 
-```js
-// .eslintrc.js
-module.exports = {
-  extends: [
-    'plugin:@devmy/eslint-plugin/recommended'
-  ]
-};
+**bun**
+```bash
+bun add -d @devmy/eslint-plugin
 ```
 
-### Angular
+**Note:** If you installed ESLint globally then you must also install `@devmy/eslint-plugin` globally.
 
-```js
-// .eslintrc.js
-module.exports = {
-  extends: [
-    'plugin:@devmy/eslint-plugin/angular-recommended'
-  ]
-};
-```
+## Usage
 
-### Angular with separate template configuration
-```js
-// eslint.config.js
-const tseslint = require("typescript-eslint");
-const devmy = require("@devmy/eslint-plugin");
-
-module.exports = tseslint.config(
-  {
-    files: ["**/*.ts"],
-    plugins: { "devmy": devmy },
-    extends: [devmy.configs["angular-recommended"]],
-  },
-  {
-    files: ["**/*.html"],
-    plugins: { "devmy": devmy },
-    extends: [devmy.configs["angular-template-recommended"]],
-  }
-);
-```
+If you're using flat configuration:
 
-### Cypress
+With
+[flat configuration](https://eslint.org/docs/latest/use/configure/configuration-files),
+just import the plugin and away you go:
 
 ```js
 // .eslintrc.js
+const pluginDevmy = require('@devmy/eslint-plugin');
+
 module.exports = {
   extends: [
-    'plugin:@devmy/eslint-plugin/cypress-recommended'
+    pluginDevmy.configs.recommended
   ]
 };
 ```
 
-### Jest
+With legacy configuration, add `@devmy/eslint-plugin` to the plugins section of your `.eslintrc`
+configuration file:
 
-```js
-// .eslintrc.js
-module.exports = {
-  extends: [
-    'plugin:@devmy/eslint-plugin/jest-recommended'
-  ]
-};
+```json
+{
+  "extends": ["plugin:@devmy/eslint-plugin/recommended"]
+}
 ```
 
 ## Configurations
 
-- **recommended**: The base configuration for TypeScript projects.
-- **angular-recommended**: Extends the "recommended" configuration with rules specific to Angular projects.
-- **angular-template-recommended**: Provides recommended rules for Angular templates.
-- **cypress-recommended**: Provides recommended rules for Cypress projects.
-- **jest-recommended**: Provides recommended rules for jest tests.
+| **Configuration**          | **full name**                          | **Description**                                       |
+|-----------------------------|------------------------------------------|-------------------------------------------------------|
+| **recommended**            | `@devmy/eslint-plugin/recommended`      | The base configuration for TypeScript projects.      |
+| **angular-recommended**    | `@devmy/eslint-plugin/angular-recommended` | Extends the "recommended" configuration with rules specific to Angular projects. |
+| **angular-template-recommended** | `@devmy/eslint-plugin/angular-template-recommended` | Provides recommended rules for Angular templates.    |
+| **cypress-recommended**    | `@devmy/eslint-plugin/cypress-recommended` | Provides recommended rules for Cypress projects.     |
+| **jest-recommended**       | `@devmy/eslint-plugin/jest-recommended` | Provides recommended rules for jest tests.           |
 
 ## Contributing
 

README.md

@@ -32,11 +32,35 @@ export default tsEslint.config({
     "@stylistic/space-before-blocks": "error",
     "@stylistic/padding-line-between-statements": [
       "error",
+      // Space after directive, es "use client"
+      { blankLine: "always", prev: "directive", next: "*" },
+      { blankLine: "any", prev: "directive", next: "directive" },
+
+      // Space before import
+      { blankLine: "always", prev: "import", next: "*" },
+      { blankLine: "any", prev: "import", next: "import" },
+
+      // Space before return
+      { blankLine: "always", prev: "*", next: "return" },
+
+      // Space before and after logic statements (if, while, for, etc.)
       {
         blankLine: "always",
         prev: "*",
-        next: "return",
+        next: ["if", "while", "for", "switch", "try"],
+      },
+      {
+        blankLine: "always",
+        prev: ["if", "while", "for", "switch", "try"],
+        next: "*",
       },
+
+      // Space before functions
+      { blankLine: "always", prev: "*", next: "function" },
+
+      // Space after blocks
+      { blankLine: "always", prev: "block-like", next: "*" },
+      { blankLine: "always", prev: "*", next: "block-like" },
     ],
     "@typescript-eslint/array-type": ["error", { default: "array-simple" }],
     "@typescript-eslint/ban-ts-comment": 0,