@firenet-designs/fnd-cli 1.0.1

package/README.md

@@ -0,0 +1,75 @@
+fnd
+=================
+
+A new CLI generated with oclif
+
+
+[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
+[![Version](https://img.shields.io/npm/v/fnd.svg)](https://npmjs.org/package/fnd)
+[![Downloads/week](https://img.shields.io/npm/dw/fnd.svg)](https://npmjs.org/package/fnd)
+
+
+<!-- toc -->
+* [Usage](#usage)
+* [Commands](#commands)
+<!-- tocstop -->
+# Usage
+<!-- usage -->
+```sh-session
+$ npm install -g @firenet-designs/fnd-cli
+$ fnd-cli COMMAND
+running command...
+$ fnd-cli (--version)
+@firenet-designs/fnd-cli/1.0.1 darwin-x64 node-v24.12.0
+$ fnd-cli --help [COMMAND]
+USAGE
+  $ fnd-cli COMMAND
+...
+```
+<!-- usagestop -->
+# Commands
+<!-- commands -->
+* [`fnd-cli create-app`](#fnd-cli-create-app)
+* [`fnd-cli help [COMMAND]`](#fnd-cli-help-command)
+
+## `fnd-cli create-app`
+
+sets up a preconfigued vite app directory on for a shopify theme
+
+```
+USAGE
+  $ fnd-cli create-app [-d <value>] [-s]
+
+FLAGS
+  -d, --dir=<value>  [default: src] directory to create the vite app in
+  -s, --skip-check   skips the checking of the parent directory for a shopify theme
+
+DESCRIPTION
+  sets up a preconfigued vite app directory on for a shopify theme
+
+EXAMPLES
+  $ fnd-cli create-app
+```
+
+_See code: [src/commands/create-app.ts](https://github.com/FireNet-Designs/fnd-cli/blob/v1.0.1/src/commands/create-app.ts)_
+
+## `fnd-cli help [COMMAND]`
+
+Display help for fnd-cli.
+
+```
+USAGE
+  $ fnd-cli help [COMMAND...] [-n]
+
+ARGUMENTS
+  [COMMAND...]  Command to show help for.
+
+FLAGS
+  -n, --nested-commands  Include all nested commands in the output.
+
+DESCRIPTION
+  Display help for fnd-cli.
+```
+
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.37/src/commands/help.ts)_
+<!-- commandsstop -->

package/bin/dev.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node --loader ts-node/esm --no-warnings=ExperimentalWarning "%~dp0\dev" %*

package/bin/dev.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env -S node --loader ts-node/esm --disable-warning=ExperimentalWarning
+
+import {execute} from '@oclif/core'
+
+await execute({development: true, dir: import.meta.url})

package/bin/run.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\run" %*

package/bin/run.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+import {execute} from '@oclif/core'
+
+await execute({dir: import.meta.url})

package/dist/commands/create-app.d.ts

@@ -0,0 +1,10 @@
+import { Command } from '@oclif/core';
+export default class CreateApp extends Command {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        dir: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        'skip-check': import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    run(): Promise<void>;
+}

package/dist/commands/create-app.js

@@ -0,0 +1,154 @@
+import { Command, Flags } from '@oclif/core';
+import chalk from 'chalk';
+import { spawn } from 'node:child_process';
+import { mkdirSync, rmSync, statSync } from 'node:fs';
+import { join, resolve } from 'node:path';
+import ora from 'ora';
+import { simpleGit } from 'simple-git';
+/**
+ * Executes a series of shell commands sequentially in a single shell session.
+ *
+ * This function takes an array of shell commands and executes them in sequence
+ * within a single shell session, sourcing the user's zsh configuration first.
+ * It provides callbacks for handling stdout and stderr data as it's received,
+ * and returns the final output, error, and exit code.
+ *
+ * @param commands - An array of shell commands to execute
+ * @param options - Execution options including environment variables and callbacks
+ * @returns A promise that resolves with the command output, error, and exit code
+ */
+const execCommands = async (commands, options) => {
+    const cmdStr = ['source ~/.zshrc', ...commands].join(' && ');
+    return new Promise((resolve) => {
+        let stdout = '';
+        let stderr = '';
+        let output = '';
+        const child = spawn(cmdStr, {
+            ...options,
+            shell: 'zsh',
+        });
+        child.stdout.on('data', (data) => {
+            stdout += data;
+            output += data;
+            options.onOutput?.(output);
+            options.onStdout?.(stdout);
+        });
+        child.stderr.on('data', (data) => {
+            stderr += data;
+            output += data;
+            options.onOutput?.(output);
+            options.onStderr?.(stderr);
+        });
+        child.on('close', (code) => {
+            resolve({ code, output, stderr, stdout });
+        });
+    });
+};
+/**
+ * Checks if a directory exists at the specified path.
+ *
+ * This function attempts to retrieve the file status of the given directory path.
+ * If the operation succeeds, it means the directory exists; otherwise, it throws
+ * an error indicating that the directory does not exist.
+ *
+ * @param dirPath - The path to the directory to check
+ * @returns true if the directory exists, false otherwise
+ */
+const checkDirectoryExists = (dirPath) => {
+    try {
+        statSync(dirPath);
+        return true;
+    }
+    catch {
+        return false;
+    }
+};
+class OutputFormatter {
+    tail;
+    formatting;
+    onData = (data) => {
+        const lines = data.split('\n').slice(-this.tail);
+        const str = lines.join('\n');
+        this.ora.suffixText = this.formatting
+            ? this.formatting(`\n${str}`.trimEnd())
+            : `\n${str}`.trimEnd();
+    };
+    setOra = (ora) => {
+        this.ora = ora;
+    };
+    ora = null;
+    constructor(tail = 10, formatting) {
+        this.tail = tail;
+        this.formatting = formatting;
+    }
+}
+export default class CreateApp extends Command {
+    static description = 'sets up a preconfigued vite app directory on for a shopify theme';
+    static examples = [
+        '<%= config.bin %> <%= command.id %>',
+    ];
+    static flags = {
+        dir: Flags.string({ char: 'd', default: 'src', description: 'directory to create the vite app in' }),
+        'skip-check': Flags.boolean({ char: 's', description: 'skips the checking of the parent directory for a shopify theme' }),
+    };
+    async run() {
+        const { flags } = await this.parse(CreateApp);
+        // Checking if a src folder already exists
+        const targetDir = join(process.cwd(), flags.dir);
+        if (checkDirectoryExists(targetDir)) {
+            this.log(chalk.red('Directory', chalk.bold(targetDir), 'already exists'));
+            this.log(chalk.yellow('Use the', chalk.bold.white('--dir <dir>'), 'flag to specify a different directory.'));
+            return;
+        }
+        // Checking if the dir is a shopify theme
+        if (!flags['skip-check']) {
+            const requiredDirs = ['snippets', 'assets', 'sections', 'templates', 'config', 'layout'];
+            const targetDirParent = resolve(targetDir, '..');
+            const hasAll = requiredDirs.every(dir => checkDirectoryExists(join(targetDirParent, dir)));
+            if (!hasAll) {
+                this.log(chalk.red('Parent directory of target is not a Shopify theme directory.'));
+                this.log(chalk.yellow('Use the', chalk.bold.white('--skip-check'), 'flag to disable checking for a Shopify theme.'));
+                return;
+            }
+        }
+        // Making directory
+        mkdirSync(targetDir);
+        // Cloning the vite template from FireNet-Designs
+        const git = simpleGit(targetDir, { binary: 'git' });
+        const formatter = new OutputFormatter(10, chalk.dim);
+        {
+            const spinner = ora('Cloning template...').start();
+            await git.clone('git@github.com:FireNet-Designs/vite-template.git', targetDir);
+            spinner.succeed('Cloned template');
+        }
+        {
+            const spinner = ora('Deleting .git directory...').start();
+            const gitDir = join(targetDir, '.git');
+            rmSync(gitDir, { recursive: true });
+            spinner.succeed('Deleted .git directory');
+        }
+        {
+            const spinner = ora('Switching/installing node version...').start();
+            formatter.setOra(spinner);
+            const { stderr } = await execCommands([`cd ${targetDir}`, 'nvm install'], { onOutput: formatter.onData, timeout: 10_000 });
+            if (stderr.length > 0 && !stderr.includes('already installed')) {
+                spinner.fail('Failed to install node version');
+                return this.error(stderr, { code: '1' });
+            }
+            spinner.suffixText = '';
+            spinner.succeed('Installed node version');
+        }
+        {
+            const spinner = ora('Installing dependencies...').start();
+            formatter.setOra(spinner);
+            const { stderr } = await execCommands([`cd ${targetDir}`, 'nvm use', 'npm ci'], { onOutput: formatter.onData, timeout: 60_000 });
+            if (stderr.length > 0) {
+                spinner.fail('Failed to install dependencies');
+                return this.error(stderr, { code: '1' });
+            }
+            spinner.suffixText = '';
+            spinner.succeed('Installed dependencies');
+        }
+        this.log("You're good to go :-)");
+    }
+}

package/dist/hooks/init/check-for-updates.d.ts

@@ -0,0 +1,3 @@
+import { Hook } from '@oclif/core';
+declare const hook: Hook<'init'>;
+export default hook;

package/dist/hooks/init/check-for-updates.js

@@ -0,0 +1,28 @@
+import { simpleGit } from 'simple-git';
+import os from 'node:os';
+import { join } from 'node:path';
+import { rmSync, readFileSync } from 'node:fs';
+import chalk from 'chalk';
+const hook = async function (opts) {
+    const tempRepo = join(os.tmpdir(), 'fnd-cli');
+    try {
+        const git = simpleGit({ binary: 'git' });
+        await git.clone('git@github.com:FireNet-Designs/fnd-cli.git', tempRepo, { '--depth': 1 });
+        // Getting package.json file to check version
+        const pjson = JSON.parse(readFileSync(join(tempRepo, 'package.json'), 'utf-8'));
+        const newestVersion = pjson.version;
+        const ourVersion = opts.config.pjson.version;
+        if (newestVersion !== ourVersion) {
+            console.log(chalk.yellow('💡 Version', chalk.green(newestVersion), 'available! Run', chalk.green('`npm i -g git@github.com:FireNet-Designs/fnd-cli.git`'), 'to update to the latest version!\n'));
+        }
+    }
+    finally {
+        // Deleting the temp repo but ignoring errors
+        try {
+            rmSync(tempRepo, { recursive: true });
+        }
+        catch { }
+        ;
+    }
+};
+export default hook;

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { run } from '@oclif/core';

package/dist/index.js

@@ -0,0 +1 @@
+export { run } from '@oclif/core';

package/oclif.manifest.json

@@ -0,0 +1,45 @@
+{
+  "commands": {
+    "create-app": {
+      "aliases": [],
+      "args": {},
+      "description": "sets up a preconfigued vite app directory on for a shopify theme",
+      "examples": [
+        "<%= config.bin %> <%= command.id %>"
+      ],
+      "flags": {
+        "dir": {
+          "char": "d",
+          "description": "directory to create the vite app in",
+          "name": "dir",
+          "default": "src",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "skip-check": {
+          "char": "s",
+          "description": "skips the checking of the parent directory for a shopify theme",
+          "name": "skip-check",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "create-app",
+      "pluginAlias": "@firenet-designs/fnd-cli",
+      "pluginName": "@firenet-designs/fnd-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "create-app.js"
+      ]
+    }
+  },
+  "version": "1.0.1"
+}

package/package.json

@@ -0,0 +1,83 @@
+{
+  "name": "@firenet-designs/fnd-cli",
+  "description": "A new CLI generated with oclif",
+  "version": "1.0.1",
+  "author": "Cole Denslow",
+  "bin": {
+    "fnd-cli": "bin/run.js"
+  },
+  "bugs": "https://github.com/FireNet-Designs/fnd-cli/issues",
+  "dependencies": {
+    "@oclif/core": "^4",
+    "@oclif/plugin-help": "^6",
+    "@oclif/plugin-plugins": "^5",
+    "chalk": "^5.6.2",
+    "ora": "^9.3.0",
+    "simple-git": "^3.32.2"
+  },
+  "devDependencies": {
+    "@eslint/compat": "^1",
+    "@oclif/prettier-config": "^0.2.1",
+    "@oclif/test": "^4",
+    "@types/chai": "^4",
+    "@types/mocha": "^10",
+    "@types/node": "^18.19.130",
+    "chai": "^4",
+    "eslint": "^9",
+    "eslint-config-oclif": "^6",
+    "eslint-config-prettier": "^10",
+    "mocha": "^10",
+    "oclif": "^4",
+    "shx": "^0.3.3",
+    "ts-node": "^10",
+    "typescript": "^5"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "files": [
+    "./bin",
+    "./dist",
+    "./oclif.manifest.json"
+  ],
+  "homepage": "https://github.com/FireNet-Designs/fnd-cli",
+  "keywords": [
+    "oclif"
+  ],
+  "license": "MIT",
+  "main": "dist/index.js",
+  "type": "module",
+  "oclif": {
+    "bin": "fnd-cli",
+    "dirname": "fnd-cli",
+    "commands": "./dist/commands",
+    "hooks": {
+      "init": [
+        "./dist/hooks/init/check-for-updates"
+      ]
+    },
+    "plugins": [
+      "@oclif/plugin-help"
+    ],
+    "topicSeparator": " ",
+    "topics": {
+      "hello": {
+        "description": "Say hello to the world and others"
+      }
+    }
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/FireNet-Designs/fnd-cli.git"
+  },
+  "scripts": {
+    "build": "shx rm -rf dist && tsc -b",
+    "lint": "eslint",
+    "postpack": "shx rm -f oclif.manifest.json",
+    "posttest": "npm run lint",
+    "prepack": "oclif manifest && oclif readme",
+    "version": "oclif readme && git add README.md",
+    "release": "npm run build && npm run prepack && npm publish --access public"
+  },
+  "types": "dist/index.d.ts"
+}