svengreb GitHub account and @svengreb npm package scope migration (…

…#89)

With the retirement of the "Arctic Ice Studio" personal & Nord project
brand [1] this project has also moved to the "real-in-person" identity
"Sven Greb" both in the context of the repository to the `svengreb`
GitHub account [2] and the `@svengreb` npm package scope.
During the migration the current npm packages
`@arcticicestudio/eslint-config-base` [3],
`@arcticicestudio/eslint-config`[8] and
`@arcticicestudio/eslint-config-typescript` [9] were deprecated in favor
of the new and upcoming `@svengreb/eslint-config-base`[10],
`@svengreb/eslint-config` [11] and
`@svengreb/eslint-config-typescript` [12] packages that will be
published afterwards.

Also the current visual representation of this style guide [6] through
the way too outdated and deprecated GitBook [5] major version `2` has
been unpublished and removed. The documentations and references have
been updated to use the GitHub repository with the Markdown rendering
instead for now until a custom website has been implemented using a
modern "TechStack" like Next.js [7].

[1]: https://github.com/orgs/nordtheme/discussions/183#retire-arctic-ice-studio-as-nord-brand
[2]: https://github.com/svengreb
[3]: https://www.npmjs.com/package/@arcticicestudio/eslint-config-base
[4]: https://www.npmjs.com/package/@svengreb/remark-preset-lint
[5]: https://www.gitbook.com
[6]: https://arcticicestudio.github.io/styleguide-markdown
[7]: https://nextjs.org
[8]: https://www.npmjs.com/package/@arcticicestudio/eslint-config-base
[9]: https://www.npmjs.com/package/@arcticicestudio/eslint-config-typescript
[10]: https://www.npmjs.com/package/@svengreb/eslint-config-base
[11]: https://www.npmjs.com/package/@svengreb/eslint-config
[12]: https://www.npmjs.com/package/@svengreb/eslint-config-typescript

GH-88

.editorconfig

@@ -1,6 +1,5 @@
-# Copyright (c) 2018-present Arctic Ice Studio <development@arcticicestudio.com>
-# Copyright (c) 2018-present Sven Greb <development@svengreb.de>
-# This source code is licensed under the MIT license found in the LICENSE file.
+# Copyright (c) 2016-present Sven Greb <development@svengreb.de>
+# This source code is licensed under the MIT license found in the license file.
 
 # Configurations for EditorConfig.
 # See https://editorconfig.org/#file-format-details for more details.
@@ -16,7 +15,7 @@ end_of_line = lf
 indent_size = 2
 indent_style = space
 insert_final_newline = true
-max_line_length = 120
+max_line_length = 160
 trim_trailing_whitespace = true
 
 # +-----------+

.eslintignore

@@ -1,11 +1,14 @@
-# Copyright (c) 2018-present Arctic Ice Studio <development@arcticicestudio.com>
-# Copyright (c) 2018-present Sven Greb <development@svengreb.de>
-# This source code is licensed under the MIT license found in the LICENSE file.
+# Copyright (c) 2016-present Sven Greb <development@svengreb.de>
+# This source code is licensed under the MIT license found in the license file.
 
-# Path match pattern to ignore specific files and directories.
-# See https://eslint.org/docs/user-guide/configuring/ignoring-code for more details.
+# Path match pattern to ignore (i.e. not lint) certain files and folders.
+# References:
+#   1. https://eslint.org/docs/latest/use/configure/ignore
 
-build/*
-**/node_modules/*
-!.eslintrc.js
+node_modules/
+
+# Explicitly include specific "dotfiles".
+# ESLint automatically applies ignore pattern for "dotfiles" by default to prevent accidentally lint over paths like
+# `.git` or any other critical paths.
+!**/.eslintrc.js
 !.remarkrc.js

.eslintrc.js

@@ -1,17 +1,31 @@
 /*
- * Copyright (c) 2018-present Arctic Ice Studio <development@arcticicestudio.com>
- * Copyright (c) 2018-present Sven Greb <development@svengreb.de>
- * This source code is licensed under the MIT license found in the LICENSE file.
+ * Copyright (c) 2016-present Sven Greb <development@svengreb.de>
+ * This source code is licensed under the MIT license found in the license file.
  */
 
 /**
  * Configurations for ESLint.
- *
- * @see https://eslint.org/docs/user-guide/configuring
+ * @see https://eslint.org/docs/latest/use/configure
+ * @see https://eslint.org/docs/latest/use/configure/#using-configuration-files
+ * @see https://eslint.org/docs/latest/use/configure/#specifying-environments
+ * @see https://eslint.org/docs/latest/rules
  */
 module.exports = {
   extends: [
-    "./packages/@arcticicestudio/eslint-config-base/index.js",
-    "./packages/@arcticicestudio/eslint-config/prettier.js",
+    "./packages/@svengreb/eslint-config-base/index.js",
+    /*
+     * Enable support for projects using Prettier.
+     * Note that this must always be placed after the `@arcticicestudio/eslint-config-base` preset to take precedence, otherwise it won't prevent errors
+     * due to useless and possibly conflicting rules!
+     */
+    "./packages/@svengreb/eslint-config/prettier.js",
+  ],
+  overrides: [
+    {
+      files: ["*.js"],
+      rules: {
+        "capitalized-comments": "off",
+      },
+    },
   ],
 };

.gitattributes

@@ -1,19 +1,11 @@
-# Copyright (c) 2018-present Arctic Ice Studio <development@arcticicestudio.com>
-# Copyright (c) 2018-present Sven Greb <development@svengreb.de>
-# This source code is licensed under the MIT license found in the LICENSE file.
+# Copyright (c) 2016-present Sven Greb <development@svengreb.de>
+# This source code is licensed under the MIT license found in the license file.
 
 # Configuration to define attributes per path.
-#
 # References:
 #   1. https://git-scm.com/docs/gitattributes
 #   2. https://git-scm.com/book/en/v2/Customizing-Git-Git-Attributes#Keyword-Expansion
 
 # Automatically perform line feed (LF) normalization for files detected as text and
 # leave all files detected as binary untouched.
 * text=auto eol=lf
-
-# +--------+
-# + Assets +
-# +--------+
-*.ai binary
-*.png binary

.github/CODEOWNERS

@@ -1,15 +1,14 @@
-# Copyright (c) 2018-present Arctic Ice Studio <development@arcticicestudio.com>
-# Copyright (c) 2018-present Sven Greb <development@svengreb.de>
-# This source code is licensed under the MIT license found in the LICENSE file.
+# Copyright (c) 2016-present Sven Greb <development@svengreb.de>
+# This source code is licensed under the MIT license found in the license file.
 
-# Configuration for the GitHub feature to automatically request reviews from the code owners when a pull request
-# changes any owned files.
+# Configuration for the GitHub feature to automatically request reviews from the code owners
+# when a pull request changes any owned files.
 #
 # References:
-#   1. https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners
+#   1. https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners#codeowners-file-location
 #   2. https://github.com/blog/2392-introducing-code-owners
 
-# +--------------------+
-# + Default Code Owner +
-# +--------------------+
-* @arcticicestudio @svengreb
+# +----------------------+
+# + Core Team Code Owner +
+# +----------------------+
+* @svengreb

.github/workflows/ci-node.yaml

@@ -1,8 +1,10 @@
-# Copyright (c) 2018-present Sven Greb <development@svengreb.de>
+# Copyright (c) 2016-present Sven Greb <development@svengreb.de>
 # This source code is licensed under the MIT license found in the LICENSE file.
 
 # GitHub Action Workflow for continuous integration jobs.
-# See https://docs.github.com/en/actions and https://github.com/features/actions for more details.
+# References:
+#   1. https://docs.github.com/en/actions
+#   2. https://github.com/features/actions
 
 name: ci-node
 on:
@@ -12,7 +14,6 @@ on:
       - "**.json"
       - "**.md"
       - "**.yaml"
-      - "**.yml"
     branches:
       - main
     tags:
@@ -23,7 +24,6 @@ on:
       - "**.json"
       - "**.md"
       - "**.yaml"
-      - "**.yml"
 
 jobs:
   lint:

.gitignore

@@ -1,16 +1,10 @@
-# Copyright (c) 2018-present Arctic Ice Studio <development@arcticicestudio.com>
-# Copyright (c) 2018-present Sven Greb <development@svengreb.de>
-# This source code is licensed under the MIT license found in the LICENSE file.
+# Copyright (c) 2016-present Sven Greb <development@svengreb.de>
+# This source code is licensed under the MIT license found in the license file.
 
 # Path match pattern to intentionally ignore untracked files and directories.
 # See https://git-scm.com/docs/gitignore for more details.
 
 # +---------+
 # + Node.js +
 # +---------+
-**/node_modules/
-
-# +-------------------+
-# + Project Structure +
-# +-------------------+
-build/
+node_modules/

.husky/pre-commit

@@ -1,11 +1,9 @@
 #!/bin/sh
 
-# Copyright (c) 2018-present Arctic Ice Studio <development@arcticicestudio.com>
-# Copyright (c) 2018-present Sven Greb <development@svengreb.de>
-# This source code is licensed under the MIT license found in the LICENSE file.
+# Copyright (c) 2016-present Sven Greb <development@svengreb.de>
+# This source code is licensed under the MIT license found in the license file.
 
 # Git "pre-commit" hook for husky.
-#
 # References:
 #   1. https://github.com/typicode/husky
 #   2. https://git-scm.com/docs/githooks#_pre_commit