Update deep merge interface (api)

.editorconfig

@@ -3,5 +3,19 @@ root = true
 [*]
 indent_style = tab
 end_of_line = lf
+charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = true
+
+[*.md]
+indent_style = space
+indent_size = 2
+trim_trailing_whitespace = false
+
+[*.yml]
+indent_style = space
+indent_size = 2
+
+[{package.json,package-lock.json}]
+indent_style = space
+indent_size = 2

.eslintrc.json

@@ -0,0 +1,202 @@
+{
+	"root": true,
+	"parserOptions": {
+		"ecmaVersion": 10,
+		"ecmaFeatures": {
+      "impliedStrict": true
+    },
+		"sourceType": "module"
+	},
+	"env": {
+		"browser": true,
+		"es6": true,
+		"node": true
+	},
+	"extends": [
+		"eslint:recommended"
+	],
+	"ignorePatterns": ["dist", "types"],
+	"rules": {
+		"no-extra-boolean-cast": "error",
+		"array-bracket-spacing": [
+			"error",
+			"always",
+			{
+				"objectsInArrays": false
+			}
+		],
+		"block-spacing": ["error", "always"],
+		"brace-style": "error",
+		"comma-dangle": ["error", "always-multiline"],
+		"comma-spacing": [
+			"error",
+			{
+				"before": false,
+				"after": true
+			}
+		],
+		"comma-style": "error",
+		"curly": "error",
+		"computed-property-spacing": ["error", "never"],
+		"func-call-spacing": ["error", "never"],
+		"indent": ["error", "tab"],
+		"key-spacing": "error",
+		"keyword-spacing": "error",
+		"no-whitespace-before-property": "error",
+		"no-trailing-spaces": "error",
+		"object-curly-spacing": ["error", "always"],
+		"padded-blocks": ["error", "never"],
+		"semi": ["error", "never"],
+		"space-before-function-paren": ["error", "never"],
+		"space-in-parens": ["error", "never"],
+		"space-infix-ops": "error",
+		"space-unary-ops": [
+			"error",
+			{
+				"words": true,
+				"nonwords": false
+			}
+		],
+		"no-regex-spaces": "error",
+		"no-unsafe-negation": "error",
+		"dot-location": ["error", "property"],
+		"dot-notation": "error",
+		"no-extra-label": "error",
+		"no-multi-spaces": [
+			"error",
+			{
+				"exceptions": {
+					"Property": false
+				}
+			}
+		],
+		"no-useless-return": "error",
+		"eol-last": ["error", "always"],
+		"linebreak-style": "error",
+		"no-lonely-if": "error",
+		"no-unneeded-ternary": "error",
+		"object-curly-newline": [
+			"error",
+			{
+				"consistent": true
+			}
+		],
+		"operator-linebreak": ["error", "before"],
+		"quote-props": ["error", "as-needed"],
+		"quotes": ["error", "backtick"],
+		"space-before-blocks": ["error", "always"],
+		"spaced-comment": ["error", "always"],
+		"template-tag-spacing": "error",
+		"unicode-bom": "error",
+		"arrow-body-style": ["error", "as-needed"],
+		"arrow-parens": ["error", "always"],
+		"arrow-spacing": "error",
+		"generator-star-spacing": "error",
+		"no-useless-computed-key": "error",
+		"no-useless-rename": "error",
+		"no-var": "error",
+		"object-shorthand": "error",
+		"prefer-arrow-callback": [
+			"error",
+			{
+				"allowNamedFunctions": true
+			}
+		],
+		"prefer-const": "error",
+		"prefer-numeric-literals": "error",
+		"prefer-spread": "error",
+		"rest-spread-spacing": "error",
+		"template-curly-spacing": ["error", "always"],
+
+		"no-bitwise": "error",
+		"no-console": "off",
+		"no-debugger": "off",
+		"no-empty": "error",
+		"no-inner-declarations": "off",
+		"no-undef": "error",
+		"no-unused-vars": "warn"
+	},
+	"overrides": [
+    {
+      "files": [
+        "**/*.ts"
+      ],
+			"parser": "@typescript-eslint/parser",
+			"parserOptions": {
+				"project": [
+					"./tsconfig.json",
+					"./test/types/tsconfig.json"
+				]
+			},
+			"plugins": [
+				"@typescript-eslint"
+			],
+			"extends": [
+				"plugin:@typescript-eslint/recommended",
+				"plugin:@typescript-eslint/recommended-requiring-type-checking"
+			],
+      "rules": {
+				"@typescript-eslint/array-type": [
+					"error",
+					{
+						"default": "generic"
+					}
+				],
+				"@typescript-eslint/ban-types": [
+					"error",
+					{
+						"types": {
+							"Object": {
+								"message": "Use object instead",
+								"fixWith": "object"
+							},
+							"object": false
+						},
+						"extendDefaults": true
+					}
+				],
+				"@typescript-eslint/consistent-type-imports": "error",
+				"@typescript-eslint/prefer-interface": "off",
+				"@typescript-eslint/no-require-imports": "error",
+				"@typescript-eslint/no-unused-vars": "off",
+				"@typescript-eslint/no-unused-vars-experimental": [
+					"warn",
+					{
+						"ignoredNamesRegex": "^_",
+						"ignoreArgsIfArgsAfterAreUsed": true
+					}
+				],
+				"@typescript-eslint/no-use-before-define": [
+					"error",
+					{
+						"functions": false,
+						"variables": true
+					}
+				],
+
+				"@typescript-eslint/prefer-for-of": "warn",
+				"@typescript-eslint/prefer-includes": "warn",
+				"@typescript-eslint/prefer-nullish-coalescing": "warn",
+				"@typescript-eslint/prefer-optional-chain": "warn",
+				"@typescript-eslint/prefer-string-starts-ends-with": "warn",
+				"@typescript-eslint/prefer-ts-expect-error": "warn",
+				"@typescript-eslint/switch-exhaustiveness-check": "warn",
+				"@typescript-eslint/unified-signatures": "warn",
+
+				"@typescript-eslint/no-explicit-any": "off",
+				"@typescript-eslint/no-unsafe-member-access": "off",
+				"@typescript-eslint/no-unsafe-assignment": "off",
+				"@typescript-eslint/no-unsafe-return": "off"
+			}
+		},
+		{
+      "files": [
+				"**/test/**/*",
+				"**/*test.ts"
+      ],
+      "rules": {
+				"no-unused-vars": "off"
+      }
+    }
+  ]
+}

.github/workflows/ci.yml

@@ -0,0 +1,49 @@
+name: CI
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  lint:
+    name: Linting Checks
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup NodeJs
+        uses: actions/setup-node@v1
+        with:
+          node-version: "14"
+
+      - name: Install Dependencies
+        run: npm ci
+
+      - name: Run Linting Checks
+        run: npm run lint
+  test:
+    strategy:
+      fail-fast: true
+      matrix:
+        os:
+          - ubuntu-latest
+        node_version:
+          - "14"
+          - "12"
+    name: Test with Node ${{ matrix.node_version }} on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup NodeJs
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node_version }}
+
+      - name: Install Dependencies
+        run: npm ci
+
+      - name: Run Tests
+        run: npm run test

.gitignore

@@ -1,2 +1,4 @@
 node_modules
 dist/*
+types/*
+!types/legacy*

changelog.md

@@ -1,5 +1,14 @@
 # [5.0.0](https://github.com/TehShrike/deepmerge/releases/tag/v5.0.0)
 
+- Update to the internals exposed in the passed `options` object
+  - `deepMerge`
+  - `deepClone`
+  - Breaking: `cloneUnlessOtherwiseSpecified` has been removed - `deepClone` is very similar
+- Breaking: Cloning is not turned off by default
+- Breaking: Endpoint are now exported in esm style [#215](https://github.com/TehShrike/deepmerge/pull/215)
+  - The main merge function is now a default export
+  - The all merge function is now exported as "deepmergeAll" and is no longer a property on the main merge function.
+- Breaking: TypeScript types have been completely reworked [#215](https://github.com/TehShrike/deepmerge/pull/215)
 - Breaking for ES5 environments: `Object.assign` is now used to avoid mutating the `options` argument.   [#167](https://github.com/TehShrike/deepmerge/pull/167)
 - Breaking: by default, only [plain objects](https://github.com/sindresorhus/is-plain-obj/#is-plain-obj-) will have their properties merged, with all other values being copied to the target.  [#152](https://github.com/TehShrike/deepmerge/issues/152)
 - Breaking: the `isMergeableObject` option is renamed to `isMergeable` [#168](https://github.com/TehShrike/deepmerge/pull/168)