@jterrazz/codestyle 1.0.0 → 1.1.0

package/README.md

@@ -1,125 +1,75 @@
-_Hey there - I'm Jean-Baptiste, just another developer doing weird things with code. All my projects live on [jterrazz.com](https://jterrazz.com) - complete with backstories and lessons learned. Feel free to poke around - you might just find something useful!_
-
 # @jterrazz/codestyle
 
-Unified lint/format configs to standardize TypeScript codebases with Oxlint + Oxfmt.
-
-## Installation
+Fast, opinionated linting and formatting for TypeScript. Powered by Oxlint (2-3x faster than ESLint) and Oxfmt.
 
-Install the package using npm:
+## Quick Start
 
 ```bash
 npm install @jterrazz/codestyle --save-dev
 ```
 
-## Usage
-
-### Oxlint Configuration
-
-Choose the configuration that matches your environment:
-
-**For Node.js projects:**
+Create `.oxlintrc.json`:
 
 ```json
-// oxlint.json
 {
     "extends": ["@jterrazz/codestyle/oxlint/node"]
 }
 ```
 
-**For Expo/React Native projects:**
-
-```json
-// oxlint.json
-{
-    "extends": ["@jterrazz/codestyle/oxlint/expo"]
-}
-```
-
-**For Next.js projects:**
-
-```json
-// oxlint.json
-{
-    "extends": ["@jterrazz/codestyle/oxlint/nextjs"]
-}
-```
-
-### Oxfmt Configuration
+Run:
 
-```json
-// oxfmt.json
-{
-    "extends": ["@jterrazz/codestyle/oxfmt"]
-}
+```bash
+npx codestyle          # Check everything
+npx codestyle --fix    # Fix everything
 ```
 
-## Features
-
-### Environment-Specific Configurations
-
-**Node.js Configuration:**
+## Configurations
 
-- Requires explicit file extensions (`.js`) for imports
-- Optimized for Node.js patterns
+| Config                              | Use Case                          |
+| ----------------------------------- | --------------------------------- |
+| `@jterrazz/codestyle/oxlint/node`   | Node.js (requires .js extensions) |
+| `@jterrazz/codestyle/oxlint/expo`   | Expo / React Native               |
+| `@jterrazz/codestyle/oxlint/nextjs` | Next.js                           |
 
-**Expo/React Native Configuration:**
+## What's Included
 
-- No file extensions in imports (auto-fixed)
-- React plugin enabled
+- TypeScript strict mode with `type` imports
+- Import sorting and grouping (perfectionist)
+- Named exports enforcement (no default exports)
+- Performance warnings (spread in loops, etc.)
+- Style consistency (curly braces, comments, naming)
 
-**Next.js Configuration:**
-
-- No file extensions in imports (Turbopack compatibility, auto-fixed)
-- React and Next.js plugins enabled
-
-### Shared Features
-
-- **TypeScript**: Strict type checking with consistent type imports
-- **Import Sorting**: Automated import organization with architectural grouping (via perfectionist)
-- **Code Quality**: Perfectionist plugin for consistent code style
-- **Performance**: Oxlint is 50-100x faster than ESLint, Oxfmt is 10x faster than Prettier, tsgo is 10x faster than tsc
-
-## CLI Tools
-
-This package includes a CLI tool for running quality checks:
+## CLI
 
 ```bash
-# Run all quality checks (tsgo, Oxlint, Oxfmt) in parallel
-npx codestyle
-
-# Automatically fix all fixable issues (Oxlint --fix, Oxfmt format)
-npx codestyle --fix
-
-# Run individual checks
-npx codestyle --type      # TypeScript type checking only
-npx codestyle --lint      # Linting only
-npx codestyle --format    # Format checking only
+npx codestyle              # Run all checks (type + lint + format)
+npx codestyle --fix        # Auto-fix all issues
 
-# Combine flags
-npx codestyle --lint --fix    # Fix lint issues only
-npx codestyle --format --fix  # Format files only
+npx codestyle --type       # TypeScript only
+npx codestyle --lint       # Lint only
+npx codestyle --format     # Format only
 ```
 
-## Scripts
+## Architecture Enforcement (Optional)
 
-Add these scripts to your `package.json` for common development tasks:
+Enforce hexagonal architecture boundaries:
 
 ```json
 {
-    "scripts": {
-        "codestyle": "codestyle",
-        "codestyle:fix": "codestyle --fix"
-    }
+    "extends": [
+        "@jterrazz/codestyle/oxlint/node",
+        "@jterrazz/codestyle/oxlint/architectures/hexagonal"
+    ]
 }
 ```
 
-## Configuration
+Rules enforced:
 
-The configurations are fully modular and include:
+- `domain/` cannot import from other layers
+- `application/` cannot import infrastructure
+- `presentation/ui/` cannot import navigation
+- `features/` cannot import other features
 
-- **Base configuration**: Common rules for TypeScript, import sorting, code quality
-- **Environment-specific**: Tailored rules for Node.js, Expo/React Native, and Next.js
-- **Custom plugins**: JS plugins for import extension enforcement
+---
 
-Happy coding!
+By [Jean-Baptiste Terrazzoni](https://jterrazz.com)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jterrazz/codestyle",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "author": "Jean-Baptiste Terrazzoni <contact@jterrazz.com>",
   "bin": {
     "codestyle": "./src/codestyle.sh"
@@ -15,16 +15,15 @@
     "./oxlint/node": "./src/oxlint/node.json",
     "./oxlint/expo": "./src/oxlint/expo.json",
     "./oxlint/nextjs": "./src/oxlint/nextjs.json",
+    "./oxlint/architectures/hexagonal": "./src/oxlint/architectures/hexagonal.json",
     "./oxfmt": "./src/oxfmt/index.json"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
   },
   "scripts": {
-    "lint": "oxlint --ignore-pattern '**/fixtures/**'",
-    "lint:fix": "oxlint --fix --ignore-pattern '**/fixtures/**'",
-    "format": "oxfmt",
-    "format:check": "oxfmt --check",
+    "lint": "oxlint --ignore-pattern '**/fixtures/**' && oxfmt --check",
+    "lint:fix": "oxlint --fix --ignore-pattern '**/fixtures/**' && oxfmt",
     "test": "vitest --run",
     "test:watch": "vitest",
     "build": "# no build script"

package/src/codestyle.sh

@@ -63,25 +63,29 @@ type_pid=""
 code_pid=""
 style_pid=""
 
+# Find the node_modules/.bin directory relative to this script
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+BIN_DIR="$SCRIPT_DIR/../node_modules/.bin"
+
 if [ "$RUN_TYPE" = true ]; then
-    tsgo --noEmit "${EXTRA_ARGS[@]}" > "$tmp_dir/type.log" 2>&1 &
+    "$BIN_DIR/tsgo" --noEmit "${EXTRA_ARGS[@]}" > "$tmp_dir/type.log" 2>&1 &
     type_pid=$!
 fi
 
 if [ "$RUN_LINT" = true ]; then
     if [ "$FIX_MODE" = true ]; then
-        oxlint --fix "${EXTRA_ARGS[@]:-.}" > "$tmp_dir/code.log" 2>&1 &
+        "$BIN_DIR/oxlint" --fix "${EXTRA_ARGS[@]:-.}" > "$tmp_dir/code.log" 2>&1 &
     else
-        oxlint "${EXTRA_ARGS[@]:-.}" > "$tmp_dir/code.log" 2>&1 &
+        "$BIN_DIR/oxlint" "${EXTRA_ARGS[@]:-.}" > "$tmp_dir/code.log" 2>&1 &
     fi
     code_pid=$!
 fi
 
 if [ "$RUN_FORMAT" = true ]; then
     if [ "$FIX_MODE" = true ]; then
-        oxfmt "${EXTRA_ARGS[@]:-.}" > "$tmp_dir/style.log" 2>&1 &
+        "$BIN_DIR/oxfmt" "${EXTRA_ARGS[@]:-.}" > "$tmp_dir/style.log" 2>&1 &
     else
-        oxfmt --check "${EXTRA_ARGS[@]:-.}" > "$tmp_dir/style.log" 2>&1 &
+        "$BIN_DIR/oxfmt" --check "${EXTRA_ARGS[@]:-.}" > "$tmp_dir/style.log" 2>&1 &
     fi
     style_pid=$!
 fi

package/src/oxlint/architectures/hexagonal.json

@@ -0,0 +1,65 @@
+{
+  "$schema": "https://raw.githubusercontent.com/oxc-project/oxc/main/npm/oxlint/configuration_schema.json",
+  "jsPlugins": ["../plugins/architecture-boundaries.js"],
+  "rules": {
+    // Hexagonal Architecture (Ports & Adapters)
+    //
+    // Dependency rule: outer layers depend on inner layers, never the reverse
+    // All layers CAN import domain (it's the core)
+    //
+    //   ┌─────────────────────────────────────────┐
+    //   │  infrastructure / presentation (outer)  │
+    //   │  ┌─────────────────────────────────┐    │
+    //   │  │  application (use-cases, ports) │    │
+    //   │  │  ┌─────────────────────────┐    │    │
+    //   │  │  │  domain (core business) │    │    │
+    //   │  │  └─────────────────────────┘    │    │
+    //   │  └─────────────────────────────────┘    │
+    //   └─────────────────────────────────────────┘
+
+    "architecture-boundaries/architecture-boundaries": [
+      "error",
+      {
+        "rules": [
+          {
+            "from": "/domain/",
+            "disallow": [
+              "/application/",
+              "/infrastructure/",
+              "/presentation/",
+              "/di/",
+              "/config/",
+              "/generated/"
+            ],
+            "message": "Domain layer must be pure - cannot import from other layers"
+          },
+          {
+            "from": "/application/use-cases/",
+            "disallow": ["/infrastructure/", "/presentation/", "/di/"],
+            "message": "Use cases can only depend on domain and ports"
+          },
+          {
+            "from": "/application/ports/",
+            "disallow": ["/infrastructure/", "/presentation/", "/di/"],
+            "message": "Ports are interfaces - cannot depend on implementations"
+          },
+          {
+            "from": "/infrastructure/inbound/",
+            "disallow": ["/infrastructure/outbound/"],
+            "message": "Inbound adapters should not import outbound adapters - use DI"
+          },
+          {
+            "from": "/presentation/ui/(atoms|molecules)/",
+            "disallow": ["/navigation/"],
+            "message": "Atoms and molecules must be pure - no navigation imports"
+          },
+          {
+            "from": "/presentation/features/",
+            "disallow": ["/presentation/features/(?!common)"],
+            "message": "Features should be independent - use shared code in features/common"
+          }
+        ]
+      }
+    ]
+  }
+}

package/src/oxlint/base.json

@@ -1,29 +1,23 @@
 {
   "$schema": "https://raw.githubusercontent.com/oxc-project/oxc/main/npm/oxlint/configuration_schema.json",
-  "plugins": ["typescript", "import", "oxc"],
+  "plugins": ["typescript", "import", "oxc", "unicorn"],
   "jsPlugins": ["eslint-plugin-perfectionist"],
   "categories": {
     "correctness": "error",
-    "suspicious": "warn",
+    "suspicious": "error",
     "perf": "warn",
     "pedantic": "off",
     "style": "warn",
     "nursery": "off"
   },
   "rules": {
+    // ============================================
+    // ENABLED RULES
+    // ============================================
+
     "no-unused-vars": "error",
-    "sort-keys": "off",
-    "sort-imports": "off",
-    "func-style": "off",
-    "no-magic-numbers": "off",
-    "import/no-named-export": "off",
-    "import/no-anonymous-default-export": "off",
-    "import/group-exports": "off",
-    "no-ternary": "off",
-    "init-declarations": "off",
-    "capitalized-comments": "off",
-    "id-length": "off",
-    "typescript/consistent-type-definitions": "off",
+
+    // -- TypeScript --
     "typescript/consistent-type-imports": [
       "error",
       {
@@ -40,19 +34,14 @@
         "allowTaggedTemplates": true
       }
     ],
-    "perfectionist/sort-array-includes": ["error", { "type": "natural" }],
-    "perfectionist/sort-classes": ["error", { "type": "natural" }],
+
+    // -- Perfectionist (sorting/ordering) --
     "perfectionist/sort-heritage-clauses": ["error", { "type": "natural" }],
     "perfectionist/sort-intersection-types": ["error", { "type": "natural" }],
     "perfectionist/sort-jsx-props": ["error", { "type": "natural" }],
     "perfectionist/sort-named-exports": ["error", { "type": "natural" }],
     "perfectionist/sort-named-imports": ["error", { "type": "natural" }],
-    "perfectionist/sort-switch-case": ["error", { "type": "natural" }],
     "perfectionist/sort-union-types": ["error", { "type": "natural" }],
-    "perfectionist/sort-variable-declarations": [
-      "error",
-      { "type": "natural" }
-    ],
     "perfectionist/sort-imports": [
       "error",
       {
@@ -68,7 +57,62 @@
           "unknown"
         ]
       }
-    ]
+    ],
+
+    // ============================================
+    // DISABLED - Conflicts with perfectionist
+    // ============================================
+
+    "sort-keys": "off",
+    "sort-imports": "off",
+
+    // ============================================
+    // DISABLED - Too strict / opinionated
+    // ============================================
+
+    "func-style": "off",
+    "no-magic-numbers": "off",
+    "no-ternary": "off",
+    "init-declarations": "off",
+    "id-length": "off",
+    "max-statements": "off",
+    "max-params": "off",
+    "no-continue": "off",
+    "arrow-body-style": "off",
+    "prefer-destructuring": "off",
+    "typescript/consistent-type-definitions": "off",
+    "typescript/array-type": "off",
+    "unicorn/no-null": "off",
+    "unicorn/no-array-sort": "off",
+
+    // ============================================
+    // ENABLED - Code style enforcement
+    // ============================================
+
+    "capitalized-comments": "warn",
+    "new-cap": "error",
+    "curly": "error",
+    "no-nested-ternary": "error",
+    "unicorn/catch-error-name": "error",
+    "unicorn/numeric-separators-style": "warn",
+
+    // ============================================
+    // DISABLED - Conflicts with other rules
+    // ============================================
+
+    "import/no-named-export": "off",
+    "import/consistent-type-specifier-style": "off",
+    "import/prefer-default-export": "off",
+    "import/no-default-export": "off",
+    "import/group-exports": "off",
+    "import/no-anonymous-default-export": "off",
+
+    // ============================================
+    // ENABLED - Clean imports
+    // ============================================
+
+    "import/first": "error",
+    "import/no-namespace": "error"
   },
   "ignorePatterns": ["dist/**", "node_modules/**"]
 }

package/src/oxlint/expo.json

@@ -10,6 +10,16 @@
         "allow": ["\\.png$", "\\.jpg$", "\\.jpeg$", "\\.gif$", "\\.webp$"]
       }
     ],
-    "remove-ts-extensions/remove-ts-extensions": "error"
+    "remove-ts-extensions/remove-ts-extensions": "error",
+
+    // React 17+ doesn't require importing React
+    "react/react-in-jsx-scope": "off",
+    // Prop spreading is common in React Native
+    "react/jsx-props-no-spreading": "off",
+    // Style preferences - not worth enforcing
+    "react/jsx-boolean-value": "off",
+    "react/jsx-handler-names": "off",
+    "react/jsx-curly-brace-presence": "off",
+    "unicorn/no-nested-ternary": "off"
   }
 }

package/src/oxlint/plugins/architecture-boundaries.js

@@ -0,0 +1,86 @@
+// Custom rule to enforce architecture boundaries
+// Prevents imports between layers (e.g., domain cannot import infra)
+
+const architectureBoundariesRule = {
+  meta: {
+    type: "problem",
+    docs: {
+      description: "Enforce architecture layer boundaries",
+      category: "Best Practices",
+    },
+    schema: [
+      {
+        type: "object",
+        properties: {
+          rules: {
+            type: "array",
+            items: {
+              type: "object",
+              properties: {
+                from: { type: "string" }, // Regex pattern for source file path
+                disallow: {
+                  type: "array",
+                  items: { type: "string" }, // Regex patterns for disallowed imports
+                },
+                message: { type: "string" },
+              },
+              required: ["from", "disallow"],
+            },
+          },
+        },
+      },
+    ],
+  },
+  create(context) {
+    const options = context.options[0] || {};
+    const rules = options.rules || [];
+    const filename = context.getFilename();
+
+    function checkNode(node) {
+      if (!node.source || !node.source.value) {
+        return;
+      }
+
+      const importPath = node.source.value;
+
+      for (const rule of rules) {
+        const fromPattern = new RegExp(rule.from);
+
+        // Check if this file matches the "from" pattern
+        if (!fromPattern.test(filename)) {
+          continue;
+        }
+
+        // Check if the import matches any disallowed pattern
+        for (const disallowPattern of rule.disallow) {
+          const disallowRegex = new RegExp(disallowPattern);
+
+          if (disallowRegex.test(importPath)) {
+            context.report({
+              node: node.source,
+              message:
+                rule.message || `Import from "${importPath}" violates architecture boundaries`,
+            });
+            break;
+          }
+        }
+      }
+    }
+
+    return {
+      ImportDeclaration: checkNode,
+      ExportNamedDeclaration: checkNode,
+      ExportAllDeclaration: checkNode,
+    };
+  },
+};
+
+export default {
+  meta: {
+    name: "architecture-boundaries",
+    version: "1.0.0",
+  },
+  rules: {
+    "architecture-boundaries": architectureBoundariesRule,
+  },
+};