Skip to content

display multiple suggestions when a config has an unknown feature #1062

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.

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
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions plugin-packs/postcss-preset-env/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

### Unreleased (patch)

- Display multiple feature suggestions when an unknown feature is used in plugin options
- Fix `env` option for plugin specific options by @BPScott

### 9.1.0
Expand Down
2 changes: 1 addition & 1 deletion plugin-packs/postcss-preset-env/dist/index.cjs

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion plugin-packs/postcss-preset-env/dist/index.mjs

Large diffs are not rendered by default.

52 changes: 26 additions & 26 deletions plugin-packs/postcss-preset-env/src/plugins/plugin-id-help.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -10,38 +10,38 @@ export function pluginIdHelp(featureNamesInOptions, root, result) {
return;
}

const byId = mostSimilar(featureName, featureNames);
const byPackage = mostSimilar(featureName, packageNames);
const suggestions = [
...featureNames.map((x) => {
return [x, levenshteinDistance(featureName, x)];
}),
...packageNames.map((x) => {
return [packageNamesToIds[x], levenshteinDistance(featureName, x)];
}),
].sort((a, b) => {
return a[1] - b[1];
}).filter((x) => x[1] < 10);

if (Math.min(byId.distance, byPackage.distance) > 10) {
root.warn(result, `Unknown feature: "${featureName}", see the list of features https://github.com/csstools/postcss-plugins/blob/main/plugin-packs/postcss-preset-env/FEATURES.md`);
return;
}
const uniqueSuggestions = new Set();

if (byId.distance < byPackage.distance) {
root.warn(result, `Unknown feature: "${featureName}", did you mean: "${byId.mostSimilar}"`);
} else {
root.warn(result, `Unknown feature: "${featureName}", did you mean: "${packageNamesToIds[byPackage.mostSimilar]}"`);
}
});
}
for (let i = 0; i < suggestions.length; i++) {
uniqueSuggestions.add(suggestions[i][0]);

function mostSimilar(a, b) {
let mostSimilar = 'unknown';
let leastDistance = Infinity;
if (uniqueSuggestions.size >= 3) {
break;
}
}

for (let j = 0; j < b.length; j++) {
const distance = levenshteinDistance(a, b[j]);
if (distance < leastDistance) {
leastDistance = distance;
mostSimilar = b[j];
if (!uniqueSuggestions.size) {
root.warn(result, `Unknown feature: "${featureName}", see the list of features https://github.com/csstools/postcss-plugins/blob/main/plugin-packs/postcss-preset-env/FEATURES.md`);
return;
}
}

return {
mostSimilar: mostSimilar,
distance: leastDistance,
};
let formattedSuggestions = '"';
formattedSuggestions += Array.from(uniqueSuggestions).join('", "');
formattedSuggestions += '"';

root.warn(result, `Unknown feature: "${featureName}", did you mean one of: ${formattedSuggestions}`);
});
}

function levenshteinDistance(s, t) {
Expand Down