Skip to content
This repository has been archived by the owner on Apr 12, 2022. It is now read-only.

Commit

Permalink
deps: Improve TypeScript config (#1)
Browse files Browse the repository at this point in the history
* chore: Improve tsconfig.json

* feat: Add #src path alias

* deps: Move typescript to devDependencies

* fix: TypeScript build errors

* deps: Add node version enforcement

* deps: Remove lodash

* chore: Update README.md

* build(NPM): Add build:watch script

* chore: Update README.md
  • Loading branch information
ardalanamini authored Mar 6, 2022
1 parent b3f1aa5 commit 159e766
Show file tree
Hide file tree
Showing 10 changed files with 157 additions and 44 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,9 @@ dist
.yarn/install-state.gz
.pnp.*

# Build
.build/

# IDE
.idea/
.vscode/
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ XCoins code review repository.

- [Code Review](#code-review)
- [Issues](#issues)
- [Improvements](#improvements)

## Code Review

Expand All @@ -21,3 +22,20 @@ This section includes the issues, changes & improvements I've made, with the tho
> as it makes it difficult to debug & avoid possible incompatibility & security issues in dependencies.
- Missing `"private": true` property:
> This property will avoid accidental publication of the repository.
- `devDependencies` being wrongly included in `dependencies`:
> This will result to unnecessary packages being installed in the production server.
> This can increase production project size (e.g. Docker image).
- Issues in the `src` directory:
- Unused imports. (e.g. unused `lodash` import in the `src/scripts/seed.ts`)

### Improvements

- Improvements related to `TypeScript`:
- Changed `target` from `es5` to `esnext` to avoid polyfill overhead & possibly improve performance.
- Enabled `incremental` to improve build times.
- Enabled `removeComments` to avoid emitting comments unnecessarily & improve production size (Very small improvement, but still an improvement 😁).
- Enabled `inlineSources` to improve source mapping for usage in services such as `Sentry`.
- Added `paths` to improve code quality and avoid long relative imports.
> for this purpose, I used `imports` property in `package.json` to avoid using unnecessary third-party application,
> which improves both the startup time and security, due to the fact that `Node.js` will only apply these path aliases to the current package,
> meaning no installed dependency can use these path aliases (which could cause security issues as well)
20 changes: 6 additions & 14 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

20 changes: 13 additions & 7 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,19 @@
"bugs": {
"url": "https://github.com/ardalanamini/xcoins-code-review/issues"
},
"main": "index.js",
"engines": {
"node": ">=16.14.0"
},
"imports": {
"#src/*": "./.build/*"
},
"main": ".build/api.js",
"scripts": {
"dev": "ts-node-dev src/api.ts",
"seed": "ts-node-dev src/scripts/seed.ts",
"start": "node dist/api.js",
"build": "tsc -b"
"start": "node .build/api.js",
"build": "tsc",
"build:watch": "npm run build -- --watch"
},
"dependencies": {
"@types/cors": "^2.8.10",
Expand All @@ -28,18 +35,17 @@
"dotenv": "^8.2.0",
"express": "^4.17.1",
"express-handlebars": "^5.3.0",
"lodash": "^4.17.21",
"luxon": "^1.26.0",
"mongoose": "^5.12.7",
"nodemon": "^2.0.7",
"ts-node": "^9.1.1",
"ts-node-dev": "^1.1.6",
"typescript": "^4.2.4"
"ts-node-dev": "^1.1.6"
},
"devDependencies": {
"@typescript-eslint/eslint-plugin": "^4.22.0",
"@typescript-eslint/parser": "^4.22.0",
"eslint": "^7.25.0",
"eslint-plugin-react": "^7.23.2"
"eslint-plugin-react": "^7.23.2",
"typescript": "^4.2.4"
}
}
12 changes: 6 additions & 6 deletions src/api.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
import express from "express";
import { PORT, DBURL, CORS_ORIGINS } from "./config";
import cors from "cors";
import { CORS_ORIGINS, DBURL, PORT } from "#src/config.js";
import { router as favoriteRouter } from "#src/routes/favorite.router.js";
import { router as profileRouter } from "#src/routes/profile.router.js";
import { router as simulatorRouter } from "#src/routes/simulator.router.js";
import bodyParser from "body-parser";
import cors from "cors";
import express from "express";
import mongoose from "mongoose";
import { router as favoriteRouter } from "./routes/favorite.router";
import { router as profileRouter } from "./routes/profile.router";
import { router as simulatorRouter } from "./routes/simulator.router";

mongoose
.connect(`${DBURL}`, { useNewUrlParser: true, useUnifiedTopology: true })
Expand Down
2 changes: 1 addition & 1 deletion src/routes/favorite.router.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { Favorite } from "#src/models/Favorite.js";
import express from "express";
import { Favorite } from "../models/Favorite";

export const router = express.Router();

Expand Down
2 changes: 1 addition & 1 deletion src/routes/profile.router.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { Profile } from "#src/models/Profile.js";
import express from "express";
import { Profile } from "../models/Profile";

export var router = express.Router();

Expand Down
5 changes: 2 additions & 3 deletions src/routes/simulator.router.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import express from "express";
import { Router } from "express";
import { Simulator } from "../models/Simulator";
import { Simulator } from "#src/models/Simulator.js";
import cors from "cors";
import express from "express";

var app = express();
app.use(cors());
Expand Down
11 changes: 5 additions & 6 deletions src/scripts/seed.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
import { DBURL } from "#src/config.js";
import { Favorite } from "#src/models/Favorite.js";
import { Profile } from "#src/models/Profile.js";
import { Simulator } from "#src/models/Simulator.js";
import mongoose from "mongoose";
import _ from "lodash";
import { Profile } from "../models/Profile";
import { Simulator } from "../models/Simulator";
import { Favorite } from "../models/Favorite";
import { DBURL } from "../config";

(async () => {

Expand All @@ -22,7 +21,7 @@ import { DBURL } from "../config";
await profile.save();

const query = { _id: "6093abb3dfd9da1deeae56f2" };
const idProfile = await Profile.findOne(query).then((e) => {
const idProfile = await Profile.findOne(query).then((e: any) => {
return e?._id;
});

Expand Down
108 changes: 102 additions & 6 deletions tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,105 @@
{
"compilerOptions": {
"target": "es5",
"module": "commonjs",
"sourceMap": true,
"outDir": "dist",
"esModuleInterop": true
}
/* Visit https://aka.ms/tsconfig.json to read more about this file */

/* Projects */
"incremental": true, /* Enable incremental compilation */
// "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
// "tsBuildInfoFile": "./", /* Specify the folder for .tsbuildinfo incremental compilation files. */
// "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects */
// "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
// "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */

/* Language and Environment */
"target": "esnext", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
// "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
// "jsx": "preserve", /* Specify what JSX code is generated. */
// "experimentalDecorators": true, /* Enable experimental support for TC39 stage 2 draft decorators. */
// "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
// "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h' */
// "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
// "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx*`.` */
// "reactNamespace": "", /* Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit. */
// "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
// "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */

/* Modules */
"module": "commonjs", /* Specify what module code is generated. */
"rootDir": "./src", /* Specify the root folder within your source files. */
"moduleResolution": "node", /* Specify how TypeScript looks up a file from a given module specifier. */
"baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
"paths": { /* Specify a set of entries that re-map imports to additional lookup locations. */
"#src/*": ["src/*"]
},
// "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
// "typeRoots": [], /* Specify multiple folders that act like `./node_modules/@types`. */
// "types": [], /* Specify type package names to be included without being referenced in a source file. */
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
"resolveJsonModule": true, /* Enable importing .json files */
// "noResolve": true, /* Disallow `import`s, `require`s or `<reference>`s from expanding the number of files TypeScript should add to a project. */

/* JavaScript Support */
// "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */
// "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
// "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`. */

/* Emit */
// "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
// "declarationMap": true, /* Create sourcemaps for d.ts files. */
// "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
"sourceMap": true, /* Create source map files for emitted JavaScript files. */
// "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output. */
"outDir": "./.build", /* Specify an output folder for all emitted files. */
"removeComments": true, /* Disable emitting comments. */
// "noEmit": true, /* Disable emitting files from a compilation. */
// "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
// "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types */
// "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
"sourceRoot": "/", /* Specify the root path for debuggers to find the reference source code. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
"inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
// "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
// "newLine": "crlf", /* Set the newline character for emitting files. */
// "stripInternal": true, /* Disable emitting declarations that have `@internal` in their JSDoc comments. */
// "noEmitHelpers": true, /* Disable generating custom helper functions like `__extends` in compiled output. */
// "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
// "preserveConstEnums": true, /* Disable erasing `const enum` declarations in generated code. */
// "declarationDir": "./", /* Specify the output directory for generated declaration files. */
// "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */

/* Interop Constraints */
"isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
// "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
"esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */
// "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
"forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */

/* Type Checking */
"strict": true, /* Enable all strict type-checking options. */
// "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied `any` type.. */
// "strictNullChecks": true, /* When type checking, take into account `null` and `undefined`. */
// "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
// "strictBindCallApply": true, /* Check that the arguments for `bind`, `call`, and `apply` methods match the original function. */
// "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
// "noImplicitThis": true, /* Enable error reporting when `this` is given the type `any`. */
// "useUnknownInCatchVariables": true, /* Type catch clause variables as 'unknown' instead of 'any'. */
"alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
// "noUnusedLocals": true, /* Enable error reporting when a local variables aren't read. */
// "noUnusedParameters": true, /* Raise an error when a function parameter isn't read */
// "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
// "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
// "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
// "noUncheckedIndexedAccess": true, /* Include 'undefined' in index signature results */
// "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
// "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type */
// "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
// "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */

/* Completeness */
// "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
"skipLibCheck": true /* Skip type checking all .d.ts files. */
},
"include": ["src"],
"exclude": ["node_modules", ".build"]
}

0 comments on commit 159e766

Please sign in to comment.