ui5-task-copyright

UI5 task for appending copyright headers for TypeScript, JavaScript and XML files

👋 This is an open‑source, community‑driven project, developed and actively monitored by members of the UI5 community. You are welcome to use it, report issues, contribute enhancements, and support others in the community.

Task for ui5-builder for appending copyright headers to every TypeScript (*.ts), JavaScript (*.js), or XML (*.xml) source file.

Prerequisites

• Requires at least @ui5/cli@3.0.0 (to support specVersion: "3.0")

⚠️ UI5 CLI Compatibility All releases of this UI5 CLI extension using the major version 3 require UI5 CLI V3. Any previous releases below major version 3 (if available) also support older versions of the UI5 CLI. But the usage of the latest UI5 CLI is strongly recommended!

Install

npm install ui5-task-copyright --save-dev

Configuration options (in $yourapp/ui5.yaml)

• copyright: String (via env var: ui5_task_copyright__file expects file name, or ui5_task_copyright__copyright with the value) the value of the copyright or the path to a file containing the copyright statement - if not given, the task will be skipped - the copyright can also be injected by the environment variable ui5_task_copyright__file which must point to an existing file and then the copyright is extracted from this file or directly via environment variable ui5_task_copyright__copyright

• copyrightPlaceholder: String (defaults to: copyright, env var: ui5_task_copyright__placeholder_copyright) the name of the copyright placeholder to check for in the copyright comments and to replace with the copyright value (will replace all hits of ${copyright} or @copyright@)

• currentYearPlaceholder: String (defaults to: currentYear, env var: ui5_task_copyright__placeholder_current_year) the name of the currentYear placeholder in the copyright comments which will be replaced with the currentYear value (will replace all hits of ${currentYear} or @currentYear@)

• currentYear: String (defaults to: new Date().getFullYear(), env var: ui5_task_copyright__current_year) the value of the currentYear placeholder in the copyright comments

• excludePatterns: Array<String> array of paths inside $yourapp/ to exclude from the copyright processing, e.g. 3-rd party libs in lib/*. defaults to an empty array []. Uses substring matching (classic behavior).

• includes: Array<String> array of glob patterns (matched via minimatch); when set, only resources matching at least one pattern are processed, e.g. ["**/controller/**"]. defaults to an empty array [].

• excludes: Array<String> array of glob patterns (matched via minimatch); resources matching any pattern are excluded from processing, e.g. ["**/thirdparty/**", "**/*.designtime.js"]. defaults to an empty array [].

Usage

1. Define the dependency in $yourapp/package.json:

"devDependencies": {
    // ...
    "ui5-task-copyright": "*"
    // ...
}

2. configure it in $yourapp/ui5.yaml:

builder:
  customTasks:
  - name: ui5-task-copyright
    beforeTask: replaceCopyright
    configuration:
      copyright: "Copyright ${currentYear} UI5 Community"
      excludePatterns:
      - "thirdparty/"

How to obtain support

Please use the GitHub bug tracking system to post questions, bug reports or to create pull requests.

Contributing

Any type of contribution (code contributions, pull requests, issues) to this showcase will be equally appreciated.

License

This work is licensed under Apache 2.0.

Built with care (and a lot of caffeine). If this helped you build, test, or ship, the next coffee — or drink — is on you when you bump into a contributor.