Jest Framework + Some clean up and fixes (#6)

MathieuGermain · web-flow · commit 92ec6b51a95a · 2022-09-09T20:18:31.000-04:00
* Update package scripts

* Update tsconfig.json

* Update .gitignore

* Create .npmignore

* Delete .prettierignore

* Update .prettierrc

* Update .eslintrc

* Create .eslintignore

* Update README.md

* Update build.yml
- Renamed to Build
- Changed matrix to use node 16.x

* Update dependabot.yml

- Removed target-branch

* Update description

* Added jest framework

* Fixed prettier not fixing during linting.

* Update build.yml to tests.yml
The yarn command was already running the build script, so there was no need to call it twice.
diff --git a/.eslintignore b/.eslintignore
@@ -0,0 +1 @@
+dist/
diff --git a/.eslintrc b/.eslintrc
@@ -1,6 +1,15 @@
 {
-  "extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended"],
+  "extends": [
+    "eslint:recommended", 
+    "plugin:@typescript-eslint/recommended"
+  ],
   "parser": "@typescript-eslint/parser",
-  "plugins": ["@typescript-eslint"],
+  "plugins": [
+    "@typescript-eslint",
+    "prettier"
+  ],
+  "rules": {
+    "prettier/prettier": "warn"
+  },
   "root": true
-}
+}
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -9,6 +9,5 @@ updates:
     directory: "/" # Location of package manifests
     schedule:
       interval: "weekly"
-    target-branch: "dev"
     labels:
       - "npm dependencies"
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -1,18 +1,18 @@
 # This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
 # For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
 
-name: CI
+name: Tests
 
 on: ["push", "pull_request"]
 
 jobs:
-  build:
+  tests:
 
     runs-on: ubuntu-latest
 
     strategy:
       matrix:
-        node-version: [12.x, 14.x, 16.x]
+        node-version: [16.x]
         # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
 
     steps:
@@ -22,6 +22,5 @@ jobs:
         with:
           node-version: ${{ matrix.node-version }}
           cache: 'yarn'
-      - run: yarn install --frozen-lockfile
-      - run: yarn build
+      - run: yarn --frozen-lockfile
       - run: yarn test
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,11 @@
+# NPM
 node_modules/
-dist/
+
+# Sources
+dist/
+types/
+
+# Archives
+*.tgz
+*.zip
+*.rar
diff --git a/.npmignore b/.npmignore
@@ -0,0 +1,22 @@
+# Github
+.git/
+.github/
+
+# NPM
+node_modules/
+
+# Sources
+src/
+tests/
+
+# Files
+jest.config.ts
+tsconfig.json
+.eslintignore
+.eslintrc
+.prettierrc
+
+# Archives
+*.tgz
+*.zip
+*.rar
diff --git a/.prettierignore b/.prettierignore
diff --git a/.prettierrc b/.prettierrc
@@ -1,6 +1,9 @@
 {
+    "$schema": "http://json.schemastore.org/prettierrc",
     "tabWidth": 4,
     "singleQuote": true,
     "trailingComma": "all",
-    "printWidth": 120
+    "printWidth": 120,
+    "endOfLine": "auto",
+    "bracketSpacing": true
 }
diff --git a/README.md b/README.md
@@ -1,36 +1,30 @@
 # Typescript Base Project
 
-[![CI](https://github.com/MathieuGermain/ts-base-project/actions/workflows/build.yml/badge.svg)](https://github.com/MathieuGermain/ts-base-project/actions/workflows/build.yml)
+[![CI](https://github.com/MathieuGermain/ts-base-project/actions/workflows/tests.yml/badge.svg)](https://github.com/MathieuGermain/ts-base-project/actions/workflows/tests.yml)
 
-**Basic TypeScript template using yarn.**  
-Includes: `ES6`, `Github Workflows`, `linting & prettier`.
+Strict TypeScript template using yarn / CommonJS / TypeScript / Jest / ESLint / Prettier / Github Actions
 
 <br>
 
-## Create a repository
+## Create repository
 
 Create repository from template using [GitHub CLI](https://cli.github.com/).
 ```bash
-# Replace <new-repo-name> for your repository name.
+# Replace <new-repo-name> for your new repository name.
 gh repo create <new-repo-name> --template="MathieuGermain/ts-base-project"
 ```
 
 <br>
 
-## Usages
+## Usage
 
 Make sure you have **yarn** installed globally.
+> To learn more about **yarn** visit https://classic.yarnpkg.com/en/docs/getting-started
 ```bash
 npm install --global yarn
 ```
-> To learn more about **yarn** visit https://classic.yarnpkg.com/en/docs/getting-started
 
-Install project dependencies.
+Install and build project.
 ```bash
 yarn
 ```
-
-Build your project.
-```bash
-yarn build
-```
diff --git a/jest.config.ts b/jest.config.ts
@@ -0,0 +1,11 @@
+import type { Config } from '@jest/types';
+
+// Sync object
+const config: Config.InitialOptions = {
+  verbose: true,
+  transform: {
+    "^.+\\.tsx?$": "ts-jest",
+  },
+};
+
+export default config;
diff --git a/package.json b/package.json
@@ -1,19 +1,32 @@
 {
   "name": "ts-base-project",
   "version": "1.0.0",
-  "description": "Typescript Base Project",
+  "description": "Strict TypeScript template using yarn / Github Actions / CommonJS / TypeScript / Jest / ESLint / Prettier",
+  "type": "commonjs",
   "main": "dist/index.js",
   "scripts": {
-    "clean": "rm -rf ./dist",
-    "prelint": "prettier --write ./src",
-    "lint": "yarn run eslint --fix --ext .ts src",
-    "prebuild": "yarn run lint",
+    "clean": "del-cli -f ./dist ./types",
+    "prepublish": "yarn build",
+    "prebuild": "yarn clean && yarn run lint",
     "build": "yarn run tsc",
-    "test": "echo test",
+    "lint": "yarn run eslint --fix --ext .ts src tests --cache src tests --cache-location node_modules/.cache/",
+    "test": "jest",
+    "dev:test": "jest --watch",
+    "dev:build": "tsc --watch",
     "start": "node ./dist/index.js"
   },
   "author": "MathieuGermain",
   "license": "MIT",
+  "keywords": [
+    "yarn",
+    "TypeScript",
+    "Template",
+    "CommonJS",
+    "Jest",
+    "ESLint",
+    "Prettier",
+    "Github Actions"
+  ],
   "homepage": "https://github.com/MathieuGermain/ts-base-project#readme",
   "repository": {
     "type": "git",
@@ -24,10 +37,17 @@
   },
   "dependencies": {},
   "devDependencies": {
+    "@types/jest": "^29.0.0",
+    "@types/node": "^17.0.25",
     "@typescript-eslint/eslint-plugin": "^5.36.2",
     "@typescript-eslint/parser": "^5.36.2",
+    "del-cli": "^5.0.0",
     "eslint": "^8.23.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "jest": "^29.0.2",
     "prettier": "2.7.1",
+    "ts-jest": "^29.0.0",
+    "ts-node": "^10.9.1",
     "typescript": "^4.8.3"
   }
 }
diff --git a/src/index.ts b/src/index.ts
@@ -1 +1,7 @@
-console.log('Hello World!');
+/**
+ * 1 + 1
+ * @returns 2
+ */
+export function onePlusOne() {
+    return 1 + 1;
+}
diff --git a/tests/index.test.ts b/tests/index.test.ts
@@ -0,0 +1,8 @@
+import { onePlusOne } from '../src/index';
+
+describe('Test method onePlusOne', () => {
+    it('should be 2', () => {
+        const result = onePlusOne();
+        expect(result).toBe(2);
+    });
+});
diff --git a/tsconfig.json b/tsconfig.json
@@ -1,15 +1,28 @@
 {
   "compilerOptions": {
-      "target": "es6",
-      "module": "commonjs",
+      "target": "ESNext",
+      "module": "CommonJS",
+      "moduleResolution": "Node",
+      "lib": ["ESNext", "DOM"],
       "allowJs": false,
       "sourceMap": true,
+      "baseUrl": "./",
       "outDir": "./dist",
+      "declaration": true,
+      "declarationDir": "./types",
       "strict": true,
       "noImplicitAny": true,
       "strictNullChecks": true,
-      "baseUrl": "./",
-      "typeRoots": ["node_modules/@types"],
-      "esModuleInterop": true
-  }
+      "esModuleInterop": true,
+      "experimentalDecorators": true,
+      "typeRoots": [
+        "node_modules/@types"
+      ]
+  },
+  "include": [
+    "src/**/*.ts"
+  ],
+  "exclude": [
+    "tests/**/*"
+  ]
 }
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,9 @@`
`1`	`1`	`{`
	`2`	`+ "$schema": "http://json.schemastore.org/prettierrc",`
`2`	`3`	`"tabWidth": 4,`
`3`	`4`	`"singleQuote": true,`
`4`	`5`	`"trailingComma": "all",`
`5`		`- "printWidth": 120`
	`6`	`+ "printWidth": 120,`
	`7`	`+ "endOfLine": "auto",`
	`8`	`+ "bracketSpacing": true`
`6`	`9`	`}`