mirror of
https://github.com/compiler-explorer/compiler-explorer.git
synced 2026-09-10 14:37:42 -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>
82 lines
2.9 KiB
TypeScript
82 lines
2.9 KiB
TypeScript
// Copyright (c) 2023, 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 rison from '../shared/rison.js';
|
|
|
|
// Copied from https://github.com/Nanonid/rison/blob/master/python/rison/tests.py
|
|
const py_testcases = {
|
|
'(a:0,b:1)': {a: 0, b: 1},
|
|
"(a:0,b:foo,c:'23skidoo')": {a: 0, c: '23skidoo', b: 'foo'},
|
|
'!t': true,
|
|
'!f': false,
|
|
'!n': null,
|
|
"''": '',
|
|
0: 0,
|
|
1.5: 1.5,
|
|
'-3': -3,
|
|
'1e30': 1e30,
|
|
'1e-30': 1.0000000000000001e-30,
|
|
'G.': 'G.',
|
|
a: 'a',
|
|
"'0a'": '0a',
|
|
"'abc def'": 'abc def',
|
|
'()': {},
|
|
'(a:0)': {a: 0},
|
|
'(id:!n,type:/common/document)': {type: '/common/document', id: null},
|
|
'!()': [],
|
|
"!(!t,!f,!n,'')": [true, false, null, ''],
|
|
"'-h'": '-h',
|
|
'a-z': 'a-z',
|
|
"'wow!!'": 'wow!',
|
|
'domain.com': 'domain.com',
|
|
"'user@domain.com'": 'user@domain.com',
|
|
"'US $10'": 'US $10',
|
|
"'can!'t'": "can't",
|
|
};
|
|
|
|
const encode_testcases = {
|
|
"can't": "'can!'t'",
|
|
'"can\'t"': "'\"can!'t\"'",
|
|
"'can't'": "'!'can!'t!''",
|
|
};
|
|
|
|
describe('Rison test cases', () => {
|
|
for (const [r, obj] of Object.entries(py_testcases)) {
|
|
it(`Should decode "${r}"`, () => {
|
|
// hack to get around "TypeError: Cannot read properties of null (reading 'should')"
|
|
expect(rison.decode(r)).toEqual(obj);
|
|
});
|
|
it(`Should encode ${JSON.stringify(obj)}`, () => {
|
|
expect(rison.encode(obj)).toEqual(r);
|
|
});
|
|
}
|
|
for (const [obj, r] of Object.entries(encode_testcases)) {
|
|
it(`Should encode ${JSON.stringify(obj)}`, () => {
|
|
expect(rison.encode(obj)).toEqual(r);
|
|
});
|
|
}
|
|
});
|