* fix(profiles): fix vscode profile generation - Add .instructions.md extension for VSCode Copilot instructions file. - Add customReplacement to remove unsupported property `alwaysApply` from YAML front-matter in VSCode instructions files. - Add missing property `targetExtension` to the base profile object to support the change to file extension. * chore: run format --------- Co-authored-by: Ralph Khreish <35776126+Crunchyman-ralph@users.noreply.github.com>
260 lines
8.6 KiB
JavaScript
260 lines
8.6 KiB
JavaScript
// Base profile factory for rule-transformer
|
|
import path from 'path';
|
|
|
|
/**
|
|
* Creates a standardized profile configuration for different editors
|
|
* @param {Object} editorConfig - Editor-specific configuration
|
|
* @param {string} editorConfig.name - Profile name (e.g., 'cursor', 'vscode')
|
|
* @param {string} [editorConfig.displayName] - Display name for the editor (defaults to name)
|
|
* @param {string} editorConfig.url - Editor website URL
|
|
* @param {string} editorConfig.docsUrl - Editor documentation URL
|
|
* @param {string} editorConfig.profileDir - Directory for profile configuration
|
|
* @param {string} [editorConfig.rulesDir] - Directory for rules files (defaults to profileDir/rules)
|
|
* @param {boolean} [editorConfig.mcpConfig=true] - Whether to create MCP configuration
|
|
* @param {string} [editorConfig.mcpConfigName='mcp.json'] - Name of MCP config file
|
|
* @param {string} [editorConfig.fileExtension='.mdc'] - Source file extension
|
|
* @param {string} [editorConfig.targetExtension='.md'] - Target file extension
|
|
* @param {Object} [editorConfig.toolMappings={}] - Tool name mappings
|
|
* @param {Array} [editorConfig.customReplacements=[]] - Custom text replacements
|
|
* @param {Object} [editorConfig.fileMap={}] - Custom file name mappings
|
|
* @param {boolean} [editorConfig.supportsRulesSubdirectories=false] - Whether to use taskmaster/ subdirectory for taskmaster-specific rules (only Cursor uses this by default)
|
|
* @param {boolean} [editorConfig.includeDefaultRules=true] - Whether to include default rule files
|
|
* @param {Function} [editorConfig.onAdd] - Lifecycle hook for profile addition
|
|
* @param {Function} [editorConfig.onRemove] - Lifecycle hook for profile removal
|
|
* @param {Function} [editorConfig.onPostConvert] - Lifecycle hook for post-conversion
|
|
* @returns {Object} - Complete profile configuration
|
|
*/
|
|
export function createProfile(editorConfig) {
|
|
const {
|
|
name,
|
|
displayName = name,
|
|
url,
|
|
docsUrl,
|
|
profileDir = `.${name.toLowerCase()}`,
|
|
rulesDir = `${profileDir}/rules`,
|
|
mcpConfig = true,
|
|
mcpConfigName = mcpConfig ? 'mcp.json' : null,
|
|
fileExtension = '.mdc',
|
|
targetExtension = '.md',
|
|
toolMappings = {},
|
|
customReplacements = [],
|
|
fileMap = {},
|
|
supportsRulesSubdirectories = false,
|
|
includeDefaultRules = true,
|
|
onAdd,
|
|
onRemove,
|
|
onPostConvert
|
|
} = editorConfig;
|
|
|
|
const mcpConfigPath = mcpConfigName
|
|
? path.join(profileDir, mcpConfigName)
|
|
: null;
|
|
|
|
// Standard file mapping with custom overrides
|
|
// Use taskmaster subdirectory only if profile supports it
|
|
const taskmasterPrefix = supportsRulesSubdirectories ? 'taskmaster/' : '';
|
|
const defaultFileMap = {
|
|
'rules/cursor_rules.mdc': `${name.toLowerCase()}_rules${targetExtension}`,
|
|
'rules/dev_workflow.mdc': `${taskmasterPrefix}dev_workflow${targetExtension}`,
|
|
'rules/self_improve.mdc': `self_improve${targetExtension}`,
|
|
'rules/taskmaster.mdc': `${taskmasterPrefix}taskmaster${targetExtension}`
|
|
};
|
|
|
|
// Build final fileMap - merge defaults with custom entries when includeDefaultRules is true
|
|
const finalFileMap = includeDefaultRules
|
|
? { ...defaultFileMap, ...fileMap }
|
|
: fileMap;
|
|
|
|
// Base global replacements that work for all editors
|
|
const baseGlobalReplacements = [
|
|
// Handle URLs in any context
|
|
{ from: /cursor\.so/gi, to: url },
|
|
{ from: /cursor\s*\.\s*so/gi, to: url },
|
|
{ from: /https?:\/\/cursor\.so/gi, to: `https://${url}` },
|
|
{ from: /https?:\/\/www\.cursor\.so/gi, to: `https://www.${url}` },
|
|
|
|
// Handle tool references
|
|
{ from: /\bedit_file\b/gi, to: toolMappings.edit_file || 'edit_file' },
|
|
{
|
|
from: /\bsearch tool\b/gi,
|
|
to: `${toolMappings.search || 'search'} tool`
|
|
},
|
|
{ from: /\bSearch Tool\b/g, to: `${toolMappings.search || 'Search'} Tool` },
|
|
|
|
// Handle basic terms with proper case handling
|
|
{
|
|
from: /\bcursor\b/gi,
|
|
to: (match) =>
|
|
match.charAt(0) === 'C' ? displayName : name.toLowerCase()
|
|
},
|
|
{ from: /Cursor/g, to: displayName },
|
|
{ from: /CURSOR/g, to: displayName.toUpperCase() },
|
|
|
|
// Handle file extensions if different
|
|
...(targetExtension !== fileExtension
|
|
? [
|
|
{
|
|
from: new RegExp(`\\${fileExtension}(?!\\])\\b`, 'g'),
|
|
to: targetExtension
|
|
}
|
|
]
|
|
: []),
|
|
|
|
// Handle documentation URLs
|
|
{ from: /docs\.cursor\.com/gi, to: docsUrl },
|
|
|
|
// Custom editor-specific replacements
|
|
...customReplacements
|
|
];
|
|
|
|
// Standard tool mappings
|
|
const defaultToolMappings = {
|
|
search: 'search',
|
|
read_file: 'read_file',
|
|
edit_file: 'edit_file',
|
|
create_file: 'create_file',
|
|
run_command: 'run_command',
|
|
terminal_command: 'terminal_command',
|
|
use_mcp: 'use_mcp',
|
|
switch_mode: 'switch_mode',
|
|
...toolMappings
|
|
};
|
|
|
|
// Create conversion config
|
|
const conversionConfig = {
|
|
// Profile name replacements
|
|
profileTerms: [
|
|
{ from: /cursor\.so/g, to: url },
|
|
{ from: /\[cursor\.so\]/g, to: `[${url}]` },
|
|
{ from: /href="https:\/\/cursor\.so/g, to: `href="https://${url}` },
|
|
{ from: /\(https:\/\/cursor\.so/g, to: `(https://${url}` },
|
|
{
|
|
from: /\bcursor\b/gi,
|
|
to: (match) => (match === 'Cursor' ? displayName : name.toLowerCase())
|
|
},
|
|
{ from: /Cursor/g, to: displayName }
|
|
],
|
|
|
|
// File extension replacements
|
|
fileExtensions:
|
|
targetExtension !== fileExtension
|
|
? [
|
|
{
|
|
from: new RegExp(`\\${fileExtension}\\b`, 'g'),
|
|
to: targetExtension
|
|
}
|
|
]
|
|
: [],
|
|
|
|
// Documentation URL replacements
|
|
docUrls: [
|
|
{
|
|
from: new RegExp(`https:\\/\\/docs\\.cursor\\.com\\/[^\\s)'\"]+`, 'g'),
|
|
to: (match) => match.replace('docs.cursor.com', docsUrl)
|
|
},
|
|
{
|
|
from: new RegExp(`https:\\/\\/${docsUrl}\\/`, 'g'),
|
|
to: `https://${docsUrl}/`
|
|
}
|
|
],
|
|
|
|
// Tool references - direct replacements
|
|
toolNames: defaultToolMappings,
|
|
|
|
// Tool references in context - more specific replacements
|
|
toolContexts: Object.entries(defaultToolMappings).flatMap(
|
|
([original, mapped]) => [
|
|
{
|
|
from: new RegExp(`\\b${original} tool\\b`, 'g'),
|
|
to: `${mapped} tool`
|
|
},
|
|
{ from: new RegExp(`\\bthe ${original}\\b`, 'g'), to: `the ${mapped}` },
|
|
{ from: new RegExp(`\\bThe ${original}\\b`, 'g'), to: `The ${mapped}` },
|
|
{
|
|
from: new RegExp(`\\bCursor ${original}\\b`, 'g'),
|
|
to: `${displayName} ${mapped}`
|
|
}
|
|
]
|
|
),
|
|
|
|
// Tool group and category names
|
|
toolGroups: [
|
|
{ from: /\bSearch tools\b/g, to: 'Read Group tools' },
|
|
{ from: /\bEdit tools\b/g, to: 'Edit Group tools' },
|
|
{ from: /\bRun tools\b/g, to: 'Command Group tools' },
|
|
{ from: /\bMCP servers\b/g, to: 'MCP Group tools' },
|
|
{ from: /\bSearch Group\b/g, to: 'Read Group' },
|
|
{ from: /\bEdit Group\b/g, to: 'Edit Group' },
|
|
{ from: /\bRun Group\b/g, to: 'Command Group' }
|
|
],
|
|
|
|
// File references in markdown links
|
|
fileReferences: {
|
|
pathPattern: /\[(.+?)\]\(mdc:\.cursor\/rules\/(.+?)\.mdc\)/g,
|
|
replacement: (match, text, filePath) => {
|
|
const baseName = path.basename(filePath, '.mdc');
|
|
const newFileName =
|
|
finalFileMap[`rules/${baseName}.mdc`] ||
|
|
`${baseName}${targetExtension}`;
|
|
// Update the link text to match the new filename (strip directory path for display)
|
|
const newLinkText = path.basename(newFileName);
|
|
// For Cursor, keep the mdc: protocol; for others, use standard relative paths
|
|
if (name.toLowerCase() === 'cursor') {
|
|
return `[${newLinkText}](mdc:${rulesDir}/${newFileName})`;
|
|
} else {
|
|
return `[${newLinkText}](${rulesDir}/${newFileName})`;
|
|
}
|
|
}
|
|
}
|
|
};
|
|
|
|
function getTargetRuleFilename(sourceFilename) {
|
|
if (finalFileMap[sourceFilename]) {
|
|
return finalFileMap[sourceFilename];
|
|
}
|
|
return targetExtension !== fileExtension
|
|
? sourceFilename.replace(
|
|
new RegExp(`\\${fileExtension}$`),
|
|
targetExtension
|
|
)
|
|
: sourceFilename;
|
|
}
|
|
|
|
return {
|
|
profileName: name, // Use name for programmatic access (tests expect this)
|
|
displayName: displayName, // Keep displayName for UI purposes
|
|
profileDir,
|
|
rulesDir,
|
|
mcpConfig,
|
|
mcpConfigName,
|
|
mcpConfigPath,
|
|
supportsRulesSubdirectories,
|
|
includeDefaultRules,
|
|
fileMap: finalFileMap,
|
|
globalReplacements: baseGlobalReplacements,
|
|
conversionConfig,
|
|
getTargetRuleFilename,
|
|
targetExtension,
|
|
// Optional lifecycle hooks
|
|
...(onAdd && { onAddRulesProfile: onAdd }),
|
|
...(onRemove && { onRemoveRulesProfile: onRemove }),
|
|
...(onPostConvert && { onPostConvertRulesProfile: onPostConvert })
|
|
};
|
|
}
|
|
|
|
// Common tool mappings for editors that share similar tool sets
|
|
export const COMMON_TOOL_MAPPINGS = {
|
|
// Most editors (Cursor, Cline, Windsurf) keep original tool names
|
|
STANDARD: {},
|
|
|
|
// Roo Code uses different tool names
|
|
ROO_STYLE: {
|
|
edit_file: 'apply_diff',
|
|
search: 'search_files',
|
|
create_file: 'write_to_file',
|
|
run_command: 'execute_command',
|
|
terminal_command: 'execute_command',
|
|
use_mcp: 'use_mcp_tool'
|
|
}
|
|
};
|