mirror of
https://github.com/Mibew/simple-icons.git
synced 2024-11-17 19:04:13 +03:00
e0df400494
* Add prettier as a dependency * Add format command and configure prettier I opted for single quotes to be in line with other simple-icons projects I ignore the data file because changing its formatting is quite a bit of trouble for all open PRs. * Run prettier * Replace all functions by arrow functions * Move prettier configuration to config file Move it to a file so editors (and other software) can pick up on the configuration. I went with .js because (a) it allows for comments and (2) it seems most of the config files are in JavaScript already. * Add prettier --check when running npm run lint (This adds it to the CI as well) * Add husky and format changes before committing * Use object destructuring for imports consistently * Add shebang and fileoverview to jsonlint.js
84 lines
2.2 KiB
JavaScript
84 lines
2.2 KiB
JavaScript
#!/usr/bin/env node
|
|
/**
|
|
* @fileoverview
|
|
* Linters for the package that can't easily be implemented in the existing
|
|
* linters (e.g. jsonlint/svglint).
|
|
*/
|
|
|
|
const fs = require('fs');
|
|
const path = require('path');
|
|
|
|
const { diffLinesUnified } = require('jest-diff');
|
|
|
|
const UTF8 = 'utf8';
|
|
|
|
const rootDir = path.resolve(__dirname, '..', '..');
|
|
const dataFile = path.resolve(rootDir, '_data', 'simple-icons.json');
|
|
const data = require(dataFile);
|
|
|
|
/**
|
|
* Contains our tests so they can be isolated from each other.
|
|
* @type {{[k:string]: () => (string|undefined)}}
|
|
*/
|
|
const TESTS = {
|
|
/* Tests whether our icons are in alphabetical order */
|
|
alphabetical: () => {
|
|
const collector = (invalidEntries, icon, index, array) => {
|
|
if (index > 0) {
|
|
const prev = array[index - 1];
|
|
const compare = icon.title.localeCompare(prev.title);
|
|
if (compare < 0) {
|
|
invalidEntries.push(icon);
|
|
} else if (compare === 0) {
|
|
if (prev.slug) {
|
|
if (!icon.slug || icon.slug.localeCompare(prev.slug) < 0) {
|
|
invalidEntries.push(icon);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
return invalidEntries;
|
|
};
|
|
const format = (icon) => {
|
|
if (icon.slug) {
|
|
return `${icon.title} (${icon.slug})`;
|
|
}
|
|
return icon.title;
|
|
};
|
|
|
|
const invalids = data.icons.reduce(collector, []);
|
|
if (invalids.length) {
|
|
return `Some icons aren't in alphabetical order:
|
|
${invalids.map((icon) => format(icon)).join(', ')}`;
|
|
}
|
|
},
|
|
|
|
/* Check the formatting of the data file */
|
|
prettified: () => {
|
|
const dataString = fs.readFileSync(dataFile, UTF8).replace(/\r\n/g, '\n');
|
|
const dataPretty = `${JSON.stringify(data, null, ' ')}\n`;
|
|
if (dataString !== dataPretty) {
|
|
const dataDiff = diffLinesUnified(
|
|
dataString.split('\n'),
|
|
dataPretty.split('\n'),
|
|
{
|
|
expand: false,
|
|
omitAnnotationLines: true,
|
|
},
|
|
);
|
|
|
|
return `Data file is formatted incorrectly:\n\n${dataDiff}`;
|
|
}
|
|
},
|
|
};
|
|
|
|
// execute all tests and log all errors
|
|
const errors = Object.keys(TESTS)
|
|
.map((k) => TESTS[k]())
|
|
.filter(Boolean);
|
|
|
|
if (errors.length > 0) {
|
|
errors.forEach((error) => console.error(`\u001b[31m${error}\u001b[0m`));
|
|
process.exit(1);
|
|
}
|