Migrate to Prettier 3 with JavaScript module format

- Replace JSON config with JavaScript module for Prettier 3 compatibility
- Update GitHub Actions workflow to latest versions and Node.js LTS
- Add comprehensive documentation and usage examples
- Include additional package metadata and improve changelog formatting

Author: marsicdev

.github/workflows/npm-publish.yml

@@ -12,16 +12,18 @@ jobs:
             contents: write
             id-token: write
         steps:
-            - uses: actions/checkout@v3
+            - uses: actions/checkout@v4
             - name: Get package version
               id: package-version
               uses: martinbeentjes/[email protected]
             - name: Setup node environment
-              uses: actions/setup-node@v3
+              uses: actions/setup-node@v4
               with:
-                  node-version: '18.x'
+                  node-version: 'lts/*'  # Always use latest LTS version
                   registry-url: https://registry.npmjs.org
-            - run: npm ci
+                  cache: 'npm'
+            - name: Install dependencies
+              run: npm ci
             - name: Publish to NPM
               run: npm publish --provenance --access public
               env:
@@ -37,7 +39,7 @@ jobs:
                   echo "::endgroup::"
             - name: Create Release Tag
               id: create-release
-              uses: softprops/action-gh-release@v1
+              uses: softprops/action-gh-release@v2
               with:
                   tag_name: ${{ steps.package-version.outputs.current-version }}
                   body: ${{ env.RELEASE_NOTES }}

CHANGELOG.md

@@ -1,12 +1,32 @@
-# Changelog
+# 📋 Changelog
 
 All notable changes to this project will be documented in this file.
 
+## [2.0.0] - 2025-01-24
+
+### 💥 Breaking Changes
+
+-   🔄 Migrated from JSON to JavaScript module format for Prettier 3 compatibility
+-   📝 Changed main entry point from `main.json` to `index.js`
+-   ⬆️ Now requires Prettier 3.0.0 or higher
+
+### ✨ Added
+
+-   📦 JavaScript module export for better extensibility
+-   📋 Additional package.json metadata (files, engines, keywords)
+-   📚 Improved documentation for Prettier 3 usage
+-   🔧 Updated GitHub Actions workflow to latest versions with Node.js LTS
+
+### 🔄 Changed
+
+-   🏗️ Configuration now uses CommonJS module.exports instead of JSON format
+-   📝 Updated README with Prettier 3 specific instructions
+
 ## [1.0.1] - 2023-08-16
 
-### Added
+### ✨ Added
 
--   Default Prettier configuration
--   Actions release workflow
--   Install documentation
--   Changes changelog
+-   🎨 Default Prettier configuration
+-   🚀 Actions release workflow
+-   📖 Install documentation
+-   📋 Changes changelog

README.md

@@ -2,6 +2,8 @@
 
 The official HypeTech prettier configuration, part of Frontend Coding Standards.
 
+> **Note**: Version 2.0.0+ requires Prettier 3.0.0 or higher. For Prettier 2.x, use version 1.x of this package.
+
 ## Installation
 
 The configuration can be installed via package manager.
@@ -25,6 +27,10 @@ With NPM:
 npm install --dev @hypetech/prettier-config
 ```
 
+## Usage
+
+### Method 1: package.json (Recommended for simple usage)
+
 To inform prettier of this configuration, you have to add the `prettier` property to your `package.json` file:
 
 ```json
@@ -37,19 +43,38 @@ Instead of manually editing your `package.json`, you can also utilize the `npm p
 npm pkg set prettier=@hypetech/prettier-config
 ```
 
-## Extending
+### Method 2: .prettierrc.js (Required for extending)
+
+For Prettier 3, create a `.prettierrc.js` file:
+
+```js
+module.exports = require('@hypetech/prettier-config');
+```
 
-[Prettier does not ship with a built-in way of extending configurations](https://prettier.io/docs/en/configuration.html#sharing-configurations).
+## Extending
 
-To extend the configuration, you will have to create a `.prettierrc.js` file (or `.prettierrc.cjs` if your package is a `"type": "module"`) and import the HypeTech configuration using `require`:
+To extend the configuration, you will have to create a `.prettierrc.js` file (or `.prettierrc.cjs` if your package is a `"type": "module"`) and import the HypeTech configuration:
 
 ```js
 module.exports = {
     ...require('@hypetech/prettier-config'),
+    // Your custom overrides
     semi: true,
 }
 ```
 
+## Configuration Details
+
+This configuration includes the following settings:
+
+- **semi**: `false` - No semicolons at the end of statements
+- **singleQuote**: `false` - Use double quotes
+- **printWidth**: `120` - Line wrap at 120 characters
+- **tabWidth**: `4` - Use 4 spaces for indentation
+- **quoteProps**: `"preserve"` - Only add quotes around object properties where necessary
+- **endOfLine**: `"auto"` - Maintain existing line endings
+- **trailingComma**: `"es5"` - Trailing commas where valid in ES5 (objects, arrays, etc.)
+
 If you have previously added the configuration to your `package.json`, via the `prettier` property, you can now remove it.
 You can also utilize the `npm pkg`:
 

index.js

@@ -0,0 +1,9 @@
+module.exports = {
+    semi: false,
+    singleQuote: false,
+    printWidth: 120,
+    tabWidth: 4,
+    quoteProps: "preserve",
+    endOfLine: "auto",
+    trailingComma: "es5",
+};

package.json

@@ -1,11 +1,23 @@
 {
     "name": "@hypetech/prettier-config",
-    "version": "1.0.1",
+    "version": "2.0.0",
     "description": "HypeTech Prettier Configuration",
     "keywords": [
         "HypeTech",
-        "prettier"
+        "prettier",
+        "prettier-config",
+        "code-style",
+        "formatting"
     ],
+    "files": [
+        "index.js",
+        "README.md",
+        "CHANGELOG.md",
+        "LICENSE"
+    ],
+    "engines": {
+        "node": ">=14.0.0"
+    },
     "homepage": "https://github.com/hypetechdev/prettier-config#readme",
     "bugs": {
         "url": "https://github.com/hypetechdev/prettier-config/issues"
@@ -16,7 +28,7 @@
     },
     "license": "MIT",
     "author": "HypeTech",
-    "main": "main.json",
+    "main": "index.js",
     "peerDependencies": {
         "prettier": ">=3"
     }