feat: migrate to typescript

Author: Wojciech Krysiak

.env-example

@@ -0,0 +1,6 @@
+NODE_ENV=test
+POSTGRES_USER="adminbro"
+POSTGRES_PASSWORD="adminbro"
+POSTGRES_DATABASE="adminbro-sequelize-test"
+POSTGRES_HOST
+POSTGRES_PORT

.eslintrc.js

@@ -1,51 +1,59 @@
 module.exports = {
-    'env': {
-        'es6': true,
-        'node': true,
-        'mocha': true
+  env: {
+    browser: true,
+    es2020: true,
+  },
+  extends: [
+    'airbnb',
+    'plugin:react/recommended',
+    'plugin:@typescript-eslint/recommended',
+  ],
+  ignorePatterns: [
+    '*/build/**/*',
+    '*.json',
+    '*.txt',
+    'yarn.lock',
+    '*.yaml',
+  ],
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    ecmaFeatures: {
+      jsx: true,
     },
-    'extends': 'airbnb-base',
-    'parserOptions': {
-        'ecmaVersion': 2018,
-        'sourceType': 'module'
+    ecmaVersion: 11,
+    sourceType: 'module',
+  },
+  plugins: [
+    'react',
+    '@typescript-eslint',
+  ],
+  rules: {
+    semi: ['error', 'never'],
+    'no-unused-vars': 'off',
+    'import/extensions': 'off',
+    'import/no-unresolved': 'off',
+    'react/jsx-filename-extension': 'off',
+    indent: [
+      'error',
+      2,
+    ],
+    'linebreak-style': ['error', 'unix'],
+    'object-curly-newline': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+  },
+  overrides: [{
+    files: ['*.tsx'],
+    rules: {
+      'react/prop-types': 'off',
+      'react/jsx-props-no-spreading': 'off',
+      'import/no-extraneous-dependencies': 'off',
     },
-    'rules': {
-        'indent': [
-            'error',
-            2
-        ],
-        'linebreak-style': [
-            'error',
-            'unix'
-        ],
-        'quotes': [
-            'error',
-            'single'
-        ],
-        'semi': [
-            'error',
-            'never'
-        ],
-        'import/no-unresolved': 'off',
-        'no-underscore-dangle': 'off',
-        'guard-for-in': 'off',
-        'no-restricted-syntax': 'off',
-        'no-await-in-loop': 'off',
+  }, {
+    files: ['./src/**/*.spec.ts', 'spec/*.ts'],
+    rules: {
+      'no-unused-expressions': 'off',
+      'func-names': 'off',
+      'import/no-extraneous-dependencies': 'off',
     },
-    overrides: [
-        {
-          files: ['*-test.js', '*.spec.js'],
-          rules: {
-            'no-unused-expressions': 'off',
-            'func-names': 'off',
-            'prefer-arrow-callback': 'off'
-          }
-        }
-    ],
-    globals: {
-        'expect': true,
-        'factory': true,
-        'sandbox': true,
-        'User': true
-    }
-}
+  }],
+}

.github/workflows/push.yml

@@ -1,5 +1,5 @@
 name: CI/CD
-on: push
+on: [push, pull_request]
 jobs:
   setup:
     name: setup
@@ -97,6 +97,7 @@ jobs:
     name: Publish
     needs: test
     runs-on: ubuntu-latest
+    if: github.event_name == 'push'
     steps:
       - name: Checkout
         uses: actions/checkout@v2

.gitignore

@@ -1,4 +1,119 @@
-node_modules
-.nyc_output
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
 coverage
-.DS_store
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+build
+types

index.js

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/no-var-requires */
 /**
  * @module @admin-bro/sequelize
  *
@@ -76,7 +77,7 @@
  * @type {typeof BaseDatabase}
  * @static
  */
-const Database = require('./src/database')
+const Database = require('./build/database').default
 
 /**
  * Implementation of {@link BaseResource} for Sequelize Adapter
@@ -85,6 +86,6 @@ const Database = require('./src/database')
  * @type {typeof BaseResource}
  * @static
  */
-const Resource = require('./src/resource')
+const Resource = require('./build/resource').default
 
 module.exports = { Database, Resource }

migrations/20181211174223-create-user.js

@@ -1,4 +1,4 @@
-GENDER_CHOICES = {
+const GENDER_CHOICES = {
   MALE: "male",
   FEMALE: "female",
 }

models/index.js

@@ -21,7 +21,8 @@ fs
     return (file.indexOf('.') !== 0) && (file !== basename) && (file.slice(-3) === '.js');
   })
   .forEach(file => {
-    const model = sequelize['import'](path.join(__dirname, file))
+    // const model = sequelize['import'](path.join(__dirname, file))
+    const model = require(path.join(__dirname, file))(sequelize, Sequelize)
     db[model.name] = model
   })
 

package.json

@@ -2,12 +2,14 @@
   "name": "@admin-bro/sequelize",
   "version": "1.0.0-beta.3",
   "description": "Sequelize adapter for AdminBro",
-  "main": "index.js",
+  "main": "build/index.js",
+  "types": "types/index.d.ts",
   "scripts": {
-    "test": "./node_modules/mocha/bin/mocha spec/index.js",
+    "build": "tsc",
+    "test": "mocha -r ts-node/register src/*.spec.ts",
     "cover": "NODE_ENV=test ./node_modules/nyc/bin/nyc.js --reporter=html -x=spec -x=coverage  --all=true npm test",
-    "sequelize": "./node_modules/.bin/sequelize",
-    "lint": "./node_modules/eslint/bin/eslint.js './spec/**/*.js' './src/**/*.js'",
+    "sequelize": "sequelize",
+    "lint": "eslint './spec/**/*.ts' './src/**/*.ts'",
     "release": "semantic-release"
   },
   "repository": {
@@ -29,26 +31,32 @@
     "@commitlint/cli": "^8.3.5",
     "@commitlint/config-conventional": "^8.3.4",
     "@semantic-release/git": "^9.0.0",
-    "@types/mocha": "^7.0.2",
-    "admin-bro": "^3.0.0",
+    "@types/chai": "^4.2.12",
+    "@types/mocha": "^8.0.3",
+    "@types/sinon": "^9.0.5",
+    "@types/sinon-chai": "^3.2.4",
+    "@typescript-eslint/eslint-plugin": "^3.7.0",
+    "@typescript-eslint/parser": "^3.7.0",
+    "admin-bro": "^3.2.3",
     "chai": "^4.2.0",
-    "eslint": "^5.10.0",
-    "eslint-config-airbnb-base": "^13.1.0",
-    "eslint-plugin-import": "^2.14.0",
-    "factory-girl": "^5.0.4",
+    "eslint": "^7.5.0",
+    "eslint-config-airbnb": "^18.2.0",
+    "eslint-plugin-import": "^2.22.0",
+    "eslint-plugin-jsx-a11y": "^6.3.1",
+    "eslint-plugin-react": "^7.20.3",
+    "eslint-plugin-react-hooks": "^4.0.8",
     "husky": "^4.2.5",
-    "lodash": "^4.17.11",
     "mocha": "^5.2.0",
-    "mongoose": "^5.3.15",
     "nyc": "^12.0.2",
     "pg": "^7.7.1",
     "semantic-release": "^17.0.7",
-    "semantic-release-jira-releases-sb": "^0.7.2",
     "semantic-release-slack-bot": "^1.6.2",
-    "sequelize": "^4.42.0",
-    "sequelize-cli": "^5.4.0",
+    "sequelize": ">4.42.0",
+    "sequelize-cli": "^6.2.0",
     "sinon": "^7.1.1",
-    "sinon-chai": "^3.3.0"
+    "sinon-chai": "^3.3.0",
+    "ts-node": "^9.0.0",
+    "typescript": "^4.0.2"
   },
   "dependencies": {
     "escape-regexp": "0.0.1",