[pull] main from sequelize:main

.eslintrc.js

@@ -0,0 +1,222 @@
+// eslint does not properly load plugins loaded by presets
+// this fixes that
+require('@rushstack/eslint-patch/modern-module-resolution');
+
+module.exports = {
+  root: true,
+  extends: [
+    '@ephys/eslint-config-typescript',
+    '@ephys/eslint-config-typescript/node',
+    '@ephys/eslint-config-typescript/commonjs',
+  ],
+  plugins: ['mocha', 'jsdoc'],
+  rules: {
+    'jsdoc/check-param-names': 'error',
+    'jsdoc/check-tag-names': 'error',
+    'jsdoc/check-types': 'off',
+    'jsdoc/tag-lines': ['error', 'any', { startLines: 1 }],
+    'jsdoc/no-undefined-types': 'off',
+    'jsdoc/require-description-complete-sentence': 'off',
+    'jsdoc/require-example': 'off',
+    'jsdoc/require-hyphen-before-param-description': 'off',
+    'jsdoc/require-param': 'error',
+    'jsdoc/require-param-description': 'off',
+    'jsdoc/require-param-name': 'error',
+    'jsdoc/require-param-type': 'off',
+    'jsdoc/require-returns-description': 'off',
+    'jsdoc/require-returns-type': 'off',
+    'jsdoc/valid-types': 'error',
+    'jsdoc/no-types': 'error',
+
+    // TODO: enable in follow-up PR. Requires the utils package.
+    'no-restricted-syntax': 'off',
+    'no-restricted-imports': 'off',
+    '@typescript-eslint/ban-types': 'off',
+    // TODO: enable in follow-up PR. Requires enabling TSC's noUncheckedIndexedAccess
+    '@typescript-eslint/no-unnecessary-condition': 'off',
+    // TODO: enable in follow-up PR. Requires manual code changes.
+    '@typescript-eslint/naming-convention': 'off',
+    '@typescript-eslint/unbound-method': 'off',
+    '@typescript-eslint/member-ordering': 'off',
+    'unicorn/no-object-as-default-parameter': 'off',
+    '@typescript-eslint/prefer-optional-chain': 'off',
+    'logical-assignment-operators': 'off',
+  },
+  overrides: [
+    {
+      files: ['**/*.{js,mjs,cjs}'],
+      rules: {
+        'jsdoc/no-types': 'off',
+        'jsdoc/require-param-type': 'error',
+        'jsdoc/check-types': 'error',
+        'jsdoc/require-returns-type': 'error',
+      },
+    },
+    {
+      files: ['**/*.js'],
+      rules: {
+        // These rules have been disabled in .js files to ease adoption.
+        // They'll be fixed during the TS migration.
+        // Remove these once most files have been migrated to TS.
+
+        // This will catch a lot of bugs with early-returns
+        'consistent-return': 'off',
+
+        // code smells that should be resolved
+        'no-restricted-syntax': 'off',
+        'no-await-in-loop': 'off',
+        'default-case': 'off',
+        'no-loop-func': 'off',
+        'no-shadow': 'off',
+        'default-param-last': 'off',
+        'no-fallthrough': 'off',
+        'prefer-rest-params': 'off',
+        'no-loss-of-precision': 'off',
+
+        // optimisation
+        'unicorn/consistent-function-scoping': 'off',
+
+        // array.reduce is difficult to reason about and can almost always
+        // be replaced by a more explicit method
+        'unicorn/no-array-reduce': 'off',
+        'unicorn/no-array-for-each': 'off',
+        'unicorn/prefer-spread': 'off',
+
+        // makes code clearer
+        'unicorn/prefer-default-parameters': 'off',
+        'max-statements-per-line': 'off',
+
+        // makes debug easier
+        'func-names': 'off',
+
+        // multi-assigns can be difficult to understand
+        // https://eslint.org/docs/rules/no-multi-assign
+        'no-multi-assign': 'off',
+
+        // GitHub's display length is 125 chars.
+        // This enforces that length.
+        'max-len': 'off',
+        'max-depth': 'off',
+
+        // Reduce diff noise.
+        'import/order': 'off',
+
+        // consistency
+        'unicorn/filename-case': 'off',
+
+        // Passing a function reference to an array callback can accidentally introduce bug
+        // due to array methods passing more than one parameter.
+        'unicorn/no-array-callback-reference': 'off',
+      },
+    },
+    {
+      // most tests are written in old JS style
+      // let's disable the most problematic rules for now.
+      // they're only disabled for .js files.
+      // .ts files will need to migrate.
+      files: ['packages/*/test/**/*.js'],
+      rules: {
+        'func-names': 'off',
+        'import/order': 'off',
+
+        'consistent-this': 'off',
+        'no-invalid-this': 'off',
+        'unicorn/no-this-assignment': 'off',
+        'no-unused-expressions': 'off',
+        camelcase: 'off',
+        'no-console': 'off',
+        'no-prototype-builtins': 'off',
+        'no-multi-spaces': 'off',
+        'unicorn/error-message': 'off',
+      },
+    },
+    {
+      // Disable slow rules that are not important in tests (perf)
+      files: ['packages/*/test/**/*', '*.test.{ts,js}'],
+      rules: {
+        'import/no-extraneous-dependencies': 'off',
+        // no need to check jsdoc in tests & docs
+        'jsdoc/check-types': 'off',
+        'jsdoc/valid-types': 'off',
+        'jsdoc/tag-lines': 'off',
+        'jsdoc/check-tag-names': 'off',
+
+        // Enable test-specific rules (perf)
+        'mocha/no-exclusive-tests': 'error',
+        'mocha/no-skipped-tests': 'warn',
+
+        // it's fine if we're not very efficient in tests.
+        'no-inner-declarations': 'off',
+        'unicorn/no-unsafe-regex': 'off',
+
+        // because of Chai
+        '@typescript-eslint/no-unused-expressions': 'off',
+      },
+      env: {
+        mocha: true,
+      },
+    },
+    {
+      files: ['packages/*/test/types/**/*'],
+      rules: {
+        // This code is never executed, it's typing only, so these rules make no sense:
+        '@typescript-eslint/no-unused-vars': 'off',
+        '@typescript-eslint/no-floating-promises': 'off',
+        'no-console': 'off',
+      },
+    },
+    {
+      files: ['**/tsconfig.json'],
+      rules: {
+        'json/*': ['error', { allowComments: true }],
+      },
+    },
+    {
+      files: ['sscce.ts'],
+      rules: {
+        'no-console': 'off',
+      },
+    },
+  ],
+  settings: {
+    jsdoc: {
+      tagNamePreference: {
+        augments: 'extends',
+      },
+      structuredTags: {
+        typeParam: {
+          type: false,
+          required: ['name'],
+        },
+        category: {
+          type: false,
+          required: ['name'],
+        },
+        internal: {
+          type: false,
+        },
+        hidden: {
+          type: false,
+        },
+      },
+    },
+  },
+  parserOptions: {
+    ecmaVersion: 2020,
+    sourceType: 'module',
+  },
+  ignorePatterns: [
+    'packages/*/lib/**/*',
+    'packages/*/types/**/*',
+    'packages/**/skeletons/**/*',
+    '.typedoc-build',
+    'packages/cli/migrations/**/*',
+    'packages/cli/seeds/**/*',
+  ],
+  env: {
+    node: true,
+    mocha: true,
+    es6: true,
+    es2020: true,
+  },
+};

.gitattributes

@@ -0,0 +1 @@
+* -lf

.github/CODEOWNERS

@@ -0,0 +1 @@
+* @sequelize/code-reviewers

.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: sequelize
+patreon: # Replace with a single Patreon username
+open_collective: sequelize
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']