create-payload-app 0.1.22 → 0.3.3

package/package.json

@@ -4,11 +4,18 @@
   "bin": {
     "create-payload-app": "bin/cli.js"
   },
+  "scripts": {
+    "build": "tsc && yarn copyfiles",
+    "copyfiles": "copyfiles -u 1 \"src/templates/**\" dist",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint \"src/**/*.ts\"",
+    "test": "jest",
+    "prepublish": "yarn test && yarn build"
+  },
   "files": [
     "package.json",
-    "bin",
-    "utils",
-    "templates"
+    "dist",
+    "bin"
   ],
   "dependencies": {
     "@sentry/node": "^6.3.3",
@@ -16,6 +23,7 @@
     "arg": "^5.0.0",
     "chalk": "^4.1.0",
     "command-exists": "^1.2.9",
+    "degit": "^2.8.4",
     "execa": "^5.0.0",
     "figures": "^3.2.0",
     "fs-extra": "^9.0.1",
@@ -23,5 +31,24 @@
     "prompts": "^2.4.0",
     "terminal-link": "^2.1.1"
   },
-  "version": "0.1.22"
+  "version": "0.3.3",
+  "devDependencies": {
+    "@types/command-exists": "^1.2.0",
+    "@types/degit": "^2.8.3",
+    "@types/fs-extra": "^9.0.12",
+    "@types/jest": "^27.0.3",
+    "@types/node": "^16.6.2",
+    "@types/prompts": "^2.4.0",
+    "@typescript-eslint/eslint-plugin": "^4.29.2",
+    "@typescript-eslint/parser": "^4.29.2",
+    "copyfiles": "^2.4.1",
+    "eslint": "^7.32.0",
+    "eslint-config-airbnb-base": "^14.2.1",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-prettier": "^3.4.0",
+    "jest": "^27.4.5",
+    "prettier": "^2.3.2",
+    "ts-jest": "^27.1.1",
+    "typescript": "^4.3.5"
+  }
 }

package/utils/createProject.js

@@ -1,101 +0,0 @@
-const path = require('path');
-const chalk = require('chalk');
-const fse = require('fs-extra');
-const execa = require('execa');
-const ora = require('ora');
-const { getArgs } = require('./getArgs');
-
-const { getProjectDir } = require('./getProjectDir');
-const { getTemplate } = require('./getTemplate');
-const { success, error, warning } = require('./log');
-const { getPackageManager } = require('./getPackageManager');
-const { setTags } = require('./usage');
-
-const createProjectDir = (projectDir) => {
-  fse.mkdirpSync(projectDir);
-  const readDir = fse.readdirSync(projectDir);
-  if (readDir && readDir.length > 0) {
-    error(`The project directory '${projectDir}' is not empty`);
-    process.exit(1);
-  }
-};
-
-const installDeps = async (dir, packageManager) => {
-  const args = getArgs();
-  if (args['--no-deps']) {
-    return { failed: false };
-  }
-  let cmd = packageManager === 'yarn' ? 'yarn' : 'npm install --legacy-peer-deps';
-
-  let result = false;
-  try {
-    result = execa.command(cmd, {
-      cwd: path.resolve(dir),
-    });
-  } catch (error) {
-    result = error;
-  }
-  return result;
-};
-
-const getLatestPayloadVersion = async () => {
-  let result = false;
-  try {
-    const { stdout } = await execa('npm info payload version', [], { shell: true });
-    return `^${stdout}`;
-  } catch (error) {
-    result = error;
-  }
-  return result;
-}
-
-const updatePayloadVersion = async (projectDir) => {
-  const payloadVersion = await getLatestPayloadVersion();
-  if (payloadVersion.failed) {
-    warning('Error retrieving latest Payload version. Please update your package.json manually.');
-    return;
-  }
-  setTags({ payload_version: payloadVersion });
-
-  const pjson = path.resolve(projectDir, 'package.json');
-  try {
-    const packageObj = await fse.readJson(pjson);
-    packageObj.dependencies.payload = payloadVersion;
-    await fse.writeJson(pjson, packageObj, { spaces: 2 });
-  } catch (err) {
-    warning('Unable to write Payload version to package.json. Please update your package.json manually.');
-  }
-}
-
-const createProject = async () => {
-  const projectDir = await getProjectDir();
-  createProjectDir(projectDir);
-  const templateDir = path.resolve(__dirname, `../templates/${await getTemplate()}`);
-
-  console.log(`\n  Creating a new Payload app in ${chalk.green(path.resolve(projectDir))}\n`)
-
-  try {
-    await fse.copy(templateDir, projectDir);
-    success('Project directory created')
-  } catch (err) {
-    const msg = 'Unable to copy template files. Please check template name or directory permissions.';
-    error(msg);
-    process.exit(1);
-  }
-
-  const spinner = ora('Checking latest Payload version...').start();
-  await updatePayloadVersion(projectDir);
-
-  const packageManager = await getPackageManager();
-  spinner.text = 'Installing dependencies...';
-  const result = await installDeps(projectDir, packageManager);
-  spinner.stop();
-  spinner.clear();
-  if (result.failed) {
-    error('Error installing dependencies');
-  } else {
-    success('Dependencies installed');
-  }
-}
-
-module.exports = { createProject };

package/utils/getArgs.js

@@ -1,28 +0,0 @@
-const arg = require('arg');
-
-let ARGS = false; // Store ARGS if they've been parsed before
-const getArgs = () => {
-  // Already parsed
-  if (ARGS) {
-    return ARGS;
-  }
-
-  // Set to ARGS so only parsed once
-  ARGS = arg({
-    '--help': Boolean,
-    '--name': String,
-    '--template': String,
-    '--db': String,
-    '--secret': String,
-    '--use-npm': Boolean,
-    '--no-deps': Boolean,
-    '--dry-run': Boolean,
-
-    '-h': '--help',
-    '-n': '--name',
-    '-t': '--template',
-  }, { permissive: true });
-  return ARGS;
-};
-
-module.exports = { getArgs };

package/utils/getDatabaseConnection.js

@@ -1,37 +0,0 @@
-const prompts = require('prompts');
-const slugify  = require('@sindresorhus/slugify');
-const { getArgs } = require('./getArgs');
-const { getProjectName } = require('./getProjectName');
-
-let MONGODB_URI;
-const getDatabaseConnection = async () => {
-  if (MONGODB_URI) {
-    return MONGODB_URI;
-  }
-
-  const args = getArgs();
-  if (args['--db']) {
-    MONGODB_URI = args['--db'];
-    return MONGODB_URI;
-  }
-
-  const response = await prompts(
-    {
-      type: 'text',
-      name: 'value',
-      message: 'Enter MongoDB connection',
-      initial: `mongodb://localhost/${slugify(await getProjectName())}`,
-      validate: value => value.length,
-    },
-    {
-      onCancel: () => {
-        process.exit(0);
-      },
-    }
-  );
-
-  MONGODB_URI = response.value;
-  return MONGODB_URI;
-};
-
-module.exports = { getDatabaseConnection };

package/utils/getLanguage.js

@@ -1,43 +0,0 @@
-const prompts = require('prompts');
-const { getArgs } = require('./getArgs');
-
-let LANGUAGE;
-const getLanguage = async () => {
-  if (LANGUAGE) {
-    return LANGUAGE;
-  }
-
-  const args = getArgs();
-  // TODO: Split template to get lang?
-  if (args['--template']) {
-    LANGUAGE = args['--template'];
-    return LANGUAGE;
-  }
-
-  const response = await prompts(
-    {
-      type: 'select',
-      name: 'value',
-      message: 'Choose language',
-      choices: [
-        {
-          title: 'javascript', value: 'js'
-        },
-        {
-          title: 'typescript', value: 'ts'
-        }
-      ],
-      validate: value => value.length,
-    },
-    {
-      onCancel: () => {
-        process.exit(0);
-      },
-    }
-  );
-
-  LANGUAGE = response.value;
-  return LANGUAGE;
-};
-
-module.exports = { getLanguage };

package/utils/getPackageManager.js

@@ -1,27 +0,0 @@
-const commandExists = require('command-exists');
-const { getArgs } = require('./getArgs');
-const { setTags } = require('./usage');
-
-let PACKAGE_MANAGER = false;
-const getPackageManager = async () => {
-  if (PACKAGE_MANAGER) {
-    return PACKAGE_MANAGER;
-  }
-
-  const args = getArgs();
-
-  if (args['--use-npm']) {
-    PACKAGE_MANAGER = 'npm';
-  } else {
-    try {
-      await commandExists('yarn');
-      PACKAGE_MANAGER = 'yarn';
-    } catch (error) {
-      PACKAGE_MANAGER = 'npm';
-    }
-  }
-  setTags({ package_manager: PACKAGE_MANAGER });
-  return PACKAGE_MANAGER;
-}
-
-module.exports = { getPackageManager };

package/utils/getPayloadSecret.js

@@ -1,34 +0,0 @@
-const prompts = require('prompts');
-const { getArgs } = require('./getArgs');
-
-let PAYLOAD_SECRET;
-const getPayloadSecret = async () => {
-  if (PAYLOAD_SECRET) {
-    return PAYLOAD_SECRET;
-  }
-
-  const args = getArgs();
-  if (args['--secret']) {
-    PAYLOAD_SECRET = args['--secret'];
-    return PAYLOAD_SECRET;
-  }
-
-  const response = await prompts(
-    {
-      type: 'password',
-      name: 'value',
-      message: 'Enter a long, complex string for Payload’s encryption key',
-      validate: value => value.length,
-    },
-    {
-      onCancel: () => {
-        process.exit(0);
-      },
-    }
-  );
-
-  PAYLOAD_SECRET = response.value;
-  return PAYLOAD_SECRET;
-};
-
-module.exports = { getPayloadSecret };

package/utils/getProjectDir.js

@@ -1,8 +0,0 @@
-const slugify = require('@sindresorhus/slugify');
-const { getProjectName } = require('./getProjectName');
-
-const getProjectDir = async () => `./${slugify(await getProjectName())}`;
-
-module.exports = {
-  getProjectDir,
-}

package/utils/getProjectName.js

@@ -1,39 +0,0 @@
-const prompts = require('prompts');
-const { getArgs } = require('./getArgs');
-
-let PROJECT_NAME;
-const getProjectName = async () => {
-  if (PROJECT_NAME) {
-    return PROJECT_NAME;
-  }
-
-  const args = getArgs();
-  if (args['--name']) {
-    PROJECT_NAME = args['--name'];
-    return PROJECT_NAME;
-  }
-
-  if (args._[0]) {
-    PROJECT_NAME = args._[0];
-    return PROJECT_NAME;
-  }
-
-  const response = await prompts(
-    {
-      type: 'text',
-      name: 'value',
-      message: 'Project name?',
-      validate: value => value.length,
-    },
-    {
-      onCancel: () => {
-        process.exit(0);
-      },
-    }
-  );
-
-  PROJECT_NAME = response.value;
-  return PROJECT_NAME;
-};
-
-module.exports = { getProjectName };

package/utils/getTemplate.js

@@ -1,49 +0,0 @@
-const prompts = require('prompts');
-const { getArgs } = require('./getArgs');
-const { getLanguage } = require('./getLanguage');
-const { getValidTemplates } = require('./getValidTemplates');
-const { setTags } = require('./usage');
-
-let TEMPLATE;
-const getTemplate = async () => {
-  if (TEMPLATE) {
-    return TEMPLATE;
-  }
-
-  const args = getArgs();
-  const templates = await getValidTemplates();
-  if (args['--template']) {
-    TEMPLATE = args['--template'];
-    setTags({ template: TEMPLATE });
-    return TEMPLATE;
-  }
-
-  const lang = await getLanguage();
-  const filteredTemplates = templates
-    .filter(d => d.startsWith(lang))
-    .map(t => t.replace(`${lang}-`, ''));
-
-  const response = await prompts(
-    {
-      type: 'select',
-      name: 'value',
-      message: 'Choose project template',
-      choices: filteredTemplates.map(p => {
-        return { title: p, value: p };
-      }),
-      validate: value => value.length,
-    },
-    {
-      onCancel: () => {
-        process.exit(0);
-      },
-    }
-  );
-
-  TEMPLATE = `${lang}-${response.value}`;
-  setTags({ template: TEMPLATE });
-
-  return TEMPLATE;
-};
-
-module.exports = { getTemplate };

package/utils/getValidTemplates.js

@@ -1,29 +0,0 @@
-const fs = require('fs');
-const path = require('path');
-const { error, info } = require('./log');
-
-const getDirectories = (dir) => fs.readdirSync(dir).filter(file => {
-  return fs.statSync(dir + '/' + file).isDirectory();
-});
-
-let VALID_TEMPLATES;
-const getValidTemplates = async () => {
-  if (VALID_TEMPLATES) {
-    return VALID_TEMPLATES;
-  }
-  const templateDir = path.resolve(__dirname, '../templates');
-  VALID_TEMPLATES = getDirectories(templateDir);
-  return VALID_TEMPLATES;
-};
-
-const validateTemplate = async (templateName) => {
-  VALID_TEMPLATES = await getValidTemplates();
-  if (!VALID_TEMPLATES.includes(templateName)) {
-    error(`'${templateName}' is not a valid template.`);
-    info(`Valid templates: ${VALID_TEMPLATES.join(', ')}`);
-    return false;
-  }
-  return true;
-}
-
-module.exports = { getValidTemplates, validateTemplate };

package/utils/log.js

@@ -1,27 +0,0 @@
-const chalk = require('chalk');
-const figures = require('figures');
-
-const isWin = process.platform === 'win32';
-
-const success = (message) => {
-  console.log(chalk.green(figures.tick) + ' ' + chalk.bold(message));
-}
-
-const warning = (message) => {
-  console.log(chalk.yellow('? ') + chalk.bold(message));
-}
-
-const info = (message) => {
-  console.log(chalk.yellow(figures.info) + ' ' + chalk.bold(message));
-}
-
-const error = (message) => {
-  console.log(chalk.red(figures.cross) + ' ' + chalk.bold(message));
-}
-
-module.exports = {
-  success,
-  warning,
-  info,
-  error,
-}

package/utils/messages.js

@@ -1,51 +0,0 @@
-const chalk = require('chalk');
-const figures = require('figures');
-const terminalLink = require('terminal-link');
-const { getProjectDir } = require('./getProjectDir');
-const { getPackageManager } = require('./getPackageManager');
-const { getValidTemplates } = require('./getValidTemplates');
-
-const header = (message) => chalk.yellow(figures.star) + ' ' + chalk.bold(message);
-
-const welcomeMessage = chalk`
-  {green Welcome to Payload. Let's create a project! }
-`;
-
-const helpMessage = async () => {
-  const validTemplates = await getValidTemplates();
-  return chalk`
-  {bold USAGE}
-
-      {dim $} {bold npx create-payload-app}
-
-  {bold OPTIONS}
-
-      --name {underline my-payload-app}              Set project name
-      --template {underline template_name}           Choose specific template
-
-        {dim Available templates: ${validTemplates.join(', ')}}
-
-      --use-npm                          Use npm to install dependencies
-      --no-deps                          Do not install any dependencies
-      --help                             Show help
-`;
-};
-
-const successMessage = async () => `
-  ${header('Launch Application:')}
-
-    - cd ${await getProjectDir()}
-    - ${await getPackageManager() === 'yarn' ? 'yarn' : 'npm run'} dev
-
-  ${header('Documentation:')}
-
-    - ${terminalLink('Getting Started', 'https://payloadcms.com/docs/getting-started/what-is-payload')}
-    - ${terminalLink('Configuration', 'https://payloadcms.com/docs/configuration/overview')}
-
-`;
-
-module.exports = {
-  welcomeMessage,
-  helpMessage,
-  successMessage,
-}

package/utils/usage.js

@@ -1,35 +0,0 @@
-const Sentry = require('@sentry/node');
-const os = require('os');
-
-const init = () => {
-  Sentry.init({
-    dsn: "https://139de3d0197f464082d5715a0c48a497@o589961.ingest.sentry.io/5739829",
-    tracesSampleRate: 1.0,
-  });
-
-  Sentry.setTags({
-    os_type: os.type(),
-    os_platform: os.platform(),
-    os_release: os.release(),
-    node_version: process.version,
-  });
-
-  return Sentry.startTransaction({
-    op: "create-payload-app",
-    name: "New Project",
-  });
-}
-
-const setTags = (tags) => {
-  Sentry.setTags({ ...tags });
-}
-
-const handleException = (e) => {
-  Sentry.captureException(e);
-}
-
-module.exports = {
-  init,
-  setTags,
-  handleException,
-};

package/utils/writeEnvFile.js

@@ -1,25 +0,0 @@
-const fs = require('fs-extra');
-const { getDatabaseConnection } = require('./getDatabaseConnection');
-const { getPayloadSecret } = require('./getPayloadSecret');
-const { getProjectDir } = require('./getProjectDir');
-const { error, success } = require('./log');
-
-const writeEnvFile = async () => {
-
-  const mongoURI = await getDatabaseConnection();
-  const payloadSecret = await getPayloadSecret();
-
-  let content = `MONGODB_URI=${mongoURI}\nPAYLOAD_SECRET=${payloadSecret}`;
-
-  try {
-    await fs.outputFile(`${await getProjectDir()}/.env`, content);
-    success('.env file created');
-  } catch (err) {
-    error('Unable to write .env file');
-    error(err);
-    process.exit(1);
-  }
-  return;
-};
-
-module.exports = { writeEnvFile };