Migrate to bun

Drop Sequelize
Drop shelljs

Author: nkwwk

.github/workflows/tests.yml

@@ -13,19 +13,11 @@ jobs:
   build:
     runs-on: ubuntu-latest
 
-    strategy:
-      matrix:
-        node-version: [18.x, 20.x, 22.x]
-        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
-
     steps:
       - uses: actions/checkout@v4
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v4
-        with:
-          node-version: ${{ matrix.node-version }}
-          cache: 'npm'
-      - run: npm install
+      - name: Use Latest Bun Bundle
+        uses: oven-sh/setup-bun@v2
+      - run: bun install
       - run: npx vitest --project unit --coverage.enabled true --watch=false
       - name: 'Report Coverage'
         uses: davelosert/vitest-coverage-report-action@v2

bun.lockb

@@ -8,9 +8,7 @@
     "wp-tool": "dist/bin/app.js"
   },
   "scripts": {
-    "compile:ts": "tsc -p .",
-    "compile:alias": "tsc-alias -p tsconfig.json",
-    "build": "run-s compile:*",
+    "build": "bun build ./src/bin/app.ts --compile --outfile wp-tool",
     "test": "npm run test:unit & npm run test:e2e",
     "test:unit": "vitest --project unit",
     "test:unit:coverage": "vitest run --project unit --coverage",
@@ -29,6 +27,7 @@
     "commander": "^11.0.0",
     "crypto-random-string": "^5.0.0",
     "date-fns": "^2.30.0",
+    "execa": "^9.5.2",
     "extract-zip": "^2.0.1",
     "ini": "^5.0.0",
     "inquirer": "^9.2.10",
@@ -37,8 +36,6 @@
     "php-parser": "^3.2.2",
     "psl": "^1.9.0",
     "rimraf": "^5.0.1",
-    "sequelize": "^6.32.1",
-    "shelljs": "^0.8.5",
     "tmp": "^0.2.1"
   },
   "devDependencies": {
@@ -51,9 +48,6 @@
     "@types/shelljs": "^0.8.12",
     "@types/tmp": "^0.2.3",
     "@vitest/coverage-v8": "^2.1.8",
-    "npm-run-all": "^4.1.5",
-    "ts-node": "^10.9.1",
-    "tsc-alias": "^1.8.7",
     "typescript": "^5.7.3",
     "vitest": "^2.1.8",
     "vitest-mock-extended": "^2.0.2"

package-lock.json

@@ -51,7 +51,12 @@ program
         throw new Error('Using localhost or 127.0.0.1 must be installed MySQL database on host.');
       }
     }
-    const accessible = await new DatabaseService({ host, port, username, password }).isAccessible();
+    const accessible = await new DatabaseService({
+      host,
+      port,
+      user: username,
+      password,
+    }).isAccessible();
     if (accessible) {
       return;
     }
@@ -87,7 +92,12 @@ program
     ) {
       throw new Error('Using localhost or 127.0.0.1 must be installed MySQL database on host.');
     }
-    const accessible = await new DatabaseService({ host, port, username, password }).isAccessible();
+    const accessible = await new DatabaseService({
+      host,
+      port,
+      user: username,
+      password,
+    }).isAccessible();
     if (accessible) {
       return;
     }

package.json

@@ -1,31 +1,41 @@
-import { Options, QueryTypes, Sequelize } from 'sequelize';
+import mysql from 'mysql2/promise';
 
 export default class DatabaseService {
-  sequelize: Sequelize;
-  constructor(options?: Options) {
-    this.sequelize = new Sequelize(options);
+  options?: mysql.ConnectionOptions;
+  constructor(options?: mysql.ConnectionOptions) {
+    this.options = options;
+  }
+  private async createConnection() {
+    return await mysql.createConnection(
+      this.options || { host: 'localhost', port: 3306, user: 'root', password: '' }
+    );
   }
   async isAccessible() {
     try {
-      await this.sequelize.authenticate();
+      const connection = await this.createConnection();
+      connection.destroy();
       return true;
     } catch (e) {
       console.error('Failed To Connect MySQL Server.', { cause: e });
       return false;
-    } finally {
-      await this.sequelize.close();
     }
   }
   async dropUser(identity: string) {
-    await this.sequelize.query(`DROP USER IF EXISTS ${identity};`, { type: QueryTypes.RAW });
+    const connection = await this.createConnection();
+    await connection.execute(`DROP USER IF EXISTS ${identity};`);
+    connection.destroy();
   }
   async createDatabase(database: string) {
-    await this.sequelize.query(`CREATE DATABASE IF NOT EXISTS ${database};`);
+    const connection = await this.createConnection();
+    await connection.execute(`CREATE DATABASE IF NOT EXISTS ${database};`);
+    connection.destroy();
   }
   async createUserAndGrantPermission(identity: string, password: string, database: string) {
-    await this.sequelize.query(`
+    const connection = await this.createConnection();
+    await connection.execute(`
       CREATE USER '${identity}'@'%' IDENTIFIED WITH mysql_native_password BY '${password}';
       GRANT ALL PRIVILEGES ON ${database}.* TO '${identity}'@'%';
       FLUSH PRIVILEGES;`);
+    connection.destroy();
   }
 }

src/bin/app.ts

@@ -86,7 +86,7 @@ export default class InstallationService {
     // finish directory with permission
     setWpInstalledPathPermission(wpDir, identity);
 
-    const databaseService = new DatabaseService({ host, port, username, password });
+    const databaseService = new DatabaseService({ host, port, user: username, password });
 
     if (wpConfigDbUser !== undefined) {
       await databaseService.dropUser(wpConfigDbUser);

src/service/database.ts

@@ -1,55 +1,61 @@
-import shell from 'shelljs';
+import { execaCommandSync } from 'execa';
 
 import { getPHPErrorLogPath } from './path';
 
 import PHPVersionNotFoundError from '@/error/PHPVersionNotFoundError';
 import RestartServiceError from '@/error/RestartServiceError';
 
 export function isPHPInstalled() {
-  return shell.which('php');
+  return execaCommandSync('which php', { reject: false }).exitCode === 0;
 }
 
 export function isMySQLInstalled() {
-  return shell.which('mysqld');
+  return execaCommandSync('which mysqld', { reject: false }).exitCode === 0;
 }
 
 export function restartNginxService() {
-  if (shell.exec(`systemctl restart nginx`).code !== 0) {
+  if (execaCommandSync('systemctl restart nginx', { reject: false }).exitCode !== 0) {
     throw new RestartServiceError('nginx');
   }
 }
 
 export function restartPHPFPMService(phpVer: string) {
-  if (shell.exec(`systemctl restart php${phpVer}-fpm`).code !== 0) {
+  if (execaCommandSync(`systemctl restart php${phpVer}-fpm`, { reject: false }).exitCode !== 0) {
     throw new RestartServiceError('php-fpm');
   }
 }
 
 export function createPHPErrorLogFile(phpVer: string, identity: string) {
   const path = getPHPErrorLogPath(phpVer, identity);
-  shell.touch(path);
-  shell.exec(`chown ${identity}:${identity} ${path}`);
+  execaCommandSync(`touch ${path}`);
+  execaCommandSync(`chown ${identity}:${identity} ${path}`);
 }
 
 export function setWpInstalledPathPermission(wpInstalledPath: string, identity: string) {
-  shell.exec(`chown ${identity}:${identity} -R ${wpInstalledPath}`);
-  shell.exec(`find ${wpInstalledPath} -type d -exec chmod 755 {} \;`);
-  shell.exec(`find ${wpInstalledPath} -type f -exec chmod 644 {} \;`);
+  execaCommandSync(`chown ${identity}:${identity} -R ${wpInstalledPath}`);
+  execaCommandSync(`find ${wpInstalledPath} -type d -exec chmod 755 {} \;`);
+  execaCommandSync(`find ${wpInstalledPath} -type f -exec chmod 644 {} \;`);
 }
 
 export function createUnixUser(identity: string) {
-  if (shell.grep(identity, '/etc/passwd').code === 0) {
+  if (execaCommandSync(`grep ${identity} /etc/passwd`, { reject: false }).exitCode === 0) {
     return;
   }
   if (
-    shell.exec(`adduser --system --no-create-home --group --disabled-login ${identity}`).code !== 0
+    execaCommandSync(`adduser --system --no-create-home --group --disabled-login ${identity}`, {
+      reject: false,
+    }).exitCode !== 0
   ) {
     throw new Error(`Failed to create the user named ${identity}`);
   }
 }
 
+export function getPHPVersionOutput() {
+  return execaCommandSync('php -v', { reject: false }).stdout || '';
+}
+
 export function getCurrentPHPVersion() {
-  const matches = shell.exec('php -v').stdout.match(/^PHP ([0-9]\.[0-9])/);
+  const matches = getPHPVersionOutput().match(/^PHP ([0-9]\.[0-9])/);
   if (matches === null) {
     throw new PHPVersionNotFoundError('Cannot find php version using `php -v`');
   }