create-docus 1.0.4 → 1.1.0

package/README.md

@@ -8,14 +8,45 @@ Add `docus` package globally:
 
 ```bash
 # Using Yarn
-yarn install --global docus
+yarn global add docus
+
 # Using NPM
 npm install --global docus
 ```
 
 ## Commands
 
-TODO
+### `npm init docus`
+
+This package is also responsible for the `npm init docus` command.
+
+You can use it without installing `docus` package globally.
+
+`--` is required as specified [here](https://docs.npmjs.com/cli/v7/commands/npm-init#forwarding-additional-options).
+
+```bash
+npm init docus -- path/to/project
+
+npm init docus -- --type="module" path/to/project
+
+npm init docus -- --type="theme" path/to/project
+```
+
+### `create-docus`
+
+If you install the `docus` package globally, it will be shipped with `create-docus` executable.
+
+This allows the creation of a [Docus project](https://github.com/docusgen/starter), a [theme](https://github.com/docusgen/theme-starter) or a [module](https://github.com/docusgen/module-starter).
+
+You can execute this command anywhere:
+
+```bash
+create-docus path/to/project
+
+create-docus --type="module" path/to/project
+
+create-docus --type="theme" path/to/project
+```
 
 ## Development
 

package/dist/create-docus/create-docus.js

@@ -1,4 +1,4 @@
-#\!/usr/bin/env node
+#!/usr/bin/env node
 // #!/usr/bin/env node
 "use strict";
 

package/dist/create-docus/helpers.js

@@ -0,0 +1,246 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.args = void 0;
+exports.createDir = createDir;
+exports.createProject = createProject;
+exports.cwd = void 0;
+exports.getProjectType = getProjectType;
+exports.getTargetDir = getTargetDir;
+exports.getTemplate = getTemplate;
+exports.getValidPackageName = getValidPackageName;
+exports.pkgManager = exports.log = void 0;
+
+var _package = require("../../package.json");
+
+var _fs = _interopRequireDefault(require("fs"));
+
+var _path = _interopRequireDefault(require("path"));
+
+var _kolorist = require("kolorist");
+
+var _minimist = _interopRequireDefault(require("minimist"));
+
+var _prompts = _interopRequireDefault(require("prompts"));
+
+var _degit = _interopRequireDefault(require("degit"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+const cwd = process.cwd();
+exports.cwd = cwd;
+const args = (0, _minimist.default)(process.argv.slice(2));
+exports.args = args;
+const pkgManager = /pnpm/.test(process.env.npm_execpath || "") || /pnpm/.test(process.env.npm_config_user_agent || "") ? "pnpm" : /yarn/.test(process.env.npm_execpath || "") ? "yarn" : "npm";
+exports.pkgManager = pkgManager;
+const log = {
+  space: () => console.log(),
+  bold: str => (0, _kolorist.bold)(str),
+  primary: str => (0, _kolorist.green)(str),
+  secondary: str => (0, _kolorist.dim)(str),
+  warning: str => (0, _kolorist.yellow)(str),
+  error: str => (0, _kolorist.red)(str),
+  broadcast: str => console.log(`  ${str}`),
+  motd: () => {
+    log.space();
+    log.broadcast(`${(0, _kolorist.bold)("Docus") + log.secondary(" CLI")} ${log.primary(`v${_package.version}`)}`);
+    log.space();
+  }
+};
+exports.log = log;
+const REPOSITORIES = {
+  website: "git@github.com:docusgen/starter.git",
+  theme: "git@github.com:docusgen/theme-starter.git",
+  module: "git@github.com:docusgen/module-starter.git"
+};
+
+function copyDir(srcDir, destDir) {
+  _fs.default.mkdirSync(destDir, {
+    recursive: true
+  });
+
+  for (const file of _fs.default.readdirSync(srcDir)) {
+    const srcFile = _path.default.resolve(srcDir, file);
+
+    const destFile = _path.default.resolve(destDir, file);
+
+    copy(srcFile, destFile);
+  }
+}
+
+function emptyDir(dir) {
+  if (!_fs.default.existsSync(dir)) return;
+
+  for (const file of _fs.default.readdirSync(dir)) {
+    const abs = _path.default.resolve(dir, file);
+
+    if (_fs.default.lstatSync(abs).isDirectory()) {
+      emptyDir(abs);
+
+      _fs.default.rmdirSync(abs);
+    } else {
+      _fs.default.unlinkSync(abs);
+    }
+  }
+}
+
+function copy(src, dest) {
+  const stat = _fs.default.statSync(src);
+
+  if (stat.isDirectory()) copyDir(src, dest);else _fs.default.copyFileSync(src, dest);
+}
+
+function getProjectType() {
+  switch (args["type"]) {
+    case "theme":
+      return "theme";
+
+    case "module":
+      return "module";
+
+    default:
+      return "website";
+  }
+}
+
+async function getTemplate(projectType) {
+  const {
+    broadcast,
+    primary,
+    secondary
+  } = log;
+
+  const templateDir = _path.default.join(__dirname, "./template");
+
+  broadcast([secondary("Cloning the latest"), primary(projectType === "website" ? "Docus" : projectType), secondary("template...")].join(" "));
+  emptyDir(templateDir);
+  const projectRepository = REPOSITORIES[projectType];
+  const repo = (0, _degit.default)(projectRepository, {
+    force: true,
+    verbose: true,
+    mode: "git"
+  });
+  await repo.clone(templateDir);
+  return templateDir;
+}
+
+async function createDir(targetDir) {
+  const projectPath = _path.default.join(cwd, targetDir);
+
+  const {
+    broadcast,
+    warning,
+    error,
+    space,
+    secondary
+  } = log;
+
+  if (!_fs.default.existsSync(projectPath)) {
+    _fs.default.mkdirSync(projectPath, {
+      recursive: true
+    });
+  } else {
+    const existing = _fs.default.readdirSync(projectPath);
+
+    const dir = projectPath.split("/");
+    const dirName = dir[dir.length - 1];
+
+    if (existing.length) {
+      space();
+      broadcast(warning(`Target directory "${dirName}" is not empty.`));
+      space();
+      const {
+        yes
+      } = await (0, _prompts.default)({
+        type: "confirm",
+        name: "yes",
+        initial: "Y",
+        message: "Remove existing files and continue?"
+      });
+      if (yes) emptyDir(projectPath);else {
+        space();
+        broadcast(warning(`Target directory is not empty and you do not want to overwrite it.`));
+        space();
+        broadcast(error(`Cancelling project creation.`));
+        process.exit(1);
+      }
+    }
+  }
+
+  space();
+  broadcast(secondary("Scaffolding project in ") + targetDir + secondary("..."));
+  return projectPath;
+}
+
+async function getValidPackageName(projectName) {
+  projectName = _path.default.basename(projectName);
+  const packageNameRegExp = /^(?:@[a-z0-9-*~][a-z0-9-*._~]*\/)?[a-z0-9-~][a-z0-9-._~]*$/;
+
+  if (packageNameRegExp.test(projectName)) {
+    return projectName;
+  } else {
+    const suggestedPackageName = projectName.trim().toLowerCase().replace(/\s+/g, "-").replace(/^[._]/, "").replace(/[^a-z0-9-~]+/g, "-");
+    const {
+      inputPackageName
+    } = await (0, _prompts.default)({
+      type: "text",
+      name: "inputPackageName",
+      message: "Package name:",
+      initial: suggestedPackageName,
+      validate: input => packageNameRegExp.test(input) ? true : "Invalid package.json name"
+    });
+    return inputPackageName;
+  }
+}
+
+async function getTargetDir(projectType) {
+  const {
+    space,
+    broadcast,
+    error,
+    warning
+  } = log;
+  let targetDir = args._[0];
+
+  if (!targetDir) {
+    const {
+      projectName
+    } = await (0, _prompts.default)({
+      type: "text",
+      name: "projectName",
+      message: "Project name:",
+      initial: `my-${projectType}`
+    });
+
+    if (!projectName) {
+      space();
+      broadcast(warning(`You must specify a project name.`));
+      space();
+      broadcast(error(`Cancelling project creation.`));
+      process.exit(1);
+    }
+
+    targetDir = projectName.trim();
+  }
+
+  return targetDir;
+}
+
+function createProject(root, templateDir, packageName) {
+  const write = (file, content = void 0) => {
+    const targetPath = _path.default.join(root, file);
+
+    if (content) _fs.default.writeFileSync(targetPath, content);else copy(_path.default.join(templateDir, file), targetPath);
+  };
+
+  const files = _fs.default.readdirSync(templateDir);
+
+  for (const file of files.filter(f => f !== "package.json")) write(file);
+
+  const pkg = require(_path.default.join(templateDir, "package.json"));
+
+  pkg.name = packageName;
+  write("package.json", JSON.stringify(pkg, null, 2));
+}

package/dist/create-docus/index.js

@@ -5,76 +5,34 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.createDocus = createDocus;
 
-var _fs = _interopRequireDefault(require("fs"));
-
-var _path = _interopRequireDefault(require("path"));
-
-var _minimist = _interopRequireDefault(require("minimist"));
+var _path = require("path");
 
 var _prompts = _interopRequireDefault(require("prompts"));
 
-var _execa = _interopRequireDefault(require("execa"));
+var _execa = require("execa");
 
-var _helpers = require("../helpers");
+var _helpers = require("./helpers");
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-const argv = (0, _minimist.default)(process.argv.slice(2));
 const {
   motd,
   primary,
   secondary,
+  warning,
   bold,
   space,
   broadcast
-} = (0, _helpers.log)();
-const cwd = process.cwd();
+} = _helpers.log;
 
 async function createDocus() {
   motd();
-  let targetDir = argv._[0];
-
-  if (!targetDir) {
-    const {
-      projectName
-    } = await (0, _prompts.default)({
-      type: "text",
-      name: "projectName",
-      message: "Project name:",
-      initial: "my-website"
-    });
-    targetDir = projectName.trim();
-  }
-
+  const projectType = (0, _helpers.getProjectType)();
+  const targetDir = await (0, _helpers.getTargetDir)(projectType);
   const packageName = await (0, _helpers.getValidPackageName)(targetDir);
-
-  const root = _path.default.join(cwd, targetDir);
-
-  await (0, _helpers.overwriteDir)(root);
-  space();
-  broadcast(secondary("Scaffolding project in ") + targetDir + secondary("..."));
-  const {
-    templateDir
-  } = await (0, _helpers.getTemplate)();
-
-  const write = (file, content = void 0) => {
-    const targetPath = _path.default.join(root, file);
-
-    if (content) _fs.default.writeFileSync(targetPath, content);else (0, _helpers.copy)(_path.default.join(templateDir, file), targetPath);
-  };
-
-  const files = _fs.default.readdirSync(templateDir);
-
-  for (const file of files.filter(f => f !== "package.json")) write(file);
-
-  const pkg = require(_path.default.join(templateDir, "package.json"));
-
-  pkg.name = packageName;
-  write("package.json", JSON.stringify(pkg, null, 2));
-  const pkgManager = /pnpm/.test(process.env.npm_execpath || "") || /pnpm/.test(process.env.npm_config_user_agent || "") ? "pnpm" : /yarn/.test(process.env.npm_execpath || "") ? "yarn" : "npm";
-
-  const related = _path.default.relative(cwd, root);
-
+  const projectPath = await (0, _helpers.createDir)(targetDir);
+  const templateDir = await (0, _helpers.getTemplate)(projectType);
+  (0, _helpers.createProject)(projectPath, templateDir, packageName);
   broadcast(primary("Done."));
   space();
   const {
@@ -85,7 +43,7 @@ async function createDocus() {
     initial: "Y",
     message: "Install and start it now?"
   });
-  if (yes) await startProject(root);else startItLater(pkgManager, root, related);
+  if (yes) await startProject(projectPath);else startItLater(projectPath);
 }
 
 async function startProject(projectPath) {
@@ -101,22 +59,29 @@ async function startProject(projectPath) {
       title: i
     }))
   });
-  if (!agent) return;
-  await (0, _execa.default)(agent, ["install"], {
+
+  if (!agent) {
+    space();
+    broadcast(warning(`You cancelled the agent selection!`));
+    return startItLater(projectPath);
+  }
+
+  await (0, _execa.execa)(agent, ["install"], {
     stdio: "inherit",
     cwd: projectPath
   });
-  await (0, _execa.default)(agent, ["run", "dev"], {
+  await (0, _execa.execa)(agent, ["run", "dev"], {
     stdio: "inherit",
     cwd: projectPath
   });
 }
 
-function startItLater(pkgManager, root, dir) {
+function startItLater(projectPath) {
   space();
   broadcast(secondary("Start it later with:"));
   space();
-  if (root !== cwd) broadcast(primary(`cd ${bold(dir)}`));
-  broadcast(primary(`${pkgManager === "yarn" ? "yarn" : `${pkgManager} install`}`));
-  broadcast(primary(`${pkgManager === "yarn" ? "yarn dev" : `${pkgManager} run dev`}`));
+  const dir = (0, _path.relative)(_helpers.cwd, projectPath);
+  if (projectPath !== _helpers.cwd) broadcast(primary(`cd ${bold(dir)}`));
+  broadcast(primary(`${_helpers.pkgManager === "yarn" ? "yarn" : `${_helpers.pkgManager} install`}`));
+  broadcast(primary(`${_helpers.pkgManager === "yarn" ? "yarn dev" : `${_helpers.pkgManager} run dev`}`));
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-docus",
-  "version": "1.0.4",
+  "version": "1.1.0",
   "description": "The Docus CLI.",
   "repository": "https://github.com/docusgen/cli",
   "bugs": {
@@ -38,24 +38,26 @@
   ],
   "dependencies": {
     "degit": "^2.8.4",
+    "execa": "^6.0.0",
     "kolorist": "^1.5.0",
     "minimist": "^1.2.5",
-    "prompts": "^2.4.1"
+    "prompts": "^2.4.2"
   },
   "devDependencies": {
     "@types/degit": "^2.8.3",
-    "@types/jest": "^27.0.1",
+    "@types/jest": "^27.0.3",
     "@types/minimist": "^1.2.2",
     "@types/prompts": "^2.0.14",
     "chokidar": "^3.5.2",
-    "jest": "^27.0.6",
-    "lint-staged": "^11.1.2",
+    "jest": "^27.3.1",
+    "jiti": "^1.12.9",
+    "lint-staged": "^12.1.2",
     "pascalcase": "^1.0.0",
-    "prettier": "^2.3.2",
-    "ts-jest": "^27.0.5",
-    "typescript": "^4.3.5",
-    "unbuild": "^0.4.2",
-    "jiti": "^1.11.0"
+    "prettier": "^2.4.1",
+    "ts-jest": "^27.0.7",
+    "typescript": "^4.5.2",
+    "unbuild": "^0.5.13",
+    "upath": "^2.0.1"
   },
   "gitHooks": {
     "pre-commit": "lint-staged"

package/dist/helpers.js

@@ -1,154 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.copy = copy;
-exports.log = log;
-exports.getTemplate = getTemplate;
-exports.overwriteDir = overwriteDir;
-exports.getValidPackageName = getValidPackageName;
-
-var _package = require("../package.json");
-
-var _fs = _interopRequireDefault(require("fs"));
-
-var _path = _interopRequireDefault(require("path"));
-
-var _kolorist = require("kolorist");
-
-var _prompts = _interopRequireDefault(require("prompts"));
-
-var _degit = _interopRequireDefault(require("degit"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-function copyDir(srcDir, destDir) {
-  _fs.default.mkdirSync(destDir, {
-    recursive: true
-  });
-
-  for (const file of _fs.default.readdirSync(srcDir)) {
-    const srcFile = _path.default.resolve(srcDir, file);
-
-    const destFile = _path.default.resolve(destDir, file);
-
-    copy(srcFile, destFile);
-  }
-}
-
-function emptyDir(dir) {
-  if (!_fs.default.existsSync(dir)) return;
-
-  for (const file of _fs.default.readdirSync(dir)) {
-    const abs = _path.default.resolve(dir, file);
-
-    if (_fs.default.lstatSync(abs).isDirectory()) {
-      emptyDir(abs);
-
-      _fs.default.rmdirSync(abs);
-    } else {
-      _fs.default.unlinkSync(abs);
-    }
-  }
-}
-
-function copy(src, dest) {
-  const stat = _fs.default.statSync(src);
-
-  if (stat.isDirectory()) copyDir(src, dest);else _fs.default.copyFileSync(src, dest);
-}
-
-function log() {
-  const commands = {
-    space: () => console.log(),
-    bold: str => (0, _kolorist.bold)(str),
-    primary: str => (0, _kolorist.green)(str),
-    secondary: str => (0, _kolorist.dim)(str),
-    warning: str => (0, _kolorist.yellow)(str),
-    broadcast: str => console.log(`  ${str}`),
-    motd: () => {
-      commands.space();
-      commands.broadcast(`${(0, _kolorist.bold)("Docus") + commands.secondary(" CLI")} ${commands.primary(`v${_package.version}`)}`);
-      commands.space();
-    }
-  };
-  return commands;
-}
-
-async function getTemplate() {
-  const {
-    broadcast,
-    primary,
-    secondary
-  } = log();
-
-  const templateDir = _path.default.join(__dirname, "./template");
-
-  broadcast([secondary("Cloning the latest"), primary("Docus"), secondary("template...")].join(" "));
-  emptyDir(templateDir);
-  const repo = (0, _degit.default)("git@github.com:docusgen/starter.git", {
-    force: true,
-    verbose: true,
-    mode: "git"
-  });
-  await repo.clone(templateDir);
-  return {
-    templateDir
-  };
-}
-
-async function overwriteDir(path2) {
-  const {
-    broadcast,
-    warning,
-    space
-  } = log();
-
-  if (!_fs.default.existsSync(path2)) {
-    _fs.default.mkdirSync(path2, {
-      recursive: true
-    });
-  } else {
-    const existing = _fs.default.readdirSync(path2);
-
-    const dir = path2.split("/");
-    const dirName = dir[dir.length - 1];
-
-    if (existing.length) {
-      space();
-      broadcast(warning(`Target directory "${dirName}" is not empty.`));
-      space();
-      const {
-        yes
-      } = await (0, _prompts.default)({
-        type: "confirm",
-        name: "yes",
-        initial: "Y",
-        message: "Remove existing files and continue?"
-      });
-      if (yes) emptyDir(path2);else return;
-    }
-  }
-}
-
-async function getValidPackageName(projectName) {
-  projectName = _path.default.basename(projectName);
-  const packageNameRegExp = /^(?:@[a-z0-9-*~][a-z0-9-*._~]*\/)?[a-z0-9-~][a-z0-9-._~]*$/;
-
-  if (packageNameRegExp.test(projectName)) {
-    return projectName;
-  } else {
-    const suggestedPackageName = projectName.trim().toLowerCase().replace(/\s+/g, "-").replace(/^[._]/, "").replace(/[^a-z0-9-~]+/g, "-");
-    const {
-      inputPackageName
-    } = await (0, _prompts.default)({
-      type: "text",
-      name: "inputPackageName",
-      message: "Package name:",
-      initial: suggestedPackageName,
-      validate: input => packageNameRegExp.test(input) ? true : "Invalid package.json name"
-    });
-    return inputPackageName;
-  }
-}