sinto 1.3.1 → 1.5.0

package/README.md

@@ -24,7 +24,7 @@ mkdir app01
 cd app01
 ```
 
-Generate default directories and files:
+Generate default web directories and files:
 
 ```cmd
 sin init
@@ -58,6 +58,7 @@ This command is generate public directory from src directory.
 * sin api - Generate fake REST API with hai-server
 * sin webpack - Generate Webpack project
 * sin pup - Generate Puppeteer test with Mocha
+* sin rmno - Delete node_modules directory
 
 The Default task manager is gulp. Development serve is browser-sync.
 
@@ -112,16 +113,18 @@ app01/
 
 ## Puppeteer test with Mocha
 
-The sin pup command generate a Puppeteer test with Mocha default test file.
+The **sin pup** command generate a Puppeteer test with Mocha default test file.
+
+The **sin pup** command does not install the dependencies, it just writes them into the package.json file. Install the dependencies with the **npm i** or **pnpm i** command.
 
 Using:
 
 ```cmd
 sin pup
-npm install --save-dev puppeteer mocha
+npm i
 ```
 
-Generated directories and files:
+Generated directoriy and file:
 
 ```txt
 app01/
@@ -129,17 +132,23 @@ app01/
       `-apptest.js
 ```
 
-Add to package.json file a script:
+Automatically adds the test script and dependencies to the package.json file.
 
 ```json
 {
   "scripts": {
     "test": "mocha"
+  },
+  "devDependencies": {
+    "mocha": "^x.y.z",
+    "puppeteer": "^x.y.z"    
   }
 }
 ```
 
-Run the test:
+The version numbers are updated.
+
+Write the tests in test directory and run the tests:
 
 ```cmd
 npm test

package/build/build.js

@@ -0,0 +1,7 @@
+const { exec } = require('child_process');
+
+const build = (argv) => {
+    exec('npx gulp')
+}
+
+module.exports.build = build;

package/gentest/generate.js

@@ -1,16 +1,44 @@
 const { createFile, createDirectory } = require('../tools/tools.js');
-const puppeteerTestContent = require('./testPupContent')
+const puppeteerTestContent = require('./testPupContent');
+const jsonfile = require('jsonfile');
+const path = require('path');
+const { exec } = require('child_process');
+const { addDevDep } = require('../tools/dep.js');
 
-const createPuppeteerTest = () => {    
+const createPuppeteerTest = async () => {    
     const dir = process.cwd();
     createDirectory(`${dir}/test`);
     createFile(`${dir}/test/apptest.js`, puppeteerTestContent);
-    console.log('\n')
-    console.log('Install the dependencies:')
-    console.log('  npm install --save-dev puppeteer mocha')
-    console.log('Add start script to package.json:')
-    console.log('  \"test\": \"mocha\"')
-    console.log('\n')
+
+    await writeTestScriptInPackageJson();  
+}
+
+async function writeTestScriptInPackageJson() {    
+    const dir = process.cwd();
+    const filePath = dir + '/package.json'
+    jsonfile.readFile(filePath, async (err, obj) => {
+        if(err) {
+            console.error('Error! Failed to read package.json file.', err);
+            return;
+        }
+        obj.scripts = obj.scripts || {};
+        obj.scripts["test"] = "mocha";
+
+        jsonfile.writeFile(filePath, obj, { spaces: 2 }, async (err) => {
+            if(err) {
+                console.error('Error! Failed to write package.json file!')
+            }else {
+                console.log('The package.json updated');
+                await writePuppeteerDependencies(['mocha', 'puppeteer']);
+            }
+        });
+    });
+}
+
+const writePuppeteerDependencies = async (packageNames) => {
+    const dir = process.cwd();
+    const filePath = dir + '/package.json';
+    await addDevDep(filePath, packageNames);
 }
 
 module.exports.createPuppeteerTest = createPuppeteerTest;

package/gents/gents.js

@@ -0,0 +1,36 @@
+const tsconfigContent = require('./tsconfigContent');
+const { createFile } = require('../tools/tools.js');
+const jsonfile = require('jsonfile');
+const { addDevDep } = require('../tools/dep.js');
+
+const supplementTypescript = () => {
+    writeConfigFile();
+    showMsg();
+    addDependencies();
+}
+
+const writeConfigFile = () => {
+    const dir = process.cwd();
+    const path = `${dir}/tsconfig.json`;
+    jsonfile.writeFileSync(path, tsconfigContent, { spaces: 2 });
+}
+
+const showMsg = () => {
+    console.log(`
+Proposal:
+In the tsconfig.json file, leave the module value
+at commonjs for a NodeJS project. In the case of 
+an ES project, rewrite it to, for example, ES6.
+
+Install dependencies:
+pnpm install
+        `);
+}
+
+const addDependencies = () => {
+    const dir = process.cwd();
+    const path = `${dir}/package.json`;
+    addDevDep(path, ['typescript']);
+}
+
+module.exports.supplementTypescript = supplementTypescript;

package/gents/tsconfigContent.js

@@ -0,0 +1,14 @@
+
+const tsconfigContent = 
+{
+    "compilerOptions": {
+        "target": "ES6",
+        "module": "commonjs",
+        "outDir": "./app",
+        "strict": true,
+        "esModuleInterop": true
+    }
+}
+
+
+module.exports = tsconfigContent;

package/genweb/genweb.js

@@ -0,0 +1,66 @@
+const {debug} = require('../config.json');
+const jsonfile = require('jsonfile');
+const fsExtra = require('fs-extra');
+
+const defaultPackageContent = require('../genweb/generators/genPackage');
+const defaultHtmlContent = require('../genweb/generators/genHtml');
+const defaultGulpfileContent = require('../genweb/generators/genGulpfile');
+const defaultBsconfigContent = require('../genweb/generators/genBsconfig');
+
+const {
+    createDirectory, 
+    createFile
+  } = require('../tools/tools');
+
+const createWeb = () => {
+    const currentDirectory = process.cwd();
+  
+    createDirectory(`${currentDirectory}/src`);
+    createDirectory(`${currentDirectory}/assets`);
+  
+    createFile(`${currentDirectory}/src/style.css`, '');  
+    createFile(`${currentDirectory}/src/app.js`, '');
+    createFile(`${currentDirectory}/README.md`, '# Sinto Project');
+    
+    createPackageJsonFile(currentDirectory);
+    createIndexHtmlFile(currentDirectory);
+    createGulpfileJsFile(currentDirectory);
+    createBsconfigFile(currentDirectory);
+  
+    console.log('Base directories and files created.');
+};
+
+const createPackageJsonFile = (directory) => {
+  const packageJsonPath = `${directory}/package.json`;
+  jsonfile.writeFileSync(packageJsonPath, defaultPackageContent, { spaces: 2 });
+  if(debug) {
+      console.log('package.json file created.');
+  }        
+}
+
+const createIndexHtmlFile = (directory) => {
+  const indexHtmlPath = `${directory}/src/index.html`;
+  fsExtra.writeFileSync(indexHtmlPath, defaultHtmlContent);
+  if(debug)
+  console.log('index.html file created');
+}
+
+const createGulpfileJsFile = (directory) => {
+  const gulpfileJsPath = `${directory}/gulpfile.js`;
+  fsExtra.writeFileSync(gulpfileJsPath, defaultGulpfileContent);
+  if(debug)
+  console.log('gulpfile.js file created.');
+}
+
+const createBsconfigFile = (directory) => {
+  const bsconfigPath = `${directory}/bs-config.json`;
+  jsonfile.writeFileSync(bsconfigPath, defaultBsconfigContent, { spaces: 2 });
+  if(debug)
+  console.log('bs-config.json file created.');
+}
+
+module.exports.createWeb = createWeb;
+module.exports.createPackageJsonFile = createPackageJsonFile;
+module.exports.createIndexHtmlFile = createIndexHtmlFile;
+module.exports.createGulpfileJsFile = createGulpfileJsFile;
+module.exports.createBsconfigFile = createBsconfigFile;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sinto",
-  "version": "1.3.1",
+  "version": "1.5.0",
   "description": "Website project development manager",
   "bin": {
     "sin": "sin.js"
@@ -12,8 +12,10 @@
   "license": "MIT",
   "dependencies": {
     "browser-sync": "^3.0.2",
+    "commander": "^12.1.0",
     "fs-extra": "^11.2.0",
     "gulp": "^5.0.0",
+    "jsonfile": "^6.1.0",
     "yargs": "^17.7.2"
   },
   "keywords": [

package/rmno/rmno.js

@@ -0,0 +1,13 @@
+const fs = require('node:fs');
+
+const rmno = () => {
+    const dir = 'node_modules';
+    fs.rm(dir,{ recursive: true, force: true } ,err => {
+      if (err) {
+        throw err;
+      }    
+      console.log(`${dir} is deleted!`);
+    });    
+}
+
+module.exports.rmno = rmno;

package/sin.js

@@ -1,70 +1,78 @@
 #!/usr/bin/env node
 
-const {debug} = require('./config.json')
-const { exec } = require('child_process');
-
-const cli = require('./cli');
-const serve = require('./server');
+const { Command } = require('commander');
+const { createWeb } = require('./genweb/genweb');
+const { server } = require('./startserver/server');
+const { build } = require('./build/build');
+const { rmno } = require('./rmno/rmno');
 const { createApi } = require('./haiserver/apigen');
 const { createWebpack } = require('./webpack/generate');
 const { createPuppeteerTest } = require('./gentest/generate');
+const { supplementTypescript } = require('./gents/gents');
 
-const { 
-  createDirectory, 
-  createFile, 
-  createPackageJsonFile, 
-  createIndexHtmlFile, 
-  createGulpfileJsFile, 
-  createBsconfigFile 
-} = require('./tools/tools');
+const program = new Command();
 
+program
+    .name('sin')
+    .description('Project handler')
+    .version('1.5.0');
 
-const init = () => {
-  const currentDirectory = process.cwd();
+program
+    .command('init')
+    .description('Initialize the web project')
+    .action(() => {
+        createWeb();
+    });
 
-  createDirectory(`${currentDirectory}/src`);
-  createDirectory(`${currentDirectory}/assets`);
+program
+    .command('serve')
+    .description('Start develop server')
+    .option('-p, --port [port]', 'Server port number')
+    .action((options) => {
+        server(options);
+    });
 
-  createFile(`${currentDirectory}/src/style.css`, '');  
-  createFile(`${currentDirectory}/src/app.js`, '');
-  createFile(`${currentDirectory}/README.md`, '# Sinto Project');
-  
-  createPackageJsonFile(currentDirectory);
-  createIndexHtmlFile(currentDirectory);
-  createGulpfileJsFile(currentDirectory);
-  createBsconfigFile(currentDirectory);
+program
+    .command('build')
+    .description('Start build with Gulp')
+    .action(() => {
+        build();
+    });
 
-  console.log('Base directories and files created.');
-};
+program
+    .command('rmno')
+    .description('Delete node_modules directory')
+    .action(() => {
+        rmno();
+    });
 
-const build = (argv) => {
-  exec('npx gulp')
-}
+program
+    .command('api')
+    .description('REST API with hai-server')
+    .action(() => {
+        createApi();
+    });
 
-const rmno = (argv) => {
-  console.log('Not implemented...')
-}
+program
+    .command('webpack')
+    .description('Webpack client')
+    .action(() => {
+        createWebpack();
+    });
 
-const serverOptions = (yargs) => {
-  return yargs.option('p', {
-    alias: 'port',
-    describe: 'Server port number'
-  })
-}
+program
+    .command('pup')
+    .description('Puppeteer test')
+    .action(async () => {
+        await createPuppeteerTest();
+    })
 
-cli.command('init', 'Initilize the project', {}, init);
-cli.command('serve', 'Start develop server', serverOptions, serve);
-cli.command('build', 'Start build with gulp', {}, build);
-cli.command('rmno', 'Delete node_modules directory', {}, rmno);
-cli.command('api', 'REST API with hai-server', {}, createApi);
-cli.command('webpack', 'Webpack client', {}, createWebpack);
-cli.command('pup', 'Puppeteer test', {}, createPuppeteerTest);
+program
+    .command('ts')
+    .description('Supplement with TypeScript')
+    .action(() => {
+        supplementTypescript();
+    })
 
-const main = () => {
-  argv = cli.parse();
-  if (!argv._[0]) {
-    console.log('Használja a "sin init" vagy a "sin serve" parancsot!');
-  }
-};
 
-main();
+program.parse();

package/{server.js → startserver/server.js}

@@ -29,10 +29,11 @@ const serve = (argv) => {
     readConfigFile(configFilePath, (error, config) => {
       if(error) {
         console.error('Error! The configuration file cannot be read!')
+        console.error(error)
         return;
       }
       initializeServer(argv, config)
     })
 };
 
-module.exports = serve;
+module.exports.server = serve;

package/tools/dep.js

@@ -0,0 +1,77 @@
+const {debug} = require('../config.json');
+const jsonfile = require('jsonfile');
+const util = require('util');
+const exec = util.promisify(require('child_process').exec);
+
+const addDep = async (filePath, packageNames) => {
+    await writeDependencies(filePath, packageNames, false);
+}
+
+const addDevDep = async (filePath, packageNames) => {
+    await writeDependencies(filePath, packageNames, true);
+}
+
+async function writeDependencies(filePath, packageNames, devDep) {  
+    var obj = await readJsonFile(filePath);
+    obj = await addDependencies(obj, packageNames, devDep);
+    await writeJsonFile(filePath, obj);
+}
+
+async function readJsonFile(filePath) {
+    try {
+        const obj = await jsonfile.readFile(filePath);
+        if(debug) {
+            console.log(`Readed JSON file`);
+        }        
+        return obj;
+    } catch (err) {
+        console.error(`Error! Failed to read ${filePath}`);
+        console.error(err);
+    }
+}
+
+async function addDependencies(obj, packageNames, devDep) {
+    for(const packageName of packageNames) {
+        try {
+            const newDependency = await getPackageInfo(packageName);
+            if(devDep) {
+                await Object.assign(obj.devDependencies, newDependency);
+            }else {
+                await Object.assign(obj.dependencies, newDependency);
+            }
+            
+        } catch (err) {
+            console.error(`Error! Failed add packages!`);
+            console.error(err);       
+        }
+    }
+    return obj;
+}
+
+async function getPackageInfo(packageName) {
+    try {
+        const { stdout, stderr } = await exec(`npm view ${packageName} version`);
+        if (stderr) {
+            throw new Error(`Error! Retrieving the version of package named ${packageName} failed: ${stderr}`);
+        }
+        const version = stdout.trim();
+        return { [packageName]: `^${version}` };
+    } catch (err) {
+        throw new Error(err.message);
+    }
+}
+
+async function writeJsonFile(path, obj) {
+    try {
+        await jsonfile.writeFile(path, obj, { spaces: 2});
+        if(debug) {
+            console.log(`Added new depencies`);
+        }
+    } catch (err) {
+        console.error('Error! Failed to write package.json:');
+        console.error(err);
+    }
+}
+
+module.exports.addDep = addDep;
+module.exports.addDevDep = addDevDep;

package/tools/tools.js

@@ -1,12 +1,5 @@
 const {debug} = require('../config.json');
 const fsExtra = require('fs-extra');
-const jsonfile = require('jsonfile');
-const fs = require('fs');
-
-const defaultPackageContent = require('../generators/genPackage');
-const defaultHtmlContent = require('../generators/genHtml');
-const defaultGulpfileContent = require('../generators/genGulpfile');
-const defaultBsconfigContent = require('../generators/genBsconfig');
 
 const createDirectory = (path) => {
     if (!fsExtra.existsSync(path)) {
@@ -20,38 +13,5 @@ const createFile = (path, content) => {
     }
 }
 
-const createPackageJsonFile = (directory) => {
-    const packageJsonPath = `${directory}/package.json`;
-    jsonfile.writeFileSync(packageJsonPath, defaultPackageContent, { spaces: 2 });
-    if(debug) {
-        console.log('package.json file created.');
-    }        
-}
-
-const createIndexHtmlFile = (directory) => {
-    const indexHtmlPath = `${directory}/src/index.html`;
-    fsExtra.writeFileSync(indexHtmlPath, defaultHtmlContent);
-    if(debug)
-    console.log('index.html file created');
-}
-
-const createGulpfileJsFile = (directory) => {
-    const gulpfileJsPath = `${directory}/gulpfile.js`;
-    fsExtra.writeFileSync(gulpfileJsPath, defaultGulpfileContent);
-    if(debug)
-    console.log('gulpfile.js file created.');
-}
-
-const createBsconfigFile = (directory) => {
-    const bsconfigPath = `${directory}/bs-config.json`;
-    jsonfile.writeFileSync(bsconfigPath, defaultBsconfigContent, { spaces: 2 });
-    if(debug)
-    console.log('bs-config.json file created.');
-}
-
 module.exports.createDirectory = createDirectory;
 module.exports.createFile = createFile;
-module.exports.createPackageJsonFile = createPackageJsonFile;
-module.exports.createIndexHtmlFile = createIndexHtmlFile;
-module.exports.createGulpfileJsFile = createGulpfileJsFile;
-module.exports.createBsconfigFile = createBsconfigFile;

package/cli.js

@@ -1,7 +0,0 @@
-
-const yargs = require('yargs/yargs')
-const { hideBin } = require('yargs/helpers')
-
-const cli = yargs(hideBin(process.argv));
-
-module.exports = cli;