- eslint

- typescript config
- package json commands
- refactor script to be able to run up/down/reset
- config
- linting

database/.eslintignore

@@ -0,0 +1,3 @@
+node_modules
+**/*.min.js
+build

database/.eslintrc.js

@@ -0,0 +1,26 @@
+module.exports = {
+  root: true,
+  env: {
+    node: true,
+    // jest: true,
+  },
+  parser: '@typescript-eslint/parser',
+  plugins: ['prettier', '@typescript-eslint' /*, 'jest' */],
+  extends: [
+    'standard',
+    'eslint:recommended',
+    'plugin:prettier/recommended',
+    'plugin:@typescript-eslint/recommended',
+  ],
+  // add your custom rules here
+  rules: {
+    'no-console': ['error'],
+    'no-debugger': 'error',
+    'prettier/prettier': [
+      'error',
+      {
+        htmlWhitespaceSensitivity: 'ignore',
+      },
+    ],
+  },
+}

database/.gitignore

@@ -1,6 +1,6 @@
 .DS_Store
 node_modules/
-dist/
+build/
 .cache/
 npm-debug.log*
 yarn-debug.log*

database/.prettierrc.js

@@ -0,0 +1,8 @@
+module.exports = {
+  semi: false,
+  printWidth: 100,
+  singleQuote: true,
+  trailingComma: "all",
+  tabWidth: 2,
+  bracketSpacing: true,
+};

database/migrations/1-init_db.ts

@@ -2,12 +2,12 @@ export async function upgrade(queryFn: (query: string, values?: any[]) => Promis
   // write upgrade logic as parameter of queryFn
   await queryFn(`
     CREATE TABLE TEST (ID INTEGER NULL, NAME VARCHAR(20) NULL);
-  `);
+  `)
 }
-    
+
 export async function downgrade(queryFn: (query: string, values?: any[]) => Promise<Array<any>>) {
   // write downgrade logic as parameter of queryFn
   await queryFn(`
     DROP TABLE TEST;
-  `);
+  `)
-}
+}

database/package.json

@@ -10,14 +10,34 @@
   "scripts": {
     "build": "tsc --build",
     "clean": "tsc --build --clean",
-    "start": "node build/index.js",
+    "up": "node build/src/index.js up",
-    "dev": "nodemon -w src --ext ts --exec ts-node src/index.ts",
+    "down": "node build/src/index.js down",
+    "reset": "node build/src/index.js reset",
+    "dev_up": "nodemon -w src --ext ts --exec ts-node src/index.ts up",
+    "dev_down": "nodemon -w src --ext ts --exec ts-node src/index.ts down",
+    "dev_reset": "nodemon -w src --ext ts --exec ts-node src/index.ts reset",
     "lint": "eslint . --ext .js,.ts"
   },
   "devDependencies": {
+    "@types/mysql": "^2.15.19",
+    "@types/node": "^16.7.1",
+    "@typescript-eslint/eslint-plugin": "^4.29.2",
+    "@typescript-eslint/parser": "^4.29.2",
+    "eslint": "^7.32.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-config-standard": "^16.0.3",
+    "eslint-plugin-import": "^2.24.1",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-prettier": "^3.4.1",
+    "eslint-plugin-promise": "^5.1.0",
     "nodemon": "^2.0.12",
+    "prettier": "^2.3.2",
     "ts-node": "^10.2.1",
     "typescript": "^4.3.5"
   },
-  "dependencies": {}
+  "dependencies": {
+    "dotenv": "^10.0.0",
+    "mysql": "^2.18.1",
+    "ts-mysql-migrate": "^1.0.2"
+  }
 }

database/src/config/index.ts

@@ -0,0 +1,21 @@
+// ATTENTION: DO NOT PUT ANY SECRETS IN HERE (or the .env)
+
+import dotenv from 'dotenv'
+dotenv.config()
+
+const database = {
+  DB_HOST: process.env.DB_HOST || 'localhost',
+  DB_PORT: process.env.DB_PORT ? parseInt(process.env.DB_PORT) : 3306,
+  DB_USER: process.env.DB_USER || 'root',
+  DB_PASSWORD: process.env.DB_PASSWORD || '',
+  DB_DATABASE: process.env.DB_DATABASE || 'gradido_community',
+}
+
+const migrations = {
+  MIGRATIONS_TABLE: process.env.MIGRATIONS_TABLE || 'migrations',
+  MIGRATIONS_DIRECTORY: process.env.MIGRATIONS_DIRECTORY || './migrations/',
+}
+
+const CONFIG = { ...database, ...migrations }
+
+export default CONFIG

database/src/index.ts

@@ -0,0 +1,48 @@
+import { createPool, PoolConfig } from 'mysql'
+import { Migration } from 'ts-mysql-migrate'
+import CONFIG from './config'
+
+const run = async (command: string) => {
+  // Database connection
+  const poolConfig: PoolConfig = {
+    host: CONFIG.DB_HOST,
+    port: CONFIG.DB_PORT,
+    user: CONFIG.DB_USER,
+    password: CONFIG.DB_PASSWORD,
+    database: CONFIG.DB_DATABASE,
+  }
+
+  // Pool?
+  const pool = createPool(poolConfig)
+
+  // Create & Initialize Migrations
+  const migration = new Migration({
+    conn: pool,
+    tableName: CONFIG.MIGRATIONS_TABLE,
+    dir: CONFIG.MIGRATIONS_DIRECTORY,
+  })
+
+  await migration.initialize()
+
+  // Execute command
+  switch (command) {
+    case 'up':
+      await migration.up() // use for upgrade script
+      break
+    case 'down':
+      await migration.down() // use for downgrade script
+      break
+    case 'reset':
+      await migration.reset() // use for resetting database
+      break
+    default:
+      throw new Error(`Unsupported command ${command}`)
+  }
+}
+
+run(process.argv[2]).catch((err) => {
+  // eslint-disable-next-line no-console
+  console.log(err)
+}).then(()=>{
+  process.exit()
+})

database/src/upgrade.ts

@@ -1,54 +0,0 @@
-import { Migration, MigrationConnection } from 'ts-mysql-migrate';
-
-const run = async () => {
-  
-/**** mysqljs example ****/
-
-/*
-   const poolConfig: PoolConfig = {
-    host: process.env.DB_HOST,
-    port: parseInt(process.env.DB_PORT),
-    user: process.env.DB_USER,
-    password: process.env.DB_PASSWORD,
-    database: process.env.DB_DATABASE,
-
-  };
-
-  const pool = createPool(poolConfig);
-
-  migration = new Migration({
-    conn: pool,
-    tableName: 'migrations',
-    dir: `./src/migrations/`
-  });
-
-*/
-
-/**** node-mysql2 example ****/
-
-const poolConfig: ConnectionOptions = {
-    host: process.env.DB_HOST,
-    port: parseInt(process.env.DB_PORT),
-    user: process.env.DB_USER,
-    password: process.env.DB_PASSWORD,
-    database: process.env.DB_DATABASE,
-  };
-
-  const pool = createPool(poolConfig); // make sure that you are not using mysl2/promise lib
-
-  const migration = new Migration({
-    conn: pool as unknown as mysql.Connection,
-    tableName: 'migrations',
-    dir: `./src/migrations/`
-  });
-
-  await migration.initialize();
-  
-  await migration.up();       // use for upgrade script
-  // await migration.down();  // use for downgrade script
-  // await migration.reset(); // use for resetting database
-};
-
-run().catch((err) => {
-  console.log(err);
-});

database/tsconfig.json

@@ -0,0 +1,72 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig.json to read more about this file */
+
+    /* Basic Options */
+    // "incremental": true,                         /* Enable incremental compilation */
+    "target": "es5",                                /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', 'ES2021', or 'ESNEXT'. */
+    "module": "commonjs",                           /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
+    // "lib": [],                                   /* Specify library files to be included in the compilation. */
+    // "allowJs": true,                             /* Allow javascript files to be compiled. */
+    // "checkJs": true,                             /* Report errors in .js files. */
+    // "jsx": "preserve",                           /* Specify JSX code generation: 'preserve', 'react-native', 'react', 'react-jsx' or 'react-jsxdev'. */
+    // "declaration": true,                         /* Generates corresponding '.d.ts' file. */
+    // "declarationMap": true,                      /* Generates a sourcemap for each corresponding '.d.ts' file. */
+    // "sourceMap": true,                           /* Generates corresponding '.map' file. */
+    // "outFile": "./",                             /* Concatenate and emit output to single file. */
+    "outDir": "./build",                            /* Redirect output structure to the directory. */
+    // "rootDir": "./",                             /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
+    // "composite": true,                           /* Enable project compilation */
+    // "tsBuildInfoFile": "./",                     /* Specify file to store incremental compilation information */
+    // "removeComments": true,                      /* Do not emit comments to output. */
+    // "noEmit": true,                              /* Do not emit outputs. */
+    // "importHelpers": true,                       /* Import emit helpers from 'tslib'. */
+    // "downlevelIteration": true,                  /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
+    // "isolatedModules": true,                     /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
+
+    /* Strict Type-Checking Options */
+    "strict": true,                                 /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                       /* Raise error on expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,                    /* Enable strict null checks. */
+    // "strictFunctionTypes": true,                 /* Enable strict checking of function types. */
+    // "strictBindCallApply": true,                 /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
+    "strictPropertyInitialization": false,          /* Enable strict checking of property initialization in classes. */
+    // "noImplicitThis": true,                      /* Raise error on 'this' expressions with an implied 'any' type. */
+    // "alwaysStrict": true,                        /* Parse in strict mode and emit "use strict" for each source file. */
+
+    /* Additional Checks */
+    // "noUnusedLocals": true,                      /* Report errors on unused locals. */
+    // "noUnusedParameters": true,                  /* Report errors on unused parameters. */
+    // "noImplicitReturns": true,                   /* Report error when not all code paths in function return a value. */
+    // "noFallthroughCasesInSwitch": true,          /* Report errors for fallthrough cases in switch statement. */
+    // "noUncheckedIndexedAccess": true,            /* Include 'undefined' in index signature results */
+    // "noImplicitOverride": true,                  /* Ensure overriding members in derived classes are marked with an 'override' modifier. */
+    // "noPropertyAccessFromIndexSignature": true,  /* Require undeclared properties from index signatures to use element accesses. */
+
+    /* Module Resolution Options */
+    // "moduleResolution": "node",                  /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
+    // "baseUrl": "./",                             /* Base directory to resolve non-absolute module names. */
+    // "paths": {},                                 /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
+    // "rootDirs": [],                              /* List of root folders whose combined content represents the structure of the project at runtime. */
+    // "typeRoots": [],                             /* List of folders to include type definitions from. */
+    // "types": [],                                 /* Type declaration files to be included in compilation. */
+    // "allowSyntheticDefaultImports": true,        /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
+    "esModuleInterop": true,                        /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
+    // "preserveSymlinks": true,                    /* Do not resolve the real path of symlinks. */
+    // "allowUmdGlobalAccess": true,                /* Allow accessing UMD globals from modules. */
+
+    /* Source Map Options */
+    // "sourceRoot": "",                            /* Specify the location where debugger should locate TypeScript files instead of source locations. */
+    // "mapRoot": "",                               /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,                     /* Emit a single file with source maps instead of having a separate file. */
+    // "inlineSources": true,                       /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
+
+    /* Experimental Options */
+    "experimentalDecorators": true,                 /* Enables experimental support for ES7 decorators. */
+    "emitDecoratorMetadata": true,                  /* Enables experimental support for emitting type metadata for decorators. */
+
+    /* Advanced Options */
+    "skipLibCheck": true,                           /* Skip type checking of declaration files. */
+    "forceConsistentCasingInFileNames": true        /* Disallow inconsistently-cased references to the same file. */
+  }
+}