Merge pull request #44 from HSLdevcom/feature/66224-integrate-prettier

feat(66224): integrate prettier autoformatter

Author: bogdandina

.github/workflows/ci-cd.yml

@@ -0,0 +1,25 @@
+---
+name: "CI/CD: Continuous integration and continuous deployment"
+on: [pull_request]
+permissions:
+  contents: read
+
+jobs:
+  build-check:
+    name: 'Build & check format'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Install Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: "lts/*"
+          cache: "npm"
+
+      - name: Install NPM dependencies
+        run: yarn install --frozen-lockfile
+
+      - name: Check code formatting
+        run: yarn run format:check

.gitignore

@@ -1,2 +1,3 @@
 node_modules
-.env
+.env
+.idea/

.prettierignore

@@ -0,0 +1,4 @@
+node_modules
+dist
+build
+coverage

.prettierrc

@@ -0,0 +1,9 @@
+{
+  "semi": false,
+  "singleQuote": true,
+  "printWidth": 95,
+  "arrowParens": "always",
+  "bracketSpacing": true,
+  "trailingComma": "es5",
+  "tabWidth": 2
+}

PgNumericToFloatPlugin.js

@@ -11,16 +11,11 @@
  * arbitrary precision numbers such as NUMERIC because loss of precision can
  * occur.
  */
-module.exports = function PgNumericToFloatPlugin(
-  builder
-) {
-  builder.hook("build", build => {
+module.exports = function PgNumericToFloatPlugin(builder) {
+  builder.hook('build', (build) => {
     // Register a type handler for NUMERIC / DECIMAL (oid = 1700), always
     // returning the GraphQLFloat type
-    build.pgRegisterGqlTypeByTypeId(
-      "1700",
-      () => build.graphql.GraphQLFloat
-    );
-    return build;
-  });
-};
+    build.pgRegisterGqlTypeByTypeId('1700', () => build.graphql.GraphQLFloat)
+    return build
+  })
+}

README.md

@@ -3,6 +3,7 @@
 ### Prerequisites
 
 Start a postgis docker container:
+
 ```
 docker run --name jore-postgis -e POSTGRES_PASSWORD=mysecretpassword -d mdillon/postgis
 ```
@@ -12,13 +13,15 @@ Import data using [jore-graphql-import](https://github.com/HSLdevcom/jore-graphq
 ### Install
 
 Build the container:
+
 ```
 docker build -t hsldevcom/jore-graphql .
 ```
 
 ### Run
 
 Start the server:
+
 ```
 docker run --link jore-postgis -e "PG_CONNECTION_STRING=postgres://postgres:mysecretpassword@jore-postgis:5432/postgres" -d -p 0.0.0.0:5000:5000 hsldevcom/jore-graphql
 ```

constants.js

@@ -3,4 +3,4 @@ module.exports = {
   DB_JORE_SCHEMA: process.env.DB_JORE_SCHEMA || 'jore',
   SERVICE_PATH_PREFIX: (process.env.SERVICE_PATH_PREFIX || '').replace(/\/$/, ''), // Remove trailing slash if accidentally given.
   PORT: process.env.PORT || 5000,
-};
+}

index.js

@@ -1,21 +1,30 @@
-const http = require('http');
-const { postgraphile } = require('postgraphile');
-const numericPlugin = require('./PgNumericToFloatPlugin');
-const { PG_CONNECTION_STRING, DB_JORE_SCHEMA, SERVICE_PATH_PREFIX, PORT } = require('./constants');
+const http = require('http')
+const { postgraphile } = require('postgraphile')
+const numericPlugin = require('./PgNumericToFloatPlugin')
+const {
+  PG_CONNECTION_STRING,
+  DB_JORE_SCHEMA,
+  SERVICE_PATH_PREFIX,
+  PORT,
+} = require('./constants')
 
-if (!PG_CONNECTION_STRING) throw new Error("Missing required env PG_CONNECTION_STRING")
+if (!PG_CONNECTION_STRING) throw new Error('Missing required env PG_CONNECTION_STRING')
 
-http.createServer(postgraphile(PG_CONNECTION_STRING, DB_JORE_SCHEMA, {
-  disableDefaultMutations: true,
-  dynamicJson: true,
-  enableCors: true,
-  externalUrlBase: SERVICE_PATH_PREFIX,
-  graphiql: true,
-  host: '0.0.0.0',
-  retryOnInitFail: true,
-  timeout: 36000000,
-  disableQueryLog: true,
-  appendPlugins: [ numericPlugin ]
-})).listen(PORT, () => {
-  console.log('JORE GraphQL listening on port ' + PORT)
-});
+http
+  .createServer(
+    postgraphile(PG_CONNECTION_STRING, DB_JORE_SCHEMA, {
+      disableDefaultMutations: true,
+      dynamicJson: true,
+      enableCors: true,
+      externalUrlBase: SERVICE_PATH_PREFIX,
+      graphiql: true,
+      host: '0.0.0.0',
+      retryOnInitFail: true,
+      timeout: 36000000,
+      disableQueryLog: true,
+      appendPlugins: [numericPlugin],
+    })
+  )
+  .listen(PORT, () => {
+    console.log('JORE GraphQL listening on port ' + PORT)
+  })

package.json

@@ -6,12 +6,28 @@
   "license": "MIT",
   "scripts": {
     "start": "node -r dotenv/config index.js",
-    "start:production": "node index.js"
+    "start:production": "node index.js",
+    "format": "prettier --write \"**/*.{ts,tsx,js,jsx,json,css,md}\"",
+    "format:check": "prettier --check \"**/*.{ts,tsx,js,jsx,json,css,md}\""
   },
   "dependencies": {
     "postgraphile": "^4.14.1"
   },
   "devDependencies": {
-    "dotenv": "^17.2.1"
+    "dotenv": "^17.2.1",
+    "husky": "^9.1.7",
+    "lint-staged": "^16.2.3",
+    "prettier": "^3.6.2"
+  },
+  "lint-staged": {
+    "*.{ts,js}": [
+      "prettier --write",
+      "git add"
+    ]
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "lint-staged"
+    }
   }
 }