Merge pull request #121 from rcpch/testing-and-linting

Testing-and-linting

Author: eatyourpeas

.babelrc.json

@@ -1,16 +1,16 @@
 {
-  "sourceType": "unambiguous",
-  "presets": [
-    [
-      "@babel/preset-env",
-      {
-        "targets": {
-          "chrome": 100
-        }
-      }
+    "sourceType": "unambiguous",
+    "presets": [
+        [
+            "@babel/preset-env",
+            {
+                "targets": {
+                    "chrome": 100
+                }
+            }
+        ],
+        "@babel/preset-typescript",
+        "@babel/preset-react"
     ],
-    "@babel/preset-typescript",
-    "@babel/preset-react"
-  ],
-  "plugins": []
+    "plugins": []
 }

.eslintrc.js

@@ -1,35 +1,38 @@
 module.exports = {
     env: {
-      browser: true,
-      es2021: true,
+        browser: true,
+        es2021: true,
     },
-    parser: "@typescript-eslint/parser", // Specifies the ESLint parser
+    parser: '@typescript-eslint/parser', // Specifies the ESLint parser
     parserOptions: {
-      ecmaVersion: 2020, // Allows for the parsing of modern ECMAScript features
-      sourceType: "module", // Allows for the use of imports
-      ecmaFeatures: {
-        jsx: true // Allows for the parsing of JSX
-      }
+        ecmaVersion: 2020, // Allows for the parsing of modern ECMAScript features
+        sourceType: 'module', // Allows for the use of imports
+        ecmaFeatures: {
+            jsx: true, // Allows for the parsing of JSX
+        },
     },
     settings: {
-      react: {
-        version: "detect" // Tells eslint-plugin-react to automatically detect the version of React to use
-      }
+        react: {
+            version: 'detect', // Tells eslint-plugin-react to automatically detect the version of React to use
+        },
     },
     extends: [
-      "plugin:react/recommended",
-      "airbnb-typescript",
-      "plugin:@typescript-eslint/recommended",
-      "prettier/@typescript-eslint",
-      "plugin:prettier/recommended",
-      "plugin:storybook/recommended"
+        'eslint:recommended',
+        'plugin:react/recommended',
+        'airbnb-typescript',
+        'plugin:@typescript-eslint/recommended',
+        'plugin:prettier/recommended',
+        'plugin:storybook/recommended',
+        'prettier',
+        'prettier/@typescript-eslint',
+        'prettier/react',
     ],
     rules: {
-      // Place to specify ESLint rules. Can be used to overwrite rules specified from the extended configs
-      // e.g. "@typescript-eslint/explicit-function-return-type": "off",
+        // Place to specify ESLint rules. Can be used to overwrite rules specified from the extended configs
+        // e.g. "@typescript-eslint/explicit-function-return-type": "off",
     },
     plugins: ['react', '@typescript-eslint', 'prettier'],
     rules: {
-      'prettier/prettier': 'error',
+        'prettier/prettier': 'error',
     },
-  };
+};

.github/workflows/auto-add-issues-to-project.yml

@@ -1,20 +1,19 @@
 name: Adds new Issues automatically to the dGC Project
 
 on:
-  issues:
-    types:
-      - opened
-  pull_request:
-    types:
-      - opened
+    issues:
+        types:
+            - opened
+    pull_request:
+        types:
+            - opened
 
 jobs:
-  add-to-project:
-    name: Add issue or PR to project automatically
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/add-to-project@v0.4.0
-        with:
-          project-url: https://github.com/orgs/rcpch/projects/5 #dGC Project
-          github-token: ${{ secrets.AUTO_ADD_TO_PROJECT_TOKEN }}
-
+    add-to-project:
+        name: Add issue or PR to project automatically
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/add-to-project@v0.4.0
+              with:
+                  project-url: https://github.com/orgs/rcpch/projects/5 #dGC Project
+                  github-token: ${{ secrets.AUTO_ADD_TO_PROJECT_TOKEN }}

.github/workflows/check.yml

@@ -1,22 +1,22 @@
 name: Check build and tests on PR and merge to live
 
 on:
-  pull_request:
-    branches:
-      - "*"
-  push:
-    branches:
-      - live
+    pull_request:
+        branches:
+            - '*'
+    push:
+        branches:
+            - live
 
 jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
-        with:
-          node-version: "20.x"
-          registry-url: "https://registry.npmjs.org"
-      - run: npm install
-      - run: npm run build
-      - run: npm test
+    build:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v4
+            - uses: actions/setup-node@v4
+              with:
+                  node-version: '20.x'
+                  registry-url: 'https://registry.npmjs.org'
+            - run: npm install
+            - run: npm run build
+            - run: npm test

.github/workflows/publish.yml

@@ -3,27 +3,27 @@ name: NPM Publish
 
 # This action will publish to NPM on every new release
 on:
-  release:
-    types: [created]
+    release:
+        types: [created]
 
 # Job will run on a ubuntu instance
 jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      # Checkout the code
-      - uses: actions/checkout@v4
-      # Setup node with version 20.x and NPM registry url
-      - uses: actions/setup-node@v4
-        with:
-          node-version: "20.x"
-          registry-url: "https://registry.npmjs.org"
-      # Run npm install to install project packages
-      - run: npm install
-      # npm build to build the project
-      - run: npm run build
-      # publish the files to NPM
-      - run: npm publish --access public
-      # for publishing, npm need authorization. We add the NPM token to the environment which will take care of authorization to publish to the package
-        env:
-          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
+    build:
+        runs-on: ubuntu-latest
+        steps:
+            # Checkout the code
+            - uses: actions/checkout@v4
+            # Setup node with version 20.x and NPM registry url
+            - uses: actions/setup-node@v4
+              with:
+                  node-version: '20.x'
+                  registry-url: 'https://registry.npmjs.org'
+            # Run npm install to install project packages
+            - run: npm install
+            # npm build to build the project
+            - run: npm run build
+            # publish the files to NPM
+            - run: npm publish --access public
+              # for publishing, npm need authorization. We add the NPM token to the environment which will take care of authorization to publish to the package
+              env:
+                  NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

.prettierignore

@@ -0,0 +1,2 @@
+node_modules
+build

.prettierrc.js

@@ -1,7 +1,7 @@
 module.exports = {
     semi: true,
-    trailingComma: "all",
+    trailingComma: 'all',
     singleQuote: true,
     printWidth: 120,
-    tabWidth: 4
-  };
+    tabWidth: 4,
+};

.storybook/main.ts

@@ -26,6 +26,6 @@ const config: StorybookConfig = {
     },
     docs: {
         autodocs: 'tag',
-    }
+    },
 };
 export default config;

.vscode/settings.json

@@ -2,5 +2,9 @@
     "editor.codeActionsOnSave": {
         "source.fixAll": "explicit"
     },
-    "git.enableCommitSigning": true
+    "git.enableCommitSigning": true,
+    {
+        "editor.formatOnSave": true,
+        "editor.defaultFormatter": "esbenp.prettier-vscode"
+      }
 }

CSSStub.js __mocks__/styleMock.ts

@@ -1,9 +1,9 @@
-const path = require("path");
+const path = require('path');
 
 module.exports = {
-  process(sourceText, sourcePath, options) {
-    return {
-      code: `module.exports = ${JSON.stringify(path.basename(sourcePath))};`,
-    };
-  },
+    process(sourceText, sourcePath, options) {
+        return {
+            code: `module.exports = ${JSON.stringify(path.basename(sourcePath))};`,
+        };
+    },
 };

fileTransformer.js

@@ -1,17 +1,17 @@
-import type {Config} from 'jest';
+import type { Config } from 'jest';
 
 const config: Config = {
     preset: 'ts-jest',
     verbose: true,
-    moduleFileExtensions: ["js", "jsx", "ts", "tsx"],
-    moduleDirectories: ["node_modules", "src"],
+    moduleFileExtensions: ['js', 'jsx', 'ts', 'tsx'],
+    moduleDirectories: ['node_modules', 'src'],
     transform: {
         '\\.(jpg|jpeg|png|gif|eot|otf|webp|svg|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga)$':
-        '<rootDir>/fileTransformer.js',
+            '<rootDir>/fileTransformer.js',
+    },
+    moduleNameMapper: {
+        '\\.(css|less|scss|sass)$': '<rootDir>/__mocks__/styleMock.ts',
     },
-    moduleNameMapper:{
-        "\\.(css|less|sass|scss)$": '<rootDir>/CSSStub.js'
-    }
 };
 
-export default config;
+export default config;