@ttoss/config 1.37.9 → 1.37.11

package/README.md

@@ -12,13 +12,29 @@ pnpm add -Dw @ttoss/config
 
 Use the configs of this section on the root of your monorepo.
 
+### Quick Setup (Recommended)
+
+The easiest way to set up all monorepo configurations at once is using the `@ttoss/monorepo` command:
+
+```shell
+pnpm add -Dw @ttoss/monorepo
+npx @ttoss/monorepo setup-monorepo
+```
+
+This command will automatically create all configuration files and install all necessary dependencies for ESLint, Prettier, Husky, commitlint, lint-staged, Lerna, Syncpack, and pnpm workspace.
+
+For more details, see [@ttoss/monorepo documentation](https://github.com/ttoss/ttoss/tree/main/packages/monorepo).
+
+### Manual Setup
+
+Alternatively, you can set up each tool manually:
+
 ### ESLint and Prettier
 
 Install the following packages:
 
 ```shell
-pnpm add -Dw eslint prettier @ttoss/eslint-config
-
+pnpm add -Dw eslint prettier @ttoss/eslint-config @ttoss/config
 ```
 
 Create the `.prettierrc.js` file and add the following configuration:
@@ -63,13 +79,133 @@ const { lintstagedConfig } = require('@ttoss/config');
 module.exports = lintstagedConfig();
 ```
 
+The default config runs ESLint on JS/TS files, Prettier on Markdown/JSON/YAML, and automatically sorts `package.json` keys using [sort-package-json](https://github.com/nicolo-ribaudo/sort-package-json). No additional packages needed.
+
 Finally, configure Husky:
 
 ```shell
 npm set-script prepare "husky install"
 pnpm run prepare
 pnpm husky add .husky/commit-msg "pnpm commitlint --edit"
-pnpm husky add .husky/pre-commit "pnpm lint-staged"
+pnpm husky add .husky/pre-commit "pnpm lint-staged && pnpm syncpack:list"
+```
+
+### Lerna (optional)
+
+[Lerna](https://lerna.js.org/) helps manage versioning and publishing of packages in a monorepo.
+
+Install lerna-lite packages:
+
+```shell
+pnpm add -Dw @lerna-lite/cli @lerna-lite/version @lerna-lite/changed @lerna-lite/list
+```
+
+Create the `lerna.json` file and configure it according to your monorepo structure:
+
+```json title="lerna.json"
+{
+  "$schema": "node_modules/@lerna-lite/cli/schemas/lerna-schema.json",
+  "version": "independent",
+  "npmClient": "pnpm",
+  "stream": true,
+  "command": {
+    "publish": {
+      "allowBranch": "main",
+      "noPrivate": true
+    },
+    "version": {
+      "conventionalCommits": true,
+      "createRelease": "github",
+      "message": "chore(release): publish packages",
+      "syncWorkspaceLock": true,
+      "allowPeerDependenciesUpdate": true
+    }
+  },
+  "ignoreChanges": ["**/__fixtures__/**", "**/tests/**"],
+  "packages": ["packages/*"]
+}
+```
+
+### Syncpack (optional)
+
+[Syncpack](https://jamiemason.github.io/syncpack/) ensures consistent versions of dependencies across all packages in your monorepo.
+
+Install syncpack:
+
+```shell
+pnpm add -Dw syncpack
+```
+
+Create the `.syncpackrc.js` file:
+
+```js title=".syncpackrc.js"
+const { syncpackConfig } = require('@ttoss/config');
+
+module.exports = syncpackConfig();
+```
+
+Add syncpack scripts to your root `package.json`:
+
+```json title="package.json"
+{
+  "scripts": {
+    "syncpack:fix": "syncpack fix-mismatches",
+    "syncpack:list": "syncpack list-mismatches"
+  }
+}
+```
+
+### pnpm workspace (required for pnpm monorepos)
+
+Create a `pnpm-workspace.yaml` file to define which directories contain packages:
+
+```yaml title="pnpm-workspace.yaml"
+packages:
+  - 'packages/*'
+```
+
+Adjust the `packages` array to match your monorepo structure. For example:
+
+```yaml title="pnpm-workspace.yaml"
+packages:
+  - 'packages/*'
+  - 'examples/*'
+  - 'apps/*'
+```
+
+### .gitignore (recommended)
+
+Create a `.gitignore` file in the monorepo root to exclude common build artifacts and dependencies:
+
+```gitignore title=".gitignore"
+node_modules/
+dist/
+build/
+.build/
+coverage/
+*.log
+.env
+.env.test
+.cache/
+.turbo
+**/i18n/compiled/
+**/i18n/missing/
+**/i18n/unused/
+tsup.config.bundled*.mjs
+package-lock.json
+yarn.lock
+```
+
+### .npmrc (recommended for pnpm)
+
+Create an `.npmrc` file to configure pnpm behavior:
+
+```ini title=".npmrc"
+enable-pre-post-scripts=true
+engine-strict=true
+public-hoist-pattern[]=*eslint*
+public-hoist-pattern[]=*prettier*
+public-hoist-pattern[]=@types*
 ```
 
 ## Packages

package/bin/sort-package-json

@@ -0,0 +1,47 @@
+#!/usr/bin/env node
+
+const fs = require('node:fs');
+const path = require('node:path');
+
+const { sortPackageJson } = require('sort-package-json');
+
+const files = process.argv
+  .slice(2)
+  .filter((filePath) => path.basename(filePath) === 'package.json');
+
+if (files.length === 0) {
+  process.exit(0);
+}
+
+const failedFiles = [];
+
+for (const filePath of files) {
+  try {
+    const fileContent = fs.readFileSync(filePath, 'utf8');
+    const packageJson = JSON.parse(fileContent);
+    const sortedPackageJson = sortPackageJson(packageJson);
+    const nextContent = `${JSON.stringify(sortedPackageJson, null, 2)}\n`;
+
+    if (fileContent !== nextContent) {
+      fs.writeFileSync(filePath, nextContent);
+    }
+  } catch (error) {
+    failedFiles.push({
+      error,
+      filePath,
+    });
+  }
+}
+
+if (failedFiles.length > 0) {
+  for (const failedFile of failedFiles) {
+    const message =
+      failedFile.error instanceof Error
+        ? failedFile.error.message
+        : String(failedFile.error);
+
+    console.error(`Failed to sort ${failedFile.filePath}: ${message}`);
+  }
+
+  process.exit(1);
+}

package/dist/esm/index.js

@@ -133,7 +133,7 @@ var jestUnitConfig = configCreator({
 var defaultConfig4 = {
   "*.{js,jsx,ts,tsx}": "eslint --quiet --fix",
   "*.{md,mdx,html,json,yml,yaml}": "prettier --write",
-  "package.json": "prettier-package-json --write"
+  "package.json": "node ./node_modules/@ttoss/config/bin/sort-package-json"
 };
 var lintstagedConfig = configCreator(defaultConfig4);
 

package/dist/index.js

@@ -177,7 +177,7 @@ var jestUnitConfig = configCreator({
 var defaultConfig4 = {
   "*.{js,jsx,ts,tsx}": "eslint --quiet --fix",
   "*.{md,mdx,html,json,yml,yaml}": "prettier --write",
-  "package.json": "prettier-package-json --write"
+  "package.json": "node ./node_modules/@ttoss/config/bin/sort-package-json"
 };
 var lintstagedConfig = configCreator(defaultConfig4);
 

package/package.json

@@ -1,26 +1,31 @@
 {
   "name": "@ttoss/config",
-  "version": "1.37.9",
+  "version": "1.37.11",
   "description": "Default configuration for packages.",
-  "license": "MIT",
-  "author": "ttoss",
-  "contributors": [
-    "Pedro Arantes <pedro@arantespp.com> (https://arantespp.com)"
-  ],
+  "keywords": [],
   "repository": {
     "type": "git",
     "url": "https://github.com/ttoss/ttoss.git",
     "directory": "packages/config"
   },
+  "license": "MIT",
+  "author": "ttoss",
+  "contributors": [
+    "Pedro Arantes <pedro@arantespp.com> (https://arantespp.com)"
+  ],
+  "sideEffects": false,
   "main": "dist/index.js",
   "module": "dist/esm/index.js",
+  "typings": "dist/index.d.ts",
+  "bin": {
+    "ttoss-sort-package-json": "./bin/sort-package-json"
+  },
   "files": [
+    "bin",
     "dist",
     "tsconfig.json",
     "tsconfig.test.json"
   ],
-  "sideEffects": false,
-  "typings": "dist/index.d.ts",
   "dependencies": {
     "@babel/core": "^7.29.0",
     "@babel/plugin-proposal-decorators": "^7.29.0",
@@ -28,12 +33,12 @@
     "@babel/preset-react": "^7.28.5",
     "@babel/preset-typescript": "^7.28.5",
     "@commitlint/config-conventional": "^20.5.0",
-    "@formatjs/ts-transformer": "^4.4.3",
+    "@formatjs/ts-transformer": "^4.4.8",
     "babel-plugin-formatjs": "^11.3.2",
     "babel-plugin-transform-import-meta": "^2.3.3",
     "deepmerge": "^4.3.1",
     "identity-obj-proxy": "^3.0.0",
-    "prettier-package-json": "^2.8.0"
+    "sort-package-json": "^3.6.1"
   },
   "devDependencies": {
     "@jest/types": "^30.3.0",
@@ -43,7 +48,6 @@
     "jest": "^30.3.0",
     "tsup": "^8.5.1"
   },
-  "keywords": [],
   "publishConfig": {
     "access": "public",
     "provenance": true

package/tsconfig.json

@@ -22,8 +22,8 @@
      */
     "types": ["node"],
     /**
-     * `target` to `es2024` because Node.js 24 supports ES2024 features.
-     * https://node.green/#ES2024
+     * `target` to `es2024` because Node.js 24 supports ES2024 features and
+     * esbuild does not yet support `es2025` as a target.
      */
     "target": "es2024",
     "declaration": true,