Merge pull request #29 from citation-file-format/test-config

Test config

Author: fdiblen

.babelrc

@@ -0,0 +1,19 @@
+{
+  "plugins": ["@babel/plugin-syntax-dynamic-import"],
+  "env": {
+    "test": {
+      "plugins": ["dynamic-import-node"],
+      "presets": [
+        [
+          "@babel/preset-env",
+          {
+            "modules": "commonjs",
+            "targets": {
+              "node": "current"
+            }
+          }
+        ]
+      ]
+    }
+  }
+}

README.dev.md

@@ -57,3 +57,18 @@ To run linting on commit, you can install a git commit hook with
 ```shell
 npx husky install
 ```
+
+## Tests
+
+We use Jest for unit tests. To run unit tests (`src/**/*.jest.spec.ts`)
+
+You can run the test with
+
+```shell
+npm run test:unit:ci
+```
+
+You can also use the Majestic web interface to run the unit tests in your browser.
+
+```shell
+npm run test:unit:ui

babel.config.js

@@ -1,15 +1,18 @@
 /* eslint-env node */
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const fs = require('fs-extra');
+let extend = undefined;
 
-module.exports = api => {
-  return {
-    presets: [
-      [
-        '@quasar/babel-preset-app',
-        api.caller(caller => caller && caller.target === 'node')
-          ? { targets: { node: 'current' } }
-          : {}
-      ]
-    ]
-  }
+/**
+ * The .babelrc file has been created to assist Jest for transpiling.
+ * You should keep your application's babel rules in this file.
+ */
+
+if (fs.existsSync('./.babelrc')) {
+  extend = './.babelrc';
 }
 
+module.exports = {
+  presets: ['@quasar/babel-preset-app'],
+  extends: extend,
+};

jest.config.js

@@ -0,0 +1,75 @@
+const esModules = ['quasar/lang', 'lodash-es'].join('|')
+
+/* eslint-env node */
+module.exports = {
+    globals: {
+        __DEV__: true,
+        // TODO: Remove if resolved natively
+        // See https://github.com/vuejs/vue-jest/issues/175
+        'vue-jest': {
+            pug: { doctype: 'html' }
+        }
+    },
+    // noStackTrace: true,
+    // bail: true,
+    // cache: false,
+    // verbose: true,
+    // watch: true,
+    collectCoverage: false,
+    coverageDirectory: '<rootDir>/test/jest/coverage',
+    collectCoverageFrom: [
+        '<rootDir>/src/**/*.vue',
+        '<rootDir>/src/**/*.js',
+        '<rootDir>/src/**/*.ts',
+        '<rootDir>/src/**/*.jsx',
+        '<rootDir>/src/**/*.tsx'
+    ],
+    coveragePathIgnorePatterns: ['/node_modules/', '.d.ts$'],
+    coverageThreshold: {
+        global: {
+            //  branches: 50,
+            //  functions: 50,
+            //  lines: 50,
+            //  statements: 50
+        }
+    },
+    testMatch: [
+    // Matches tests in any subfolder of 'src' or into 'test/jest/__tests__'
+    // Matches all files with extension 'js', 'jsx', 'ts' and 'tsx'
+        '<rootDir>/test/jest/__tests__/**/*.(spec|test).+(ts|js)?(x)',
+        '<rootDir>/src/**/*.jest.(spec|test).+(ts|js)?(x)'
+    ],
+    // Extension-less imports of components are resolved to .ts files by TS,
+    //  grating correct type-checking in test files.
+    // Being 'vue' the first moduleFileExtension option, the very same imports
+    //  will be resolved to .vue files by Jest, if both .vue and .ts files are
+    //  in the same folder.
+    // This guarantee a great dev experience both for testing and type-checking.
+    // See https://github.com/vuejs/vue-jest/issues/188#issuecomment-620750728
+    moduleFileExtensions: ['vue', 'js', 'jsx', 'json', 'ts', 'tsx'],
+    moduleNameMapper: {
+        '^~/(.*)$': '<rootDir>/$1',
+        '^src/(.*)$': '<rootDir>/src/$1',
+        '^app/(.*)$': '<rootDir>/$1',
+        '^components/(.*)$': '<rootDir>/src/components/$1',
+        '^layouts/(.*)$': '<rootDir>/src/layouts/$1',
+        '^pages/(.*)$': '<rootDir>/src/pages/$1',
+        '^assets/(.*)$': '<rootDir>/src/assets/$1',
+        '^boot/(.*)$': '<rootDir>/src/boot/$1',
+        '.*css$': '@quasar/quasar-app-extension-testing-unit-jest/stub.css'
+    },
+    transform: {
+    // See https://jestjs.io/docs/en/configuration.html#transformignorepatterns-array-string
+        [`^(${esModules}).+\\.js$`]: 'babel-jest',
+        '^.+\\.(ts|js|html)$': 'ts-jest',
+        // vue-jest uses find-babel-file, which searches by this order:
+        //  (async) .babelrc, .babelrc.js, package.json, babel.config.js
+        //  (sync) .babelrc, .babelrc.js, babel.config.js, package.json
+        // https://github.com/tleunen/find-babel-config/issues/33
+        '.*\\.vue$': 'vue-jest',
+        '.+\\.(css|styl|less|sass|scss|svg|png|jpg|ttf|woff|woff2)$':
+      'jest-transform-stub'
+    },
+    transformIgnorePatterns: [`node_modules/(?!(${esModules}))`],
+    snapshotSerializers: ['<rootDir>/node_modules/jest-serializer-vue']
+}