chore: update project architecture

Signed-off-by: Lexus Drumgold <[email protected]>

Author: unicornware

.commitlintrc.json

@@ -11,6 +11,7 @@
       [
         "cjs",
         "deps",
+        "deps-bundle",
         "deps-dev",
         "deps-opt",
         "deps-peer",
@@ -19,6 +20,7 @@
         "github",
         "hybrid",
         "native",
+        "patches",
         "pkg",
         "ponyfill",
         "release",

.cspell.json

@@ -14,11 +14,18 @@
   "flagWords": [],
   "ignorePaths": [
     "**/*.snap",
+    "**/.gitconfig",
     "**/.gitignore",
+    "**/.gitkeep",
+    "**/.npmignore",
     ".cspell.json",
     ".env*",
+    ".eslintignore",
     ".git/",
     ".husky/_/",
+    ".markdownlintignore",
+    ".nvmrc",
+    ".prettierignore",
     ".yarn/",
     "CHANGELOG.md",
     "LICENSE.md",
@@ -27,13 +34,13 @@
     "patches/",
     "yarn.lock"
   ],
-  "ignoreRegExpList": ["/from\\s+(['\"]).*\\1/"],
+  "ignoreRegExpList": ["/@flex-development\\/.*/", "/from\\s+(['\"]).*\\1/"],
   "ignoreWords": [],
   "language": "en-US",
   "patterns": [],
   "readonly": true,
   "useGitignore": true,
   "usePnP": false,
   "version": "0.2",
-  "words": ["fldv"]
+  "words": ["fldv", "flexdevelopmentllc"]
 }

.dictionary.txt

@@ -1,15 +1,7 @@
+anson
 ardatan
-autocrlf
-autosetuprebase
-bdel
-bdelr
 bdougie
-bren
 cefc
-chbfeat
-chbfix
-chbhotfix
-chbrelease
 commitlintrc
 dawidd
 dedupe
@@ -18,7 +10,6 @@ dohm
 esbenp
 esbuild
 fbca
-fpnv
 gpgsign
 graphqlrc
 hmarr
@@ -28,17 +19,12 @@ larsgw
 lcov
 micnncim
 mkbuild
-mlly
 nocheck
 npmrc
 nums
-nvmrc
-ohmyzsh
 pkgs
 preid
-safecrlf
 syncer
-tspaths
 vates
 vitest
 vsicons

.editorconfig

@@ -1,23 +1,35 @@
 # EDITORCONFIG
 # https://editorconfig.org
+# https://github.com/editorconfig/editorconfig/wiki/EditorConfig-Properties
 
 # indicate top-most editorconfig file
 root = true
 
 # universal rules
 [*]
-charset = 'utf-8'
+charset = utf-8
+continuation_indent_size = 2
+curly_bracket_next_line = false
 end_of_line = lf
+indent_brace_style = BSD
 indent_size = 2
-indent_style = 'space'
+indent_style = space
 insert_final_newline = true
 max_line_length = 80
+quote_type = single
+spaces_around_brackets = inside
+spaces_around_operators = true
+tab_width = 2
 trim_trailing_whitespace = true
 
 # handlebars
 [*.hbs]
 max_line_length = 100
 
+# markdown
+[*.md]
+max_line_length = 120
+
 # shellscript
 [*.sh]
 max_line_length = 100

.eslintrc.base.cjs

@@ -214,7 +214,7 @@ const config = {
       2,
       {
         allowInGenericTypeArguments: true,
-        allowAsThisParameter: false
+        allowAsThisParameter: true
       }
     ],
     '@typescript-eslint/no-loop-func': 2,
@@ -281,7 +281,7 @@ const config = {
     '@typescript-eslint/no-var-requires': 2,
     '@typescript-eslint/padding-line-between-statements': 0,
     '@typescript-eslint/prefer-as-const': 2,
-    '@typescript-eslint/prefer-enum-initializers': 2,
+    '@typescript-eslint/prefer-enum-initializers': 0,
     '@typescript-eslint/prefer-for-of': 2,
     '@typescript-eslint/prefer-function-type': 2,
     '@typescript-eslint/prefer-includes': 0,
@@ -320,7 +320,8 @@ const config = {
     'jsdoc/check-access': 1,
     'jsdoc/check-alignment': 1,
     'jsdoc/check-examples': 0,
-    'jsdoc/check-indentation': [1, { excludeTags: ['description', 'example'] }],
+    // https://github.com/gajus/eslint-plugin-jsdoc/issues/541
+    'jsdoc/check-indentation': 0,
     'jsdoc/check-line-alignment': 1,
     'jsdoc/check-param-names': [
       1,
@@ -337,7 +338,7 @@ const config = {
     'jsdoc/check-tag-names': [
       1,
       {
-        definedTags: ['visibleName'],
+        definedTags: ['next', 'visibleName'],
         jsxTags: jsx
       }
     ],
@@ -403,6 +404,7 @@ const config = {
         enableFixer: true,
         enableRestElementFixer: true,
         enableRootFixer: true,
+        exemptedBy: ['inheritdoc', 'this'],
         unnamedRootBase: ['param'],
         useDefaultObjectProperties: true
       }
@@ -415,7 +417,7 @@ const config = {
       1,
       {
         exemptAsync: false,
-        exemptGenerators: false,
+        exemptGenerators: true,
         reportMissingReturnForUndefinedTypes: false
       }
     ],
@@ -594,7 +596,7 @@ const config = {
     'unicorn/no-thenable': 2,
     'unicorn/no-this-assignment': 2,
     'unicorn/no-unreadable-array-destructuring': 2,
-    'unicorn/no-unsafe-regex': 2,
+    'unicorn/no-unsafe-regex': 0,
     'unicorn/no-unused-properties': 2,
     'unicorn/no-useless-fallback-in-spread': 2,
     'unicorn/no-useless-length-check': 2,
@@ -626,7 +628,7 @@ const config = {
     'unicorn/prefer-optional-catch-binding': 2,
     'unicorn/prefer-prototype-methods': 2,
     'unicorn/prefer-reflect-apply': 2,
-    'unicorn/prefer-regexp-test': 2,
+    'unicorn/prefer-regexp-test': 0,
     'unicorn/prefer-set-has': 2,
     'unicorn/prefer-spread': 2,
     'unicorn/prefer-string-replace-all': 0,
@@ -709,7 +711,7 @@ const config = {
         '@typescript-eslint/no-unnecessary-condition': [
           2,
           {
-            allowConstantLoopConditions: false,
+            allowConstantLoopConditions: true,
             allowRuleToRunWithoutStrictNullChecksIKnowWhatIAmDoing: false
           }
         ],
@@ -922,7 +924,7 @@ const config = {
       }
     },
     {
-      files: ['*.json5', '*.jsonc'],
+      files: ['*.jsonc'],
       rules: {
         'jsonc/no-comments': 0
       }
@@ -1014,6 +1016,7 @@ const config = {
       plugins: ['chai-expect', 'jest-formatting'],
       rules: {
         '@typescript-eslint/no-base-to-string': 0,
+        '@typescript-eslint/no-empty-function': 0,
         '@typescript-eslint/no-unused-expressions': 0,
         '@typescript-eslint/restrict-template-expressions': 0,
         '@typescript-eslint/unbound-method': 0,
@@ -1033,9 +1036,10 @@ const config = {
         'unicorn/consistent-destructuring': 0,
         'unicorn/explicit-length-check': 0,
         'unicorn/no-array-for-each': 0,
+        'unicorn/no-useless-undefined': 0,
         'unicorn/prefer-at': 0,
         'unicorn/prefer-dom-node-append': 0,
-        'unicorn/no-useless-undefined': 0
+        'unicorn/string-content': 0
       }
     },
     {
@@ -1097,12 +1101,6 @@ const config = {
         'yml/key-name-casing': 0
       }
     },
-    {
-      files: ['helpers/tsconfig-paths.cjs'],
-      rules: {
-        'node/no-deprecated-api': 0
-      }
-    },
     {
       files: ['tsconfig*.json'],
       rules: {
@@ -1141,6 +1139,10 @@ const config = {
           name: 'namepath-defining',
           required: ['name', 'type']
         },
+        next: {
+          name: 'namepath-defining',
+          required: ['type']
+        },
         return: {
           name: 'namepath-defining',
           required: ['type']

.github/.gitconfig

@@ -75,9 +75,16 @@ gpgsign = true
 
 [core]
 autocrlf = false
+editor = code-insiders --wait
 ignorecase = false
 safecrlf = false
 
+[diff]
+tool = vscode
+
+[difftool "vscode"]
+cmd = code-insiders --wait --diff $LOCAL $REMOTE
+
 [gitflow "prefix"]
 feature = feat/
 hotfix = hotfix/
@@ -90,15 +97,18 @@ program = gpg2
 [init]
 defaultBranch = main
 
+[merge]
+tool = vscode
+
+[mergetool "vscode"]
+cmd = code-insiders --wait --merge $REMOTE $LOCAL $BASE $MERGED
+
 [pull]
 rebase = true
 
 [rebase]
 autoStash = true
 
-[url "[email protected]:"]
-insteadOf = bb:
-
 [url "[email protected]:"]
 insteadOf = gh:
 

.github/workflows/ci.yml

@@ -70,12 +70,10 @@ jobs:
         name: Run tests
         run: yarn test:cov
         env:
-          NODE_ENV: test
           NODE_NO_WARNINGS: 1
           VITEST_SEGFAULT_RETRY: 3
       - id: pack
         name: Pack project
         run: yarn pack -o %s-%v.tgz
         env:
           NODE_ENV: production
-          NODE_NO_WARNINGS: 1

.github/workflows/release.yml

@@ -114,10 +114,11 @@ jobs:
         run: yarn pack -o %s-%v.tgz
         env:
           NODE_ENV: production
-          NODE_NO_WARNINGS: 1
       - id: release-notes
         name: Generate release notes
         run: yarn conventional-changelog -o $NOTES_FILE
+        env:
+          NODE_NO_WARNINGS: 1
       - id: tag
         name: Create annotated tag
         run: |
@@ -133,7 +134,7 @@ jobs:
         name: Publish release
         run: gh release create $TAG *.tgz -t=$TAG -F=$NOTES_FILE -p=$PRERELEASE
         env:
-          GITHUB_TOKEN: ${{ secrets.PAT_BOT }}
+          GITHUB_TOKEN: ${{ secrets.PAT_REPO }}
           PRERELEASE: ${{ needs.metadata.outputs.prerelease }}
   cleanup:
     needs: [metadata, publish]

.gitignore

@@ -1,8 +1,6 @@
 # macOS
 # ------------------------------------------------------------------------------
-.AppleDouble
 .DS_*
-.LSOverride
 ._*
 
 # Node
@@ -28,7 +26,6 @@ yarn-error.log*
 # ------------------------------------------------------------------------------
 .pnp.*
 .yarn/*
-!.yarn/patches
 !.yarn/plugins
 !.yarn/releases
 !.yarn/sdks
@@ -47,6 +44,7 @@ yarn-error.log*
 *.lcov
 __tests__/report.json
 coverage/
+vitest.config.*.timestamp-*.mjs
 
 # ESLint
 # ------------------------------------------------------------------------------
@@ -56,3 +54,7 @@ coverage/
 # ------------------------------------------------------------------------------
 dist/
 !typings/**/dist/
+
+# Scratch work
+# ------------------------------------------------------------------------------
+scratch.ts