@nutrient-sdk/dws-client-typescript/scripts/add_github_copilot_rule.cjs

Node.js TypeScript client library for Nutrient Document Web Services (DWS) API

#! /usr/bin/env node
const fs = require('fs');
const path = require('path');

const docPath = path.join(__dirname, '..', 'LLM_DOC.md');
const typePath = path.join(__dirname, '../dist', 'index.d.ts');

// Use process.cwd() as the actual root of the user's project
const userProjectRoot = process.cwd();
const outputDirectory = path.join(userProjectRoot, '.github');
const outputFile = path.join(outputDirectory, 'copilot-instructions.md');

// Relative path from user project to the README file
const relativeDocPath = path.relative(userProjectRoot, docPath);
const relativeTypePath = path.relative(userProjectRoot, typePath);

try {
  const rule = `
# Nutrient DWS TypeScript Client Usage
- Use the \`nutrient-dws-client-typescript\` package for operations with document processing operations including conversion, merging, compression, watermarking, signage, and text extraction.
- Package Documentation and Examples can be found at: ${relativeDocPath}
- TypeScript Type Definitions can be found at: ${relativeTypePath}
`
  if (!fs.existsSync(outputDirectory)) {
    fs.mkdirSync(outputDirectory, { recursive: true });
  }
  fs.appendFileSync(outputFile, `${rule}`);
  console.log(`📄 Updated GitHub Copilot Rules to point to Nutrient DWS documentation at ${relativeDocPath} and ${relativeTypePath}.`);
} catch (err) {
  console.error('Failed to update .github/copilot-instructions.md file:', err.message);
}