feat: migrate to typescript

Author: JonaszJestem

.eslintrc.js

@@ -1,56 +1,24 @@
 module.exports = {
-  'env': {
-    'es6': true,
-    'node': true,
-    'mocha': true
-  },
-  'extends': 'airbnb-base',
-  'parserOptions': {
-    'ecmaVersion': 2018,
-    'sourceType': 'module'
+  parser: '@typescript-eslint/parser',
+  plugins: ['@typescript-eslint/eslint-plugin'],
+  extends: [
+    'plugin:@typescript-eslint/recommended',
+    'plugin:prettier/recommended',
+  ],
+  parserOptions: {
+    ecmaVersion: 2018,
+    sourceType: 'module',
+    ecmaFeatures: {
+      jsx: true,
+    },
   },
-  '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',
+  rules: {
+    'prettier/prettier': 'error'
   },
-  overrides: [
-    {
-      files: ['*-test.js', '*.spec.js'],
-      rules: {
-        'no-unused-expressions': 'off',
-        'func-names': 'off',
-        'prefer-arrow-callback': 'off'
-      }
+  ignorePatterns: ['node_modules', 'lib'],
+  settings: {
+    react: {
+      version: 'detect',
     },
-    {
-      files: ["examples/**/*.js"],
-      rules: {
-        'import/no-extraneous-dependencies': 'off'
-      }
-    }
-  ],
-  globals: {
-    'expect': true,
-    'factory': true,
-    'sandbox': true
-  }
-}
+  },
+};

.gitignore

@@ -1,2 +1,121 @@
-node_modules
-.DS_store
+# 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
+*.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.*
+
+.DS_store
+
+# build files
+/lib

.idea/admin-bro-expressjs.iml

@@ -0,0 +1,8 @@
+export {};
+
+declare module "express-session" {
+  interface SessionData {
+    adminUser?: unknown;
+    redirectTo?: string;
+  }
+}

.idea/inspectionProfiles/Project_Default.xml

@@ -88,6 +88,7 @@
  * meaning that it should have at least an email property.
  */
 
-const Plugin = require('./plugin')
+import * as Plugin from "./src/plugin";
 
-module.exports = Plugin
+module.exports = Plugin;
+export default Plugin;

.idea/modules.xml

@@ -4,9 +4,12 @@
   "description": "This is an official AdminBro plugin which integrates it to expressjs framework",
   "main": "index.js",
   "scripts": {
+    "dev": "rm -rf lib && tsc --watch",
+    "build": "rm -rf lib && tsc",
     "simple": "nodemon examples/simple.js",
-    "test": "./node_modules/.bin/mocha spec/index.js",
-    "lint": "./node_modules/eslint/bin/eslint.js './examples/**/*.js' './plugin.js'",
+    "test": "jest --config ./test/jest.json",
+    "lint": "eslint './**/*.ts'",
+    "check:all": "yarn lint && yarn build && yarn test",
     "release": "semantic-release"
   },
   "repository": {
@@ -20,7 +23,7 @@
     "admin-panel"
   ],
   "author": "Michał Laskowski",
-  "license": "MIT",
+  "license": "SEE LICENSE IN LICENSE",
   "bugs": {
     "url": "https://github.com/SoftwareBrothers/admin-bro-expressjs/issues"
   },
@@ -37,28 +40,35 @@
     }
   },
   "devDependencies": {
-    "@types/express": "^4.17.4",
-    "@types/mocha": "^7.0.2",
-    "admin-bro": ">=3.0.0",
-    "@admin-bro/mongoose": "^1.0.0",
+    "@admin-bro/mongoose": "^1.1.0",
+    "@types/express": "^4.16.4",
+    "@types/express-formidable": "^1.0.4",
+    "@types/express-serve-static-core": "^4.17.13",
+    "@types/express-session": "^1.17.3",
+    "@types/jest": "^26.0.15",
+    "@types/mongoose": "^5.10.1",
+    "@typescript-eslint/eslint-plugin": "^4.8.1",
+    "@typescript-eslint/parser": "^4.8.1",
+    "admin-bro": "^3.3.1",
     "chai": "^4.2.0",
-    "eslint": "^5.10.0",
-    "eslint-config-airbnb-base": "^13.1.0",
-    "eslint-plugin-import": "^2.14.0",
-    "express": "^4.16.4",
+    "eslint": "^7.13.0",
+    "eslint-config-airbnb-base": "^14.2.1",
+    "eslint-config-prettier": "^6.15.0",
+    "eslint-plugin-import": "^2.22.1",
+    "eslint-plugin-prettier": "^3.1.4",
+    "express": "^4.17.1",
     "express-formidable": "^1.2.0",
-    "express-session": ">=1.15.6",
-    "mocha": "^5.2.0",
-    "mongoose": "^5.3.16",
-    "nodemon": "^1.18.8",
-    "sinon": "^7.2.3",
-    "sinon-chai": "^3.3.0",
-    "semantic-release": "^17.0.7",
+    "express-session": "^1.17.1",
+    "husky": "^4.3.0",
+    "jest": "^26.6.3",
+    "mongoose": "^5.10.15",
+    "prettier": "^2.2.0",
+    "semantic-release": "^17.2.4",
     "semantic-release-jira-releases-sb": "^0.7.2",
     "semantic-release-slack-bot": "^1.6.2",
-    "@semantic-release/git": "^9.0.0",
-    "husky": "^4.2.5",
-    "@commitlint/cli": "^8.3.5",
-    "@commitlint/config-conventional": "^8.3.4"
+    "sinon": "^9.2.1",
+    "sinon-chai": "^3.5.0",
+    "ts-jest": "^26.4.4",
+    "typescript": "^4.1.2"
   }
 }