@ttoss/config 1.11.6 → 1.12.1

package/README.md

@@ -1,6 +1,6 @@
 # @ttoss/config
 
-<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 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:
 
@@ -20,6 +20,31 @@ module.exports = prettierConfig({
 });
 ```
 
+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',
+  }
+);
+```
+
 ## Install
 
 ```shell
@@ -28,7 +53,7 @@ $ yarn add -DW @ttoss/config
 
 ## Monorepo
 
-### Eslint and Prettier
+### ESLint and Prettier
 
 Install the following packages on the root of your monorepo:
 
@@ -58,7 +83,7 @@ You need `require('@rushstack/eslint-patch/modern-module-resolution');` because
 
 ### 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).
 
 Install the following packages on the root of your monorepo:
 
@@ -91,6 +116,50 @@ 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` 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/):
+
+```json title="package.json"
+{
+  "private": true,
+  "workspaces": ["workspace-a", "workspace-b"]
+}
+```
+
+### Turborepo
+
+Coming soon...
+
 ## Packages and Applications
 
 ### Babel
@@ -123,7 +192,7 @@ export default config;
 
 Configure the `test` script on `package.json`:
 
-```json title="package.json'
+```json title="package.json"
 "scripts: {
   test: 'jest',
 }
@@ -149,7 +218,7 @@ export const tsup = tsupConfig();
 
 Configure the `build` script on `package.json`:
 
-```json title="package.json'
+```json title="package.json"
 "scripts: {
   build: 'tsup',
 }

package/dist/esm/index.js

@@ -1,7 +1,9 @@
 // src/configCreator.ts
 import deepmerge from "deepmerge";
 var overwriteMerge = (_, sourceArray) => sourceArray;
-var configCreator = (defaultConfig7 = {}) => (config = {}) => deepmerge(defaultConfig7, config, { arrayMerge: overwriteMerge });
+var configCreator = (defaultConfig7 = {}) => (config = {}, deepmergeConfig) => deepmerge(defaultConfig7, config, {
+  arrayMerge: (deepmergeConfig == null ? void 0 : deepmergeConfig.arrayMerge) === "overwrite" ? overwriteMerge : void 0
+});
 
 // src/babel.ts
 var defaultConfig = {

package/dist/index.d.ts

@@ -1,15 +1,256 @@
+import { Config } from '@jest/types';
 import { Options } from 'tsup';
 
-declare const babelConfig: (config?: any) => any;
+declare const babelConfig: (config?: any, deepmergeConfig?: {
+    arrayMerge: "append" | "overwrite";
+} | undefined) => any;
 
-declare const commitlintConfig: (config?: any) => any;
+declare const commitlintConfig: (config?: any, deepmergeConfig?: {
+    arrayMerge: "append" | "overwrite";
+} | undefined) => any;
 
-declare const jestConfig: (config?: any) => any;
+declare const jestConfig: (config?: Partial<{
+    automock: boolean;
+    bail: number | boolean;
+    cache: boolean;
+    cacheDirectory: string;
+    ci: boolean;
+    clearMocks: boolean;
+    changedFilesWithAncestor: boolean;
+    changedSince: string;
+    collectCoverage: boolean;
+    collectCoverageFrom: string[];
+    collectCoverageOnlyFrom: {
+        [key: string]: boolean;
+    };
+    coverageDirectory: string;
+    coveragePathIgnorePatterns: string[];
+    coverageProvider: "v8" | "babel";
+    coverageReporters: Config.CoverageReporters;
+    coverageThreshold: {
+        [path: string]: Config.CoverageThresholdValue;
+        global: Config.CoverageThresholdValue;
+    };
+    dependencyExtractor: string;
+    detectLeaks: boolean;
+    detectOpenHandles: boolean;
+    displayName: string | Config.DisplayName;
+    expand: boolean;
+    extensionsToTreatAsEsm: string[];
+    extraGlobals: string[];
+    filter: string;
+    findRelatedTests: boolean;
+    forceCoverageMatch: string[];
+    forceExit: boolean;
+    json: boolean;
+    globals: Config.ConfigGlobals;
+    globalSetup: string | null | undefined;
+    globalTeardown: string | null | undefined;
+    haste: Config.HasteConfig;
+    injectGlobals: boolean;
+    reporters: (string | Config.ReporterConfig)[];
+    logHeapUsage: boolean;
+    lastCommit: boolean;
+    listTests: boolean;
+    maxConcurrency: number;
+    maxWorkers: string | number;
+    moduleDirectories: string[];
+    moduleFileExtensions: string[];
+    moduleLoader: string;
+    moduleNameMapper: {
+        [key: string]: string | string[];
+    };
+    modulePathIgnorePatterns: string[];
+    modulePaths: string[];
+    name: string;
+    noStackTrace: boolean;
+    notify: boolean;
+    notifyMode: string;
+    onlyChanged: boolean;
+    onlyFailures: boolean;
+    outputFile: string;
+    passWithNoTests: boolean;
+    preprocessorIgnorePatterns: string[];
+    preset: string | null | undefined;
+    prettierPath: string | null | undefined;
+    projects: (string | Config.InitialProjectOptions)[];
+    replname: string | null | undefined;
+    resetMocks: boolean;
+    resetModules: boolean;
+    resolver: string | null | undefined;
+    restoreMocks: boolean;
+    rootDir: string;
+    roots: string[];
+    runner: string;
+    runTestsByPath: boolean;
+    scriptPreprocessor: string;
+    setupFiles: string[];
+    setupTestFrameworkScriptFile: string;
+    setupFilesAfterEnv: string[];
+    silent: boolean;
+    skipFilter: boolean;
+    skipNodeResolution: boolean;
+    slowTestThreshold: number;
+    snapshotResolver: string;
+    snapshotSerializers: string[];
+    snapshotFormat: Config.PrettyFormatOptions;
+    errorOnDeprecated: boolean;
+    testEnvironment: string;
+    testEnvironmentOptions: Record<string, unknown>;
+    testFailureExitCode: string | number;
+    testLocationInResults: boolean;
+    testMatch: string[];
+    testNamePattern: string;
+    testPathDirs: string[];
+    testPathIgnorePatterns: string[];
+    testRegex: string | string[];
+    testResultsProcessor: string;
+    testRunner: string;
+    testSequencer: string;
+    testURL: string;
+    testTimeout: number;
+    timers: "fake" | "real" | "modern" | "legacy";
+    transform: {
+        [regex: string]: string | Config.TransformerConfig;
+    };
+    transformIgnorePatterns: string[];
+    watchPathIgnorePatterns: string[];
+    unmockedModulePathPatterns: string[];
+    updateSnapshot: boolean;
+    useStderr: boolean;
+    verbose?: boolean | undefined;
+    watch: boolean;
+    watchAll: boolean;
+    watchman: boolean;
+    watchPlugins: (string | [string, Record<string, unknown>])[];
+}>, deepmergeConfig?: {
+    arrayMerge: "append" | "overwrite";
+} | undefined) => Partial<{
+    automock: boolean;
+    bail: number | boolean;
+    cache: boolean;
+    cacheDirectory: string;
+    ci: boolean;
+    clearMocks: boolean;
+    changedFilesWithAncestor: boolean;
+    changedSince: string;
+    collectCoverage: boolean;
+    collectCoverageFrom: string[];
+    collectCoverageOnlyFrom: {
+        [key: string]: boolean;
+    };
+    coverageDirectory: string;
+    coveragePathIgnorePatterns: string[];
+    coverageProvider: "v8" | "babel";
+    coverageReporters: Config.CoverageReporters;
+    coverageThreshold: {
+        [path: string]: Config.CoverageThresholdValue;
+        global: Config.CoverageThresholdValue;
+    };
+    dependencyExtractor: string;
+    detectLeaks: boolean;
+    detectOpenHandles: boolean;
+    displayName: string | Config.DisplayName;
+    expand: boolean;
+    extensionsToTreatAsEsm: string[];
+    extraGlobals: string[];
+    filter: string;
+    findRelatedTests: boolean;
+    forceCoverageMatch: string[];
+    forceExit: boolean;
+    json: boolean;
+    globals: Config.ConfigGlobals;
+    globalSetup: string | null | undefined;
+    globalTeardown: string | null | undefined;
+    haste: Config.HasteConfig;
+    injectGlobals: boolean;
+    reporters: (string | Config.ReporterConfig)[];
+    logHeapUsage: boolean;
+    lastCommit: boolean;
+    listTests: boolean;
+    maxConcurrency: number;
+    maxWorkers: string | number;
+    moduleDirectories: string[];
+    moduleFileExtensions: string[];
+    moduleLoader: string;
+    moduleNameMapper: {
+        [key: string]: string | string[];
+    };
+    modulePathIgnorePatterns: string[];
+    modulePaths: string[];
+    name: string;
+    noStackTrace: boolean;
+    notify: boolean;
+    notifyMode: string;
+    onlyChanged: boolean;
+    onlyFailures: boolean;
+    outputFile: string;
+    passWithNoTests: boolean;
+    preprocessorIgnorePatterns: string[];
+    preset: string | null | undefined;
+    prettierPath: string | null | undefined;
+    projects: (string | Config.InitialProjectOptions)[];
+    replname: string | null | undefined;
+    resetMocks: boolean;
+    resetModules: boolean;
+    resolver: string | null | undefined;
+    restoreMocks: boolean;
+    rootDir: string;
+    roots: string[];
+    runner: string;
+    runTestsByPath: boolean;
+    scriptPreprocessor: string;
+    setupFiles: string[];
+    setupTestFrameworkScriptFile: string;
+    setupFilesAfterEnv: string[];
+    silent: boolean;
+    skipFilter: boolean;
+    skipNodeResolution: boolean;
+    slowTestThreshold: number;
+    snapshotResolver: string;
+    snapshotSerializers: string[];
+    snapshotFormat: Config.PrettyFormatOptions;
+    errorOnDeprecated: boolean;
+    testEnvironment: string;
+    testEnvironmentOptions: Record<string, unknown>;
+    testFailureExitCode: string | number;
+    testLocationInResults: boolean;
+    testMatch: string[];
+    testNamePattern: string;
+    testPathDirs: string[];
+    testPathIgnorePatterns: string[];
+    testRegex: string | string[];
+    testResultsProcessor: string;
+    testRunner: string;
+    testSequencer: string;
+    testURL: string;
+    testTimeout: number;
+    timers: "fake" | "real" | "modern" | "legacy";
+    transform: {
+        [regex: string]: string | Config.TransformerConfig;
+    };
+    transformIgnorePatterns: string[];
+    watchPathIgnorePatterns: string[];
+    unmockedModulePathPatterns: string[];
+    updateSnapshot: boolean;
+    useStderr: boolean;
+    verbose?: boolean | undefined;
+    watch: boolean;
+    watchAll: boolean;
+    watchman: boolean;
+    watchPlugins: (string | [string, Record<string, unknown>])[];
+}>;
 
-declare const lintstagedConfig: (config?: any) => any;
+declare const lintstagedConfig: (config?: any, deepmergeConfig?: {
+    arrayMerge: "append" | "overwrite";
+} | undefined) => any;
 
-declare const prettierConfig: (config?: any) => any;
+declare const prettierConfig: (config?: any, deepmergeConfig?: {
+    arrayMerge: "append" | "overwrite";
+} | undefined) => any;
 
-declare const tsupConfig: (config?: Options) => Options;
+declare const tsupConfig: (config?: Options, deepmergeConfig?: {
+    arrayMerge: "append" | "overwrite";
+} | undefined) => Options;
 
 export { babelConfig, commitlintConfig, jestConfig, lintstagedConfig, prettierConfig, tsupConfig };

package/dist/index.js

@@ -34,7 +34,9 @@ module.exports = __toCommonJS(src_exports);
 // src/configCreator.ts
 var import_deepmerge = __toESM(require("deepmerge"));
 var overwriteMerge = (_, sourceArray) => sourceArray;
-var configCreator = (defaultConfig7 = {}) => (config = {}) => (0, import_deepmerge.default)(defaultConfig7, config, { arrayMerge: overwriteMerge });
+var configCreator = (defaultConfig7 = {}) => (config = {}, deepmergeConfig) => (0, import_deepmerge.default)(defaultConfig7, config, {
+  arrayMerge: (deepmergeConfig == null ? void 0 : deepmergeConfig.arrayMerge) === "overwrite" ? overwriteMerge : void 0
+});
 
 // src/babel.ts
 var defaultConfig = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ttoss/config",
-  "version": "1.11.6",
+  "version": "1.12.1",
   "description": "Default configuration for packages.",
   "license": "UNLICENSED",
   "publishConfig": {
@@ -40,7 +40,7 @@
     "identity-obj-proxy": "^3.0.0",
     "tsup": "^5.11.11"
   },
-  "gitHead": "eb5615ee3b87ffa3eea40f072cefb6d74a3f5423",
+  "gitHead": "1236f19e0efc3ed37df87f1bbfd21776b6b5d697",
   "devDependencies": {
     "@jest/types": "^27.4.2"
   }

package/src/babel.spec.ts

@@ -3,3 +3,24 @@ import { babelConfig, defaultConfig } from './babel';
 test('should return default config', () => {
   expect(babelConfig()).toEqual(defaultConfig);
 });
+
+test('should update plugin', () => {
+  expect(
+    babelConfig(
+      { plugins: ['relay'] },
+      {
+        arrayMerge: 'overwrite',
+      }
+    )
+  ).toEqual({
+    ...defaultConfig,
+    plugins: ['relay'],
+  });
+});
+
+test('should append plugin', () => {
+  expect(babelConfig({ plugins: ['relay'] })).toEqual({
+    ...defaultConfig,
+    plugins: [...defaultConfig.plugins, 'relay'],
+  });
+});

package/src/commitlint.spec.ts

@@ -4,10 +4,15 @@ test('should return default configuration', () => {
   expect(commitlintConfig()).toEqual(defaultConfig);
 });
 
-test('should return default configuration', () => {
+test('should return default configuration with different extends', () => {
   expect(
-    commitlintConfig({
-      extends: ['other-config'],
-    })
+    commitlintConfig(
+      {
+        extends: ['other-config'],
+      },
+      {
+        arrayMerge: 'overwrite',
+      }
+    )
   ).toEqual({ ...defaultConfig, extends: ['other-config'] });
 });

package/src/configCreator.spec.ts

@@ -0,0 +1,36 @@
+import { configCreator } from './configCreator';
+
+const defaultConfig: any = {
+  obj: { a: 1, b: 2 },
+  arr: [1, 2, 3],
+};
+
+const config = configCreator(defaultConfig);
+
+test('should append array', () => {
+  expect(config({ arr: [4, 5] })).toEqual({
+    obj: { a: 1, b: 2 },
+    arr: [1, 2, 3, 4, 5],
+  });
+});
+
+test('should overwrite array', () => {
+  expect(
+    config(
+      { arr: [4, 5] },
+      {
+        arrayMerge: 'overwrite',
+      }
+    )
+  ).toEqual({
+    obj: { a: 1, b: 2 },
+    arr: [4, 5],
+  });
+});
+
+test('should add obj key', () => {
+  expect(config({ obj: { c: 3 } })).toEqual({
+    arr: [1, 2, 3],
+    obj: { a: 1, b: 2, c: 3 },
+  });
+});

package/src/configCreator.ts

@@ -4,5 +4,13 @@ const overwriteMerge = (_: any, sourceArray: any) => sourceArray;
 
 export const configCreator =
   <T extends Record<string, any>>(defaultConfig: T = {} as T) =>
-  (config: T = {} as T) =>
-    deepmerge<T>(defaultConfig, config, { arrayMerge: overwriteMerge });
+  (
+    config: T = {} as T,
+    deepmergeConfig?: { arrayMerge: 'append' | 'overwrite' }
+  ) =>
+    deepmerge<T>(defaultConfig, config, {
+      arrayMerge:
+        deepmergeConfig?.arrayMerge === 'overwrite'
+          ? overwriteMerge
+          : undefined,
+    });

package/src/jest.ts

@@ -198,4 +198,4 @@ export const defaultConfig: Config.InitialOptions = {
   // watchman: true,
 };
 
-export const jestConfig = configCreator<any>(defaultConfig);
+export const jestConfig = configCreator<Config.InitialOptions>(defaultConfig);

package/src/tsup.spec.ts

@@ -1,13 +1,18 @@
-import { tsupConfig, defaultConfig } from './tsup';
+import { defaultConfig, tsupConfig } from './tsup';
 
 test('should return default configuration', () => {
   expect(tsupConfig()).toEqual(defaultConfig);
 });
 
-test('should return default configuration', () => {
+test('should return default configuration with different entrypoint', () => {
   expect(
-    tsupConfig({
-      entryPoints: ['src/index.tsx'],
-    })
+    tsupConfig(
+      {
+        entryPoints: ['src/index.tsx'],
+      },
+      {
+        arrayMerge: 'overwrite',
+      }
+    )
   ).toEqual({ ...defaultConfig, entryPoints: ['src/index.tsx'] });
 });