Skip to main content

File Headers

Every source file in an Oidis project requires a license header. This is enforced by the oidislint.conf.json configuration and checked during pre-commit hooks and CI builds.

TypeScript / JavaScript / CSS​

/*! ******************************************************************************************************** *
 *
 * Copyright 2026 Oidis
 *
 * SPDX-License-Identifier: BSD-3-Clause
 * The BSD-3-Clause license for this file can be found in the LICENSE.txt file included with this distribution
 * or at https://spdx.org/licenses/BSD-3-Clause.html#licenseText
 *
 * ********************************************************************************************************* */

SASS / SCSS​

// ********************************************************************************************************* //
//
// Copyright 2026 Oidis
//
// SPDX-License-Identifier: BSD-3-Clause
// The BSD-3-Clause license for this file can be found in the LICENSE.txt file included with this distribution
// or at https://spdx.org/licenses/BSD-3-Clause.html#licenseText
//
// ********************************************************************************************************* //

Year Handling​

  • New files: Use the current year only (e.g., Copyright 2026 Oidis)
  • Modified files across years (preferred): Use a range with a dash (no spaces): Copyright 2025-2026 Oidis
  • Rarely used alternative: Comma separator: Copyright 2025, 2026 Oidis — reserved for files that were untouched for many years and are now being updated. Default to the range format.
  • The year must reflect when the file was first created and last modified
  • Oidis Builder enforces year correctness via the copyrights-cleanup pre-commit hook

Exceptions​

Some file types are excluded from the copyright lint check (configured in oidislint.conf.json):

  • .bsdesign files (Bootstrap Studio proprietary format)
  • Generated files (between generated-code-start / generated-code-end markers)
  • Builder-generated root files (package.json, tsconfig.json, etc.)

Verification​

oidis.cmd project-cleanup test:lint

The linter checks that every qualifying source file has the correct header format and valid year.

See also: Formatting Rules | Naming Conventions