feat: Add definitive .editorconfig to use across sofie projects (#33)

Based on various .editorconfigs in sofie projects, without specifying
the size of tabs. The point of tabs is that the user can configure
how wide they want them in their particular editor.

Author: rjmunro

.editorconfig

@@ -0,0 +1,20 @@
+root = true
+
+[*]
+indent_style = tab
+charset = utf-8
+trim_trailing_whitespace = true
+end_of_line = lf
+insert_final_newline = true
+
+[*.{yml,yaml}]
+indent_style = space
+indent_size = 2
+
+[*.{md,diff,patch}]
+# Trailing whitespace is meaningful in these file types
+trim_trailing_whitespace = false
+
+[*.md]
+# Markdown files indent with spaces, but sometimes include code blocks that use tabs
+indent_style = unset

README.md

@@ -28,25 +28,25 @@ This readme assumes you are using yarn v4. For other package managers the steps
 
 ```json
 {
-    ...,
-    "scripts": {
-        ...,
+	...,
+	"scripts": {
+		...,
 		"prepare": "husky",
 		"lint:raw": "eslint",
-        "lint": "run lint:raw .",
-        "lint-fix": "run lint --fix",
-        "license-validate": "sofie-licensecheck"
-    },
-    "prettier": "@sofie-automation/code-standard-preset/.prettierrc.json",
-    "lint-staged": {
-        "*.{css,json,md,scss}": [
-            "prettier --write"
-        ],
-        "*.{ts,tsx,js,jsx}": [
-            "run lint:raw --fix"
-        ]
-    },
-    ...
+		"lint": "run lint:raw .",
+		"lint-fix": "run lint --fix",
+		"license-validate": "sofie-licensecheck"
+	},
+	"prettier": "@sofie-automation/code-standard-preset/.prettierrc.json",
+	"lint-staged": {
+		"*.{css,json,md,scss}": [
+			"prettier --write"
+		],
+		"*.{ts,tsx,js,jsx}": [
+			"run lint:raw --fix"
+		]
+	},
+	...
 }
 ```
 
@@ -152,6 +152,8 @@ _Note: replace the {{PACKAGE-NAME}} with the correct package name, i.e. `hyperde
 * text=auto eol=lf
 ```
 
+Also copy the `.editorconfig` file from this repository if you want to use it.
+
 **Adjust** jest configuration files to use `tsconfig.json`. For example, update the start of `jest.config.js` ...
 
 ```javascript

bin/checkLicenses.mjs

@@ -6,17 +6,19 @@ import path from 'path'
 import checker from 'license-checker'
 
 const cli = meow(
+	// editorconfig-checker-disable -- The below string should be formatted with spaces
 	`
     Usage
       $ sofie-licensecheck
-	  $ sofie-licensecheck --allowPackages "package-name@1.2.3;other-package@1.2.3"
+      $ sofie-licensecheck --allowPackages "package-name@1.2.3;other-package@1.2.3"
 
     Options
-	  --debug  Show full packages list
-	  --allowPackages Semi-colon separated list of packages to ignore (eg cycle@1.0.3;underscore@1.12.0)
-	  --allowList Which default list of licenses to use. Possible values: "MIT", "none". Defaults to "MIT"
-	  --allowLicenses Semi-colon separated list of licenses to allow in addition to the default list (eg GPL-3.0-only;MIT)
+      --debug  Show full packages list
+      --allowPackages Semi-colon separated list of packages to ignore (eg cycle@1.0.3;underscore@1.12.0)
+      --allowList Which default list of licenses to use. Possible values: "MIT", "none". Defaults to "MIT"
+      --allowLicenses Semi-colon separated list of licenses to allow in addition to the default list (eg GPL-3.0-only;MIT)
 `,
+	// editorconfig-checker-enable
 	{
 		importMeta: import.meta,
 		flags: {

bin/updateVersion.mjs

@@ -7,15 +7,17 @@ import meow from 'meow'
 import { format } from 'date-fns'
 
 const cli = meow(
+	// editorconfig-checker-disable -- The below string should be formatted with spaces
 	`
     Usage
       $ sofie-version
 
     Options
-	  --dry-run  Simulate the version update process
-	  --prerelease Whether to tag a prerelease build, and the suffix to use
-	  --lastTag Optionally specify the last tag in the existing changelog
+      --dry-run  Simulate the version update process
+      --prerelease Whether to tag a prerelease build, and the suffix to use
+      --lastTag Optionally specify the last tag in the existing changelog
 `,
+	// editorconfig-checker-enable
 	{
 		importMeta: import.meta,
 		flags: {