docs: github workflow badges added

.eslintrc.js → .eslintrc.cjs

@@ -10,7 +10,8 @@ module.exports = {
   parserOptions: {
     ecmaVersion: 2023,
     tsconfigRootDir: __dirname,
-    project: ['./tsconfig.json', './packages/*/tsconfig.json', './packages/*/rollup.config.js'],
+    sourceType: 'module',
+    project: ['./tsconfig.json', './packages/*/tsconfig.json'],
   },
   ignorePatterns: ['examples/**/*'],
   extends: [

README.md

@@ -1,3 +1,7 @@
+[![Build and test](https://github.com/arturwojnar/hermes/actions/workflows/build-and-test.yaml/badge.svg?branch=main)](https://github.com/arturwojnar/hermes/actions/workflows/build-and-test.yaml)
+[![Deploy VitePress site to Pages](https://github.com/arturwojnar/hermes/actions/workflows/publish-docs.yaml/badge.svg)](https://github.com/arturwojnar/hermes/actions/workflows/publish-docs.yaml)
+[![Publish to NPM](https://github.com/arturwojnar/hermes/actions/workflows/publish.yaml/badge.svg)](https://github.com/arturwojnar/hermes/actions/workflows/publish.yaml)
+
 <img src="./docs/public/logo-main.png" alt="Hermes logo" style="margin: 0 auto; width: 70%; display: block;" />
 <br />
 <br />

docs/.vitepress/theme/style.css

@@ -140,3 +140,14 @@
 .row-container {display: flex; width: 100%; height: 100%; flex-direction: column; background-color: blue; overflow: hidden;}
 .first-row {background-color: lime; }
 .second-row { flex-grow: 1; border: none; margin: 0; padding: 0; }
+
+.badges {
+  width: 100%;
+  text-align: center;
+  margin-top: 2em;
+
+  p {
+    display: inline-block;
+    padding: 0 0.5em;
+  }
+}

docs/index.md

@@ -36,3 +36,13 @@ features:
 <div style="max-width: 600px;  text-align: justify; text-justify: inter-word; margin: 0 auto;">
 <i>"Hermes is the god of reliable deliveries. His two insignias are an outbox and a letter. Just write a message, put it into an envoy, and put it in the box. That's it! You don't need prayers, keeping crossed fingers and hope. Your message will be delivered for sure! Hermes is on it!</i>
 </div>
+
+<div class="badges">
+
+[![Build and test](https://github.com/arturwojnar/hermes/actions/workflows/build-and-test.yaml/badge.svg?branch=main)](https://github.com/arturwojnar/hermes/actions/workflows/build-and-test.yaml)
+
+[![Deploy VitePress site to Pages](https://github.com/arturwojnar/hermes/actions/workflows/publish-docs.yaml/badge.svg)](https://github.com/arturwojnar/hermes/actions/workflows/publish-docs.yaml)
+
+[![Publish to NPM](https://github.com/arturwojnar/hermes/actions/workflows/publish.yaml/badge.svg)](https://github.com/arturwojnar/hermes/actions/workflows/publish.yaml)
+
+</div>

package.json

@@ -46,6 +46,7 @@
   "devDependencies": {
     "@commitlint/cli": "~19.2.0",
     "@commitlint/config-conventional": "~19.1.0",
+    "@jest/globals": "^29.7.0",
     "@microsoft/tsdoc": "~0.14.2",
     "@microsoft/tsdoc-config": "~0.16.2",
     "@semantic-release/changelog": "~6.0.3",

packages/hermes/.eslintrc.js → packages/hermes-mongodb/.eslintrc.cjs

@@ -1,5 +1,6 @@
 module.exports = {
-  extends: '../../.eslintrc.js',
+  extends: '../../.eslintrc.cjs',
+  ignorePatterns: ['lib/'],
   parserOptions: {
     project: ['./tsconfig.json'],
   },

packages/hermes-mongodb/jest.config.cjs

@@ -11,20 +11,7 @@ module.exports = {
       tsconfig: 'tsconfig.jest.json',
     },
   },
-  moduleNameMapper: {
-    '^(\\.{1,2}/.*)\\.js$': '$1',
-  },
   transform: {},
-  // transform: {
-  //   // '^.+\\.[tj]sx?$' to process js/ts with `ts-jest`
-  //   // '^.+\\.m?[tj]sx?$' to process js/ts/mjs/mts with `ts-jest`
-  //   '^.+\\.m?[tj]sx?$': [
-  //     'ts-jest',
-  //     {
-  //       useESM: true,
-  //     },
-  //   ],
-  // },
   testMatch: ['**/test/*.test.ts'],
   testEnvironment: 'node',
   testTimeout: 20000,
@@ -34,30 +21,5 @@ module.exports = {
   },
   modulePaths: ['<rootDir>'],
   collectCoverage: true,
-  // clearMocks: true,
   coverageDirectory: 'coverage',
-  // globals: {
-  //   'ts-jest': {
-  //     tsConfig: 'tsconfig.json',
-  //   },
-  // },
-  // transform: {
-  //   '^.+\\.{ts|tsx}?$': [
-  //     'ts-jest',
-  //     {
-  //       babel: true,
-  //       tsConfig: 'tsconfig.jest.json',
-  //     },
-  //   ],
-  // },
-  // moduleFileExtensions: ['ts', 'js', 'json'],
-  // // testMatch: ['**/?(*.)+(e2e.)(spec|test).ts', 'test/e2e/*.test.(ts)'],
-  // testMatch: ['**/test/*.test.ts'],
-  // testEnvironment: 'node',
-  // testTimeout: 20000,
-  // moduleNameMapper: pathsToModuleNameMapper(compilerOptions.paths, { prefix: '<rootDir>' }),
-  // modulePaths: ['<rootDir>'],
-  // collectCoverage: true,
-  // // clearMocks: true,
-  // coverageDirectory: 'coverage',
 }

packages/hermes-mongodb/package.json

@@ -6,7 +6,7 @@
     "build": "rollup -c",
     "build:ts": "tsc -p tsconfig.build.json",
     "clean": "rm -rf ./lib/",
-    "lint:eslint": "eslint '**/*.ts'",
+    "lint:eslint": "eslint 'src/**/*.ts'",
     "lint:prettier": "prettier --check \"**/**/!(*.d).{ts,json,md}\"",
     "lint-fix": "eslint --fix -f unix \"src/**/*.{ts,tsx}\"",
     "prepare": "husky install",
@@ -44,6 +44,7 @@
   ],
   "license": "ISC",
   "devDependencies": {
+    "@jest/globals": "^29.7.0",
     "@microsoft/tsdoc": "~0.14.2",
     "@microsoft/tsdoc-config": "~0.16.2",
     "@rollup/plugin-commonjs": "^25.0.7",

packages/hermes-mongodb/tsconfig.build.json

@@ -1,4 +1,7 @@
 {
   "extends": "./tsconfig.json",
-  "exclude": ["test/**/*.spec.ts", "test/**/*"]
+  "exclude": ["test/**/*.spec.ts", "test/**/*"],
+  "compilerOptions": {
+    "outDir": "./lib"
+  }
 }

packages/hermes/.eslintrc.cjs

@@ -0,0 +1,7 @@
+module.exports = {
+  extends: '../../.eslintrc.cjs',
+  ignorePatterns: ['lib/'],
+  parserOptions: {
+    project: ['./tsconfig.json'],
+  },
+}

packages/hermes/package.json

@@ -7,7 +7,7 @@
     "build": "rollup -c",
     "build:ts": "tsc -p tsconfig.build.json",
     "clean": "rm -rf ./lib/",
-    "lint:eslint": "eslint '**/*.ts'",
+    "lint:eslint": "eslint 'src/**/*.ts'",
     "lint:prettier": "prettier --check \"**/**/!(*.d).{ts,json,md}\"",
     "lint-fix": "eslint --fix -f unix \"src/**/*.{ts,tsx}\"",
     "semantic-release": "semantic-release",

packages/hermes/tsconfig.build.json

@@ -1,4 +1,7 @@
 {
   "extends": "./tsconfig.json",
-  "exclude": ["test/**/*.spec.ts", "test/**/*"]
+  "exclude": ["test/**/*.spec.ts", "test/**/*"],
+  "compilerOptions": {
+    "outDir": "./lib"
+  }
 }