@ttoss/config 1.18.1 → 1.18.2

package/README.md

@@ -1,70 +1,27 @@
 # @ttoss/config
 
-<strong>@ttoss/config</strong> is an opinionated configuration library for monorepo repositories, packages, and applications. It contains a set of <a href="/docs/core/config/default-configs">default configurations</a> that you can use on your projects.
-
-Each configuration is customizable and you can extend them with your own. For example, you can use the default `.prettierrc.js` file in your monorepo:
-
-```js title=".prettierrc.js"
-const { prettierConfig } = require('@ttoss/config');
-
-module.exports = prettierConfig();
-```
-
-But, if you want to change the `printWidth` [option](https://prettier.io/docs/en/options.html), you can do so:
-
-```js title=".prettierrc.js"
-const { prettierConfig } = require('@ttoss/config');
-
-module.exports = prettierConfig({
-  printWidth: 120,
-});
-```
-
-You can also pass a second argument to every configuration to handle array's append or overwrite items.
-
-```js title="babel.config.js"
-const { babelConfig } = require('@ttoss/config');
-
-// Append plugins (default)
-const appendConfig = babelConfig(
-  {
-    plugins: ['@babel/plugin-proposal-class-properties'],
-  },
-  {
-    arrayMerge: 'append',
-  }
-);
-
-const overwriteConfig = babelConfig(
-  {
-    plugins: ['@babel/plugin-proposal-class-properties'],
-  },
-  {
-    arrayMerge: 'overwrite',
-  }
-);
-```
+**@ttoss/config** is an opinionated configuration library for [monorepo](#monorepo) and [packages](#packages). It contains a set of [default configurations](./defaults) that you can use on your projects.
 
 ## Install
 
 ```shell
-$ yarn add -DW @ttoss/config @ttoss/eslint-config
+yarn add -DW @ttoss/config
 ```
 
-It already installs:
-
-- ESLint
-- Prettier
-- commitlint
-- lint-staged
-
 ## Monorepo
 
-Add the configs of this section on the root of your monorepo. For configs for packages, you can check the section [Packages and Applications](#packages-and-applications). You can check [this monorepo template](https://github.com/ttoss/monorepo) if you want to see the final configuration after following the steps.
+Use the configs of this section on the root of your monorepo.
 
 ### ESLint and Prettier
 
-Create `.prettierrc.js` (`touch .prettierrc.js`) and add the following to it:
+Install the following packages:
+
+```shell
+yarn add -DW eslint prettier @ttoss/eslint-config
+
+```
+
+Create the `.prettierrc.js` file and add the following configuration:
 
 ```js title=".prettierrc.js"
 const { prettierConfig } = require('@ttoss/config');
@@ -72,7 +29,7 @@ const { prettierConfig } = require('@ttoss/config');
 module.exports = prettierConfig();
 ```
 
-Create `.eslintrc.js` (`touch .eslintrc.js`) and add the following to it:
+Create the `.eslintrc.js` file and add the following configuration:
 
 ```js title=".eslintrc.js"
 module.exports = {
@@ -82,15 +39,15 @@ module.exports = {
 
 ### Husky, commitlint, and lint-staged
 
-This group of packages will only work if you have already installed [ESLint and Prettier](#eslint-and-prettier).
+This group of packages will only work if you have already installed [ESLint and Prettier](#eslint-and-prettier) because lint-staged will run the `eslint --fix` command.
 
 Install the following packages on the root of your monorepo:
 
 ```shell
-yarn add -DW husky
+yarn add -DW husky @commitlint/cli lint-staged
 ```
 
-Create `.commitlintrc.js` (`touch .commitlintrc.js`) and add the following to it:
+Create the `.commitlintrc.js` file and add the following configuration:
 
 ```js title=".commitlintrc.js"
 const { commitlintConfig } = require('@ttoss/config');
@@ -98,7 +55,7 @@ const { commitlintConfig } = require('@ttoss/config');
 module.exports = commitlintConfig();
 ```
 
-Create `.lintstagedrc.js` (`touch .lintstagedrc.js`) and add the following to it:
+Create the `.lintstagedrc.js` file and add the following configuration:
 
 ```js title=".lintstagedrc.js"
 const { lintstagedConfig } = require('@ttoss/config');
@@ -115,57 +72,13 @@ yarn husky add .husky/commit-msg "yarn commitlint --edit"
 yarn husky add .husky/pre-commit "yarn lint-staged"
 ```
 
-### Lerna and Yarn Workspaces
-
-Although this package doesn't export any configuration for [Lerna](https://github.com/lerna/lerna) or [Yarn Workspaces](https://classic.yarnpkg.com/lang/en/docs/workspaces/), it's still useful to have them installed.
-
-Install [Lerna](https://github.com/lerna/lerna) on the root of your monorepo:
-
-```shell
-yarn add -DW lerna
-```
-
-And add `lerna.json` (`touch lerna.json`) config file:
-
-```json title="lerna.json"
-{
-  "version": "0.0.0",
-  "npmClient": "yarn",
-  "useWorkspaces": true,
-  "stream": true,
-  "command": {
-    "publish": {
-      "allowBranch": "main",
-      "conventionalCommits": true,
-      "message": "chore: publish new version"
-    },
-    "version": {
-      "forcePublish": true
-    }
-  }
-}
-```
-
-Finally, add the following in a `package.json` file to configure [Yarn Workspaces](https://classic.yarnpkg.com/lang/en/docs/workspaces/):
+## Packages
 
-```json title="package.json"
-{
-  "private": true,
-  "workspaces": ["packages/**/*"]
-}
-```
-
-### Turborepo
-
-Coming soon...
-
-## Packages and Applications
-
-You can use configs below to your packages and applications folders.
+You can use configs below to your packages folders.
 
 ### Babel
 
-Add `babel.config.js` (`touch babel.config.js`) on the package folder:
+Add the `babel.config.js` file on the package folder:
 
 ```js title="babel.config.js"
 const { babelConfig } = require('@ttoss/config');
@@ -181,7 +94,7 @@ Install [Jest](https://jestjs.io/) and its types on your package:
 yarn add -D jest @types/jest
 ```
 
-Create `jest.config.ts` (`touch jest.config.ts`) on the package folder:
+Create the `jest.config.ts` file on the package folder:
 
 ```ts title="jest.config.ts"
 import { jestConfig } from '@ttoss/config';
@@ -201,15 +114,15 @@ Configure the `test` script on `package.json` of your package:
 
 ### Tsup
 
-Use [tsup](https://tsup.egoist.sh/) to bundle your TypeScript package, if you need to.
+Use [tsup](https://tsup.egoist.sh/) to bundle your TypeScript packages.
 
-Install [tsup](https://tsup.egoist.sh/) on the root of your monorepo:
+Install [tsup](https://tsup.egoist.sh/) on your package.
 
 ```shell
-yarn add -DW tsup
+yarn add -D tsup
 ```
 
-Create `tsup.config.ts` (`touch tsup.config.ts`) on the package folder:
+Create the `tsup.config.ts` file on the package folder:
 
 ```ts title="tsup.config.ts"
 import { tsupConfig } from '@ttoss/config';
@@ -227,10 +140,10 @@ Configure the `build` script on `package.json`:
 
 ### TypeScript
 
-Install [TypeScript](https://www.npmjs.com/package/typescript) on the root of your monorepo:
+Install [TypeScript](https://www.npmjs.com/package/typescript) on your package:
 
 ```shell
-yarn add -DW typescript
+yarn add -D typescript
 ```
 
 Extend default configuration for each `tsconfig.json` (`touch tsconfig.json`) on the package folder:
@@ -240,3 +153,48 @@ Extend default configuration for each `tsconfig.json` (`touch tsconfig.json`) on
   "extends": "@ttoss/config/tsconfig.json"
 }
 ```
+
+## Extending configurations
+
+Each configuration is customizable and you can extend them with your own. For example, you can use the default `.prettierrc.js` file in your monorepo:
+
+```js title=".prettierrc.js"
+const { prettierConfig } = require('@ttoss/config');
+
+module.exports = prettierConfig();
+```
+
+But, if you want to change the `printWidth` [option](https://prettier.io/docs/en/options.html), you can do so:
+
+```js title=".prettierrc.js"
+const { prettierConfig } = require('@ttoss/config');
+
+module.exports = prettierConfig({
+  printWidth: 120,
+});
+```
+
+You can also pass a second argument to every configuration to handle array's append or overwrite items.
+
+```js title="babel.config.js"
+const { babelConfig } = require('@ttoss/config');
+
+// Append plugins (default)
+const appendConfig = babelConfig(
+  {
+    plugins: ['@babel/plugin-proposal-class-properties'],
+  },
+  {
+    arrayMerge: 'append',
+  }
+);
+
+const overwriteConfig = babelConfig(
+  {
+    plugins: ['@babel/plugin-proposal-class-properties'],
+  },
+  {
+    arrayMerge: 'overwrite',
+  }
+);
+```

package/dist/esm/index.js

@@ -1,4 +1,4 @@
-"use strict";
+/** Powered by @ttoss/config. https://ttoss.dev/docs/modules/packages/config/ */
 
 // src/configCreator.ts
 import deepmerge from "deepmerge";
@@ -72,7 +72,10 @@ var defaultConfig6 = {
   entryPoints: ["src/index.ts"],
   format: ["cjs", "esm"],
   legacyOutput: true,
-  minify: false
+  minify: false,
+  banner: {
+    js: `/** Powered by @ttoss/config. https://ttoss.dev/docs/modules/packages/config/ */`
+  }
 };
 var tsupConfig = configCreator(defaultConfig6);
 export {

package/dist/index.js

@@ -1,3 +1,4 @@
+/** Powered by @ttoss/config. https://ttoss.dev/docs/modules/packages/config/ */
 "use strict";
 var __create = Object.create;
 var __defProp = Object.defineProperty;
@@ -17,7 +18,10 @@ var __copyProps = (to, from, except, desc) => {
   }
   return to;
 };
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target, mod));
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // src/index.ts
@@ -104,7 +108,10 @@ var defaultConfig6 = {
   entryPoints: ["src/index.ts"],
   format: ["cjs", "esm"],
   legacyOutput: true,
-  minify: false
+  minify: false,
+  banner: {
+    js: `/** Powered by @ttoss/config. https://ttoss.dev/docs/modules/packages/config/ */`
+  }
 };
 var tsupConfig = configCreator(defaultConfig6);
 // Annotate the CommonJS export names for ESM import in node:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ttoss/config",
-  "version": "1.18.1",
+  "version": "1.18.2",
   "description": "Default configuration for packages.",
   "license": "UNLICENSED",
   "author": "ttoss",
@@ -39,5 +39,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "5624791e118681b8ecbe2372bbc61806442df71b"
+  "gitHead": "4548135614dd048140cece482703445cf436f39f"
 }

package/src/tsup.ts

@@ -15,6 +15,9 @@ export const defaultConfig: Options = {
    * Becomes difficult to debug if code is minified.
    */
   minify: false,
+  banner: {
+    js: `/** Powered by @ttoss/config. https://ttoss.dev/docs/modules/packages/config/ */`,
+  },
 };
 
 export const tsupConfig = configCreator(defaultConfig);