express-generator-typescript/lib/express-generator-typescript.js

Generate new Express applications similar to express-generate which but sets it up to use TypeScript instead

const path = require('path'),
  editJsonFile = require('edit-json-file'),
  childProcess = require('child_process'),
  ncp = require('ncp').ncp,
  fs = require('fs');

/******************************************************************************
                                 Constants
******************************************************************************/

const PROJECT_FOLDER_PATH = './project-files';

const DEPENDENCIES = [
  'cookie-parser',
  'cross-env',
  'dayjs',
  'dotenv',
  'express',
  'helmet',
  'jet-env',
  'jet-logger',
  'jet-paths',
  'jet-validators',
  'jsonfile',
  'module-alias',
  'morgan',
  'tspo',
];

const DEV_DEPENDENCIES = [
  '@eslint/js',
  '@swc/core',
  '@trivago/prettier-plugin-sort-imports',
  '@types/cookie-parser',
  '@types/find',
  '@types/fs-extra',
  '@types/jsonfile',
  '@types/module-alias',
  '@types/morgan',
  '@types/node',
  '@types/supertest',
  'browser-sync',
  'concurrently',
  'delay-cli',
  'eslint',
  'eslint-config-prettier',
  'eslint-plugin-n',
  'find',
  'fs-extra',
  'jiti',
  'nodemon',
  'prettier',
  'shx',
  'supertest',
  'ts-node',
  'tsconfig-paths',
  'typescript',
  'typescript-eslint',
  'vitest',
];

// "ncp" options
const ncpOpts = {
  filter: (fileName) => {
    return !(fileName === 'package-lock.json' || fileName === 'node_modules');
  },
};

/******************************************************************************
                                 Functions
******************************************************************************/

/**
 * Entry point
 */
async function expressGenTs(destination, useYarn) {
  try {
    await copyProjectFiles(destination);
    updatePackageJson(destination);
    await renameGitigoreFile(destination);
    downloadNodeModules(destination, useYarn);
  } catch (err) {
    console.error(err);
  }
}

/**
 * Copy project files
 */
function copyProjectFiles(destination) {
  const source = path.join(__dirname, PROJECT_FOLDER_PATH);
  return /** @type {Promise<void>} */(new Promise((res, rej) => {
    return ncp(source, destination, ncpOpts, (err) => {
      return (!!err ? rej(err) : res());
    });
  }));
}

/**
 * Set update the package.json file.
 */
function updatePackageJson(destination) {
  let file = editJsonFile(destination + '/package.json', {
    autosave: true
  });
  file.set('name', path.basename(destination));
  file.set('dependencies', {});
  file.set('devDependencies', {});
}

/**
 * Because npm does not allow .gitignore to be published.
 */
function renameGitigoreFile(destination) {
  return /** @type {Promise<void>} */(new Promise((res, rej) => 
    fs.rename(
      (destination + '/gitignore'),
      (destination + '/.gitignore'),
      (err => !!err ? rej(err) : res()),
    )
  ));
}

/**
 * Download the dependencies.
 */
function downloadNodeModules(destination, useYarn) {
  const options = { cwd: destination };
  // Setup dependencies string
  let depStr = DEPENDENCIES.join(' '),
    devDepStr = DEV_DEPENDENCIES.join(' ');
  // Setup download command
  let downloadLibCmd,
    downloadDepCmd;
  if (useYarn) {
    downloadLibCmd = 'yarn add ' + depStr;
    downloadDepCmd = 'yarn add ' + devDepStr + ' -D';
  } else {
    downloadLibCmd = 'npm i -s ' + depStr;
    downloadDepCmd = 'npm i -D ' + devDepStr;
  }
  // Execute command
  childProcess.execSync(downloadLibCmd, options);
  childProcess.execSync(downloadDepCmd, options);
}

/******************************************************************************
                                Export
******************************************************************************/

module.exports = expressGenTs;