create-payload-app 0.3.14 → 0.3.15-beta.0

package/dist/index.js

@@ -37,31 +37,19 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 var main_1 = require("./main");
-var usage_1 = require("./utils/usage");
 var log_1 = require("./utils/log");
-(function () { return __awaiter(void 0, void 0, void 0, function () {
-    var trx, main, e_1;
-    return __generator(this, function (_a) {
-        switch (_a.label) {
-            case 0:
-                trx = (0, usage_1.init)();
-                main = new main_1.Main();
-                _a.label = 1;
-            case 1:
-                _a.trys.push([1, 3, 4, 5]);
-                return [4 /*yield*/, main.init()];
-            case 2:
-                _a.sent();
-                return [3 /*break*/, 5];
-            case 3:
-                e_1 = _a.sent();
-                (0, usage_1.handleException)(e_1);
-                (0, log_1.error)("An error has occurred: ".concat(e_1 instanceof Error ? e_1.message : e_1));
-                return [3 /*break*/, 5];
-            case 4:
-                trx === null || trx === void 0 ? void 0 : trx.finish();
-                return [7 /*endfinally*/];
-            case 5: return [2 /*return*/];
-        }
+function main() {
+    return __awaiter(this, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, new main_1.Main().init()];
+                case 1:
+                    _a.sent();
+                    return [2 /*return*/];
+            }
+        });
     });
-}); })();
+}
+main().catch(function (e) {
+    return (0, log_1.error)("An error has occurred: ".concat(e instanceof Error ? e.message : e));
+});

package/dist/lib/common-files/README.template.md

@@ -0,0 +1,9 @@
+# {{projectName}}
+
+This project was created using create-payload-app using the {{templateName}} template.
+
+## How to Use
+
+`yarn dev` will start up your application and reload on any changes.
+
+If you have docker and docker-compose installed, you can run `docker-compose up`

package/dist/lib/common-files/docker-compose.template.yml

@@ -0,0 +1,35 @@
+version: '3'
+
+services:
+
+  payload:
+    image: node:18-alpine
+    ports:
+      - "3000:3000"
+    volumes:
+      - .:/home/node/app
+      - node_modules:/home/node/app/node_modules
+    working_dir: /home/node/app/
+    command: sh -c "{{installCmd}} && {{devCmd}}"
+    depends_on:
+      - mongo
+    environment:
+      MONGODB_URI: mongodb://mongo:27017/payload
+      PORT: 3000
+      NODE_ENV: development
+      PAYLOAD_SECRET: TESTING
+
+  mongo:
+    image: mongo:latest
+    ports:
+      - "27017:27017"
+    command:
+      - --storageEngine=wiredTiger
+    volumes:
+      - data:/data/db
+    logging:
+      driver: none
+
+volumes:
+  data:
+  node_modules:

package/dist/{templates/js-blank/package.json → lib/common-files/javascript/package.template.json}

@@ -1,6 +1,6 @@
 {
-  "name": "payload-starter-javascript",
-  "description": "Blank template - no collections",
+  "name": "payload-template-{{templateName}}",
+  "description": "Payload project created from {{templateName}} template",
   "version": "1.0.0",
   "main": "server.js",
   "license": "MIT",
@@ -10,7 +10,7 @@
     "serve": "NODE_ENV=production node server.js"
   },
   "dependencies": {
-    "payload": "1.0.8",
+    "payload": "1.1.17",
     "dotenv": "^8.2.0",
     "express": "^4.17.1"
   },

package/dist/{templates/ts-blank/package.json → lib/common-files/typescript/package.template.json}

@@ -1,6 +1,6 @@
 {
-  "name": "payload-starter-typescript",
-  "description": "Blank template - no collections",
+  "name": "payload-template-{{templateName}}",
+  "description": "Payload project created from {{templateName}} template",
   "version": "1.0.0",
   "main": "dist/server.js",
   "license": "MIT",
@@ -15,7 +15,7 @@
     "generate:graphQLSchema": "PAYLOAD_CONFIG_PATH=src/payload.config.ts payload generate:graphQLSchema"
   },
   "dependencies": {
-    "payload": "1.0.8",
+    "payload": "1.1.17",
     "dotenv": "^8.2.0",
     "express": "^4.17.1"
   },
@@ -25,6 +25,6 @@
     "nodemon": "^2.0.6",
     "ts-node": "^9.1.1",
     "copyfiles": "^2.4.1",
-    "typescript": "^4.1.3"
+    "typescript": "^4.8.4"
   }
 }

package/dist/lib/{createProject.js → create-project.js}

@@ -47,7 +47,7 @@ var execa_1 = __importDefault(require("execa"));
 var ora_1 = __importDefault(require("ora"));
 var degit_1 = __importDefault(require("degit"));
 var log_1 = require("../utils/log");
-var usage_1 = require("../utils/usage");
+var write_common_files_1 = require("./write-common-files");
 function createProjectDir(projectDir) {
     return __awaiter(this, void 0, void 0, function () {
         var pathExists;
@@ -70,7 +70,7 @@ function createProjectDir(projectDir) {
 }
 function installDeps(args, dir, packageManager) {
     return __awaiter(this, void 0, void 0, function () {
-        var cmd, error_1;
+        var cmd, err_1;
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0:
@@ -88,7 +88,7 @@ function installDeps(args, dir, packageManager) {
                     _a.sent();
                     return [2 /*return*/, true];
                 case 3:
-                    error_1 = _a.sent();
+                    err_1 = _a.sent();
                     return [2 /*return*/, false];
                 case 4: return [2 /*return*/];
             }
@@ -98,7 +98,7 @@ function installDeps(args, dir, packageManager) {
 function getLatestPayloadVersion(betaFlag) {
     if (betaFlag === void 0) { betaFlag = false; }
     return __awaiter(this, void 0, void 0, function () {
-        var packageWithTag, stdout, error_2;
+        var packageWithTag, stdout, err_2;
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0:
@@ -113,7 +113,11 @@ function getLatestPayloadVersion(betaFlag) {
                     stdout = (_a.sent()).stdout;
                     return [2 /*return*/, "^".concat(stdout)];
                 case 2:
-                    error_2 = _a.sent();
+                    err_2 = _a.sent();
+                    if (err_2 instanceof Error) {
+                        console.error(err_2.message);
+                        console.error(err_2.stack);
+                    }
                     return [2 /*return*/, false];
                 case 3: return [2 /*return*/];
             }
@@ -124,7 +128,7 @@ exports.getLatestPayloadVersion = getLatestPayloadVersion;
 function updatePayloadVersion(projectDir, betaFlag) {
     if (betaFlag === void 0) { betaFlag = false; }
     return __awaiter(this, void 0, void 0, function () {
-        var payloadVersion, packageJsonPath, packageObj, err_1;
+        var payloadVersion, packageJsonPath, packageObj, err_3;
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0: return [4 /*yield*/, getLatestPayloadVersion(betaFlag)];
@@ -134,7 +138,6 @@ function updatePayloadVersion(projectDir, betaFlag) {
                         (0, log_1.warning)('Error retrieving latest Payload version. Please update your package.json manually.');
                         return [2 /*return*/];
                     }
-                    (0, usage_1.setTags)({ payload_version: payloadVersion });
                     packageJsonPath = path_1.default.resolve(projectDir, 'package.json');
                     _a.label = 2;
                 case 2:
@@ -148,7 +151,7 @@ function updatePayloadVersion(projectDir, betaFlag) {
                     _a.sent();
                     return [3 /*break*/, 6];
                 case 5:
-                    err_1 = _a.sent();
+                    err_3 = _a.sent();
                     (0, log_1.warning)('Unable to write Payload version to package.json. Please update your package.json manually.');
                     return [3 /*break*/, 6];
                 case 6: return [2 /*return*/];
@@ -159,7 +162,7 @@ function updatePayloadVersion(projectDir, betaFlag) {
 exports.updatePayloadVersion = updatePayloadVersion;
 function createProject(args, projectDir, template, packageManager) {
     return __awaiter(this, void 0, void 0, function () {
-        var templateDir, emitter, src, dest, gi, giDest, err_2, msg, spinner, result;
+        var templateDir, emitter, err_4, msg, spinner, result;
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0: return [4 /*yield*/, createProjectDir(projectDir)];
@@ -172,38 +175,34 @@ function createProject(args, projectDir, template, packageManager) {
                     return [4 /*yield*/, emitter.clone(projectDir)];
                 case 2:
                     _a.sent();
-                    return [3 /*break*/, 8];
+                    return [3 /*break*/, 7];
                 case 3:
-                    _a.trys.push([3, 7, , 8]);
+                    _a.trys.push([3, 6, , 7]);
                     return [4 /*yield*/, fs_extra_1.default.copy(templateDir, projectDir, { recursive: true })];
                 case 4:
                     _a.sent();
-                    src = path_1.default.resolve(templateDir, '..', 'npmrc.template');
-                    dest = path_1.default.resolve(projectDir, '.npmrc');
-                    return [4 /*yield*/, fs_extra_1.default.copy(src, dest)];
+                    return [4 /*yield*/, (0, write_common_files_1.writeCommonFiles)(projectDir, template, packageManager)];
                 case 5:
-                    _a.sent();
-                    gi = path_1.default.resolve(templateDir, '..', 'gitignore.template');
-                    giDest = path_1.default.resolve(projectDir, '.gitignore');
-                    return [4 /*yield*/, fs_extra_1.default.copy(gi, giDest)];
-                case 6:
                     _a.sent();
                     (0, log_1.success)('Project directory created');
-                    return [3 /*break*/, 8];
-                case 7:
-                    err_2 = _a.sent();
+                    return [3 /*break*/, 7];
+                case 6:
+                    err_4 = _a.sent();
                     msg = 'Unable to copy template files. Please check template name or directory permissions.';
                     (0, log_1.error)(msg);
+                    if (err_4 instanceof Error) {
+                        console.error({ err: err_4 });
+                    }
                     process.exit(1);
-                    return [3 /*break*/, 8];
-                case 8:
+                    return [3 /*break*/, 7];
+                case 7:
                     spinner = (0, ora_1.default)('Checking latest Payload version...').start();
                     return [4 /*yield*/, updatePayloadVersion(projectDir, args['--beta'])];
-                case 9:
+                case 8:
                     _a.sent();
                     spinner.text = 'Installing dependencies...';
                     return [4 /*yield*/, installDeps(args, projectDir, packageManager)];
-                case 10:
+                case 9:
                     result = _a.sent();
                     spinner.stop();
                     spinner.clear();

package/dist/lib/{createProject.test.js → create-project.test.js}

@@ -41,9 +41,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 var fs_extra_1 = __importDefault(require("fs-extra"));
 var path_1 = __importDefault(require("path"));
-var createProject_1 = require("./createProject");
+var create_project_1 = require("./create-project");
+var projectDir = path_1.default.resolve(__dirname, './tmp');
 describe('createProject', function () {
-    var projectDir = path_1.default.resolve(__dirname, './tmp');
     beforeAll(function () {
         console.log = jest.fn();
     });
@@ -58,22 +58,36 @@ describe('createProject', function () {
         }
     });
     describe('#createProject', function () {
+        // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
         var args = { _: ['project-name'], '--no-deps': true };
         var packageManager = 'yarn';
         it('creates static project', function () { return __awaiter(void 0, void 0, void 0, function () {
             var expectedPayloadVersion, template, packageJsonPath, packageJson;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, (0, createProject_1.getLatestPayloadVersion)()];
+                    case 0: return [4 /*yield*/, (0, create_project_1.getLatestPayloadVersion)()];
                     case 1:
                         expectedPayloadVersion = _a.sent();
-                        template = { name: 'ts-todo', type: 'static' };
-                        return [4 /*yield*/, (0, createProject_1.createProject)(args, projectDir, template, packageManager)];
+                        template = {
+                            name: 'ts-todo',
+                            type: 'static',
+                            language: 'typescript',
+                        };
+                        return [4 /*yield*/, (0, create_project_1.createProject)(args, projectDir, template, packageManager)];
                     case 2:
                         _a.sent();
                         packageJsonPath = path_1.default.resolve(projectDir, 'package.json');
                         packageJson = fs_extra_1.default.readJsonSync(packageJsonPath);
                         expect(packageJson.dependencies.payload).toBe(expectedPayloadVersion);
+                        // Check package name comtains template name
+                        expect(packageJson.name).toContain('ts-todo');
+                        // Check all common files are create
+                        assertProjectFileExists('.npmrc');
+                        assertProjectFileExists('.gitignore');
+                        assertProjectFileExists('nodemon.json');
+                        assertProjectFileExists('README.md');
+                        assertProjectFileExists('tsconfig.json');
+                        assertProjectFileExists('docker-compose.yml');
                         return [2 /*return*/];
                 }
             });
@@ -92,7 +106,7 @@ describe('createProject', function () {
                         return [4 /*yield*/, fs_extra_1.default.writeJson(packageJsonPath, { dependencies: { payload: '0.0.1' } }, { spaces: 2 })];
                     case 2:
                         _a.sent();
-                        return [4 /*yield*/, (0, createProject_1.updatePayloadVersion)(projectDir)];
+                        return [4 /*yield*/, (0, create_project_1.updatePayloadVersion)(projectDir)];
                     case 3:
                         _a.sent();
                         return [4 /*yield*/, fs_extra_1.default.readJson(packageJsonPath)];
@@ -105,3 +119,19 @@ describe('createProject', function () {
         }); });
     });
 });
+function assertProjectFileExists(fileName) {
+    return __awaiter(this, void 0, void 0, function () {
+        var filePath, _a;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    filePath = path_1.default.resolve(projectDir, fileName);
+                    _a = expect;
+                    return [4 /*yield*/, fs_extra_1.default.pathExists(filePath)];
+                case 1:
+                    _a.apply(void 0, [_b.sent()]).toBe(true);
+                    return [2 /*return*/];
+            }
+        });
+    });
+}

package/dist/lib/{parseTemplate.js → parse-template.js}

@@ -41,7 +41,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseTemplate = void 0;
 var prompts_1 = __importDefault(require("prompts"));
-var usage_1 = require("../utils/usage");
 function parseTemplate(args, validTemplates, language) {
     return __awaiter(this, void 0, void 0, function () {
         var templateName_1, template_1, filteredTemplates, response, template;
@@ -50,10 +49,9 @@ function parseTemplate(args, validTemplates, language) {
                 case 0:
                     if (args['--template']) {
                         templateName_1 = args['--template'];
-                        template_1 = validTemplates.find(function (template) { return template.name === templateName_1; });
+                        template_1 = validTemplates.find(function (t) { return t.name === templateName_1; });
                         if (!template_1)
                             throw new Error('Invalid template given');
-                        (0, usage_1.setTags)({ template: template_1.name });
                         return [2 /*return*/, template_1];
                     }
                     filteredTemplates = validTemplates
@@ -79,7 +77,6 @@ function parseTemplate(args, validTemplates, language) {
                     template = validTemplates.find(function (t) { return t.name === response.value; });
                     if (!template)
                         throw new Error('Template is undefined');
-                    (0, usage_1.setTags)({ template: template.name });
                     return [2 /*return*/, template];
             }
         });

package/dist/lib/templates.js

@@ -69,7 +69,11 @@ function getValidTemplates() {
             templateDir = path_1.default.resolve(__dirname, '../templates');
             dirs = getDirectories(templateDir);
             templates = dirs.map(function (name) {
-                return { name: name, type: 'static' };
+                return {
+                    name: name,
+                    type: 'static',
+                    language: name.startsWith('js-') ? 'javascript' : 'typescript',
+                };
             });
             return [2 /*return*/, templates];
         });
@@ -78,6 +82,6 @@ function getValidTemplates() {
 exports.getValidTemplates = getValidTemplates;
 function getDirectories(dir) {
     return fs_1.default.readdirSync(dir).filter(function (file) {
-        return fs_1.default.statSync(dir + '/' + file).isDirectory();
+        return fs_1.default.statSync("".concat(dir, "/").concat(file)).isDirectory();
     });
 }

package/dist/lib/write-common-files.js

@@ -0,0 +1,118 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.writeCommonFiles = void 0;
+var path_1 = __importDefault(require("path"));
+var fs_extra_1 = __importDefault(require("fs-extra"));
+var handlebars_1 = __importDefault(require("handlebars"));
+function writeCommonFiles(projectDir, template, packageManager) {
+    return __awaiter(this, void 0, void 0, function () {
+        var commonFilesDir, npmrc, npmrcDest, gi, giDest, packageJsonTemplate, packageJson, nodemon, nodemonDest, readmeTemplate, readme, tsconfig, tsconfigDest, dockerComposeTemplate, dockerCompose;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    commonFilesDir = path_1.default.resolve(__dirname, 'common-files');
+                    npmrc = path_1.default.resolve(commonFilesDir, 'npmrc.template');
+                    npmrcDest = path_1.default.resolve(projectDir, '.npmrc');
+                    return [4 /*yield*/, fs_extra_1.default.copy(npmrc, npmrcDest)
+                        // .gitignore
+                    ];
+                case 1:
+                    _a.sent();
+                    gi = path_1.default.resolve(commonFilesDir, 'gitignore.template');
+                    giDest = path_1.default.resolve(projectDir, '.gitignore');
+                    return [4 /*yield*/, fs_extra_1.default.copy(gi, giDest)
+                        // package.json
+                    ];
+                case 2:
+                    _a.sent();
+                    return [4 /*yield*/, fs_extra_1.default.readFile(path_1.default.resolve(commonFilesDir, template.language, 'package.template.json'), 'utf8')];
+                case 3:
+                    packageJsonTemplate = _a.sent();
+                    packageJson = handlebars_1.default.compile(packageJsonTemplate)({
+                        templateName: template.name,
+                    });
+                    return [4 /*yield*/, fs_extra_1.default.writeFile(path_1.default.resolve(projectDir, 'package.json'), packageJson)
+                        // nodemon.json
+                    ];
+                case 4:
+                    _a.sent();
+                    nodemon = path_1.default.resolve(commonFilesDir, template.language, 'nodemon.json');
+                    nodemonDest = path_1.default.resolve(projectDir, 'nodemon.json');
+                    return [4 /*yield*/, fs_extra_1.default.copy(nodemon, nodemonDest)
+                        // README.md
+                    ];
+                case 5:
+                    _a.sent();
+                    return [4 /*yield*/, fs_extra_1.default.readFile(path_1.default.resolve(commonFilesDir, 'README.template.md'), 'utf8')];
+                case 6:
+                    readmeTemplate = _a.sent();
+                    readme = handlebars_1.default.compile(readmeTemplate)({
+                        projectName: path_1.default.basename(projectDir),
+                        templateName: template.name,
+                    });
+                    return [4 /*yield*/, fs_extra_1.default.writeFile(path_1.default.resolve(projectDir, 'README.md'), readme)
+                        // tsconfig.json
+                    ];
+                case 7:
+                    _a.sent();
+                    if (!(template.language === 'typescript')) return [3 /*break*/, 9];
+                    tsconfig = path_1.default.resolve(commonFilesDir, template.language, 'tsconfig.json');
+                    tsconfigDest = path_1.default.resolve(projectDir, 'tsconfig.json');
+                    return [4 /*yield*/, fs_extra_1.default.copy(tsconfig, tsconfigDest)];
+                case 8:
+                    _a.sent();
+                    _a.label = 9;
+                case 9: return [4 /*yield*/, fs_extra_1.default.readFile(path_1.default.resolve(commonFilesDir, 'docker-compose.template.yml'), 'utf8')];
+                case 10:
+                    dockerComposeTemplate = _a.sent();
+                    dockerCompose = handlebars_1.default.compile(dockerComposeTemplate)(packageManager === 'yarn'
+                        ? { installCmd: 'yarn install', devCmd: 'yarn dev' }
+                        : { installCmd: 'npm install', devCmd: 'npm run dev' });
+                    return [4 /*yield*/, fs_extra_1.default.writeFile(path_1.default.resolve(projectDir, 'docker-compose.yml'), dockerCompose)];
+                case 11:
+                    _a.sent();
+                    return [2 /*return*/];
+            }
+        });
+    });
+}
+exports.writeCommonFiles = writeCommonFiles;