hana-developer-cli-tool-example: Instructions file for GitHub Copilot

Configuration Files Management Guidelines

Use this guide when creating or modifying configuration files for development tools.

Scope and Purpose

This guide applies to configuration files for:

• ESLint (eslint.config.js flat config)
• Prettier (.prettierrc.json, .prettierrc.js)
• NYC/Istanbul coverage (.nycrc, .nycrc.json)
• Mocha testing (.mocharc.json, .mocharc.js)
• Markdown linting (.markdownlintrc.json)
• EditorConfig (.editorconfig)
• Git ignore patterns (.gitignore, .npmignore)

Critical Principles

1. Shared Configs: Extend from shared configurations when available
2. Consistency: Align configs across similar projects
3. Override Hierarchy: Understand config precedence and overrides
4. Ignore Patterns: Maintain comprehensive ignore lists
5. JSON vs JS: Choose appropriate format (JSON for simple, JS for complex)
6. Comments: Use JS format when extensive comments needed
7. Integration: Ensure tools work together harmoniously
8. CI/CD Alignment: Config should work in both local and CI environments

ESLint Configuration

Pattern: ESLint for JavaScript with CDS Plugin

{
  "env": {
    "es2022": true,
    "node": true,
    "mocha": true
  },
  "extends": [
    "eslint:recommended"
  ],
  "plugins": [
    "@sap/cds"
  ],
  "parserOptions": {
    "ecmaVersion": 2022,
    "sourceType": "module"
  },
  "rules": {
    // Possible Errors
    "no-console": "off",              // Allow console in Node.js
    "no-unused-vars": [
      "error",
      {
        "argsIgnorePattern": "^_",    // Allow _unused variables
        "varsIgnorePattern": "^_"
      }
    ],
    
    // Best Practices
    "eqeqeq": ["error", "always"],    // Require === and !==
    "no-eval": "error",               // No eval()
    "no-implied-eval": "error",       // No setTimeout("string")
    "no-return-await": "error",       // No unnecessary await
    
    // Code Style
    "indent": ["error", 4],           // 4-space indentation
    "quotes": ["error", "single"],    // Single quotes
    "semi": ["error", "always"],      // Always semicolons
    "comma-dangle": ["error", "never"], // No trailing commas
    
    // CDS-specific rules
    "@sap/cds/no-dollar-prefixed-names": "off"
  },
  "overrides": [
    {
      // Relaxed rules for test files
      "files": ["**/*.test.js", "**/*.Test.js"],
      "rules": {
        "no-unused-expressions": "off" // For should/expect
      }
    }
  ],
  "ignorePatterns": [
    "node_modules/",
    "dist/",
    "coverage/",
    "*.min.js",
    "mochawesome-report/"
  ]
}