fix: lint + github action (#31)

* fix: lint + github action

* feat(test): adds sonarcloud to test.yml

* Removes coverage threshold

.github/workflows/test.yml

@@ -0,0 +1,46 @@
+name: Tests
+
+on: [push, pull_request]
+
+env:
+  CI: true
+
+jobs:
+  run:
+    name: Node ${{ matrix.node }} on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      fail-fast: false
+      matrix:
+        node: [14, 16]
+        os: [ubuntu-latest]
+
+    steps:
+      - name: Clone repository
+        uses: actions/checkout@v2
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node }}
+
+      - name: Cache Node Modules
+        id: cache-node-modules
+        uses: actions/cache@v2
+        with:
+          path: node_modules
+          key: node-modules-${{ hashFiles('package-lock.json') }}
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run tests
+        run: npm test
+
+      - name: SonarCloud Scan
+        uses: SonarSource/sonarcloud-github-action@master
+        if: startsWith(matrix.os, 'ubuntu') && startsWith(matrix.node, '16')
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}  # Needed to get PR information, if any
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

.gitignore

@@ -20,6 +20,7 @@ pids
 lib-cov
 
 # Coverage directory used by tools like istanbul
+__coverage__
 coverage
 *.lcov
 

index.js

@@ -11,16 +11,16 @@
  * });
  *
  */
- const { getValidationHelpers } = require('./lib/helpers/validation');
- const { getLocaleHelpers } = require('./lib/helpers/locale');
+const { getValidationHelpers } = require('./lib/helpers/validation');
+const { getLocaleHelpers } = require('./lib/helpers/locale');
 
- // Export wrapper
- module.exports.withHelpers = (cb) => (migration, context) => {
-   const locale = getLocaleHelpers(migration, context);
-   const validation = getValidationHelpers(migration, context);
+// Export wrapper
+module.exports.withHelpers = (cb) => (migration, context) => {
+  const locale = getLocaleHelpers(migration, context);
+  const validation = getValidationHelpers(migration, context);
 
-   return cb(migration, context, { locale, validation });
- };
+  return cb(migration, context, { locale, validation });
+};
 
- module.exports.getValidationHelpers = getValidationHelpers;
- module.exports.getLocaleHelpers = getLocaleHelpers;
+module.exports.getValidationHelpers = getValidationHelpers;
+module.exports.getLocaleHelpers = getLocaleHelpers;

lib/migration.js

@@ -93,10 +93,12 @@ const fetchMigration = async (config) => {
         .toString()
         // Add call to utils.getDefaultLocale() to the top
         .replace(
-          'module.exports = function (migration) {',`
+          'module.exports = function (migration) {',
+          `
           ${migrationHeader}
           const defaultLocale = helpers.locale.getDefaultLocale();
-        `)
+        `
+        )
         // Replace the default locale with defaultLocale.code so that the migration
         // still works as expected when the locale is changed in contentful
         .replace(testDefaultValueRegex, '$1[defaultLocale.code]$2')

package.json

@@ -15,7 +15,7 @@
     "migrations": "cli.js"
   },
   "scripts": {
-    "test": "jest && npm run lint",
+    "test": "jest --coverage && npm run lint",
     "lint": "eslint .  --ext .js,.ts,.tsx --ignore-path .gitignore",
     "fix-lint": "npm run lint -- --fix"
   },
@@ -68,6 +68,7 @@
     "eslint-plugin-prettier": "^4.0.0",
     "husky": "^7.0.4",
     "jest": "^27.5.1",
+    "jest-sonar-reporter": "^2.0.0",
     "lint-staged": "^12.1.2"
   },
   "publishConfig": {
@@ -78,6 +79,9 @@
     "printWidth": 120
   },
   "eslintConfig": {
+    "ignorePatterns": [
+      "**/*.d.ts"
+    ],
     "plugins": [
       "prettier"
     ],
@@ -110,24 +114,11 @@
     ]
   },
   "jest": {
+    "testResultsProcessor": "jest-sonar-reporter",
     "coverageDirectory": "<rootDir>/__coverage__/",
     "collectCoverageFrom": [
       "<rootDir>/lib/*/**"
     ],
-    "coverageThreshold": {
-      "global": {
-        "statements": 85,
-        "branches": 80,
-        "functions": 80,
-        "lines": 85
-      },
-      "**/*": {
-        "statements": 75,
-        "branches": 70,
-        "functions": 70,
-        "lines": 75
-      }
-    },
     "roots": [
       "<rootDir>/lib/"
     ],
@@ -154,5 +145,10 @@
     "storage": "content",
     "migrationContentTypeId": "contentful-migrations",
     "directory": "migrations"
+  },
+  "jestSonar": {
+    "reportPath": "__coverage__",
+    "reportFile": "test-report.xml",
+    "indent": 2
   }
 }

sonar-project.properties

@@ -0,0 +1,15 @@
+sonar.projectKey=jungvonmatt_contentful-migrations
+sonar.organization=jungvonmatt
+
+# This is the name and version displayed in the SonarCloud UI.
+#sonar.projectName=contentful-migrations
+#sonar.projectVersion=1.0
+
+# Path is relative to the sonar-project.properties file. Replace "\" by "/" on Windows.
+#sonar.sources=.
+
+# Encoding of the source code. Default is default system encoding
+#sonar.sourceEncoding=UTF-8
+
+sonar.testExecutionReportPaths=__coverage__/test-report.xml
+sonar.javascript.lcov.reportPaths=__coverage__/lcov.info