chore: update project architecture

Signed-off-by: Lexus Drumgold <unicornware@flexdevelopment.llc>
flex-development · Aug 9, 2023 · 7173959 · 7173959
1 parent 8f18fa2
commit 7173959
Show file tree

Hide file tree

Showing 16 changed files with 2,021 additions and 780 deletions.
diff --git a/.eslintignore b/.eslintignore
@@ -2,6 +2,7 @@
 # https://eslint.org/docs/user-guide/configuring/ignoring-code#the-eslintignore-file
 
 # DIRECTORIES & FILES
+**/*.patch
 **/*.snap
 **/*config.*.timestamp*
 **/.DS_Store
@@ -18,6 +19,7 @@ yarn.lock
 !**/__fixtures__/**/dist/
 !**/__fixtures__/**/node_modules/
 !**/typings/**/dist/
+!.attw.json
 !.codecov.yml
 !.commitlintrc.*
 !.cspell.json

diff --git a/.eslintrc.base.cjs b/.eslintrc.base.cjs
@@ -53,6 +53,7 @@ const config = {
       },
       plugins: [
         '@typescript-eslint',
+        'import',
         'jsdoc',
         'node',
         'prettier',
@@ -171,7 +172,6 @@ const config = {
           }
         ],
         '@typescript-eslint/no-dupe-class-members': 2,
-        '@typescript-eslint/no-duplicate-imports': 2,
         '@typescript-eslint/no-dynamic-delete': 2,
         '@typescript-eslint/no-empty-function': [
           2,
@@ -246,7 +246,7 @@ const config = {
             allowedNames: ['self']
           }
         ],
-        '@typescript-eslint/no-throw-literal': 2,
+        '@typescript-eslint/no-throw-literal': 0,
         '@typescript-eslint/no-type-alias': 0,
         '@typescript-eslint/no-unnecessary-boolean-literal-compare': [
           2,
@@ -352,7 +352,11 @@ const config = {
           2,
           {
             allowAny: false,
-            checkCompoundAssignments: false
+            allowBoolean: false,
+            allowNullish: false,
+            allowNumberAndString: true,
+            allowRegExp: false,
+            skipCompoundAssignments: true
           }
         ],
         '@typescript-eslint/restrict-template-expressions': [
@@ -366,7 +370,7 @@ const config = {
           }
         ],
         '@typescript-eslint/return-await': [2, 'in-try-catch'],
-        '@typescript-eslint/sort-type-union-intersection-members': 2,
+        '@typescript-eslint/sort-type-constituents': 2,
         '@typescript-eslint/strict-boolean-expressions': [
           2,
           {
@@ -394,6 +398,13 @@ const config = {
         '@typescript-eslint/unified-signatures': 2,
         'default-param-last': 0,
         eqeqeq: 1,
+        'import/no-duplicates': [
+          2,
+          {
+            considerQueryString: true,
+            'prefer-inline': true
+          }
+        ],
         'init-declarations': 0,
         'jsdoc/check-access': 1,
         'jsdoc/check-alignment': 1,
@@ -417,6 +428,7 @@ const config = {
           1,
           {
             definedTags: [
+              'decorator',
               'experimental',
               'maximum',
               'minimum',
@@ -434,7 +446,6 @@ const config = {
         'jsdoc/match-description': 0,
         'jsdoc/match-name': 0,
         'jsdoc/multiline-blocks': 1,
-        'jsdoc/newline-after-description': [1, 'always'],
         'jsdoc/no-bad-blocks': [1, { preventAllMultiAsteriskBlocks: true }],
         'jsdoc/no-defaults': 0,
         'jsdoc/no-missing-syntax': 0,
@@ -557,9 +568,10 @@ const config = {
           1,
           'any',
           {
+            applyToEndTag: true,
             count: 1,
-            dropEndLines: true,
-            noEndLines: false,
+            endLines: 0,
+            startLines: 1,
             tags: {}
           }
         ],
@@ -572,6 +584,7 @@ const config = {
         'no-empty-function': 0,
         'no-ex-assign': 0,
         'no-extra-parens': 0,
+        'no-extra-semi': 0,
         'no-implied-eval': 0,
         'no-invalid-this': 0,
         'no-loop-func': 0,
@@ -661,7 +674,7 @@ const config = {
             terms: ['@fixme', '@todo']
           }
         ],
-        'unicorn/explicit-length-check': 2,
+        'unicorn/explicit-length-check': 0,
         'unicorn/filename-case': [
           2,
           {
@@ -774,15 +787,8 @@ const config = {
             allowArgumentsExplicitlyTypedAsAny: true,
             allowDirectConstAssertionInArrowFunctions: true,
             allowHigherOrderFunctions: false,
-            allowTypedFunctionExpressions: true,
-            allowedNames: [],
-            shouldTrackReferences: true
-          }
-        ],
-        '@typescript-eslint/no-implicit-any-catch': [
-          2,
-          {
-            allowExplicitAny: false
+            allowTypedFunctionExpressions: false,
+            allowedNames: []
           }
         ],
         'no-undef': 0
@@ -835,6 +841,7 @@ const config = {
       },
       plugins: ['chai-expect', 'jest-formatting'],
       rules: {
+        '@typescript-eslint/class-literal-property-style': 0,
         '@typescript-eslint/consistent-indexed-object-style': 0,
         '@typescript-eslint/no-base-to-string': 0,
         '@typescript-eslint/no-empty-function': 0,
@@ -858,7 +865,6 @@ const config = {
         'promise/valid-params': 0,
         'unicorn/consistent-destructuring': 0,
         'unicorn/error-message': 0,
-        'unicorn/explicit-length-check': 0,
         'unicorn/no-array-for-each': 0,
         'unicorn/no-hex-escape': 0,
         'unicorn/no-useless-undefined': 0,
@@ -878,6 +884,12 @@ const config = {
         '@typescript-eslint/no-redundant-type-constituents': 0
       }
     },
+    {
+      files: ['**/decorators/*.constraint.ts', '**/*.decorator.ts'],
+      rules: {
+        '@typescript-eslint/ban-types': 0
+      }
+    },
     {
       files: ['**/enums/*.ts', '**/interfaces/*.ts', '**/types/*.ts'],
       rules: {
@@ -990,14 +1002,14 @@ const config = {
         '@typescript-eslint/naming-convention': 0,
         '@typescript-eslint/no-base-to-string': 0,
         '@typescript-eslint/no-confusing-void-expression': 0,
+        '@typescript-eslint/no-duplicate-type-constituents': 0,
         '@typescript-eslint/no-floating-promises': 0,
         '@typescript-eslint/no-for-in-array': 0,
         '@typescript-eslint/no-implied-eval': 0,
         '@typescript-eslint/no-meaningless-void-operator': 0,
         '@typescript-eslint/no-misused-promises': 0,
         '@typescript-eslint/no-mixed-enums': 0,
         '@typescript-eslint/no-redundant-type-constituents': 0,
-        '@typescript-eslint/no-throw-literal': 0,
         '@typescript-eslint/no-unnecessary-boolean-literal-compare': 0,
         '@typescript-eslint/no-unnecessary-condition': 0,
         '@typescript-eslint/no-unnecessary-qualifier': 0,
@@ -1006,12 +1018,14 @@ const config = {
         '@typescript-eslint/no-unsafe-argument': 0,
         '@typescript-eslint/no-unsafe-assignment': 0,
         '@typescript-eslint/no-unsafe-call': 0,
+        '@typescript-eslint/no-unsafe-enum-comparison': 0,
         '@typescript-eslint/no-unsafe-member-access': 0,
         '@typescript-eslint/no-unsafe-return': 0,
         '@typescript-eslint/no-unused-expressions': 0,
         '@typescript-eslint/non-nullable-type-assertion-style': 0,
         '@typescript-eslint/prefer-includes': 0,
         '@typescript-eslint/prefer-nullish-coalescing': 0,
+        '@typescript-eslint/prefer-optional-chain': 0,
         '@typescript-eslint/prefer-readonly': 0,
         '@typescript-eslint/prefer-readonly-parameter-types': 0,
         '@typescript-eslint/prefer-reduce-type-parameter': 0,
@@ -1032,7 +1046,7 @@ const config = {
       }
     },
     {
-      files: '**/*.yml',
+      files: '**/*.+(yaml|yml)',
       parser: 'yaml-eslint-parser',
       plugins: ['yml'],
       rules: {
@@ -1151,20 +1165,35 @@ const config = {
     'prettier/prettier': [2, {}, { usePrettierrc: true }]
   },
   settings: {
+    'import/parsers': {
+      '@typescript-eslint/parser': ['.cts', '.mts', '.ts', '.tsx']
+    },
+    'import/resolver': {
+      node: true,
+      typescript: true
+    },
     jsdoc: {
       augmentsExtendsReplacesDocs: true,
       ignoreInternal: false,
       ignorePrivate: false,
       implementsReplacesDocs: true,
       overrideReplacesDocs: true,
       preferredTypes: {
-        '*': false
+        '*': false,
+        '.<>': false,
+        'Array<>': { replacement: '[]' },
+        Object: { replacement: 'object' },
+        'Object<>': { replacement: 'Record<>' },
+        object: 'object'
       },
       structuredTags: {
         const: {
           name: 'namepath-defining',
           required: ['name']
         },
+        decorator: {
+          name: 'none'
+        },
         enum: {
           name: 'namepath-defining',
           required: ['name', 'type']

diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -43,13 +43,23 @@ updates:
           - conventional-changelog-core
           - conventional-changelog-writer
           - conventional-recommended-bump
+      flex-development:
+        patterns:
+          - '@flex-development/*'
+      nest-commander:
+        patterns:
+          - commander
+          - nest-commander*
+      nestjs:
+        patterns:
+          - '@nestjs/*'
       typescript-eslint:
         patterns:
           - '@typescript-eslint/*'
       vitest:
         patterns:
           - '@vitest/*'
-          - vitest
+          - vitest*
     ignore:
       - dependency-name: nest-commander
     labels:

diff --git a/.prettierignore b/.prettierignore
@@ -4,6 +4,7 @@
 # DIRECTORIES & FILES
 **/*.hbs
 **/*.md
+**/*.patch
 **/*.snap
 **/*config.*.timestamp*
 **/.temp/

diff --git a/.prettierrc.json b/.prettierrc.json
@@ -1,6 +1,7 @@
 {
   "arrowParens": "avoid",
   "bracketSpacing": true,
+  "plugins": ["prettier-plugin-sh"],
   "proseWrap": "always",
   "quoteProps": "as-needed",
   "semi": false,
@@ -22,11 +23,11 @@
         "Brewfile"
       ],
       "options": {
-        "functionNextLine": true,
+        "functionNextLine": false,
         "keepComments": true,
         "keepPadding": false,
         "parser": "sh",
-        "spaceRedirects": true,
+        "spaceRedirects": false,
         "switchCaseIndent": true,
         "variant": 0
       }

diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -187,7 +187,6 @@
     ],
     "overrideConfigFile": ".eslintrc.cjs"
   },
-  "eslint.packageManager": "yarn",
   "eslint.validate": [
     "graphql",
     "javascript",
@@ -310,7 +309,6 @@
   "typescript.tsdk": "node_modules/typescript/lib",
   "typescript.tsserver.enableTracing": true,
   "typescript.tsserver.log": "verbose",
-  "typescript.tsserver.trace": "verbose",
   "typescript.updateImportsOnFileMove.enabled": "always",
   "typescript.validate.enable": true,
   "versionlens.npm.dependencyProperties": [
@@ -393,7 +391,7 @@
   "xml.format.closingBracketNewLine": true,
   "xml.format.maxLineWidth": 100,
   "xml.format.spaceBeforeEmptyCloseTag": false,
-  "xml.format.splitAttributes": true,
+  "xml.format.splitAttributes": "splitNewLine",
   "xml.format.splitAttributesIndentSize": 0,
   "yaml.schemas": {
     "https://json.schemastore.org/github-issue-config": ".github/ISSUE_TEMPLATE/config.yml",

diff --git a/__tests__/reporters/notifier.ts b/__tests__/reporters/notifier.ts
@@ -111,8 +111,10 @@ class Notifier implements Reporter {
 
       message = dedent`
         ${passes} tests passed in ${
-        time > 1000 ? `${(time / 1000).toFixed(2)}ms` : `${Math.round(time)}ms`
-      }
+          time > 1000
+            ? `${(time / 1000).toFixed(2)}ms`
+            : `${Math.round(time)}ms`
+        }
       `
 
       title = '\u2705 Passed'

diff --git a/build.config.ts b/build.config.ts
@@ -17,10 +17,16 @@ const config: Config = defineBuildConfig({
   charset: 'utf8',
   entries: [
     { dts: 'only', ignore: ['cli/**'] },
-    { dts: false, pattern: ['(interfaces|types)/index.ts'] },
     {
       dts: false,
-      pattern: ['*.ts', 'config/*', 'internal/*', 'plugins/*', 'utils/*'],
+      pattern: [
+        '!plugins/**/options.ts',
+        '*.ts',
+        'config/**',
+        'internal/**',
+        'plugins/**',
+        'utils/**'
+      ],
       sourcemap: true
     },
     {

diff --git a/config/changelog.config.ts b/config/changelog.config.ts
@@ -31,7 +31,7 @@ import {
 } from '@flex-development/tutils'
 import { Inject, Module } from '@nestjs/common'
 import addStream from 'add-stream'
-import { Command, CommanderError } from 'commander'
+import type { Command, CommanderError } from 'commander'
 import consola from 'consola'
 import conventionalChangelog from 'conventional-changelog'
 import type { Options } from 'conventional-changelog-core'