chore(repo): Extend linting by tmilewski · Pull Request #1906 · clerk/javascript

tmilewski · 2023-10-17T18:29:49Z

Description

Our current ESLint configuration was global which left a lot to be desired as each of our packages have unique requirements.

This PR extends leans on a generic set of ESLint configurations while also allowing for a lot of customizability at both the ESLint "feature"-level as well as the package-level.

Please focus on this commit as these are the changes: f2c3b64
The other changes are to appease Prettier.

Please Note:

In an effort to keep this PR as minimal as possible, I've disabled a number of rules. The plan is to re-enable them via follow-on PRs.)

Other Notes:

The /integration directory has been factored into NPM workspaces and, ultimately, Turborepo. This doesn't have any tangible change other than running linting along with the packages.
ESLint (when utilizing Typescript) will target tsconfig.lint.json. If that does not exists, it moves on to tsconfig.json. The lint TSConfig was required in a few cases as the default one wasn't permissive enough with it's includes/excludes.
I had to skip the Husky tasks so that it didn't attempt to update and commit all of the "fixable" issues.

Checklist

npm test runs as expected.
npm run build runs as expected.
(If applicable) JSDoc comments have been added or updated for any package exports
(If applicable) Documentation has been updated

Type of change

Packages affected

changeset-bot · 2023-10-17T18:29:53Z

🦋 Changeset detected

Latest commit: 2ae8894

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 12 packages

Name	Type
eslint-config-custom	Minor
@clerk/backend	Patch
@clerk/chrome-extension	Patch
@clerk/clerk-js	Patch
@clerk/clerk-expo	Patch
@clerk/fastify	Patch
gatsby-plugin-clerk	Patch
@clerk/localizations	Patch
@clerk/nextjs	Patch
@clerk/clerk-react	Patch
@clerk/remix	Patch
@clerk/clerk-sdk-node	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

LekoArts · 2023-10-18T07:52:42Z

How much of an effort would it be to to not use tsconfig.lint.json across the board and instead rely on tsconfig.json (and fixing those)? Just as an estimated guess

tmilewski · 2023-10-18T17:25:38Z

How much of an effort would it be to to not use tsconfig.lint.json across the board and instead rely on tsconfig.json (and fixing those)? Just as an estimated guess

@LekoArts Not much of an effort, but it would make the tsconfig.json quite all-encompassing. I just didn't want to cause any unnecessary side-effects.

tmilewski · 2023-10-19T21:09:48Z

  updated_at: number;
 }

-export interface OrganizationSuggestionJSON extends ClerkResourceJSON {


Note: This is an exact copy of the interface above it which ESLint didn't catch until now.

LekoArts · 2023-10-31T08:55:12Z

Is the addition of integration into the workspaces necessary? It'll mean that you have to install more dependencies for the monorepo even though you might not be interested in running the tests + you could more easily run into problems of "multiple different versions of packages".

In CI you could still cache the node_modules on an individual level for each test suite.

tmilewski · 2023-10-31T14:05:07Z

Is the addition of integration into the workspaces necessary? It'll mean that you have to install more dependencies for the monorepo even though you might not be interested in running the tests + you could more easily run into problems of "multiple different versions of packages".

In CI you could still cache the node_modules on an individual level for each test suite.

@LekoArts There's actually no noticeable difference. I should note that integrations is included, not integations/* so it's not attempting to install each integration test's deps.

LekoArts · 2023-10-31T15:13:02Z

The integration folder doesn't have a package.json file (I see it in another commit but not in the total view of this PR). What you're saying makes sense then, but isn't that package.json then missing?

…tuents

tmilewski · 2023-10-31T15:33:27Z

The integration folder doesn't have a package.json file (I see it in another commit but not in the total view of this PR). What you're saying makes sense then, but isn't that package.json then missing?

Ah, you are correct, it's a remnant of a past commit. Updated, thanks!

LekoArts

tmilewski self-assigned this Oct 17, 2023

tmilewski requested a review from a team as a code owner October 17, 2023 18:29

clerk-cookie added types clerk-js nextjs react remix backend fastify localizations sdk-node expo chrome-extension gatsby themes integration labels Oct 17, 2023

tmilewski force-pushed the tom/eslint branch from d4ed0b3 to 8a20125 Compare October 18, 2023 17:22

tmilewski force-pushed the tom/eslint branch 2 times, most recently from 32cf88c to 3998f07 Compare October 19, 2023 17:01

tmilewski commented Oct 19, 2023

View reviewed changes

tmilewski force-pushed the tom/eslint branch from 0ded153 to e6c1926 Compare October 19, 2023 21:20

desiprisg reviewed Oct 20, 2023

View reviewed changes

Comment thread packages/clerk-js/src/utils/devBrowser.ts Outdated

tmilewski force-pushed the tom/eslint branch from 7c8e4b7 to 42ca7f3 Compare October 23, 2023 18:35

LekoArts reviewed Oct 23, 2023

View reviewed changes

Comment thread .husky/pre-commit Outdated

tmilewski force-pushed the tom/eslint branch from 6322c37 to aade606 Compare October 29, 2023 19:51

tmilewski requested review from LekoArts and nikosdouvlis October 30, 2023 14:20

tmilewski requested a review from desiprisg October 30, 2023 14:22

tmilewski force-pushed the tom/eslint branch from 6c6e98f to d03481d Compare October 31, 2023 00:30

tmilewski added 15 commits October 31, 2023 08:14

chore(repo): Extend linting

c2c2b81

fix(repo): Add backend dep to integation tests

88d45bb

chore(repo): Run Prettier

7f5121c

chore(repo): Update rules to be more in-line with current expectations

a40b733

chore(repo): Run Prettier

118d23b

chore(repo): Update precommit call to eslint fix

9166b7e

chore(repo): Test without local dependencies

64d0e79

chore(repo): Update ESLint dependencies

c098455

chore(repo): Remove integration from eslint

4ed8fc6

fix(*): Rebase formatting issues

22be7e1

chore(clerk-js): Temp disable typeof issue

1efe6d3

chore(repo): ESLint auto-fix (#1978)

2fb03ac

refactor(repo): Speed up linting staged files

b61987d

chore(repo): Temp disable @typescript-eslint/no-duplicate-type-consti…

8019462

…tuents

chore(repo): Include mjs in precommit hook

3c5c5d7

tmilewski force-pushed the tom/eslint branch from d03481d to 3c5c5d7 Compare October 31, 2023 15:20

chore(repo): Remove integration from npm workspaces

2ae8894

LekoArts approved these changes Oct 31, 2023

View reviewed changes

tmilewski added this pull request to the merge queue Oct 31, 2023

Merged via the queue into main with commit c895629 Oct 31, 2023

tmilewski deleted the tom/eslint branch October 31, 2023 16:26

clerk-cookie mentioned this pull request Nov 1, 2023

Version Packages (alpha-v5) #2000

Merged

LekoArts mentioned this pull request Nov 3, 2023

fix(shared): Remove sideEffects again #2024

Merged

24 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

chore(repo): Extend linting - #1906

chore(repo): Extend linting#1906
tmilewski merged 16 commits into
mainfrom
tom/eslint

tmilewski commented Oct 17, 2023 •

edited

Loading

Uh oh!

changeset-bot Bot commented Oct 17, 2023 •

edited

Loading

Uh oh!

LekoArts commented Oct 18, 2023 •

edited

Loading

Uh oh!

tmilewski commented Oct 18, 2023

Uh oh!

tmilewski Oct 19, 2023

Uh oh!

Uh oh!

Uh oh!

LekoArts commented Oct 31, 2023

Uh oh!

tmilewski commented Oct 31, 2023 •

edited

Loading

Uh oh!

LekoArts commented Oct 31, 2023

Uh oh!

tmilewski commented Oct 31, 2023

Uh oh!

LekoArts left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

tmilewski commented Oct 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Please Note:

Other Notes:

Checklist

Type of change

Packages affected

Uh oh!

changeset-bot Bot commented Oct 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

LekoArts commented Oct 18, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tmilewski commented Oct 18, 2023

Uh oh!

tmilewski Oct 19, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

LekoArts commented Oct 31, 2023

Uh oh!

tmilewski commented Oct 31, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

LekoArts commented Oct 31, 2023

Uh oh!

tmilewski commented Oct 31, 2023

Uh oh!

LekoArts left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

tmilewski commented Oct 17, 2023 •

edited

Loading

changeset-bot Bot commented Oct 17, 2023 •

edited

Loading

LekoArts commented Oct 18, 2023 •

edited

Loading

tmilewski commented Oct 31, 2023 •

edited

Loading