create-sy 2.1.20-alpha.0 → 2.1.31-alpha.0

package/README.md

@@ -1,33 +1,42 @@
-# Syngrisi Starter Toolkit
+# Syngrisi Project Initializer
 
-This is a command line utility for creating and installing a new Syngrisi project with all the necessary configurations and dependencies, allowing you to get started quickly.
+This command line tool is for creating and installing a new Syngrisi project with required configurations and
+dependencies, allowing you to get started quickly.
+
+## Prerequisites
+
+This initializer is for installing Syngrisi in native mode, therefore you need `Node.js >= v14.20.0`and `MongoDB >= 7.0` or remote MongoDB instance. If you want to install a dockerized Syngrisi service, please read the [Syngrisi documentation](https://github.com/syngrisi/syngrisi/tree/main/packages/syngrisi#readme).
 
 ## Usage
 
-Set up a new Syngrisi project in the current path
+To install a new Syngrisi project in the current directory, run:
 
 ```bash
 npm init sy@latest
 ```
 
 ## CLI options
-The command accepts the following options:
 
-`DIRECTORY` - The directory where to install the new Syngrisi project. If not provided, the current working directory will be used.
+The installation command supports the following options:
+
+`DIRECTORY` - The directory where your Syngrisi project will be installed. The default is the current working directory if this option is omitted.
 
-`-f, --force` - Force the installation even if the pre-install checks (like Docker, MongoDB, and Node version checks) fail.
+`-f, --force` - Ignore pre-install checks (Docker, MongoDB, Node.js versions) and force the installation.
 
 `-y, --yes` - Automatically confirm the installation.
 
-`--npmTag` - Specifies the version tag of the Syngrisi package to be installed. If not given, the latest version is installed.
+`--npmTag` - Determine the Syngrisi package version to install. Defaults to the latest version when not specified.
 
-`--help` - Show the usage information and exit.
-For example:
+`--help` - Display help information and exit.
+
+Example:
 
 ```bash
 npm init sy my-app-dir -- -f -y
 ```
 
-This command create a new Syngrisi project in the `my-app-dir` directory, ignoring any potential pre-installation checks, and automatically confirming the installation process.
+This command initializes a Syngrisi project in my-app-dir, bypassing pre-install checks and confirming prompts
+automatically.
+
 
 

package/build/constants.js

@@ -1,3 +1,5 @@
 export const MONGODB_SETUP_MANUAL_URL = 'https://www.mongodb.com/docs/manual/installation/';
 export const DOCKER_SETUP_MANUAL_URL = 'https://docs.docker.com/engine/install/';
+export const SYNGRISI_DOCUMENTATION_LINK = 'https://github.com/syngrisi/syngrisi/tree/main/packages/syngrisi#readme';
 export const NODE_VERSION = '>=14';
+export const MONGODB_VERSION = '>=7.0';

package/build/createSyngrisiProject.js

@@ -33,5 +33,5 @@ export const createSyngrisiProject = async (opts) => {
     spinner.stop();
     console.log(chalk.green(`✔ Syngrisi ${chalk.greenBright(getSyngrisiVersion(root))} successfully installed in the following directory: ${root}`));
     console.log(chalk.white(`To run the application use the ${chalk.whiteBright('npx sy')} command`));
-    console.log(chalk.white.bold('For detailed configuration see https://github.com/viktor-silakov/syngrisi'));
+    console.log(chalk.white.bold('For detailed configuration see https://github.com/syngrisi/syngrisi/tree/main/packages/syngrisi'));
 };

package/build/index.js

@@ -1,8 +1,9 @@
 // noinspection ExceptionCaughtLocallyJS
 import * as utils from './utils.js';
-import { DOCKER_SETUP_MANUAL_URL, MONGODB_SETUP_MANUAL_URL, NODE_VERSION } from './constants.js';
+import { MONGODB_SETUP_MANUAL_URL, MONGODB_VERSION, NODE_VERSION, SYNGRISI_DOCUMENTATION_LINK } from './constants.js';
 import chalk from 'chalk';
 import { createSyngrisiProject } from './createSyngrisiProject.js';
+import { checkMongoDB } from './utils.js';
 export async function run() {
     try {
         const args = utils.parseArguments();
@@ -28,14 +29,16 @@ export async function run() {
             }
         }
         if (args.force === undefined && !args._.includes('--force')) {
-            if (!utils.checkDocker()) {
-                console.log(chalk.yellow('⚠️ Docker Compose is not installed.'
-                    + `Please install Docker Compose if you want to run Syngrisi inside containers. ${DOCKER_SETUP_MANUAL_URL}\n`));
-            }
-            if (!utils.checkMongoDB()) {
+            const mongoCheck = checkMongoDB();
+            if (!mongoCheck || (!mongoCheck.supported && (mongoCheck.version === 'unknown'))) {
                 console.log(chalk.yellow('⚠️ MongoDB is not installed.'
                     + `Please install MongoDB if you want to run Syngrisi in the native mode. ${MONGODB_SETUP_MANUAL_URL}\n`));
             }
+            if (!mongoCheck.supported && (mongoCheck.version !== 'unknown')) {
+                console.log(chalk.yellow(`⚠️ Wrong MongoDB version: '${mongoCheck.version}' `
+                    + `Please install the proper MongoDB version: '${MONGODB_VERSION}' if you want to run Syngrisi in the native mode. ${MONGODB_SETUP_MANUAL_URL}\n`
+                    + `Or use standalone remote MongoDB instance, for more information read Syngrisi documentation ${SYNGRISI_DOCUMENTATION_LINK}.`));
+            }
             const versionObj = utils.checkNodeVersion();
             if (!versionObj.supported) {
                 const msg = `❌ This version: '${versionObj.version}' of Node.js is not supported. Please use Node.js version ${NODE_VERSION}\n`;

package/build/utils.js

@@ -2,7 +2,7 @@ import chalk from 'chalk';
 import child_process from 'node:child_process';
 import fss from 'node:fs';
 import inquirer from 'inquirer';
-import { NODE_VERSION } from './constants.js';
+import { MONGODB_VERSION, NODE_VERSION } from './constants.js';
 import semver from 'semver';
 import minimist from 'minimist';
 import path from 'node:path';
@@ -46,15 +46,27 @@ export const prompt = async (message) => {
     ]);
     return answer;
 };
+export const getInstalledMongoVersion = () => {
+    const versionOutput = child_process.execSync('mongod1 --version').toString();
+    const versionMatch = versionOutput.match(/db version v(\d+\.\d+\.\d+)/);
+    if (!versionMatch) {
+        throw new Error(chalk.red(`❌ Cannot parse MongoDB version, output: '${versionOutput}'`));
+    }
+    return versionMatch[1];
+};
 export const checkMongoDB = () => {
     try {
-        child_process.execSync('mongod --version', { stdio: 'ignore' });
-        console.log(chalk.green('✔ MongoDB is installed.'));
-        return true;
+        const installedVersion = getInstalledMongoVersion();
+        if (!semver.satisfies(installedVersion, MONGODB_VERSION)) {
+            console.error(chalk.red(`❌ MongoDB version is not satisfies requirements: '${MONGODB_VERSION}'. Installed version is '${installedVersion}'.`));
+            return { version: installedVersion, supported: false };
+        }
+        console.log(chalk.green(`✔ MongoDB version is satisfactory. Installed version is ${installedVersion}.`));
+        return { version: installedVersion, supported: true };
     }
     catch (error) {
-        console.error(chalk.yellow(error.message));
-        return false;
+        console.error(chalk.yellow(`Error checking MongoDB version: ${error.message}`));
+        return { version: 'unknown', supported: false };
     }
 };
 export function printAndExit(error, signal) {

package/package.json

@@ -1,20 +1,20 @@
 {
   "name": "create-sy",
-  "version": "2.1.20-alpha.0",
+  "version": "2.1.31-alpha.0",
   "description": "Install and setup Syngrisi",
   "author": {
     "name": "Viktar Silakou",
     "email": "1105714@gmail.com"
   },
   "license": "MIT",
-  "homepage": "https://github.com/viktor-silakov/syngrisi-tool",
+  "homepage": "https://github.com/syngrisi/syngrisi/tree/main/packages/create-sy",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/viktor-silakov/syngrisi-tool.git",
+    "url": "git+git@github.com:syngrisi/syngrisi.git",
     "directory": "packages/create-sy"
   },
   "bugs": {
-    "url": "https://github.com/viktor-silakov/syngrisi-tool/issues"
+    "url": "https://github.com/syngrisi/syngrisi/issues"
   },
   "keywords": [
     "Syngrisi",
@@ -72,5 +72,5 @@
     "read-pkg-up": "^10.1.0",
     "semver": "^7.3.8"
   },
-  "gitHead": "25fe5261e62a4711c3ff992aaca9a75a6199ae04"
+  "gitHead": "adc129857801f07ff80a435887ddd04fe4182962"
 }

package/typedoc.config.cjs

@@ -0,0 +1,6 @@
+/** @type {import('typedoc').TypeDocOptions} */
+module.exports = {
+    // entryPoints: ["./src/index.ts"],
+    extends: ["../../typedoc.base.json"],
+    out: ""
+};