Skip to content

Commit f5412dc

Browse files
jhildenbiddleKoooooo-7
jhildenbiddle
and
Koooooo-7
authored
chore: Update lint configuration (ESLint 9, Prettier 3) (#2438)
* Update linting configuration (eslint, prettier) * Fix lint issues following eslint prettier update * Change ESLint config to allow boolean coercion * Switch to default import name per docs * Fix suppression of error details * Update JSDoc comments * Update waiForFunctin to provide error details --------- Co-authored-by: Koy Zhuang <[email protected]>
1 parent 6552853 commit f5412dc

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

59 files changed

+744
-994
lines changed

‎.eslintignore‎

Lines changed: 0 additions & 11 deletions
This file was deleted.

‎.eslintrc.cjs‎

Lines changed: 0 additions & 83 deletions
This file was deleted.

‎build/cover.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,6 @@ let cover = read(file, 'utf8').toString();
1313
console.log('Replace version number in cover page...');
1414
cover = cover.replace(
1515
/<small>(\S+)?<\/small>/g,
16-
/* html */ `<small>${version}</small>`
16+
/* html */ `<small>${version}</small>`,
1717
);
1818
write(file, cover);

‎build/emoji.js‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ const filePaths = {
99
'src',
1010
'core',
1111
'render',
12-
'emoji-data.js'
12+
'emoji-data.js',
1313
),
1414
};
1515

@@ -26,7 +26,7 @@ async function getEmojiData() {
2626

2727
// Remove base URL from emoji URLs
2828
Object.entries(data).forEach(
29-
([key, value]) => (data[key] = value.replace(baseURL, ''))
29+
([key, value]) => (data[key] = value.replace(baseURL, '')),
3030
);
3131

3232
console.info(`- Retrieved ${Object.keys(data).length} emoji entries`);
@@ -41,7 +41,7 @@ function writeEmojiPage(emojiData) {
4141
const isExistingPage = fs.existsSync(filePaths.emojiMarkdown);
4242
const emojiPage =
4343
(isExistingPage && fs.readFileSync(filePaths.emojiMarkdown, 'utf8')) ||
44-
`<!-- START -->\n\n<!-- END -->`;
44+
'<!-- START -->\n\n<!-- END -->';
4545
const emojiRegEx = /(<!--\s*START.*-->\n)([\s\S]*)(\n<!--\s*END.*-->)/;
4646
const emojiMatch = emojiPage.match(emojiRegEx);
4747
const emojiMarkdownStart = emojiMatch[1].trim();
@@ -51,20 +51,20 @@ function writeEmojiPage(emojiData) {
5151
.reduce(
5252
(preVal, curVal) =>
5353
(preVal += `:${curVal}: ` + '`' + `:${curVal}:` + '`' + '\n\n'),
54-
''
54+
'',
5555
)
5656
.trim();
5757

5858
if (emojiMarkdown !== newEmojiMarkdown) {
5959
const newEmojiPage = emojiPage.replace(
6060
emojiMatch[0],
61-
`${emojiMarkdownStart}\n\n${newEmojiMarkdown}\n\n${emojiMarkdownEnd}`
61+
`${emojiMarkdownStart}\n\n${newEmojiMarkdown}\n\n${emojiMarkdownEnd}`,
6262
);
6363

6464
fs.writeFileSync(filePaths.emojiMarkdown, newEmojiPage);
6565

6666
console.info(
67-
`- ${!isExistingPage ? 'Created' : 'Updated'}: ${filePaths.emojiMarkdown}`
67+
`- ${!isExistingPage ? 'Created' : 'Updated'}: ${filePaths.emojiMarkdown}`,
6868
);
6969
} else {
7070
console.info(`- No changes: ${filePaths.emojiMarkdown}`);
@@ -86,7 +86,7 @@ function writeEmojiJS(emojiData) {
8686
fs.writeFileSync(filePaths.emojiJS, newEmojiJS);
8787

8888
console.info(
89-
`- ${!isExistingPage ? 'Created' : 'Updated'}: ${filePaths.emojiJS}`
89+
`- ${!isExistingPage ? 'Created' : 'Updated'}: ${filePaths.emojiJS}`,
9090
);
9191
} else {
9292
console.info(`- No changes: ${filePaths.emojiJS}`);

‎docs/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!DOCTYPE html>
1+
<!doctype html>
22
<html lang="en">
33
<head>
44
<meta charset="UTF-8" />

‎docs/markdown.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ window.$docsify = {
4747
return /* html */ `
4848
<div class="mermaid">${mermaid.render(
4949
'mermaid-svg-' + num++,
50-
code
50+
code,
5151
)}</div>
5252
`;
5353
}

‎docs/pwa.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -85,19 +85,19 @@ self.addEventListener('fetch', event => {
8585
.then(resp => resp || fetched)
8686
.catch(_ => {
8787
/* eat any errors */
88-
})
88+
}),
8989
);
9090

9191
// Update the cache with the version we fetched (only for ok status)
9292
event.waitUntil(
9393
Promise.all([fetchedCopy, caches.open(RUNTIME)])
9494
.then(
9595
([response, cache]) =>
96-
response.ok && cache.put(event.request, response)
96+
response.ok && cache.put(event.request, response),
9797
)
9898
.catch(_ => {
9999
/* eat any errors */
100-
})
100+
}),
101101
);
102102
}
103103
});

‎eslint.config.js‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
import eslintConfigPrettier from 'eslint-config-prettier';
2+
import playwrightPlugin from 'eslint-plugin-playwright';
3+
import jestPlugin from 'eslint-plugin-jest';
4+
import globals from 'globals';
5+
import js from '@eslint/js';
6+
7+
export default [
8+
// Ignore (Must be first item in array)
9+
{
10+
ignores: [
11+
// Directories
12+
'_playwright-*',
13+
'dist',
14+
'docs',
15+
'lib',
16+
'node_modules',
17+
// Files
18+
'**/*.md',
19+
'CHANGELOG.md',
20+
'emoji-data.*',
21+
'HISTORY.md',
22+
],
23+
},
24+
// ESLint Recommended
25+
js.configs.recommended,
26+
// Configuration: Prettier
27+
eslintConfigPrettier,
28+
// All Files
29+
{
30+
languageOptions: {
31+
globals: {
32+
...globals.browser,
33+
...globals.node,
34+
$docsify: 'readonly',
35+
Docsify: 'readonly',
36+
},
37+
},
38+
rules: {
39+
'array-callback-return': ['error'],
40+
'block-scoped-var': ['error'],
41+
curly: ['error'],
42+
'dot-notation': ['error'],
43+
eqeqeq: ['error'],
44+
'no-implicit-coercion': ['error', { boolean: false }],
45+
'no-implicit-globals': ['error'],
46+
'no-loop-func': ['error'],
47+
'no-return-assign': ['error'],
48+
'no-template-curly-in-string': ['error'],
49+
'no-unneeded-ternary': ['error'],
50+
'no-unused-vars': ['error', { args: 'none' }],
51+
'no-useless-computed-key': ['error'],
52+
'no-useless-return': ['error'],
53+
'no-var': ['error'],
54+
'prefer-const': [
55+
'error',
56+
{
57+
destructuring: 'all',
58+
},
59+
],
60+
},
61+
},
62+
// Source Files
63+
{
64+
files: ['src/**'],
65+
rules: {
66+
'no-console': ['warn'],
67+
},
68+
},
69+
// Tests: E2E (Playwright)
70+
{
71+
files: ['test/e2e/**'],
72+
...playwrightPlugin.configs['flat/recommended'],
73+
},
74+
// Tests: Integration & Unit (Jest)
75+
{
76+
files: ['test/{integration,unit}/**'],
77+
...jestPlugin.configs['flat/recommended'],
78+
},
79+
];

‎middleware.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ export default async function middleware(request) {
4040
const indexHTML = await fetch(indexURL).then(res => res.text());
4141
const previewHTML = rewriteRules.reduce(
4242
(html, rule) => html.replace(rule.match, rule.replace),
43-
indexHTML
43+
indexHTML,
4444
);
4545

4646
return new Response(previewHTML, {

0 commit comments

Comments
 (0)