mirror of
https://github.com/compiler-explorer/compiler-explorer.git
synced 2026-09-10 15:47: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>
76 lines
3.4 KiB
TypeScript
76 lines
3.4 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 {CompilerOverrideType} from '../../types/compilation/compiler-overrides.interfaces.js';
|
|
import type {ParseFiltersAndOutputOptions} from '../../types/features/filters.interfaces.js';
|
|
import {BaseCompiler} from '../base-compiler.js';
|
|
import {TableGenParser} from './argument-parsers.js';
|
|
|
|
export class TableGenCompiler extends BaseCompiler {
|
|
static get key() {
|
|
return 'tablegen';
|
|
}
|
|
|
|
override optionsForFilter(filters: ParseFiltersAndOutputOptions, outputFilename: string) {
|
|
const options: string[] = ['-o', outputFilename];
|
|
if (this.compiler.includePath) {
|
|
options.push(`-I${this.compiler.includePath}`);
|
|
}
|
|
return options;
|
|
}
|
|
|
|
override isCfgCompiler() {
|
|
return false;
|
|
}
|
|
|
|
override getArgumentParserClass() {
|
|
return TableGenParser;
|
|
}
|
|
|
|
override async populatePossibleOverrides() {
|
|
const possibleActions = await this.argParser.getPossibleActions();
|
|
if (possibleActions.length > 0) {
|
|
this.compiler.possibleOverrides?.push({
|
|
type: 'options',
|
|
name: CompilerOverrideType.action,
|
|
display_title: 'Action',
|
|
description:
|
|
'The action to perform, which is the backend you wish to ' +
|
|
'run. By default, the records are just printed as text. ' +
|
|
'Many backends expect to find certain classes and defnitions ' +
|
|
'in your source code. You may find details of those in the ' +
|
|
'<a href="https://llvm.org/docs/TableGen/BackEnds.html" target="_blank">documentation</a>, ' +
|
|
'but if not, refer to use of the backend in the ' +
|
|
'<a href="https://github.com/llvm/llvm-project" target="_blank">LLVM Project</a> ' +
|
|
'by searching for the command line name e.g. "gen-attrs".',
|
|
flags: ['<value>'],
|
|
values: possibleActions,
|
|
default: '--print-records',
|
|
});
|
|
}
|
|
|
|
await super.populatePossibleOverrides();
|
|
}
|
|
}
|