tsfmt 0.0.0

package/README.md

@@ -0,0 +1,106 @@
+# tsfmt
+
+**Opinionated TypeScript and JavaScript code formatter with AST-based transformations**
+
+An advanced code formatting tool that goes beyond traditional pretty-printing to enforce structural consistency across TypeScript and JavaScript codebases. Built by
+Encore Digital Group, tsfmt combines configurable formatting rules with intelligent AST analysis to automatically organize imports, sort class members, arrange file
+declarations, and apply consistent code style patterns.
+
+## What tsfmt Does
+
+tsfmt is a comprehensive code formatter that operates on multiple levels:
+
+**AST-Based Sorting & Organization**
+
+- Intelligently sorts class members (properties, constructors, methods, accessors) with dependency awareness
+- Organizes file-level declarations (interfaces, types, enums, functions, classes) in logical order
+- Handles React component lifecycle methods with specialized sorting rules
+- Respects code dependencies to prevent breaking changes during reorganization
+
+**Import Management**
+
+- Automatically organizes and groups imports (external, internal, relative)
+- Removes unused imports while preserving side-effect imports
+- Sorts import statements alphabetically within groups
+- Configurable import grouping and separation
+
+**Code Style Formatting**
+
+- Enforces consistent quote styles, semicolon usage, and bracket spacing
+- Manages indentation (spaces vs tabs) and line width constraints
+- Controls trailing comma placement and arrow function parentheses
+- Applies spacing rules for blank lines between declarations and before returns
+
+**Configuration File Formatting**
+
+- Sorts `package.json` fields according to company standards
+- Alphabetically sorts all keys in `tsconfig.json` files
+- Maintains consistent JSON indentation and structure
+
+## Core Formatting Opinions
+
+tsfmt enforces these opinionated defaults designed for enterprise-grade codebases:
+
+**Code Style Standards**
+
+- Double quotes for all string literals
+- Semicolons always required
+- No bracket spacing in object literals (`{key: value}` not `{ key: value }`)
+- 4-space indentation (no tabs)
+- 120-character line width limit
+- Trailing commas everywhere possible
+- Arrow function parentheses omitted when possible (`x => x` not `(x) => x`)
+
+**Structural Organization**
+
+- Class members ordered by type: static properties, instance properties, constructor, accessors, static methods, instance methods
+- File declarations ordered by importance: interfaces, types, enums, helper functions, exported functions, classes, default exports
+- Import groups separated by origin: external packages, internal modules, relative imports
+- Blank lines enforced between different declaration types and before return statements
+
+**Package & Config Files**
+
+- `package.json` fields ordered by company standard: name, type, author, version, description, publishConfig, keywords, homepage, engines, dependencies, devDependencies,
+  scripts, types, main, module, exports, files, repository, bugs
+- `tsconfig.json` keys sorted alphabetically at all nesting levels
+- Consistent 4-space JSON indentation throughout
+
+## Architecture
+
+tsfmt uses a sophisticated pipeline-based architecture:
+
+**Formatter Pipeline**
+
+- Executes formatters in a specific order: CodeStyle → ImportOrganization → ASTTransformation → Spacing
+- Each formatter can be independently enabled/disabled
+- Pipeline maintains context and tracks changes across transformations
+
+**AST Analysis Engine**
+
+- Built on TypeScript compiler API for accurate parsing
+- Dependency resolution prevents breaking member/declaration relationships
+- Handles complex scenarios like method dependencies and forward references
+
+**Configuration System**
+
+- Zero-configuration by default with sensible opinions
+- Optional `core.config.ts` file for project-specific customization
+- Deep merging of user configuration with defaults
+
+## Key Features
+
+- **Dependency-Aware Sorting**: Analyzes code relationships to prevent breaking changes during reorganization
+- **React-Specific Rules**: Specialized handling for React component lifecycle methods and patterns
+- **Configurable Pipeline**: Modular formatter system allows granular control over formatting operations
+- **Incremental Processing**: Only modifies files that need changes, preserving unchanged content
+- **TypeScript-Native**: Built on TypeScript compiler API for maximum compatibility and accuracy
+- **Enterprise-Ready**: Designed for large codebases with consistent, non-negotiable formatting standards
+
+## Philosophy
+
+tsfmt is built on the principle that code formatting should not just make code look consistent, but should also impose logical structure that improves maintainability. By
+combining traditional pretty-printing with intelligent AST transformations, tsfmt ensures that codebases follow not just visual consistency, but also structural patterns
+that make code easier to navigate, understand, and modify.
+
+The tool is intentionally opinionated to eliminate formatting debates and establish company-wide standards that prioritize readability, consistency, and maintainability
+over individual preferences.

package/bin/ci_build.sh

@@ -0,0 +1,50 @@
+#!/bin/bash
+#
+# Copyright (c) 2025. Encore Digital Group.
+# All Rights Reserved.
+#
+
+git config --global user.name "EncoreBot"
+git config --global user.email "ghbot@encoredigitalgroup.com"
+
+# Change to workspace directory
+cd "$GITHUB_WORKSPACE" || {
+  echo "Error: Failed to change directory to $GITHUB_WORKSPACE"
+  exit 1
+}
+
+# Run build and capture exit code
+npm run format
+BUILD_EXIT_CODE=$?
+
+# If build failed, exit with the same code
+if [ $BUILD_EXIT_CODE -ne 0 ]; then
+  echo "Build failed with exit code $BUILD_EXIT_CODE"
+  exit $BUILD_EXIT_CODE
+fi
+
+# Run format and capture exit code
+npm run format
+FORMAT_EXIT_CODE=$?
+
+# If format failed, exit with the same code
+if [ $FORMAT_EXIT_CODE -ne 0 ]; then
+  echo "Format failed with exit code $FORMAT_EXIT_CODE"
+  exit $FORMAT_EXIT_CODE
+fi
+
+# Build and format succeeded, check for changes
+if [ -z "$(git status --porcelain)" ]; then
+  # Working directory clean
+  echo "Working Tree is Clean! Nothing to commit."
+else
+  # Add all changes to staging
+  git add .
+
+  # Commit changes
+  commit_message="Apply Formatting"
+  git commit -m "$commit_message"
+
+  # Push changes to origin
+  git push origin --force
+fi

package/bin/cli.js

@@ -0,0 +1,20 @@
+#!/usr/bin/env node
+/*
+ * Copyright (c) 2026. Encore Digital Group.
+ * All Rights Reserved.
+ */
+
+// This is the entry point for consumers of the package
+// It uses tsx to run the TypeScript source directly without requiring a build step
+
+const { register } = require('tsx/cjs/api');
+const path = require('path');
+
+// Register tsx to handle TypeScript files
+const unregister = register();
+
+// Load and run the CLI
+require(path.join(__dirname, '../src/cli.ts'));
+
+// Cleanup
+process.on('exit', () => unregister());

package/package.json

@@ -0,0 +1,43 @@
+{
+    "name": "tsfmt",
+    "author": "Encore Digital Group",
+    "version": "0.0.0",
+    "description": "An opinionated TypeScript code formatter",
+    "publishConfig": {
+        "access": "public",
+        "registry": "https://registry.npmjs.org"
+    },
+    "engines": {
+        "node": ">=20.0.0"
+    },
+    "dependencies": {
+        "glob": "^13.0.0",
+        "json-sort-cli": "^4.0.9",
+        "sort-package-json": "^3.0.0",
+        "tsx": "^4.21.0",
+        "typescript": "^5.0.0"
+    },
+    "devDependencies": {
+        "@types/jest": "^30.0.0",
+        "@types/node": "^25.0.3",
+        "jest": "^30.1.1",
+        "ts-jest": "^29.0.0"
+    },
+    "scripts": {
+        "format": "node bin/cli.js",
+        "test": "jest"
+    },
+    "main": "bin/cli.js",
+    "files": [
+        "bin",
+        "README.md"
+    ],
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/EncoreDigitalGroup/tsfmt.git"
+    },
+    "license": "BSD-3-Clause",
+    "bin": {
+        "tsfmt": "./bin/cli.js"
+    }
+}