@mayrlabs/setup-project 0.1.3 → 0.1.4

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @mayrlabs/setup-project
 
+## 0.1.4
+
+### Patch Changes
+
+- bcab5ef: Error handling, and new services
+
 ## 0.1.3
 
 ### Patch Changes

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 MayR Labs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,65 +1,36 @@
 # @mayrlabs/setup-project
 
-An interactive CLI tool to quickly scaffold and configure common development tools for your projects.
+Interactive CLI to verify and configure common project tools for modern JavaScript/TypeScript applications.
 
 ## Features
 
-- **Interactive UI**: Uses `@clack/prompts` for a beautiful terminal experience.
-- **Tool Selection**: Multi-select support for:
-  - Husky (Git hooks)
-  - Prettier or Oxfmt (Formatter)
-  - ESLint or Oxlint (Linter)
-  - Lint-staged
-  - @t3-oss/env (Environment validation)
-- **Smart Configuration**:
-  - Automatically installs dependencies.
-  - Creates configuration files (`.prettierrc`, `.eslintrc.json`, `.lintstagedrc`, etc.).
-  - Sets up `pre-commit` hooks.
-  - Generates typesafe environment validation files (`env.ts` or `env/server.ts` + `env/client.ts`).
+- 🐶 **Husky**: Set up git hooks effortlessly.
+- 💅 **Formatter**: Choose between **Prettier** or **Oxfmt**.
+- 🧹 **Linter**: Choose between **ESLint** or **Oxlint**.
+- 🚫 **Lint-staged**: Automatically lint/format staged files with broad extension support.
+- 🌳 **Env Validation**: Set up **@t3-oss/env** for Next.js, Nuxt, or Core, with optional presets.
+- 🧪 **Testing**: Configure **Vitest** or **Jest**.
+- ⚙️ **EditorConfig**: Generate standardized `.editorconfig` files.
+- 📄 **License**: Generate MIT, ISC, or Apache-2.0 licenses.
+- 🛡️ **Git Safety**: Checks for uncommitted changes before making modifications.
 
 ## Usage
 
-Run the following command in your project root:
+Run the following command in your project directory:
 
 ```bash
 npx @mayrlabs/setup-project@latest
 ```
 
-Follow the interactive prompts to select the tools you need.
+The CLI will guide you through an interactive survey to select the tools you want to configure. No changes are made until you confirm the summary at the end.
 
-> [!WARNING]
-> This tool modifies configuration files. It is recommended to use it on a fresh project or commit your changes before running it.
+## How it works
 
-## Configuration Details
-
-### Husky
-
-- Initializes Husky.
-- Options to set up `lint-staged` or a custom script as a pre-commit hook.
-
-### Formatter
-
-- Choose between **Prettier** and **Oxfmt**.
-- Generates standard configuration.
-
-### Linter
-
-- Choose between **ESLint** and **Oxlint**.
-- Generates standard configuration.
-
-### Lint-staged
-
-- configure linting for js, ts, jsx, tsx.
-- configure formatting for md, css, json.
-- Automatically uses the selected linter and formatter.
-
-### Env Validation
-
-- Supports Next.js, Nuxt, and Core variants.
-- Choose validator: Zod, Valibot, or Arktype.
-- Install presets for common platforms (Vercel, Railway, etc.).
-- Generate split (`env/client.ts`, `env/server.ts`) or joined (`env.ts`) files.
+1. **Git Check**: Ensures your working directory is clean (or offers to commit changes).
+2. **Survey**: Asks you which tools you want to set up and collects your preferences.
+3. **Summary**: Shows a summary of the actions to be taken.
+4. **Execution**: Installs dependencies and creates configuration files tailored to your choices.
 
 ## License
 
-MIT
+MIT © [MayR Labs](https://mayrlabs.com)

package/dist/index.js

@@ -33,7 +33,7 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 ));
 
 // src/index.ts
-var import_prompts6 = require("@clack/prompts");
+var import_prompts9 = require("@clack/prompts");
 var import_picocolors = __toESM(require("picocolors"));
 var import_commander = require("commander");
 
@@ -376,6 +376,145 @@ export const env = createEnv({
   }
 }
 
+// src/services/test.ts
+var import_prompts6 = require("@clack/prompts");
+var import_fs_extra6 = __toESM(require("fs-extra"));
+async function promptTest(config) {
+  const runner = await (0, import_prompts6.select)({
+    message: "Select a test runner:",
+    options: [
+      { value: "vitest", label: "Vitest" },
+      { value: "jest", label: "Jest" }
+    ]
+  });
+  config.testRunner = runner;
+}
+async function installTest(config) {
+  if (config.testRunner === "vitest") {
+    await installPackages(["vitest"], true);
+    const configFile = "vitest.config.ts";
+    if (!await import_fs_extra6.default.pathExists(configFile)) {
+      await import_fs_extra6.default.outputFile(
+        configFile,
+        `import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+  test: {
+    environment: 'node',
+  },
+});
+`
+      );
+    }
+  } else if (config.testRunner === "jest") {
+    await installPackages(["jest", "ts-jest", "@types/jest"], true);
+    const configFile = "jest.config.js";
+    if (!await import_fs_extra6.default.pathExists(configFile)) {
+      await import_fs_extra6.default.outputFile(
+        configFile,
+        `/** @type {import('ts-jest').JestConfigWithTsJest} */
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+};
+`
+      );
+    }
+  }
+}
+
+// src/services/editor-config.ts
+var import_prompts7 = require("@clack/prompts");
+var import_fs_extra7 = __toESM(require("fs-extra"));
+async function promptEditorConfig(config) {
+  const preset = await (0, import_prompts7.select)({
+    message: "Select EditorConfig preset:",
+    options: [
+      { value: "default", label: "Default (Spaces 2)" },
+      { value: "spaces4", label: "Spaces 4" },
+      { value: "tabs", label: "Tabs" }
+    ]
+  });
+  config.editorConfigPreset = preset;
+}
+async function installEditorConfig(config) {
+  let content = "root = true\n\n[*]\ncharset = utf-8\nend_of_line = lf\ninsert_final_newline = true\ntrim_trailing_whitespace = true\n";
+  if (config.editorConfigPreset === "default" || config.editorConfigPreset === "spaces2") {
+    content += "indent_style = space\nindent_size = 2\n";
+  } else if (config.editorConfigPreset === "spaces4") {
+    content += "indent_style = space\nindent_size = 4\n";
+  } else if (config.editorConfigPreset === "tabs") {
+    content += "indent_style = tab\n";
+  }
+  await import_fs_extra7.default.outputFile(".editorconfig", content);
+}
+
+// src/services/license.ts
+var import_prompts8 = require("@clack/prompts");
+var import_fs_extra8 = __toESM(require("fs-extra"));
+var import_path2 = __toESM(require("path"));
+async function promptLicense(config) {
+  const name = await (0, import_prompts8.text)({
+    message: "License Holder Name:",
+    placeholder: "John Doe",
+    initialValue: config.authorName || ""
+  });
+  config.licenseName = name;
+  const email = await (0, import_prompts8.text)({
+    message: "License Holder Email:",
+    placeholder: "john@example.com"
+  });
+  config.licenseEmail = email;
+  const website = await (0, import_prompts8.text)({
+    message: "License Holder Website:",
+    placeholder: "https://example.com"
+  });
+  config.licenseWebsite = website;
+  const type = await (0, import_prompts8.select)({
+    message: "Select License Type:",
+    options: [
+      { value: "MIT", label: "MIT" },
+      { value: "ISC", label: "ISC" },
+      { value: "Apache-2.0", label: "Apache 2.0" },
+      { value: "UNLICENSED", label: "UNLICENSED" }
+    ]
+  });
+  config.licenseType = type;
+}
+async function installLicense(config) {
+  if (config.licenseType !== "UNLICENSED") {
+    const year = (/* @__PURE__ */ new Date()).getFullYear().toString();
+    const templatePath = import_path2.default.join(
+      __dirname,
+      "licenses",
+      `${config.licenseType}.txt`
+    );
+    if (await import_fs_extra8.default.pathExists(templatePath)) {
+      let licenseContent = await import_fs_extra8.default.readFile(templatePath, "utf-8");
+      licenseContent = licenseContent.replace(/{YEAR}/g, year);
+      licenseContent = licenseContent.replace(/{HOLDER}/g, config.licenseName);
+      licenseContent = licenseContent.replace(/{EMAIL}/g, config.licenseEmail);
+      licenseContent = licenseContent.replace(
+        /{WEBSITE}/g,
+        config.licenseWebsite
+      );
+      await import_fs_extra8.default.outputFile("LICENSE", licenseContent);
+    } else {
+      const simpleContent = `Copyright (c) ${year} ${config.licenseName}
+Licensed under ${config.licenseType}`;
+      await import_fs_extra8.default.outputFile("LICENSE", simpleContent);
+    }
+  }
+  if (await import_fs_extra8.default.pathExists("package.json")) {
+    const pkg = await import_fs_extra8.default.readJson("package.json");
+    pkg.license = config.licenseType;
+    if (config.licenseName) {
+      pkg.author = `${config.licenseName} <${config.licenseEmail}> (${config.licenseWebsite})`;
+    }
+    await import_fs_extra8.default.writeJson("package.json", pkg, { spaces: 2 });
+  }
+}
+
 // src/utils/git.ts
 var import_execa3 = require("execa");
 async function isGitRepository() {
@@ -402,7 +541,7 @@ async function commitChanges(message) {
 // package.json
 var package_default = {
   name: "@mayrlabs/setup-project",
-  version: "0.1.3",
+  version: "0.1.4",
   description: "Interactive CLI to setup project tools",
   private: false,
   publishConfig: {
@@ -435,7 +574,11 @@ var package_default = {
     directory: "packages/setup-project"
   },
   license: "MIT",
-  author: "Aghogho Meyoron <youngmayor.dev@gmail.com>",
+  author: {
+    name: "Aghogho Meyoron",
+    email: "youngmayor.dev@gmail.com",
+    url: "https://mayrlabs.com"
+  },
   type: "commonjs",
   main: "dist/index.js",
   scripts: {
@@ -459,106 +602,172 @@ var package_default = {
   }
 };
 
+// src/utils/logger.ts
+var import_fs_extra9 = __toESM(require("fs-extra"));
+var import_path3 = __toESM(require("path"));
+var LOG_DIR = ".mayrlabs/setup-project";
+var ERRORS_DIR = import_path3.default.join(LOG_DIR, "errors");
+async function logError(error) {
+  try {
+    await import_fs_extra9.default.ensureDir(ERRORS_DIR);
+    const gitignorePath = import_path3.default.join(LOG_DIR, ".gitignore");
+    if (!await import_fs_extra9.default.pathExists(gitignorePath)) {
+      await import_fs_extra9.default.outputFile(gitignorePath, "*\n");
+    }
+    const timestamp = (/* @__PURE__ */ new Date()).toISOString().replace(/[:.]/g, "-");
+    const logFile = import_path3.default.join(ERRORS_DIR, `log-${timestamp}.txt`);
+    const errorMessage = error instanceof Error ? error.stack || error.message : String(error);
+    const logContent = `Timestamp: ${(/* @__PURE__ */ new Date()).toISOString()}
+
+Error:
+${errorMessage}
+`;
+    await import_fs_extra9.default.outputFile(logFile, logContent);
+    return logFile;
+  } catch (e) {
+    console.error("Failed to log error:", e);
+    return "";
+  }
+}
+
 // src/index.ts
 async function main() {
-  (0, import_prompts6.intro)(import_picocolors.default.bgCyan(import_picocolors.default.black(" @mayrlabs/setup-project ")));
-  if (await isGitRepository()) {
-    if (await isGitDirty()) {
-      const shouldCommit = await (0, import_prompts6.confirm)({
-        message: "Your working directory is dirty. Would you like to commit changes before proceeding?"
-      });
-      if (shouldCommit) {
-        const message = await import("@clack/prompts").then(
-          (m) => m.text({
-            message: "Enter commit message:",
-            placeholder: "wip: pre-setup commit",
-            validate(value) {
-              if (value.length === 0) return "Commit message is required";
-            }
-          })
-        );
-        if (typeof message === "string") {
-          const s2 = (0, import_prompts6.spinner)();
-          s2.start("Committing changes...");
-          await commitChanges(message);
-          s2.stop("Changes committed.");
+  try {
+    (0, import_prompts9.intro)(import_picocolors.default.bgCyan(import_picocolors.default.black(" @mayrlabs/setup-project ")));
+    if (await isGitRepository()) {
+      if (await isGitDirty()) {
+        const shouldCommit = await (0, import_prompts9.confirm)({
+          message: "Your working directory is dirty. Would you like to commit changes before proceeding?"
+        });
+        if (shouldCommit) {
+          const message = await import("@clack/prompts").then(
+            (m) => m.text({
+              message: "Enter commit message:",
+              placeholder: "wip: pre-setup commit",
+              validate(value) {
+                if (value.length === 0) return "Commit message is required";
+              }
+            })
+          );
+          if (typeof message === "string") {
+            const s2 = (0, import_prompts9.spinner)();
+            s2.start("Committing changes...");
+            await commitChanges(message);
+            s2.stop("Changes committed.");
+          }
         }
       }
     }
-  }
-  const tools = await (0, import_prompts6.multiselect)({
-    message: "Select tools to configure:",
-    options: [
-      { value: "husky", label: "Husky" },
-      { value: "formatter", label: "Formatter (Prettier/Oxfmt)" },
-      { value: "linter", label: "Linter (Eslint/Oxlint)" },
-      { value: "lint-staged", label: "Lint-staged" },
-      { value: "env", label: "Env Validation (@t3-oss/env)" }
-    ],
-    required: false
-  });
-  if ((0, import_prompts6.isCancel)(tools)) {
-    (0, import_prompts6.cancel)("Operation cancelled.");
-    process.exit(0);
-  }
-  const selectedTools = tools;
-  const config = {
-    husky: selectedTools.includes("husky"),
-    formatter: selectedTools.includes("formatter"),
-    linter: selectedTools.includes("linter"),
-    lintStaged: selectedTools.includes("lint-staged"),
-    env: selectedTools.includes("env")
-  };
-  if (config.husky) await promptHusky(config);
-  if (config.formatter) await promptFormatter(config);
-  if (config.linter) await promptLinter(config);
-  if (config.lintStaged) await promptLintStaged(config);
-  if (config.env) await promptEnv(config);
-  let summary = "The following actions will be performed:\n\n";
-  if (config.husky) summary += "- Install and configure Husky\n";
-  if (config.formatter)
-    summary += `- Install and configure ${config.formatterChoice}
+    const tools = await (0, import_prompts9.multiselect)({
+      message: "Select tools to configure:",
+      options: [
+        { value: "husky", label: "Husky" },
+        { value: "formatter", label: "Formatter (Prettier/Oxfmt)" },
+        { value: "linter", label: "Linter (Eslint/Oxlint)" },
+        { value: "lint-staged", label: "Lint-staged" },
+        { value: "env", label: "Env Validation (@t3-oss/env)" },
+        { value: "test", label: "Test Runner (Vitest/Jest)" },
+        { value: "editorConfig", label: "EditorConfig" },
+        { value: "license", label: "License" }
+      ],
+      required: false
+    });
+    if ((0, import_prompts9.isCancel)(tools)) {
+      (0, import_prompts9.cancel)("Operation cancelled.");
+      process.exit(0);
+    }
+    const selectedTools = tools;
+    const config = {
+      husky: selectedTools.includes("husky"),
+      formatter: selectedTools.includes("formatter"),
+      linter: selectedTools.includes("linter"),
+      lintStaged: selectedTools.includes("lint-staged"),
+      env: selectedTools.includes("env"),
+      test: selectedTools.includes("test"),
+      editorConfig: selectedTools.includes("editorConfig"),
+      license: selectedTools.includes("license")
+    };
+    if (config.husky) await promptHusky(config);
+    if (config.formatter) await promptFormatter(config);
+    if (config.linter) await promptLinter(config);
+    if (config.lintStaged) await promptLintStaged(config);
+    if (config.env) await promptEnv(config);
+    if (config.test) await promptTest(config);
+    if (config.editorConfig) await promptEditorConfig(config);
+    if (config.license) await promptLicense(config);
+    let summary = "The following actions will be performed:\n\n";
+    if (config.husky) summary += "- Install and configure Husky\n";
+    if (config.formatter)
+      summary += `- Install and configure ${config.formatterChoice}
 `;
-  if (config.linter)
-    summary += `- Install and configure ${config.linterChoice}
+    if (config.linter)
+      summary += `- Install and configure ${config.linterChoice}
 `;
-  if (config.lintStaged) summary += "- Install and configure Lint-staged\n";
-  if (config.env) summary += "- Install and configure @t3-oss/env\n";
-  (0, import_prompts6.note)(summary, "Configuration Summary");
-  const proceed = await (0, import_prompts6.confirm)({
-    message: "Do you want to proceed with the installation?"
-  });
-  if (!proceed || (0, import_prompts6.isCancel)(proceed)) {
-    (0, import_prompts6.cancel)("Installation cancelled. Configuration saved.");
-    process.exit(0);
-  }
-  const s = (0, import_prompts6.spinner)();
-  if (config.husky) {
-    s.start("Setting up Husky...");
-    await installHusky(config);
-    s.stop("Husky setup complete.");
-  }
-  if (config.formatter) {
-    s.start(`Setting up ${config.formatterChoice}...`);
-    await installFormatter(config);
-    s.stop(`${config.formatterChoice} setup complete.`);
-  }
-  if (config.linter) {
-    s.start(`Setting up ${config.linterChoice}...`);
-    await installLinter(config);
-    s.stop(`${config.linterChoice} setup complete.`);
-  }
-  if (config.lintStaged) {
-    s.start("Setting up Lint-staged...");
-    await installLintStaged(config);
-    s.stop("Lint-staged setup complete.");
-  }
-  if (config.env) {
-    s.start("Setting up Env Validation...");
-    await installEnv(config);
-    s.stop("Env Validation setup complete.");
+    if (config.lintStaged) summary += "- Install and configure Lint-staged\n";
+    if (config.env) summary += "- Install and configure @t3-oss/env\n";
+    if (config.test)
+      summary += `- Install and configure ${config.testRunner}
+`;
+    if (config.editorConfig) summary += "- Create .editorconfig\n";
+    if (config.license) summary += `- Create LICENSE (${config.licenseType})
+`;
+    (0, import_prompts9.note)(summary, "Configuration Summary");
+    const proceed = await (0, import_prompts9.confirm)({
+      message: "Do you want to proceed with the installation?"
+    });
+    if (!proceed || (0, import_prompts9.isCancel)(proceed)) {
+      (0, import_prompts9.cancel)("Installation cancelled. Configuration saved.");
+      process.exit(0);
+    }
+    const s = (0, import_prompts9.spinner)();
+    if (config.husky) {
+      s.start("Setting up Husky...");
+      await installHusky(config);
+      s.stop("Husky setup complete.");
+    }
+    if (config.formatter) {
+      s.start(`Setting up ${config.formatterChoice}...`);
+      await installFormatter(config);
+      s.stop(`${config.formatterChoice} setup complete.`);
+    }
+    if (config.linter) {
+      s.start(`Setting up ${config.linterChoice}...`);
+      await installLinter(config);
+      s.stop(`${config.linterChoice} setup complete.`);
+    }
+    if (config.lintStaged) {
+      s.start("Setting up Lint-staged...");
+      await installLintStaged(config);
+      s.stop("Lint-staged setup complete.");
+    }
+    if (config.env) {
+      s.start("Setting up Env Validation...");
+      await installEnv(config);
+      s.stop("Env Validation setup complete.");
+    }
+    if (config.test) {
+      s.start(`Setting up ${config.testRunner}...`);
+      await installTest(config);
+      s.stop(`${config.testRunner} setup complete.`);
+    }
+    if (config.editorConfig) {
+      s.start("Creating .editorconfig...");
+      await installEditorConfig(config);
+      s.stop(".editorconfig created.");
+    }
+    if (config.license) {
+      s.start("Creating LICENSE...");
+      await installLicense(config);
+      s.stop("LICENSE created.");
+    }
+    (0, import_prompts9.outro)(import_picocolors.default.green("Setup complete!"));
+  } catch (error) {
+    const logPath = await logError(error);
+    (0, import_prompts9.outro)(import_picocolors.default.red(`
+Something went wrong!
+Error log saved to: ${logPath}`));
+    process.exit(1);
   }
-  (0, import_prompts6.outro)(import_picocolors.default.green("Setup complete!"));
 }
 import_commander.program.name("setup-project").description("Interactive setup for common project tools").version(package_default.version).action(main);
 import_commander.program.parse();
@@ -568,4 +777,3 @@ import_commander.program.parse();
  * Software should feel intentional.
  */
 
-//# sourceMappingURL=index.js.map