Server re-build with latest AdonisJS framework & Typescript

.adonisrc.json

@@ -0,0 +1,52 @@
+{
+  "typescript": true,
+  "commands": [
+    "./commands",
+    "@adonisjs/core/build/commands/index.js",
+    "@adonisjs/repl/build/commands",
+    "@adonisjs/lucid/build/commands",
+    "@adonisjs/mail/build/commands",
+    "adonis5-jwt/build/commands"
+  ],
+  "exceptionHandlerNamespace": "App/Exceptions/Handler",
+  "aliases": {
+    "App": "app",
+    "Config": "config",
+    "Database": "database",
+    "Contracts": "contracts"
+  },
+  "preloads": ["./start/routes", "./start/kernel", "./start/events"],
+  "providers": [
+    "./providers/AppProvider",
+    "@adonisjs/core",
+    "@adonisjs/view",
+    "@adonisjs/lucid",
+    "@adonisjs/auth",
+    "@adonisjs/shield",
+    "@adonisjs/session",
+    "@adonisjs/mail",
+    "adonis5-jwt",
+    "./providers/LegacyHasherProvider"
+  ],
+  "aceProviders": ["@adonisjs/repl"],
+  "tests": {
+    "suites": [
+      {
+        "name": "functional",
+        "files": ["tests/functional/**/*.spec(.ts|.js)"],
+        "timeout": 60000
+      }
+    ]
+  },
+  "testProviders": ["@japa/preset-adonis/TestsProvider"],
+  "metaFiles": [
+    {
+      "pattern": "resources/views/**/*.edge",
+      "reloadServer": false
+    },
+    {
+      "pattern": "public/**",
+      "reloadServer": false
+    }
+  ]
+}

.dockerignore

@@ -17,5 +17,12 @@ docker
 node_modules
 .husky
 
+# Ignore data folder
+data
+tmp
+
 # Ignore recipes folder (it is pulled in the image by git)
 recipes
+
+# Ignore build folder
+build

.env.development

@@ -0,0 +1,15 @@
+#This is a minimal needed configuration for development
+
+NODE_ENV=development
+APP_URL=http://localhost:3333
+DB_CONNECTION=sqlite
+APP_KEY=IDU2cMbrvS6iv5841YmFJSjnIqT1X1Nx
+
+# These are needed if running outside of Docker
+HOST=127.0.0.1
+PORT=3333
+
+IS_CREATION_ENABLED=true
+IS_DASHBOARD_ENABLED=true
+IS_REGISTRATION_ENABLED=true
+CONNECT_WITH_FRANZ=true

.env.example

@@ -1,3 +1,5 @@
+#This is a example file with all the available configuration options.
+
 NODE_ENV=development
 APP_URL=localhost
 DB_CONNECTION=sqlite
@@ -19,8 +21,6 @@ IS_DASHBOARD_ENABLED=true
 IS_REGISTRATION_ENABLED=true
 CONNECT_WITH_FRANZ=false
 DATA_DIR=data
-PUID=1000
-PGID=1000
 
 # These are needed if running outside of Docker
 APP_KEY= # Need to set some value

.env.test

@@ -0,0 +1,6 @@
+#This is a minimal needed configuration for test
+
+NODE_ENV=test
+ASSETS_DRIVER=fake
+SESSION_DRIVER=memory
+APP_KEY=IDU2cMbrvS6iv5841YmFJSjnIqT1X1Nx

.eslintignore

@@ -29,8 +29,7 @@ node_modules
 /recipes/
 
 # package files
-package.json
 pnpm-lock.yaml
 
 # Json
-*.json
+tests/functional/dashboard/import-stubs/invalid.json

.eslintrc.js

@@ -1,33 +1,86 @@
+/** @type {import('eslint').Linter.Config} */
 module.exports = {
   root: true,
-  env: {
-    commonjs: true,
-    es6: true,
-    node: true,
+  parserOptions: {
+    ecmaVersion: 2018,
+    sourceType: 'module',
+    project: './tsconfig.json',
   },
-  extends: ['airbnb-base'],
+  ignorePatterns: ['node_modules', 'build', 'recipes', '.eslintrc.js'],
+  extends: [
+    'plugin:adonis/typescriptApp',
+    'plugin:unicorn/recommended',
+    'prettier',
+  ],
+  plugins: [],
   globals: {
-    Atomics: 'readonly',
-    SharedArrayBuffer: 'readonly',
-    use: 'readonly',
-    window: 'readonly',
-    document: 'readonly',
-    ENV: 'readonly',
-    session: 'readonly',
-    response: 'readonly',
+    use: true,
   },
-  parserOptions: {
-    ecmaVersion: 2018,
+  env: {
+    es6: true,
+    node: true,
   },
+  reportUnusedDisableDirectives: true,
+  overrides: [
+    {
+      files: ['**/*.ts'],
+      extends: [
+        'plugin:adonis/typescriptApp',
+        'plugin:@typescript-eslint/eslint-recommended',
+        'plugin:@typescript-eslint/strict',
+        // TODO: Opt-in to a stricter ruleset in the future
+        // 'plugin:@typescript-eslint/strict-type-checked',
+        'plugin:@typescript-eslint/stylistic-type-checked',
+        'plugin:import/typescript',
+      ],
+      parser: '@typescript-eslint/parser',
+      plugins: [],
+      rules: {
+        // eslint
+        'max-len': 0,
+
+        // @typescript-eslint
+        '@typescript-eslint/no-non-null-assertion': 0,
+        '@typescript-eslint/no-empty-interface': 0,
+        '@typescript-eslint/semi': 0,
+        '@typescript-eslint/space-before-function-paren': 0,
+        '@typescript-eslint/no-extraneous-class': 0,
+        '@typescript-eslint/ban-ts-comment': 0,
+        '@typescript-eslint/prefer-ts-expect-error': 0,
+      },
+    },
+  ],
   rules: {
-    'arrow-parens': 0,
-    'class-methods-use-this': 0,
-    eqeqeq: 1,
-    'implicit-arrow-linebreak': 0,
+    // eslint
+    'array-callback-return': 1,
+    'consistent-return': 1,
     'max-len': 0,
     'no-await-in-loop': 1,
-    'no-restricted-syntax': 0,
-    'operator-linebreak': 0,
-    'object-curly-newline': 0,
+    'no-return-assign': 1,
+    'no-console': [
+      1,
+      {
+        allow: ['warn', 'error'],
+      },
+    ],
+    'no-param-reassign': 1,
+    'prefer-destructuring': 1,
+    // eslint-plugin-unicorn
+    'unicorn/filename-case': 0,
+    'unicorn/prefer-module': 0,
+    'unicorn/prevent-abbreviations': 0,
+
+    'unicorn/import-style': [
+      2,
+      {
+        styles: {
+          path: {
+            named: true,
+          },
+        },
+      },
+    ],
+    'unicorn/no-empty-file': 0,
+    'unicorn/prefer-top-level-await': 0,
   },
 };

.github/workflows/build.yml

@@ -0,0 +1,30 @@
+name: AdonisJS check
+
+on:
+  pull_request:
+    branches: [main]
+
+jobs:
+  adonis-js-check:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Use Node.js specified in the '.nvmrc' file
+        uses: actions/setup-node@v3
+        with:
+          node-version-file: ".nvmrc"
+
+      - name: Install pnpm
+        run: npm i -gf "pnpm@$(node -p 'require("./package.json").engines.pnpm')" && pnpm -v
+
+      - run: pnpm install
+
+      - run: pnpm typecheck
+
+      - run: pnpm lint
+
+      - run: pnpm test
+
+      - run: pnpm run build

.gitignore

@@ -349,6 +349,8 @@ tags
 
 # Adonis directory for storing tmp files
 tmp
+build
+public/assets
 
 # Environment variables, never commit this file
 .env

.husky/pre-commit

@@ -6,5 +6,5 @@ FILE_NAME="$(dirname "$0")/_/husky.sh"
 if [ -f $FILE_NAME ]; then
   . $FILE_NAME
   pnpm prepare
-  pnpm lint
+  pnpm prepare-code
 fi

.npmrc

@@ -1,5 +1,4 @@
 save-exact = true
 engine-strict = true
 unsafe-perm = true
-legacy-peer-deps = true
 frozen-lockfile = false

.prettierrc.js

@@ -1,5 +1,5 @@
+/** @type {import("prettier").Options} */
 module.exports = {
   singleQuote: true,
   arrowParens: 'avoid',
-  trailingComma: 'all',
-}
+};

Dockerfile

@@ -9,6 +9,7 @@ COPY . /server-build
 ENV CI=true
 RUN PNPM_VERSION=$(node -p 'require("./package.json").engines.pnpm'); npm i -g pnpm@$PNPM_VERSION
 RUN pnpm install --config.build-from-source=sqlite --config.sqlite=/usr/local
+RUN pnpm build
 
 # ---- RUNTIME IMAGE ----------------------------------------------------------
 FROM node:18.18.0-alpine
@@ -19,7 +20,9 @@ LABEL maintainer="ferdium"
 # TODO: Shouldn't we set 'NODE_ENV=production' when running in production mode?
 ENV HOST=0.0.0.0 PORT=3333 DATA_DIR="/data"
 
-RUN apk add --no-cache sqlite-libs curl su-exec python3 make g++ py3-pip git py3-pip
+RUN apk add --no-cache sqlite-libs curl su-exec python3 make g++ py3-pip git py3-pip sqlite
+# The next command is needed for sqlite3 install command executed by node-gyp
+# RUN ln -s /usr/bin/python3 /usr/bin/python
 
 
 COPY --from=build /server-build /app

README.md

@@ -1,4 +1,4 @@
-<p align="center">
+<p align="center">
     <img src="./logo.png" alt="" width="300"/>
 </p>
 

ace

@@ -1,21 +1,16 @@
-'use strict'
-
 /*
 |--------------------------------------------------------------------------
 | Ace Commands
 |--------------------------------------------------------------------------
 |
-| The ace file is just a regular Javascript file but with no extension. You
-| can call `node ace` followed by the command name and it just works.
-|
-| Also you can use `adonis` followed by the command name, since the adonis
-| global proxies all the ace commands.
+| This file is the entry point for running ace commands.
 |
 */
 
-const { Ignitor } = require('@adonisjs/ignitor')
+require('reflect-metadata')
+require('source-map-support').install({ handleUncaughtExceptions: false })
 
-new Ignitor(require('@adonisjs/fold'))
-  .appRoot(__dirname)
-  .fireAce()
-  .catch(console.error)
+const { Ignitor } = require('@adonisjs/core/build/standalone')
+new Ignitor(__dirname)
+  .ace()
+  .handle(process.argv.slice(2))