Skip to content

Check every key (regardless of compute_from) for discouraged condition #2228

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Nov 22, 2024
Merged

Check every key (regardless of compute_from) for discouraged condition #2228

Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
e5e7442
Check every key (even in compute_from) for discouraged
ddbeck Nov 13, 2024
7aa8265
Just check the underlying compat data
ddbeck Nov 14, 2024
3626814
Merge branch 'main' into surface-discouraged-on-compute-from
ddbeck Nov 14, 2024
6bcde4d
Check deprecatedness in one place only
ddbeck Nov 14, 2024
7698b0a
Revert "Check deprecatedness in one place only"
ddbeck Nov 14, 2024
7268252
Warn only for drafts
ddbeck Nov 14, 2024
432c982
Make messages shorter
ddbeck Nov 14, 2024
c2e57bb
Make structure more consistent
ddbeck Nov 14, 2024
fc0e9dc
Merge branch 'main' into surface-discouraged-on-compute-from
jamesnw Nov 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 19 additions & 3 deletions scripts/dist.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import {
parseRangedDateString,
setLogger,
} from "compute-baseline";
import { Compat, Feature } from "compute-baseline/browser-compat-data";
import { Compat, feature, Feature } from "compute-baseline/browser-compat-data";
import { fdir } from "fdir";
import fs from "node:fs";
import path from "node:path";
Expand Down Expand Up @@ -238,12 +238,12 @@ function toDist(sourcePath: string): YAML.Document {

if (!source.draft_date) {
logger.error(
`${id}: contains at least one deprecated compat feature and can never be Baseline. This is forbidden for published features.`,
`${id}: contains at least one deprecated compat feature. This is forbidden for published features.`,
Copy link
Collaborator Author

@ddbeck ddbeck Nov 20, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is kinda annoying in some cases, because you never get the one key that caused it. I should refactor this a bit, to conditionally check deprecated for each key up here.

);
exitStatus = 1;
} else {
logger.warn(
`${id}: draft contains at least one deprecated compat feature and can never be Baseline. Was this intentional?`,
`${id}: draft contains at least one deprecated compat feature. Was this intentional?`,
);
}
}
Expand Down Expand Up @@ -282,6 +282,22 @@ function toDist(sourcePath: string): YAML.Document {
);
exitStatus = 1;
}

for (const key of compatFeatures) {
const f = feature(key);
if (f.deprecated) {
if (!source.draft_date) {
logger.error(
`${id}: contains contains deprecated compat feature ${f.id}. This is forbidden for published features.`,
);
exitStatus = 1;
} else {
logger.warn(
`${id}: draft contains deprecated compat feature ${f.id}. Was this intentional?`,
);
}
}
}
}

const sortedStatus = Array.from(groups.keys()).sort(compareStatus);
Expand Down