mirror of
https://github.com/compiler-explorer/compiler-explorer.git
synced 2026-07-16 17:26:58 -04:00
3d5a62fe6b
## What & why We used to enforce the BSD-2-Clause license banner on every source file via `eslint-plugin-header`. That check was lost when we migrated from ESLint to Biome (#7033), which has no equivalent rule. This PR reinstates it as a standalone node script, modelled on the existing `etc/scripts/check-frontend-imports.js`. ### Why a script rather than a Biome rule Biome 2.x has no built-in license/header rule and no plugin equivalent to `eslint-plugin-header`; its experimental GritQL plugins aren't suited to whole-file-prefix matching. A script needs zero new dependencies and gives full control over scope and exemptions. ## The check (`etc/scripts/check-license-headers.js`) A file "has an appropriate banner" if, ignoring an optional shebang, it opens with a `// Copyright (c) …` line **and** contains the BSD-2-Clause disclaimer body. The year and copyright holder are intentionally **not** constrained — the tree legitimately has many holders (Compiler Explorer Authors, Arm, Microsoft, HRT, individuals). The `(c)`/`(C)` marker is matched case-insensitively. **Scope:** `.ts/.js/.mjs/.cjs` under `lib/ static/ shared/ types/ test/ cypress/`. **Exempt:** generated files (`lib/asm-docs/generated`), vendored (`docenizer/vendor`), `.d.ts`, and three third-party ports that carry their own upstream license — `static/ansi-to-html.ts` (MIT), `lib/node-graceful.ts` (MIT), `shared/rison.ts` (Nanonid/rison port). **Wired into:** CI (`test-and-deploy.yml`), `npm run check`, the `make pre-commit` target, the husky pre-commit hook, and `lint-staged` (per staged file). Usage: ``` node ./etc/scripts/check-license-headers.js # scan the tracked tree node ./etc/scripts/check-license-headers.js <files...> # scan specific files (lint-staged) ``` ## Backfill The check surfaced **42 CE-authored files** missing the banner. This PR backfills them all with the standard `Copyright (c) <year>, Compiler Explorer Authors` banner, using each file's **git creation year** (added-at-this-path, so no `--follow` rename artifacts). ## Verification - `check-license-headers` → clean (was 42 failures) - `biome check` on all source → no fixes needed (banner format matches existing convention) - `tsc` backend + frontend + tests → clean - pre-commit gauntlet (lint, ts-check, related tests: 528 passed) ran on commit 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: mattgodbolt-molty <mattgodbolt-molty@users.noreply.github.com> Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
124 lines
3.4 KiB
TypeScript
124 lines
3.4 KiB
TypeScript
// Copyright (c) 2026, Compiler Explorer Authors
|
|
// All rights reserved.
|
|
//
|
|
// Redistribution and use in source and binary forms, with or without
|
|
// modification, are permitted provided that the following conditions are met:
|
|
//
|
|
// * Redistributions of source code must retain the above copyright notice,
|
|
// this list of conditions and the following disclaimer.
|
|
// * Redistributions in binary form must reproduce the above copyright
|
|
// notice, this list of conditions and the following disclaimer in the
|
|
// documentation and/or other materials provided with the distribution.
|
|
//
|
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
|
|
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
// POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
import $ from 'jquery';
|
|
import * as monaco from 'monaco-editor';
|
|
import * as cpp from 'monaco-editor/esm/vs/basic-languages/cpp/cpp';
|
|
|
|
function definition(): monaco.languages.IMonarchLanguage {
|
|
const co2 = $.extend(true, {}, cpp.language);
|
|
|
|
co2.keywords = [
|
|
'alignas',
|
|
'alignof',
|
|
'auto',
|
|
'bool',
|
|
'break',
|
|
'case',
|
|
'char',
|
|
'const',
|
|
'constexpr',
|
|
'continue',
|
|
'default',
|
|
'do',
|
|
'double',
|
|
'else',
|
|
'enum',
|
|
'extern',
|
|
'false',
|
|
'float',
|
|
'fn',
|
|
'for',
|
|
'goto',
|
|
'if',
|
|
'inline',
|
|
'int',
|
|
'long',
|
|
'mod',
|
|
'nullptr',
|
|
'pub',
|
|
'register',
|
|
'restrict',
|
|
'return',
|
|
'short',
|
|
'signed',
|
|
'sizeof',
|
|
'static',
|
|
'static_assert',
|
|
'struct',
|
|
'switch',
|
|
'thread_local',
|
|
'true',
|
|
'type',
|
|
'typedef',
|
|
'typeof',
|
|
'typeof_unqual',
|
|
'union',
|
|
'unsafe',
|
|
'unsigned',
|
|
'use',
|
|
'void',
|
|
'volatile',
|
|
'while',
|
|
'_Alignas',
|
|
'_Alignof',
|
|
'_Atomic',
|
|
'_BitInt',
|
|
'_Bool',
|
|
'_Complex',
|
|
'_Decimal128',
|
|
'_Decimal32',
|
|
'_Decimal64',
|
|
'_Generic',
|
|
'_Imaginary',
|
|
'_Noreturn',
|
|
'_Pragma',
|
|
'_Static_assert',
|
|
'_Thread_local',
|
|
];
|
|
|
|
// Add CO2-specific patterns before original tokenizer rules
|
|
const origToken = co2.tokenizer.root;
|
|
co2.tokenizer.root = [
|
|
// CO2 attributes
|
|
[/^#!\[.*?\]/, 'annotation'],
|
|
[/#\[.*?\]/, 'annotation'],
|
|
|
|
// CO2 paths: foo::bar::baz
|
|
[/[a-zA-Z_]\w*(?:::[a-zA-Z_]\w*)+/, 'type.identifier'],
|
|
|
|
...origToken,
|
|
];
|
|
|
|
return co2;
|
|
}
|
|
|
|
const def = definition();
|
|
|
|
monaco.languages.register({id: 'co2'});
|
|
monaco.languages.setLanguageConfiguration('co2', cpp.conf);
|
|
monaco.languages.setMonarchTokensProvider('co2', def);
|
|
|
|
export default def;
|