mirror of
https://github.com/compiler-explorer/compiler-explorer.git
synced 2026-09-10 23:49:54 -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>
65 lines
3.5 KiB
TypeScript
65 lines
3.5 KiB
TypeScript
// Copyright (c) 2025, 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 {describe, expect, it} from 'vitest';
|
|
|
|
import * as utils from '../../static/utils.js';
|
|
|
|
describe('numeric tooltip', () => {
|
|
it('handles ASCII characters', () => {
|
|
expect(utils.getNumericToolTip('42')).toEqual('42 = 0x2A = 5.88545355e-44f = "*"');
|
|
expect(utils.getNumericToolTip('97')).toEqual('97 = 0x61 = 1.35925951e-43f = "a"');
|
|
expect(utils.getNumericToolTip('10')).toEqual('10 = 0xA = 1.40129846e-44f = "\\n"');
|
|
expect(utils.getNumericToolTip('92')).toEqual('92 = 0x5C = 1.28919459e-43f = "\\\\"');
|
|
expect(utils.getNumericToolTip('1')).toEqual('1 = 0x1 = 1.40129846e-45f = "\\u0001"');
|
|
});
|
|
it('handles ASCII strings', () => {
|
|
expect(utils.getNumericToolTip('0x61626364')).toEqual('1633837924 = 0x61626364 = 2.61007876e+20f = "dcba"');
|
|
expect(utils.getNumericToolTip('8583909746840200552')).toEqual(
|
|
'8583909746840200552 = 0x77202C6F6C6C6568 = 6.5188685003648344e+265 = "hello, w"',
|
|
);
|
|
});
|
|
it('handles UTF-8 strings', () => {
|
|
expect(utils.getNumericToolTip('-6934491452449512253')).toEqual(
|
|
'-6934491452449512253 = 0x9FC3BCC3B6C3A4C3 = -1.1500622354593239e-155 = "äöüß"',
|
|
);
|
|
expect(utils.getNumericToolTip('-1530699166')).toEqual(
|
|
'-1530699166 = 0xFFFFFFFFA4C36262 = -8.47344364e-17f = "bbä"',
|
|
);
|
|
expect(utils.getNumericToolTip('-23357')).toEqual('-23357 = 0xFFFFFFFFFFFFA4C3 = NaNf = "ä"');
|
|
});
|
|
it('inserts digit separators', () => {
|
|
expect(utils.getNumericToolTip('1234', '_')).toEqual('1_234 = 0x4D2 = 1.72920230e-42f');
|
|
expect(utils.getNumericToolTip('1234567', "'")).toEqual("1'234'567 = 0x12'D687 = 1.72999684e-39f");
|
|
expect(utils.getNumericToolTip('-6934491452449512253', '_')).toEqual(
|
|
'-6_934_491_452_449_512_253 = 0x9FC3_BCC3_B6C3_A4C3 = -1.1500622354593239e-155 = "äöüß"',
|
|
);
|
|
});
|
|
it('does nothing for strings that are not numbers', () => {
|
|
expect(utils.getNumericToolTip('word')).toEqual(null);
|
|
expect(utils.getNumericToolTip('NaN')).toEqual(null);
|
|
expect(utils.getNumericToolTip('1.5')).toEqual(null);
|
|
});
|
|
});
|