Restructure Codebase #215

RebeccaStevens · 2020-11-12T04:14:12Z

Refactor code into multiple files
Switch to using TypeScript
Update dev dependencies

fixes #180
fixes #179
fixes #161
fixes #147

closes #213
closes #211
closes #200
closes #198
closes #188
closes #181
closes #173
closes #148

This change is

TehShrike

Some quick ancillary notes, I'll circle back and read the actual implementation more carefully later.

One other picky note: I really dislike javadoc/tsdoc/jsdoc function comments, if any of the words in them actually add something, I would rather just move those words into the function names. e.g. if "A function that determins if a type is mergable" is more meaningful, then we should rename IsMergeable to IsTypeMergeable or something.

TehShrike · 2020-11-16T15:31:33Z

.editorconfig

+insert_final_newline = true
+
+[*.md]
+indent_style = space


I do tabs/trim-trailing-whitespace in Markdown too

My reason for switching to spaces in markdown files was just to ensure they render the same regardless of what render is being used - GitHub/npm/other.
But I don't have a strong opinion on this either way. I put this change its own commit so it can easily be dropped.

The reason for not trimming trailing whitespace at the end of markdown files is because two spaces at the end of a line is part of the markdown spec (meaning add a line break here). Official markdown doesn't treat a single line break any different to a single space when it comes to rendering. However, GitHub-flavored markdown, does treat single line break as an actual line break.
If you want to continue trimming trailing whitespace I'm ok with that but I'd recommend not doing so.

Whitespace at the end of the line can be meaningful in Markdown, but I never use that line-break functionality in documentation

But the indent_style should definitely be tab 😅

TehShrike · 2020-11-16T15:31:45Z

.editorconfig

+trim_trailing_whitespace = false
+
+[{package.json,package-lock.json}]
+indent_style = space


cursed npm-enforced defaults

TehShrike · 2020-11-16T15:32:31Z

.npmignore

@@ -1,3 +0,0 @@
-test/


I don't know if there's any value in pushing the extra bytes of test files to everyone via npm

I removed the .npmignore file in favor of using the "files" field in the package.json file.

The "files" field works as a whitelist as apposed to a blacklist like the .npmignore file.

I've got the files set to the following (2 folders and 3 files (plus the package.json file itself)):

"files": [ "dist", "types", "changelog.md", "license.txt", "readme.md" ],

You can run npm pack to create the package locally so you can see what's included in it.

Ah cool, yeah, I like files for that

…fault indenting style

It can have actual meaning.

This is to help ensure that markdown files are rendered similarly by different renders.

Travis has been running really slow lately

re TehShrike#173

TehShrike · 2020-11-28T18:53:23Z

.eslintrc.json

+	"parserOptions": {
+		"ecmaVersion": 10,
+		"ecmaFeatures": {
+      "impliedStrict": true


Some spaces in indentation in this file it looks like

TehShrike · 2020-11-28T18:55:24Z

.eslintrc.json

+	"rules": {
+		"no-extra-boolean-cast": "error",
+		"array-bracket-spacing": [
+			"error",


For linting, I use warn for everything and only use error for issues that would actually cause parse-time or run-time errors.

TehShrike · 2020-11-28T19:00:42Z

.eslintrc.json

+					}
+				],
+
+				"@typescript-eslint/prefer-for-of": "warn",


I detest for-of loop, personally.

I don't want to get bogged down in a full audit of this eslintrc, maybe it could be pulled out to its own PR?

TehShrike · 2020-11-28T19:02:26Z

.github/workflows/ci.yml

@@ -0,0 +1,49 @@
+name: CI


why move away from Travis in the same PR as all these other changes?

TehShrike · 2020-11-28T19:06:16Z

.editorconfig

+insert_final_newline = true
+
+[*.md]
+indent_style = space


But the indent_style should definitely be tab 😅

TehShrike · 2020-11-28T19:07:36Z

changelog.md

@@ -1,5 +1,9 @@
 # [5.0.0](https://github.com/TehShrike/deepmerge/releases/tag/v5.0.0)

+- Breaking: Endpoint are now exported in esm style [#215](https://github.com/TehShrike/deepmerge/pull/215)


It's a bit tough for folks to go check out the PR to see exactly what the change was and run into

TehShrike · 2020-11-28T19:09:34Z

readme.md

 <!--js
-const merge = require('./')
+const { default: deepmerge, deepmergeAll } = require('.')


node has always been a first-class consumer as far as deepmerge is concerned – I'm not okay with moving away from

const deepmerge = require('deepmerge')

for node.js/CommonJS

RebeccaStevens force-pushed the v5 branch 2 times, most recently from bf8d849 to c2fa3ae Compare November 12, 2020 21:55

RebeccaStevens mentioned this pull request Nov 12, 2020

Apply clone option to target object #209

Open

RebeccaStevens force-pushed the v5 branch 3 times, most recently from 8a6aa27 to 31c3514 Compare November 16, 2020 03:48

TehShrike reviewed Nov 16, 2020

View reviewed changes

RebeccaStevens force-pushed the v5 branch 2 times, most recently from 76e2102 to ad7baa0 Compare November 17, 2020 00:14

Rebecca Stevens added 3 commits November 17, 2020 13:34

chore(editorconfig): declare the charset

ca08a6c

chore(editorconfig): have package.json and its lockfile keep their de…

09c3e67

…fault indenting style

chore(editorconfig): have markdown files keep there trailing whitespace

9e6c637

It can have actual meaning.

RebeccaStevens force-pushed the v5 branch 5 times, most recently from 8756722 to dfd7b4b Compare November 17, 2020 03:52

RebeccaStevens marked this pull request as ready for review November 17, 2020 03:52

RebeccaStevens force-pushed the v5 branch 8 times, most recently from 0582e9c to 33fd9be Compare November 18, 2020 23:29

Rebecca Stevens added 4 commits November 19, 2020 12:34

chore(editorconfig): use space instead of tabs for markdown files

21e5999

This is to help ensure that markdown files are rendered similarly by different renders.

chore(editorconfig): use space instead of tabs for yaml files

dc8df6b

chore: use files field in package.json instead of .npmignore

29b862b

chore: sort package.json fields

c32dfd4

Rebecca Stevens and others added 16 commits November 27, 2020 18:46

test: tests types

776fc22

chore: refactor npm script commands

a2af763

build: update package exports

0a2be40

build: add type support for older TypeScript versions

2246372

build(lint): add eslint

8c562f5

style(lint): apply linting fixes

e0b302f

fix: remove circular dependency between utils and deepmerge files

9b55056

ci: update ci config

34fab73

ci: switch to using GitHub Actions

03bd8a9

Travis has been running really slow lately

docs: update readme with new js interface

fbf00cc

test: ensure options aren't mutated

13d6db1

re TehShrike#173

test: convert test to typescript and fixup errors this revealed

ded6c51

docs: update changelog

1e02b16

build: set required node version

6494a33

fix: small tweaks to types and formatting

0c343f2

refactor: extract out defaultClone

ced4b6d

RebeccaStevens force-pushed the v5 branch from d5b94c3 to ced4b6d Compare November 27, 2020 05:55

This was referenced Nov 28, 2020

Expand custom bryan-hunter/deepmerge#1

Closed

Update deep merge interface (api) #217

Draft

deepmerge and deepmerge.all behave differently with certain options #201

Open

TehShrike requested changes Nov 28, 2020

View reviewed changes

TehShrike reviewed Nov 28, 2020

View reviewed changes

.github/workflows/ci.yml Outdated

@@ -0,0 +1,49 @@

name: CI

Copy link

Owner

TehShrike Nov 28, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why move away from Travis in the same PR as all these other changes?

TehShrike reviewed Nov 28, 2020

View reviewed changes

RebeccaStevens mentioned this pull request Nov 29, 2020

editorconfig update #218

Merged

RebeccaStevens marked this pull request as draft December 8, 2020 02:50

Merge remote-tracking branch 'upstream/v5' into v5

afb122f

RebeccaStevens closed this Jan 20, 2021

RebeccaStevens deleted the branch TehShrike:v5 January 20, 2021 01:35

RebeccaStevens deleted the v5 branch January 20, 2021 01:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Restructure Codebase #215

Restructure Codebase #215

RebeccaStevens commented Nov 12, 2020 •

edited by TehShrike

TehShrike left a comment

TehShrike Nov 16, 2020

RebeccaStevens Nov 16, 2020

TehShrike Nov 28, 2020

TehShrike Nov 28, 2020

TehShrike Nov 16, 2020

TehShrike Nov 16, 2020

RebeccaStevens Nov 16, 2020

TehShrike Nov 28, 2020

TehShrike Nov 28, 2020

TehShrike Nov 28, 2020

TehShrike Nov 28, 2020

TehShrike Nov 28, 2020

TehShrike Nov 28, 2020

TehShrike Nov 28, 2020

TehShrike Nov 28, 2020

		@@ -1,5 +1,9 @@
		# [5.0.0](https://github.com/TehShrike/deepmerge/releases/tag/v5.0.0)

		- Breaking: Endpoint are now exported in esm style [#215](https://github.com/TehShrike/deepmerge/pull/215)

Restructure Codebase #215

Restructure Codebase #215

Conversation

RebeccaStevens commented Nov 12, 2020 • edited by TehShrike

TehShrike left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

RebeccaStevens commented Nov 12, 2020 •

edited by TehShrike