From 895f0a0106b98efc332f15e46f0769a12e4ef8c6 Mon Sep 17 00:00:00 2001 From: Chris Sebok Date: Wed, 9 Sep 2020 19:52:48 +0100 Subject: [PATCH] WIP #33. Added TypeScript and tsc compiler functionality. Only working with JS at the moment, but will be converting all code to .ts files soon --- .gitignore | 2 + Dockerfile | 34 ++++++++++++++--- package-lock.json | 94 +++++++++++++++++++++++++++++++++++++++++++++-- package.json | 17 ++++++--- tsconfig.json | 78 +++++++++++++++++++++++++++++++++++++++ 5 files changed, 211 insertions(+), 14 deletions(-) create mode 100644 tsconfig.json diff --git a/.gitignore b/.gitignore index d09ecca..16852b5 100644 --- a/.gitignore +++ b/.gitignore @@ -113,3 +113,5 @@ invite.txt # The below files contain sensitive info related to GitHub Package deployment docker-username docker-password + +.vscode/symbols.json diff --git a/Dockerfile b/Dockerfile index c5cfa3a..ed97b0e 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,22 +1,46 @@ # Node Bot Dockerfile #--------------------- -FROM node:lts-alpine3.9 +FROM node:lts-alpine3.9 as build WORKDIR /bot -COPY package.json /bot -COPY package-lock.json /bot +COPY package.json . +COPY package-lock.json . +RUN set -x \ + && npm -v \ + && npm set progress=false \ + && npm install --no-progress + +COPY tsconfig.json . +COPY index.* . +COPY app/ ./app + +RUN ls -la + +RUN set -x \ + && npm run tsc + +FROM node:lts-alpine3.9 as host +WORKDIR /bot +COPY --from=build /bot/package.json . +COPY --from=build /bot/package-lock.json . +# TODO: Only copy .js files in PROD builds (ignore .ts and .map) +COPY --from=build /bot/dist . +RUN ls -la + +# TODO: Make sure we need the node_modules directory after upgrading to TS RUN set -x \ && npm -v \ && npm set progress=false \ && npm install --no-progress --only=prod +RUN rm package-lock.json -f + RUN set -x \ && apk add tzdata +RUN ls -la COPY /config.json /bot -COPY /index.js /bot -COPY /app /bot/app CMD ["npm", "run", "start:hosted"] diff --git a/package-lock.json b/package-lock.json index 8337815..8cb1cc5 100644 --- a/package-lock.json +++ b/package-lock.json @@ -352,6 +352,12 @@ "fill-range": "^7.0.1" } }, + "builtin-modules": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/builtin-modules/-/builtin-modules-1.1.1.tgz", + "integrity": "sha1-Jw8HbFpywC9bZaR9+Uxf46J4iS8=", + "dev": true + }, "callsites": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/callsites/-/callsites-3.1.0.tgz", @@ -482,6 +488,12 @@ "delayed-stream": "~1.0.0" } }, + "commander": { + "version": "2.20.3", + "resolved": "https://registry.npmjs.org/commander/-/commander-2.20.3.tgz", + "integrity": "sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ==", + "dev": true + }, "concat-map": { "version": "0.0.1", "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", @@ -551,6 +563,12 @@ "resolved": "https://registry.npmjs.org/detect-node/-/detect-node-2.0.4.tgz", "integrity": "sha512-ZIzRpLJrOj7jjP2miAtgqIfmzbxa4ZOr5jJc601zklsfEx9oTzmmj2nVpIPRpNlRTIh8lc1kyViIY7BWSGNmKw==" }, + "diff": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/diff/-/diff-4.0.2.tgz", + "integrity": "sha512-58lmxKSA4BNyLz+HHMUzlOEpg09FV+ev6ZMe3vJihgdxzgcwZ8VoEEPmALCZG9LmqfVoNMMKpttIYTVG6uDY7A==", + "dev": true + }, "discord.js": { "version": "12.2.0", "resolved": "https://registry.npmjs.org/discord.js/-/discord.js-12.2.0.tgz", @@ -922,6 +940,17 @@ "flatted": "^2.0.0", "rimraf": "2.6.3", "write": "1.0.3" + }, + "dependencies": { + "rimraf": { + "version": "2.6.3", + "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-2.6.3.tgz", + "integrity": "sha512-mwqeW5XsA2qAejG46gYdENaxXjx9onRNCfn7L0duuP4hCuTIi/QO7PDK07KJfp1d+izWPrzEJDcSqBa0OZQriA==", + "dev": true, + "requires": { + "glob": "^7.1.3" + } + } } }, "flatted": { @@ -1592,6 +1621,12 @@ "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==", "dev": true }, + "path-parse": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/path-parse/-/path-parse-1.0.6.tgz", + "integrity": "sha512-GSmOT2EbHrINBf9SR7CDELwlJ8AENk3Qn7OikK4nFYAu3Ote2+JYNVvkpAEQm3/TLNEJFD/xZJjzyxg3KBWOzw==", + "dev": true + }, "perfy": { "version": "1.1.5", "resolved": "https://registry.npmjs.org/perfy/-/perfy-1.1.5.tgz", @@ -1667,6 +1702,15 @@ "integrity": "sha512-NKN5kMDylKuldxYLSUfrbo5Tuzh4hd+2E8NPPX02mZtn1VuREQToYe/ZdlJy+J3uCpfaiGF05e7B8W0iXbQHmg==", "dev": true }, + "resolve": { + "version": "1.17.0", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.17.0.tgz", + "integrity": "sha512-ic+7JYiV8Vi2yzQGFWOkiZD5Z9z7O2Zhm9XMaTxdJExKasieFCr+yXZ/WmXsckHiKl12ar0y6XiXDx3m4RHn1w==", + "dev": true, + "requires": { + "path-parse": "^1.0.6" + } + }, "resolve-from": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/resolve-from/-/resolve-from-4.0.0.tgz", @@ -1684,9 +1728,9 @@ } }, "rimraf": { - "version": "2.6.3", - "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-2.6.3.tgz", - "integrity": "sha512-mwqeW5XsA2qAejG46gYdENaxXjx9onRNCfn7L0duuP4hCuTIi/QO7PDK07KJfp1d+izWPrzEJDcSqBa0OZQriA==", + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-3.0.2.tgz", + "integrity": "sha512-JZkJMZkAGFFPP2YqXZXPbMlMBgsxzE8ILs4lMIX/2o0L9UBw9O/Y3o6wFw/i9YLapcUJWwqbi3kdxIPdC62TIA==", "dev": true, "requires": { "glob": "^7.1.3" @@ -1852,6 +1896,44 @@ "resolved": "https://registry.npmjs.org/tslib/-/tslib-1.13.0.tgz", "integrity": "sha512-i/6DQjL8Xf3be4K/E6Wgpekn5Qasl1usyw++dAA35Ue5orEn65VIxOA+YvNNl9HV3qv70T7CNwjODHZrLwvd1Q==" }, + "tslint": { + "version": "6.1.3", + "resolved": "https://registry.npmjs.org/tslint/-/tslint-6.1.3.tgz", + "integrity": "sha512-IbR4nkT96EQOvKE2PW/djGz8iGNeJ4rF2mBfiYaR/nvUWYKJhLwimoJKgjIFEIDibBtOevj7BqCRL4oHeWWUCg==", + "dev": true, + "requires": { + "@babel/code-frame": "^7.0.0", + "builtin-modules": "^1.1.1", + "chalk": "^2.3.0", + "commander": "^2.12.1", + "diff": "^4.0.1", + "glob": "^7.1.1", + "js-yaml": "^3.13.1", + "minimatch": "^3.0.4", + "mkdirp": "^0.5.3", + "resolve": "^1.3.2", + "semver": "^5.3.0", + "tslib": "^1.13.0", + "tsutils": "^2.29.0" + }, + "dependencies": { + "semver": { + "version": "5.7.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-5.7.1.tgz", + "integrity": "sha512-sauaDf/PZdVgrLTNYHRtpXa1iRiKcaebiKQ1BJdpQlWH2lCvexQdX55snPFyK7QzpudqbCI0qXFfOasHdyNDGQ==", + "dev": true + } + } + }, + "tsutils": { + "version": "2.29.0", + "resolved": "https://registry.npmjs.org/tsutils/-/tsutils-2.29.0.tgz", + "integrity": "sha512-g5JVHCIJwzfISaXpXE1qvNalca5Jwob6FjI4AoPlqMusJ6ftFE7IkkFoMhVLRgK+4Kx3gkzb8UZK5t5yTTvEmA==", + "dev": true, + "requires": { + "tslib": "^1.8.1" + } + }, "tweetnacl": { "version": "1.0.3", "resolved": "https://registry.npmjs.org/tweetnacl/-/tweetnacl-1.0.3.tgz", @@ -1951,6 +2033,12 @@ "integrity": "sha512-4dbzIzqvjtgiM5rw1k5rEHtBANKmdudhGyBEajN01fEyhaAIhsoKNy6y7+IN93IfpFtwY9iqi7kD+xwKhQsNJA==", "dev": true }, + "typescript": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.0.2.tgz", + "integrity": "sha512-e4ERvRV2wb+rRZ/IQeb3jm2VxBsirQLpQhdxplZ2MEzGvDkkMmPglecnNDfSUBivMjP93vRbngYYDQqQ/78bcQ==", + "dev": true + }, "uri-js": { "version": "4.2.2", "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.2.2.tgz", diff --git a/package.json b/package.json index 5df69b7..70e99f7 100644 --- a/package.json +++ b/package.json @@ -7,17 +7,19 @@ "repository": "github:lewster32/corporallancot", "license": "MIT", "scripts": { - "start": "dotenv -- node index.js", + "start": "npm run tsc && dotenv -- node dist/index.js", "start:hosted": "node index.js", "docker:start": "docker-compose up -d --build", "docker:startdb": "docker-compose up -d --scale bot=0", "docker:stop": "docker-compose down", - "docker:watch": "chokidar -p \"{index.js,docker-compose.yml,Dockerfile,.dockerignore,package.json,**/*.js,.env,config.json}\" --ignore \"{**/*.spec.js,node_modules/**/*,spec/**/*}\" -c \"npm run docker:start && docker logs corporallancot.bot\" --initial --debounce 1000", + "docker:watch": "chokidar -p \"{index.js,docker-compose.yml,Dockerfile,.dockerignore,package.json,**/*.js,.env,config.json,tsconfig.json}\" --ignore \"{**/*.spec.js,node_modules/**/*,spec/**/*,dist/**/*}\" -c \"npm run docker:start && docker logs corporallancot.bot\" --initial --debounce 1000", "test": "jasmine", - "test:watch": "chokidar -p \"{index.js,**/*.js,package.json,spec/support/jasmine.json}\" --ignore \"node_modules/**/*\" -c \"npm run test\" --initial --debounce 500", + "test:watch": "chokidar -p \"{index.js,**/*.js,package.json,spec/support/jasmine.json,tsconfig.json}\" --ignore \"{node_modules/**/*,dist/**/*}\" -c \"npm run test\" --initial --debounce 500", "lint": "eslint .", - "lint:watch": "chokidar -p \"{index.js,**/*.js,.eslintrc.json,package.json}\" --ignore \"node_modules/**/*\" -c \"npm run lint\" --initial --debounce 500", - "logs": "docker logs corporallancot.bot" + "lint:watch": "chokidar -p \"{index.js,**/*.js,.eslintrc.json,package.json}\" --ignore \"{node_modules/**/*,dist/**/*}\" -c \"npm run lint\" --initial --debounce 500", + "logs": "docker logs corporallancot.bot", + "tsc": "tsc", + "tsc:clean": "rimraf dist/" }, "dependencies": { "awilix": "^4.2.6", @@ -35,7 +37,10 @@ "faker": "^5.1.0", "jasmine": "^3.5.0", "jasmine-console-reporter": "^3.1.0", - "jasmine-theories": "^0.1.3" + "jasmine-theories": "^0.1.3", + "rimraf": "^3.0.2", + "tslint": "^6.1.3", + "typescript": "^4.0.2" }, "_moduleAliases": { "@root": "app", diff --git a/tsconfig.json b/tsconfig.json new file mode 100644 index 0000000..889694b --- /dev/null +++ b/tsconfig.json @@ -0,0 +1,78 @@ +{ + "compilerOptions": { + /* Visit https://aka.ms/tsconfig.json to read more about this file */ + + /* Basic Options */ + // "incremental": true, /* Enable incremental compilation */ + "target": "ES2020", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', 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', or 'react'. */ + "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": "./dist/index.js", /* Concatenate and emit output to single file. */ + "outDir": "./dist", /* 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": true, /* 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. */ + + /* 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. */ + }, + "include": [ + "./app/**/*", /* TODO: Set to *.ts once all .js files are migrated to .ts */ + "./index.js", /* TODO: Remove once all .js files are migrated to .ts */ + "./index.ts" + ], + "exclude": [ + "./**/*.spec.js", /* TODO: Remove once all .js files are migrated to .ts */ + "./**/*.spec.ts" + ] +}