@backtest-kit/sidekick 8.4.0 → 8.5.0

package/scripts/init.mjs

@@ -1,304 +1,304 @@
-#!/usr/bin/env node
-
-import { promises as fs } from 'fs';
-import path from 'path';
-import { fileURLToPath } from 'url';
-import { spawn } from 'child_process';
-import pc from 'picocolors';
-import { glob } from 'glob';
-import Mustache from 'mustache';
-import logSymbols from 'log-symbols';
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-
-const log = {
-  info: (msg) => console.log(`${pc.cyan(logSymbols.info)} ${msg}`),
-  success: (msg) => console.log(`${pc.green(logSymbols.success)} ${msg}`),
-  error: (msg) => console.log(`${pc.red(logSymbols.error)} ${msg}`),
-  warn: (msg) => console.log(`${pc.yellow(logSymbols.warning)} ${msg}`),
-};
-
-/**
- * Copy files using glob patterns
- */
-async function copyFiles(srcDir, destDir, pattern = '**/*') {
-  await fs.mkdir(destDir, { recursive: true });
-
-  const files = await glob(pattern, {
-    cwd: srcDir,
-    nodir: true,
-    dot: true,
-    absolute: false,
-  });
-
-  for (const file of files) {
-    const srcPath = path.join(srcDir, file);
-    const destPath = path.join(destDir, file);
-
-    // Create destination directory if needed
-    await fs.mkdir(path.dirname(destPath), { recursive: true });
-
-    // Copy file
-    await fs.copyFile(srcPath, destPath);
-
-    // Log copied file
-    console.log(`  ${pc.dim('→')} ${file}`);
-  }
-}
-
-/**
- * Check if directory exists and is empty
- */
-async function isDirEmpty(dirPath) {
-  try {
-    const files = await fs.readdir(dirPath);
-    return files.length === 0;
-  } catch (error) {
-    if (error.code === 'ENOENT') {
-      return true; // Directory doesn't exist, treat as empty
-    }
-    throw error;
-  }
-}
-
-/**
- * Run npm install
- */
-function runNpmInstall(projectPath) {
-  return new Promise((resolve, reject) => {
-    log.info('Installing dependencies...');
-
-    const npm = process.platform === 'win32' ? 'npm.cmd' : 'npm';
-    const install = spawn(npm, ['install'], {
-      cwd: projectPath,
-      stdio: 'inherit',
-      shell: true,
-    });
-
-    install.on('close', (code) => {
-      if (code !== 0) {
-        reject(new Error(`npm install exited with code ${code}`));
-        return;
-      }
-      resolve();
-    });
-
-    install.on('error', reject);
-  });
-}
-
-/**
- * Load and render template file
- */
-async function renderTemplate(templatePath, data) {
-  const template = await fs.readFile(templatePath, 'utf-8');
-  return Mustache.render(template, data);
-}
-
-/**
- * Main function
- */
-async function main() {
-  console.log();
-  console.log(`${pc.bold(pc.blue('🧿 Backtest Kit'))}`);
-  console.log();
-
-  // Get project name from arguments
-  const args = process.argv.slice(2);
-  const projectName = args[0] || 'my-backtest-project';
-
-  const projectPath = path.resolve(process.cwd(), projectName);
-  const srcTemplatePath = path.resolve(__dirname, '..', 'src');
-  const contentPath = path.resolve(__dirname, '..', 'content');
-  const templateDir = path.resolve(__dirname, '..', 'template');
-
-  // Template data for Mustache
-  const templateData = {
-    PROJECT_NAME: projectName,
-  };
-
-  try {
-    // Check if directory exists and is not empty
-    {
-      const isEmpty = await isDirEmpty(projectPath);
-      if (!isEmpty) {
-        log.error(`Directory ${projectName} already exists and is not empty.`);
-        process.exit(1);
-      }
-    }
-
-    {
-      log.info(`Creating a new Backtest Kit project in ${pc.bold(projectPath)}`);
-      console.log();
-    }
-
-    // Create project directory
-    {
-      await fs.mkdir(projectPath, { recursive: true });
-      log.success('Created project directory');
-    }
-
-    // Copy source template files using glob
-    {
-      log.info('Copying source files...');
-      await copyFiles(srcTemplatePath, path.join(projectPath, 'src'));
-      log.success('Copied source files');
-    }
-
-    // Copy content files (config/, scripts/, docker/)
-    {
-      log.info('Copying content files...');
-      await copyFiles(contentPath, projectPath);
-      log.success('Copied content files');
-    }
-
-    // Create types/backtest-kit.d.ts from template
-    {
-      log.info('Creating types/backtest-kit.d.ts...');
-      await fs.mkdir(path.join(projectPath, 'types'), { recursive: true });
-      const typesContent = await renderTemplate(
-        path.join(templateDir, 'types.mustache'),
-        templateData
-      );
-      await fs.writeFile(
-        path.join(projectPath, 'types', 'backtest-kit.d.ts'),
-        typesContent,
-        'utf-8'
-      );
-      log.success('Created types/backtest-kit.d.ts');
-    }
-
-    // Create package.json from template
-    {
-      log.info('Creating package.json...');
-      const packageJsonContent = await renderTemplate(
-        path.join(templateDir, 'package.mustache'),
-        templateData
-      );
-      await fs.writeFile(
-        path.join(projectPath, 'package.json'),
-        packageJsonContent,
-        'utf-8'
-      );
-      log.success('Created package.json');
-    }
-
-    // Create .env files from template
-    {
-      log.info('Creating .env template...');
-      const envContent = await renderTemplate(
-        path.join(templateDir, 'env.mustache'),
-        templateData
-      );
-      await fs.writeFile(
-        path.join(projectPath, '.env.example'),
-        envContent,
-        'utf-8'
-      );
-      await fs.writeFile(
-        path.join(projectPath, '.env'),
-        envContent,
-        'utf-8'
-      );
-      log.success('Created .env files');
-    }
-
-    // Create .gitignore from template
-    {
-      log.info('Creating .gitignore...');
-      const gitignoreContent = await renderTemplate(
-        path.join(templateDir, 'gitignore.mustache'),
-        templateData
-      );
-      await fs.writeFile(
-        path.join(projectPath, '.gitignore'),
-        gitignoreContent,
-        'utf-8'
-      );
-      log.success('Created .gitignore');
-    }
-
-    // Create README.md from template
-    {
-      log.info('Creating README.md...');
-      const readmeContent = await renderTemplate(
-        path.join(templateDir, 'README.mustache'),
-        templateData
-      );
-      await fs.writeFile(
-        path.join(projectPath, 'README.md'),
-        readmeContent,
-        'utf-8'
-      );
-      log.success('Created README.md');
-    }
-
-    // Create jsconfig.json from template
-    {
-      log.info('Creating jsconfig.json...');
-      const jsconfigContent = await renderTemplate(
-        path.join(templateDir, 'jsconfig.json.mustache'),
-        templateData
-      );
-      await fs.writeFile(
-        path.join(projectPath, 'jsconfig.json'),
-        jsconfigContent,
-        'utf-8'
-      );
-      log.success('Created jsconfig.json');
-    }
-
-    // Create CLAUDE.md from template
-    {
-      log.info('Creating CLAUDE.md...');
-      const claudeContent = await renderTemplate(
-        path.join(templateDir, 'CLAUDE.mustache'),
-        templateData
-      );
-      await fs.writeFile(
-        path.join(projectPath, 'CLAUDE.md'),
-        claudeContent,
-        'utf-8'
-      );
-      log.success('Created CLAUDE.md');
-      console.log();
-    }
-
-    // Install dependencies
-    {
-      await runNpmInstall(projectPath);
-      console.log();
-      log.success('Installation complete!');
-      console.log();
-    }
-
-    // Display success message with instructions
-    {
-      console.log(`${pc.bold('Success!')} Created ${pc.cyan(projectName)} at ${pc.bold(projectPath)}`);
-      console.log();
-      console.log('Inside that directory, you can run several commands:');
-      console.log();
-      console.log(`  ${pc.cyan('npm start')}`);
-      console.log('    Runs the default backtest.');
-      console.log();
-      console.log('We suggest that you begin by typing:');
-      console.log();
-      console.log(`  ${pc.cyan(`cd ${projectName}`)}`);
-      console.log(`  ${pc.cyan('npm start')}`);
-      console.log();
-      console.log(`${pc.yellow('Don\'t forget to configure your API keys in .env file!')}`);
-      console.log();
-      console.log('Happy trading! 🚀');
-      console.log();
-    }
-
-  } catch (error) {
-    log.error('Failed to create project:');
-    console.error(error);
-    process.exit(1);
-  }
-}
-
-// Run the script
-main().catch(console.error);
+#!/usr/bin/env node
+
+import { promises as fs } from 'fs';
+import path from 'path';
+import { fileURLToPath } from 'url';
+import { spawn } from 'child_process';
+import pc from 'picocolors';
+import { glob } from 'glob';
+import Mustache from 'mustache';
+import logSymbols from 'log-symbols';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+const log = {
+  info: (msg) => console.log(`${pc.cyan(logSymbols.info)} ${msg}`),
+  success: (msg) => console.log(`${pc.green(logSymbols.success)} ${msg}`),
+  error: (msg) => console.log(`${pc.red(logSymbols.error)} ${msg}`),
+  warn: (msg) => console.log(`${pc.yellow(logSymbols.warning)} ${msg}`),
+};
+
+/**
+ * Copy files using glob patterns
+ */
+async function copyFiles(srcDir, destDir, pattern = '**/*') {
+  await fs.mkdir(destDir, { recursive: true });
+
+  const files = await glob(pattern, {
+    cwd: srcDir,
+    nodir: true,
+    dot: true,
+    absolute: false,
+  });
+
+  for (const file of files) {
+    const srcPath = path.join(srcDir, file);
+    const destPath = path.join(destDir, file);
+
+    // Create destination directory if needed
+    await fs.mkdir(path.dirname(destPath), { recursive: true });
+
+    // Copy file
+    await fs.copyFile(srcPath, destPath);
+
+    // Log copied file
+    console.log(`  ${pc.dim('→')} ${file}`);
+  }
+}
+
+/**
+ * Check if directory exists and is empty
+ */
+async function isDirEmpty(dirPath) {
+  try {
+    const files = await fs.readdir(dirPath);
+    return files.length === 0;
+  } catch (error) {
+    if (error.code === 'ENOENT') {
+      return true; // Directory doesn't exist, treat as empty
+    }
+    throw error;
+  }
+}
+
+/**
+ * Run npm install
+ */
+function runNpmInstall(projectPath) {
+  return new Promise((resolve, reject) => {
+    log.info('Installing dependencies...');
+
+    const npm = process.platform === 'win32' ? 'npm.cmd' : 'npm';
+    const install = spawn(npm, ['install'], {
+      cwd: projectPath,
+      stdio: 'inherit',
+      shell: true,
+    });
+
+    install.on('close', (code) => {
+      if (code !== 0) {
+        reject(new Error(`npm install exited with code ${code}`));
+        return;
+      }
+      resolve();
+    });
+
+    install.on('error', reject);
+  });
+}
+
+/**
+ * Load and render template file
+ */
+async function renderTemplate(templatePath, data) {
+  const template = await fs.readFile(templatePath, 'utf-8');
+  return Mustache.render(template, data);
+}
+
+/**
+ * Main function
+ */
+async function main() {
+  console.log();
+  console.log(`${pc.bold(pc.blue('🧿 Backtest Kit'))}`);
+  console.log();
+
+  // Get project name from arguments
+  const args = process.argv.slice(2);
+  const projectName = args[0] || 'my-backtest-project';
+
+  const projectPath = path.resolve(process.cwd(), projectName);
+  const srcTemplatePath = path.resolve(__dirname, '..', 'src');
+  const contentPath = path.resolve(__dirname, '..', 'content');
+  const templateDir = path.resolve(__dirname, '..', 'template');
+
+  // Template data for Mustache
+  const templateData = {
+    PROJECT_NAME: projectName,
+  };
+
+  try {
+    // Check if directory exists and is not empty
+    {
+      const isEmpty = await isDirEmpty(projectPath);
+      if (!isEmpty) {
+        log.error(`Directory ${projectName} already exists and is not empty.`);
+        process.exit(1);
+      }
+    }
+
+    {
+      log.info(`Creating a new Backtest Kit project in ${pc.bold(projectPath)}`);
+      console.log();
+    }
+
+    // Create project directory
+    {
+      await fs.mkdir(projectPath, { recursive: true });
+      log.success('Created project directory');
+    }
+
+    // Copy source template files using glob
+    {
+      log.info('Copying source files...');
+      await copyFiles(srcTemplatePath, path.join(projectPath, 'src'));
+      log.success('Copied source files');
+    }
+
+    // Copy content files (config/, scripts/, docker/)
+    {
+      log.info('Copying content files...');
+      await copyFiles(contentPath, projectPath);
+      log.success('Copied content files');
+    }
+
+    // Create types/backtest-kit.d.ts from template
+    {
+      log.info('Creating types/backtest-kit.d.ts...');
+      await fs.mkdir(path.join(projectPath, 'types'), { recursive: true });
+      const typesContent = await renderTemplate(
+        path.join(templateDir, 'types.mustache'),
+        templateData
+      );
+      await fs.writeFile(
+        path.join(projectPath, 'types', 'backtest-kit.d.ts'),
+        typesContent,
+        'utf-8'
+      );
+      log.success('Created types/backtest-kit.d.ts');
+    }
+
+    // Create package.json from template
+    {
+      log.info('Creating package.json...');
+      const packageJsonContent = await renderTemplate(
+        path.join(templateDir, 'package.mustache'),
+        templateData
+      );
+      await fs.writeFile(
+        path.join(projectPath, 'package.json'),
+        packageJsonContent,
+        'utf-8'
+      );
+      log.success('Created package.json');
+    }
+
+    // Create .env files from template
+    {
+      log.info('Creating .env template...');
+      const envContent = await renderTemplate(
+        path.join(templateDir, 'env.mustache'),
+        templateData
+      );
+      await fs.writeFile(
+        path.join(projectPath, '.env.example'),
+        envContent,
+        'utf-8'
+      );
+      await fs.writeFile(
+        path.join(projectPath, '.env'),
+        envContent,
+        'utf-8'
+      );
+      log.success('Created .env files');
+    }
+
+    // Create .gitignore from template
+    {
+      log.info('Creating .gitignore...');
+      const gitignoreContent = await renderTemplate(
+        path.join(templateDir, 'gitignore.mustache'),
+        templateData
+      );
+      await fs.writeFile(
+        path.join(projectPath, '.gitignore'),
+        gitignoreContent,
+        'utf-8'
+      );
+      log.success('Created .gitignore');
+    }
+
+    // Create README.md from template
+    {
+      log.info('Creating README.md...');
+      const readmeContent = await renderTemplate(
+        path.join(templateDir, 'README.mustache'),
+        templateData
+      );
+      await fs.writeFile(
+        path.join(projectPath, 'README.md'),
+        readmeContent,
+        'utf-8'
+      );
+      log.success('Created README.md');
+    }
+
+    // Create jsconfig.json from template
+    {
+      log.info('Creating jsconfig.json...');
+      const jsconfigContent = await renderTemplate(
+        path.join(templateDir, 'jsconfig.json.mustache'),
+        templateData
+      );
+      await fs.writeFile(
+        path.join(projectPath, 'jsconfig.json'),
+        jsconfigContent,
+        'utf-8'
+      );
+      log.success('Created jsconfig.json');
+    }
+
+    // Create CLAUDE.md from template
+    {
+      log.info('Creating CLAUDE.md...');
+      const claudeContent = await renderTemplate(
+        path.join(templateDir, 'CLAUDE.mustache'),
+        templateData
+      );
+      await fs.writeFile(
+        path.join(projectPath, 'CLAUDE.md'),
+        claudeContent,
+        'utf-8'
+      );
+      log.success('Created CLAUDE.md');
+      console.log();
+    }
+
+    // Install dependencies
+    {
+      await runNpmInstall(projectPath);
+      console.log();
+      log.success('Installation complete!');
+      console.log();
+    }
+
+    // Display success message with instructions
+    {
+      console.log(`${pc.bold('Success!')} Created ${pc.cyan(projectName)} at ${pc.bold(projectPath)}`);
+      console.log();
+      console.log('Inside that directory, you can run several commands:');
+      console.log();
+      console.log(`  ${pc.cyan('npm start')}`);
+      console.log('    Runs the default backtest.');
+      console.log();
+      console.log('We suggest that you begin by typing:');
+      console.log();
+      console.log(`  ${pc.cyan(`cd ${projectName}`)}`);
+      console.log(`  ${pc.cyan('npm start')}`);
+      console.log();
+      console.log(`${pc.yellow('Don\'t forget to configure your API keys in .env file!')}`);
+      console.log();
+      console.log('Happy trading! 🚀');
+      console.log();
+    }
+
+  } catch (error) {
+    log.error('Failed to create project:');
+    console.error(error);
+    process.exit(1);
+  }
+}
+
+// Run the script
+main().catch(console.error);

package/src/classes/BacktestLowerStopOnBreakevenAction.mjs

@@ -1,17 +1,17 @@
-import { ActionBase, commitTrailingStop } from "backtest-kit";
-
-/**
- * Lowers trailing-stop by 3 points when breakeven is reached (ignores volatility)
- * @implements {bt.IPublicAction}
- */
-export class BacktestLowerStopOnBreakevenAction extends ActionBase {
-  /**
-   * @param {bt.BreakevenContract} param0 
-   */
-  async breakevenAvailable({ symbol, currentPrice }) {
-    // Lower trailing-stop by 3 points (negative value brings stop-loss closer to entry)
-    await commitTrailingStop(symbol, -3, currentPrice);
-  }
-}
-
-export default BacktestLowerStopOnBreakevenAction;
+import { ActionBase, commitTrailingStop } from "backtest-kit";
+
+/**
+ * Lowers trailing-stop by 3 points when breakeven is reached (ignores volatility)
+ * @implements {bt.IPublicAction}
+ */
+export class BacktestLowerStopOnBreakevenAction extends ActionBase {
+  /**
+   * @param {bt.BreakevenContract} param0 
+   */
+  async breakevenAvailable({ symbol, currentPrice }) {
+    // Lower trailing-stop by 3 points (negative value brings stop-loss closer to entry)
+    await commitTrailingStop(symbol, -3, currentPrice);
+  }
+}
+
+export default BacktestLowerStopOnBreakevenAction;