chore: add types #411

shioju · 2024-10-26T01:56:37Z

Add more type safety

Branched off #404 so will need to be rebased to master after that branch is merged in

I've kept this PR as small as possible (~500 lines) by splitting it into PRs with manageable chunks of code
I've requested reviews from 1 reviewer
I've tested existing features (website scan, sitemap, custom flow) in both node index and cli
I've synced this fork with GovTechSG repo
I've added/updated unit tests
I've added/updated any necessary dependencies in package[-lock].json npm audit, portable installation on GitHub Actions

Set to display lint warnings instead of stopping the next cmd

… upper-cased Object

Reason is it is still easy to read and does not introduce too many whitespacing

…pression

Due to process.exit will return early need add eslint-disable-next-line no-unreachable

…erator-runtime dependency

… with double quotes Improved clarity and consistency in the alt text error message formatting

…iable issues Resolved ESLint warnings related to undefined browser-specific variables Ensured compatibility for both Node.js and browser environments in the project

…pression

Include whitespacing, comma, use const instead of let, reorder function first before variable is used, remove unnecessary else statement, adding semicolon

…ability

Include whitespacing, comma, use const instead of let, reordering function first before variable is used, add semicolon

Include whitespacing, add semicolon, reordering function first before variable is used, add semicolon

It is being used in other files except the current file where is being defined

Explicitly cast yargs.parse() result to 'Answers' type using 'as unknown as Answers' for improved type safety

- reason is because it does not serve much purpose for now but in the future where linting will need to be enforced then change here

Wilson WeeSheng Khoo added 30 commits October 23, 2024 14:43

Update build script with lint warnings

794283f

Set to display lint warnings instead of stopping the next cmd

Reorder and remove unused methods from import packages

a9c96ac

Fix spacing issues

b5fc7ed

Fix prefer using the primitive object as a type name, rather than the…

36d17a5

… upper-cased Object

Resolve variable was used before it was defined

a19a80a

Remove unused variables

ce34d01

Disable lines-between-class-members rule

1839924

Reason is it is still easy to read and does not introduce too many whitespacing

Use const instead of let

8ab3171

Fix whitespacing linting

35a67f4

Resolve expected an assignment or function call and instead saw an ex…

01f3b49

…pression

Resolve assignment to property of function parameter 'argvs'

b79c89a

Resolve the warning of adding break before case statement

68c484c

Due to process.exit will return early need add eslint-disable-next-line no-unreachable

Resolve unexpected lexical declaration in case block

1c4a481

Resolve unexpected string concatenation

df445e7

Refactor logger transport configuration for improved readability

0d030ad

Rename __filename to filename for consistency with modern ESM syntax

5c94179

Add comma for linting purpose

72ef073

Use || for better readability

29f8c78

Fix whitespacing issues

d542e21

Refactor: Replace for...of loops with array iterations to avoid regen…

cc6bf8f

…erator-runtime dependency

Replaced single quotes with escape characters in the alt text message…

9aabed9

… with double quotes Improved clarity and consistency in the alt text error message formatting

Add browser environment to ESLint configuration to resolve global var…

9735d65

…iable issues Resolved ESLint warnings related to undefined browser-specific variables Ensured compatibility for both Node.js and browser environments in the project

Use method shorthand to resolve unnamed method and ESLint warnings

0ed9b06

Fix using variable first before method is defined

f41e5e3

Avoid reassignment of function parameter to comply with ESLint rules

bd22aae

Fix warnings for unnecessary else after return

95f747b

Use concise arrow function syntax and simplify Promise.all formatting

7abe23c

Using string interpolation syntax

e960cb0

Resolve variable name conflict in createScreenshotsFolder function

cc316d3

Remove unnecessary try/catch wrapper around spawnSync and execSync

c42ec04

Wilson WeeSheng Khoo and others added 30 commits October 23, 2024 20:29

Removed unnecessary parentheses around a single parameter

5e52e94

Add semicolon

d7a343a

Use const instead of let

5972aed

Resolve expected an assignment or function call and instead saw an ex…

ef64094

…pression

Remove unnecessary return statement

541be99

Replace == with === for strict equality checks

de88072

Fix eslint warnings for crawlIntelligentSitemap

90c30df

Include whitespacing, comma, use const instead of let, reorder function first before variable is used, remove unnecessary else statement, adding semicolon

Chain with else if

efbb92b

Reformatted function parameters across multiple lines for better read…

95193d2

…ability

Use object destructuring to simplify variable assignment

3b53706

Separated the destructuring which will be reassigned and const

2a5c4fa

Fix eslint warnings for htmlScreenshotFunc

154bea4

Include whitespacing, comma, use const instead of let, reordering function first before variable is used, add semicolon

Fix eslint warnings for pdfScreenshotFunc

372de80

Include whitespacing, add semicolon, reordering function first before variable is used, add semicolon

Replace != with !== for strict equality checks

cde27c9

Wrap eslint-disable for no-unused-vars warning

3360cfb

It is being used in other files except the current file where is being defined

Resolve variable name conflict

372a518

Remove unsued variable

3588f03

Remove redundant use of await inside Promise.all

363a079

Remove unnecessary variable assignment from RequestList.open

e773bd5

Use const instead of let

3358934

Replace unary increment operator with += 1

243fed8

Change to default export to resolve ESLint warning

8828a93

Refactor option handling for type safety and cleaner syntax

f1c3d3c

Explicitly cast yargs.parse() result to 'Answers' type using 'as unknown as Answers' for improved type safety

Using export default for single class

4f9ce0b

Update type of any to string[] for getWcagPassPercentage function

598ce18

Intentionally disable no-await-in-loop warning for retryFunction

451d0c4

Using export default for single class

d7d25bc

Remove lint from build

c687a26

- reason is because it does not serve much purpose for now but in the future where linting will need to be enforced then change here

chore: return never from process.exit calls so that eslint knows it's ok

9504243

chore: use DeviceDescriptor type derived from playwright

21eceb5

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: add types #411

chore: add types #411

shioju commented Oct 26, 2024

chore: add types #411

Are you sure you want to change the base?

chore: add types #411

Conversation

shioju commented Oct 26, 2024