Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added eslint, prettier & jest #5

Merged
merged 6 commits into from Mar 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 2 additions & 0 deletions .eslintignore
@@ -0,0 +1,2 @@
*.js
tests/*
24 changes: 24 additions & 0 deletions .eslintrc.js
@@ -0,0 +1,24 @@
module.exports = {
env: {
browser: true,
es2021: true,
node: true,
},
extends: [
'eslint:recommended',
'plugin:@typescript-eslint/recommended',
'prettier',
],
parser: '@typescript-eslint/parser',
parserOptions: {
ecmaVersion: 'latest',
sourceType: 'module',
project: './tsconfig.json',
},
plugins: ['@typescript-eslint'],
rules: {
/** your own rules. */
'no-unused-vars': 'off',
'@typescript-eslint/no-unused-vars': 'off',
},
}
5 changes: 5 additions & 0 deletions .husky/pre-commit
@@ -0,0 +1,5 @@
#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"

npm test
npm run lint
2 changes: 2 additions & 0 deletions .prettierrc
@@ -1,6 +1,8 @@
{
"singleQuote": true,
"trailingComma": "all",
"tabWidth": 2,
"semi": false,
"overrides": [
{
"files": "*.ts",
Expand Down
6 changes: 6 additions & 0 deletions babel.config.js
@@ -0,0 +1,6 @@
module.exports = {
presets: [
['@babel/preset-env', { targets: { node: 'current' } }],
'@babel/preset-typescript',
],
}
3 changes: 3 additions & 0 deletions jest.config.js
@@ -0,0 +1,3 @@
module.exports = {
testEnvironment: 'node',
}
22 changes: 20 additions & 2 deletions package.json
Expand Up @@ -13,13 +13,27 @@
"tslib": "~2.3.1"
},
"devDependencies": {
"@babel/core": "^7.18.5",
"@babel/preset-env": "^7.18.2",
"@babel/preset-typescript": "^7.17.12",
"@types/cors": "^2.8.12",
"@types/express": "^4.17.13",
"@types/jest": "^28.1.3",
"@types/node": "~17.0.5",
"@types/sinon-express-mock": "^1.3.9",
"@typescript-eslint/eslint-plugin": "^5.29.0",
"@typescript-eslint/parser": "^5.29.0",
"babel-jest": "^28.1.1",
"eslint": "^8.18.0",
"eslint-config-prettier": "^8.5.0",
"husky": "^8.0.0",
"jest": "^28.1.1",
"nodemon": "^2.0.15",
"npm-run-all": "^4.1.5",
"prettier": "~2.5.1",
"prettier": "^2.7.1",
"rimraf": "~3.0.2",
"sinon": "^14.0.0",
"sinon-express-mock": "^2.2.1",
"tsc-alias": "^1.6.6",
"tsc-watch": "^4.6.0",
"tsutils": "~3.21.0",
Expand All @@ -31,6 +45,10 @@
"clean": "rimraf dist/",
"compile": "run-s clean tsc start",
"dev": "nodemon",
"build": "run-s clean tsc"
"build": "run-s clean tsc",
"lint": "eslint src/",
"lint:fix": "eslint --cache --fix src/ && prettier --write src/",
"test": "jest",
"prepare": "husky install"
}
}
6 changes: 3 additions & 3 deletions src/controllers/homeController.ts
@@ -1,5 +1,5 @@
import {Request, Response} from 'express';
import { Request, Response } from 'express'

export async function home(req: Request, res: Response) {
res.send('Hello World!');
}
res.status(200).send('Hello World!')
}
17 changes: 9 additions & 8 deletions src/database/database.ts
@@ -1,15 +1,16 @@
import { connect } from "mongoose";
let monURI = "mongodb://localhost:27017/express-typescript-demo";
import { connect } from 'mongoose'
// eslint-disable-next-line prefer-const
let monURI = 'mongodb://localhost:27017/express-typescript-demo'

const connectDB = async () => {
try {
await connect(monURI);
console.log("MongoDB Connected...");
await connect(monURI)
console.log('MongoDB Connected...')
} catch (err) {
console.error(err.message);
console.error(err.message)
// Exit process with failure
process.exit(1);
process.exit(1)
}
};
}

export default connectDB;
export default connectDB
12 changes: 12 additions & 0 deletions tests/Features/example.spec.ts
@@ -0,0 +1,12 @@
import { mockReq, mockRes } from 'sinon-express-mock'
import { home } from '../../src/controllers/HomeController'

describe('HomeController', () => {
test('should home controller return message', async () => {
const req = mockReq()
const res = mockRes()
await home(req, res)
expect(res.status.calledWith(200)).toBeTruthy()
expect(res.send.calledWith('Hello World!')).toBeTruthy()
})
})
5 changes: 5 additions & 0 deletions tests/Unit/example.test.ts
@@ -0,0 +1,5 @@
describe('example', () => {
it('should pass', () => {
expect(true).toBe(true)
})
})
5 changes: 2 additions & 3 deletions tsconfig.json
Expand Up @@ -13,8 +13,7 @@
"*": ["node_modules/*", "src/types/*"],
"@/*": ["./src/*"]
},
"types": ["@types/jest"]
},
"include": [
"src/**/*",
]
"include": ["src/**/*"]
}