@ttoss/config 1.11.3 → 1.11.6

package/README.md

@@ -1,23 +1,102 @@
 # @ttoss/config
 
-## 📚 About
+<strong>@ttoss/config</strong> is a very opinionated configuration library for monorepo repositories, packages, and applications. It contains a set of default configuration methods that you can use to configure your projects.
 
-<strong> @ttoss/config</strong> is a easiest way to use Configs in your React application.
+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:
 
-## 🚀 Get Started
+```js title=".prettierrc.js"
+const { prettierConfig } = require('@ttoss/config');
 
-### Install
+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,
+});
+```
+
+## Install
+
+```shell
+$ yarn add -DW @ttoss/config
+```
+
+## Monorepo
+
+### Eslint and Prettier
+
+Install the following packages on the root of your monorepo:
+
+```shell
+yarn add -DW eslint @rushstack/eslint-patch prettier
+```
+
+Create `.prettierrc.js`:
+
+```js title=".prettierrc.js"
+const { prettierConfig } = require('@ttoss/config');
+
+module.exports = prettierConfig();
+```
+
+Create `.eslintrc.js`:
+
+```js title=".eslintrc.js"
+require('@rushstack/eslint-patch/modern-module-resolution');
+
+module.exports = {
+  extends: '@ttoss/eslint-config',
+};
+```
+
+You need `require('@rushstack/eslint-patch/modern-module-resolution');` because ESLint doesn't support plugins as dependency in shareable ESLint configuration, as you can see on [this issue](https://github.com/eslint/eslint/issues/3458). To overcome this, you can use the [`@rushstack/eslint-patch` package](https://www.npmjs.com/package/@rushstack/eslint-patch), a patch that improves how ESLint loads plugins when working in a monorepo
+
+### Husky, commitlint, and lint-staged
+
+This group of packages will only work if you have already installed [Eslint and Prettier](#eslint-and-prettier).
+
+Install the following packages on the root of your monorepo:
+
+```shell
+yarn add -DW husky @commitlint/cli lint-staged
+```
+
+Create `.commitlintrc.js`:
+
+```js title=".commitlintrc.js"
+const { commitlintConfig } = require('@ttoss/config');
+
+module.exports = commitlintConfig();
+```
+
+Create `.lintstagedrc.js`:
+
+```js title=".lintstagedrc.js"
+const { lintstagedConfig } = require('@ttoss/config');
+
+module.exports = lintstagedConfig();
+```
+
+Finally, configure Husky:
 
 ```shell
-$ yarn add @ttoss/config
-# or
-$ npm install @ttoss/config
+yarn set-script prepare "husky install"
+yarn run prepare
+yarn husky add .husky/commit-msg "yarn commitlint --edit"
+yarn husky add .husky/pre-commit "yarn lint-staged"
 ```
 
-## 📄 Examples of use
+## Packages and Applications
 
 ### Babel
 
+Add `babel.config.js` to each package:
+
 ```js title="babel.config.js"
 const { babelConfig } = require('@ttoss/config');
 
@@ -26,30 +105,66 @@ module.exports = babelConfig();
 
 ### Jest
 
+Install [Jest](https://jestjs.io/) and its types on the root of your monorepo (or package):
+
+```shell
+yarn add -DW jest @types/jest
+```
+
+Create `jest.config.ts` for each package:
+
 ```ts title="jest.config.ts"
 import { jestConfig } from '@ttoss/config';
 
-const config = jestConfig({
-  moduleNameMapper: {
-    '\\.(css)$': 'identity-obj-proxy',
-  },
-  setupFilesAfterEnv: ['./jest.setup.tsx'],
-  testEnvironment: 'jsdom',
-});
+const config = jestConfig();
 
 export default config;
 ```
 
+Configure the `test` script on `package.json`:
+
+```json title="package.json'
+"scripts: {
+  test: 'jest',
+}
+```
+
 ### Tsup
 
+Use [tsup](https://tsup.egoist.sh/) to bundle your TypeScript package, if you need to.
+
+Install [tsup](https://tsup.egoist.sh/) on the root of your monorepo (or package):
+
+```shell
+yarn add -DW tsup
+```
+
+Create `tsup.config.ts` for each package:
+
 ```ts title="tsup.config.ts"
 import { tsupConfig } from '@ttoss/config';
 
 export const tsup = tsupConfig();
 ```
 
+Configure the `build` script on `package.json`:
+
+```json title="package.json'
+"scripts: {
+  build: 'tsup',
+}
+```
+
 ### TypeScript
 
+Install [TypeScript](https://www.npmjs.com/package/typescript) on the root of your monorepo (or package):
+
+```shell
+yarn add -DW typescript
+```
+
+Extend default configuration for each `tsconfig.json` of the packages:
+
 ```json title="tsconfig.json"
 {
   "extends": "@ttoss/config/tsconfig.json"

package/dist/esm/index.js

@@ -1,7 +1,7 @@
 // src/configCreator.ts
 import deepmerge from "deepmerge";
 var overwriteMerge = (_, sourceArray) => sourceArray;
-var configCreator = (defaultConfig4 = {}) => (config = {}) => deepmerge(defaultConfig4, config, { arrayMerge: overwriteMerge });
+var configCreator = (defaultConfig7 = {}) => (config = {}) => deepmerge(defaultConfig7, config, { arrayMerge: overwriteMerge });
 
 // src/babel.ts
 var defaultConfig = {
@@ -22,8 +22,14 @@ var defaultConfig = {
 };
 var babelConfig = configCreator(defaultConfig);
 
-// src/jest.ts
+// src/commitlint.ts
 var defaultConfig2 = {
+  extends: ["@commitlint/config-conventional"]
+};
+var commitlintConfig = configCreator(defaultConfig2);
+
+// src/jest.ts
+var defaultConfig3 = {
   clearMocks: true,
   collectCoverage: true,
   coverageDirectory: "coverage",
@@ -33,10 +39,27 @@ var defaultConfig2 = {
   },
   timers: "fake"
 };
-var jestConfig = configCreator(defaultConfig2);
+var jestConfig = configCreator(defaultConfig3);
+
+// src/lintstaged.ts
+var defaultConfig4 = {
+  "*.{js,jsx,ts,tsx}": "eslint --fix",
+  "*.{md,mdx,html,json,yml,yaml}": "prettier --write"
+};
+var lintstagedConfig = configCreator(defaultConfig4);
+
+// src/prettier.ts
+var defaultConfig5 = {
+  arrowParens: "always",
+  printWidth: 80,
+  semi: true,
+  singleQuote: true,
+  trailingComma: "es5"
+};
+var prettierConfig = configCreator(defaultConfig5);
 
 // src/tsup.ts
-var defaultConfig3 = {
+var defaultConfig6 = {
   clean: true,
   dts: true,
   entryPoints: ["src/index.ts"],
@@ -44,9 +67,12 @@ var defaultConfig3 = {
   legacyOutput: true,
   minify: false
 };
-var tsupConfig = configCreator(defaultConfig3);
+var tsupConfig = configCreator(defaultConfig6);
 export {
   babelConfig,
+  commitlintConfig,
   jestConfig,
+  lintstagedConfig,
+  prettierConfig,
   tsupConfig
 };

package/dist/index.d.ts

@@ -2,8 +2,14 @@ import { Options } from 'tsup';
 
 declare const babelConfig: (config?: any) => any;
 
+declare const commitlintConfig: (config?: any) => any;
+
 declare const jestConfig: (config?: any) => any;
 
+declare const lintstagedConfig: (config?: any) => any;
+
+declare const prettierConfig: (config?: any) => any;
+
 declare const tsupConfig: (config?: Options) => Options;
 
-export { babelConfig, jestConfig, tsupConfig };
+export { babelConfig, commitlintConfig, jestConfig, lintstagedConfig, prettierConfig, tsupConfig };

package/dist/index.js

@@ -4,40 +4,37 @@ var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
 var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __markAsModule = (target) => __defProp(target, "__esModule", { value: true });
 var __export = (target, all) => {
   for (var name in all)
     __defProp(target, name, { get: all[name], enumerable: true });
 };
-var __reExport = (target, module2, copyDefault, desc) => {
-  if (module2 && typeof module2 === "object" || typeof module2 === "function") {
-    for (let key of __getOwnPropNames(module2))
-      if (!__hasOwnProp.call(target, key) && (copyDefault || key !== "default"))
-        __defProp(target, key, { get: () => module2[key], enumerable: !(desc = __getOwnPropDesc(module2, key)) || desc.enumerable });
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
   }
-  return target;
+  return to;
 };
-var __toESM = (module2, isNodeMode) => {
-  return __reExport(__markAsModule(__defProp(module2 != null ? __create(__getProtoOf(module2)) : {}, "default", !isNodeMode && module2 && module2.__esModule ? { get: () => module2.default, enumerable: true } : { value: module2, enumerable: true })), module2);
-};
-var __toCommonJS = /* @__PURE__ */ ((cache) => {
-  return (module2, temp) => {
-    return cache && cache.get(module2) || (temp = __reExport(__markAsModule({}), module2, 1), cache && cache.set(module2, temp), temp);
-  };
-})(typeof WeakMap !== "undefined" ? /* @__PURE__ */ new WeakMap() : 0);
+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
 var src_exports = {};
 __export(src_exports, {
   babelConfig: () => babelConfig,
+  commitlintConfig: () => commitlintConfig,
   jestConfig: () => jestConfig,
+  lintstagedConfig: () => lintstagedConfig,
+  prettierConfig: () => prettierConfig,
   tsupConfig: () => tsupConfig
 });
+module.exports = __toCommonJS(src_exports);
 
 // src/configCreator.ts
 var import_deepmerge = __toESM(require("deepmerge"));
 var overwriteMerge = (_, sourceArray) => sourceArray;
-var configCreator = (defaultConfig4 = {}) => (config = {}) => (0, import_deepmerge.default)(defaultConfig4, config, { arrayMerge: overwriteMerge });
+var configCreator = (defaultConfig7 = {}) => (config = {}) => (0, import_deepmerge.default)(defaultConfig7, config, { arrayMerge: overwriteMerge });
 
 // src/babel.ts
 var defaultConfig = {
@@ -58,8 +55,14 @@ var defaultConfig = {
 };
 var babelConfig = configCreator(defaultConfig);
 
-// src/jest.ts
+// src/commitlint.ts
 var defaultConfig2 = {
+  extends: ["@commitlint/config-conventional"]
+};
+var commitlintConfig = configCreator(defaultConfig2);
+
+// src/jest.ts
+var defaultConfig3 = {
   clearMocks: true,
   collectCoverage: true,
   coverageDirectory: "coverage",
@@ -69,10 +72,27 @@ var defaultConfig2 = {
   },
   timers: "fake"
 };
-var jestConfig = configCreator(defaultConfig2);
+var jestConfig = configCreator(defaultConfig3);
+
+// src/lintstaged.ts
+var defaultConfig4 = {
+  "*.{js,jsx,ts,tsx}": "eslint --fix",
+  "*.{md,mdx,html,json,yml,yaml}": "prettier --write"
+};
+var lintstagedConfig = configCreator(defaultConfig4);
+
+// src/prettier.ts
+var defaultConfig5 = {
+  arrowParens: "always",
+  printWidth: 80,
+  semi: true,
+  singleQuote: true,
+  trailingComma: "es5"
+};
+var prettierConfig = configCreator(defaultConfig5);
 
 // src/tsup.ts
-var defaultConfig3 = {
+var defaultConfig6 = {
   clean: true,
   dts: true,
   entryPoints: ["src/index.ts"],
@@ -80,11 +100,13 @@ var defaultConfig3 = {
   legacyOutput: true,
   minify: false
 };
-var tsupConfig = configCreator(defaultConfig3);
-module.exports = __toCommonJS(src_exports);
+var tsupConfig = configCreator(defaultConfig6);
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   babelConfig,
+  commitlintConfig,
   jestConfig,
+  lintstagedConfig,
+  prettierConfig,
   tsupConfig
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ttoss/config",
-  "version": "1.11.3",
+  "version": "1.11.6",
   "description": "Default configuration for packages.",
   "license": "UNLICENSED",
   "publishConfig": {
@@ -31,14 +31,16 @@
     "@babel/preset-env": "^7.16.11",
     "@babel/preset-react": "^7.16.7",
     "@babel/preset-typescript": "^7.16.7",
+    "@commitlint/config-conventional": "^16.0.0",
     "@emotion/jest": "^11.7.1",
     "@formatjs/ts-transformer": "^3.9.1",
+    "babel-jest": "^27.4.6",
     "babel-plugin-formatjs": "^10.3.18",
     "deepmerge": "^4.2.2",
     "identity-obj-proxy": "^3.0.0",
     "tsup": "^5.11.11"
   },
-  "gitHead": "1b83ca31ec31fc50ea04fa9fef5a25116a5c06c5",
+  "gitHead": "eb5615ee3b87ffa3eea40f072cefb6d74a3f5423",
   "devDependencies": {
     "@jest/types": "^27.4.2"
   }

package/src/commitlint.spec.ts

@@ -0,0 +1,13 @@
+import { commitlintConfig, defaultConfig } from './commitlint';
+
+test('should return default configuration', () => {
+  expect(commitlintConfig()).toEqual(defaultConfig);
+});
+
+test('should return default configuration', () => {
+  expect(
+    commitlintConfig({
+      extends: ['other-config'],
+    })
+  ).toEqual({ ...defaultConfig, extends: ['other-config'] });
+});

package/src/commitlint.ts

@@ -0,0 +1,10 @@
+/**
+ * https://prettier.io/docs/en/configuration.html#sharing-configurations
+ */
+import { configCreator } from './configCreator';
+
+export const defaultConfig: any = {
+  extends: ['@commitlint/config-conventional'],
+};
+
+export const commitlintConfig = configCreator(defaultConfig);

package/src/index.spec.ts

@@ -2,6 +2,9 @@ import * as allConfigs from '.';
 
 it('configs should be exported', () => {
   expect(allConfigs.babelConfig).toBeDefined();
+  expect(allConfigs.commitlintConfig).toBeDefined();
   expect(allConfigs.jestConfig).toBeDefined();
+  expect(allConfigs.lintstagedConfig).toBeDefined();
+  expect(allConfigs.prettierConfig).toBeDefined();
   expect(allConfigs.tsupConfig).toBeDefined();
 });

package/src/index.ts

@@ -1,3 +1,6 @@
 export { babelConfig } from './babel';
+export { commitlintConfig } from './commitlint';
 export { jestConfig } from './jest';
+export { lintstagedConfig } from './lintstaged';
+export { prettierConfig } from './prettier';
 export { tsupConfig } from './tsup';

package/src/lintstaged.spec.ts

@@ -0,0 +1,13 @@
+import { lintstagedConfig, defaultConfig } from './lintstaged';
+
+test('should return default configuration', () => {
+  expect(lintstagedConfig()).toEqual(defaultConfig);
+});
+
+test('should return default configuration', () => {
+  expect(
+    lintstagedConfig({
+      '.js': 'eslint --fix',
+    })
+  ).toEqual({ ...defaultConfig, '.js': 'eslint --fix' });
+});

package/src/lintstaged.ts

@@ -0,0 +1,8 @@
+import { configCreator } from './configCreator';
+
+export const defaultConfig: any = {
+  '*.{js,jsx,ts,tsx}': 'eslint --fix',
+  '*.{md,mdx,html,json,yml,yaml}': 'prettier --write',
+};
+
+export const lintstagedConfig = configCreator(defaultConfig);

package/src/prettier.spec.ts

@@ -0,0 +1,13 @@
+import { prettierConfig, defaultConfig } from './prettier';
+
+test('should return default configuration', () => {
+  expect(prettierConfig()).toEqual(defaultConfig);
+});
+
+test('should return default configuration', () => {
+  expect(
+    prettierConfig({
+      printWidth: 100,
+    })
+  ).toEqual({ ...defaultConfig, printWidth: 100 });
+});

package/src/prettier.ts

@@ -0,0 +1,14 @@
+/**
+ * https://prettier.io/docs/en/configuration.html#sharing-configurations
+ */
+import { configCreator } from './configCreator';
+
+export const defaultConfig: any = {
+  arrowParens: 'always',
+  printWidth: 80,
+  semi: true,
+  singleQuote: true,
+  trailingComma: 'es5',
+};
+
+export const prettierConfig = configCreator(defaultConfig);