Move common `tsconfig`, `eslintrc` into seperate packages #1114

Dogdriip · 2023-01-30T09:09:47Z

Self Checklist

I wrote a PR title in English.
I added an appropriate label to the PR.
I wrote a commit message in English.
I wrote a commit message according to the Conventional Commits specification.
I added the appropriate changeset for the changes.
[Component] I wrote a unit test about the implementation.
[Component] I wrote a storybook document about the implementation.
[Component] I tested the implementation in various browsers.
- Windows: Chrome, Edge, (Optional) Firefox
- macOS: Chrome, Edge, Safari, (Optional) Firefox
[New Component] I added my username to the correct directory in the CODEOWNERS file.

Related Issue

Summary

공통으로 사용되는 TypeScript 설정(tsconfig), ESLint(eslintrc)를 모노레포 내 별도의 패키지로 분리하고, 사용처에서 이를 사용합니다.
- 다음 패키지를 추가합니다:
  - supports/tsconfig
  - supports/eslint-config-bezier

Details

graph BT
	subgraph root-workspace[root-workspace]
		direction BT
	  subgraph bezier-react[bezier-react]
			bezier-react-tsconfig-eslint-json[tsconfig.eslint.json]
			bezier-react-eslintrc-js[.eslintrc.js]
		end
	  subgraph bezier-figma-plugin[bezier-figma-plugin]
			bezier-figma-plugin-tsconfig-eslint-json[tsconfig.eslint.json]
			bezier-figma-plugin-eslintrc-js[.eslintrc.js]
		end
		subgraph tsconfig[tsconfig]
			eslint-json[eslint.json]
			script-json[script.json]
		end
		subgraph eslint-config-bezier[eslint-config-bezier]
			index.js[index.js]
		end
		channel-io-eslint-config(["@channel.io/eslint-config"])
		channel-io-eslint-plugin(["@channel.io/eslint-plugin"])

		bezier-react-tsconfig-eslint-json --> eslint-json
		bezier-react-eslintrc-js --> eslint-config-bezier
		bezier-figma-plugin-tsconfig-eslint-json --> eslint-json
		bezier-figma-plugin-eslintrc-js --> eslint-config-bezier

		eslint-config-bezier -.-> channel-io-eslint-config
		eslint-config-bezier -.-> channel-io-eslint-plugin

		deps([eslint, stylelint, ...])
	end

기존에 root workspace에 존재하던 tsconfig.eslint.json과 tsconfig.script.json을 별도의 패키지로 분리합니다.
기존에 root workspace에 존재하던 ESLint 설정(.eslintrc.js)과 관련 패키지(@channel.io/eslint-config, @channel.io/eslint-plugin, peerDeps)들을 별도의 패키지로 분리합니다.

사용처에서는 다음과 같이 모노레포 내의 패키지를 불러와서 사용합니다.

"devDependencies": {
  "eslint-config-bezier": "workspace:*",
  "tsconfig": "workspace:*",
  ...
},

폴더 및 패키지 구성은 다음 레포와 링크를 적극 참고하였습니다:

Breaking change or not (Yes/No)

No.

References

…config

changeset-bot · 2023-01-30T09:09:51Z

⚠️ No Changeset found

Latest commit: 88ae450

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

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

codecov · 2023-01-30T09:13:44Z

Codecov Report

Patch and project coverage have no change.

Comparison is base (543632e) 78.00% compared to head (88ae450) 78.00%.

Additional details and impacted files

@@           Coverage Diff            @@
##           next-v1    #1114   +/-   ##
========================================
  Coverage    78.00%   78.00%           
========================================
  Files          291      291           
  Lines         3778     3778           
  Branches       833      833           
========================================
  Hits          2947     2947           
  Misses         537      537           
  Partials       294      294

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

github-actions · 2023-01-30T09:14:50Z

Chromatic Report

🚀 Congratulations! Your build was successful!

carlos-channel-io · 2023-02-02T05:31:55Z

packages/eslint-config-bezier/package.json

+    "eslint-plugin-react-hooks": "^4.6.0",
+    "typescript": "^4.9.4"
+  }
+}


inhibitor1217 · 2023-02-02T08:05:45Z

packages/tsconfig/script.json

@@ -1,7 +1,8 @@
 {
+  "$schema": "https://json.schemastore.org/tsconfig",


https://json-schema.org/ turbo 예제에서도 사용하고 있어서 일단 사용해 보았습니다. 원래 VSCode에서 파일명이 tsconfig*이면 잡아주는 것 같긴 한데, 이 파일은 그렇지 않아서 유용하다고 생각했습니다.

packages/tsconfig/package.json

packages/bezier-react/.eslintrc.js

inhibitor1217 · 2023-02-02T08:12:55Z

packages/bezier-figma-plugin/.eslintrc.js

@@ -0,0 +1,17 @@
+module.exports = {
+  root: true,
+  extends: ['bezier'],


package 이름이 eslint-config-bezier 라서 bezier로 로드되는거죠?

넵 맞습니다!

The eslint-config- prefix can be omitted from the configuration name. For example, airbnb resolves as eslint-config-airbnb. #

…or1217

…or1217)

Dogdriip · 2023-03-02T08:49:36Z

IDE의 ESLint 설정을 모노레포 환경에 맞게 잡으려면 https://medium.com/devityoself/monorepo-eslint-vscode-6f5982c8404d 이 글과 같이 IDE별로 별도의 설정이 필요한데, .vscode/settings.json를 레포에 포함시키는 건 좋지 않을 것 같아서 어떻게 해야 할지 고민이네요 🤔

README.md

sungik-choi · 2023-03-06T08:45:26Z

IDE의 ESLint 설정을 모노레포 환경에 맞게 잡으려면 https://medium.com/devityoself/monorepo-eslint-vscode-6f5982c8404d 이 글과 같이 IDE별로 별도의 설정이 필요한데, .vscode/settings.json를 레포에 포함시키는 건 좋지 않을 것 같아서 어떻게 해야 할지 고민이네요 🤔

레포에 포함해도 괜찮다고 생각해요. https://github.com/Shopify/polaris/tree/main/.vscode 이런 예시들도 있구요.

This reverts commit a6099c8.

Dogdriip added 14 commits January 30, 2023 15:15

feat(packages): add tsconfig package

a8927ef

refactor(tsconfig.script): move into packages/tsconfig

9151eed

feat(bezier-react): add tsconfig as deps

ddb1c88

refactor(bezier-react): move eslintrc, tsconfig.eslint into package

7c3a831

fix(bezier-react/eslintrc): resolve path, remove bezier-figma-plugin …

5d5e77e

…config

feat(bezier-figma-plugin): move eslintrc into package

93457e2

feat(packages): add eslint-config-bezier

91ff270

feat(packages/*): use eslint-config-bezier

300e72f

refactor(root): remove eslint config/plugin deps from root workspace

446689c

docs(readme): add tsconfig, eslint-config-bezier to table

a6099c8

refactor(eslint-config-bezier): remove eslint from deps

d0620bd

chore(bezier-figma-plugin): add tsconfig deps

74f4119

fix(eslint-config-bezier): devDeps to deps

4bbf9b9

feat(root): add root eslintrc

56714d2

Dogdriip added refactoring Issue or PR related to refactoring with no functional changes build Issue or PR related to build system labels Jan 30, 2023

Dogdriip requested a review from sungik-choi as a code owner January 30, 2023 09:09

Dogdriip self-assigned this Jan 30, 2023

Dogdriip requested a review from carlos-channel-io January 30, 2023 10:04

Dogdriip mentioned this pull request Jan 30, 2023

Remove path alias of tsconfig and use tilde(~) specifier #1109

Merged

9 tasks

carlos-channel-io approved these changes Feb 2, 2023

View reviewed changes

Dogdriip requested a review from inhibitor1217 February 2, 2023 05:41

inhibitor1217 reviewed Feb 2, 2023

View reviewed changes

Dogdriip added 3 commits February 6, 2023 11:17

chore(packages): move config packages to supports (@inhibitor1217)

be2822b

fix(.eslintrc): remove redundant nextjs settings

dfd72f2

feat(eslint-config-bezier): add eslintrc for config package itself

997bcc9

carlos-channel-io self-requested a review February 6, 2023 05:06

Dogdriip added 4 commits March 2, 2023 16:42

Merge branch 'next-v1' into refactor/shared-tsconfig

cead66a

fix(root): remove root .eslintrc

e20dd81

fix(bezier-react/.eslintrc): fix import/order override path (@inhibit…

25e9bfc

…or1217)

chore(supports/eslint-config-bezier): remove eslintrc of itself

274e71b

sungik-choi approved these changes Mar 6, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

Dogdriip added 3 commits March 7, 2023 12:55

Merge branch 'next-v1' into refactor/shared-tsconfig

d25bf19

Revert "docs(readme): add tsconfig, eslint-config-bezier to table"

fc50c26

This reverts commit a6099c8.

feat(.vscode): add workspace settings for eslint

88ae450

Dogdriip merged commit 82f6be3 into channel-io:next-v1 Mar 9, 2023

Dogdriip deleted the refactor/shared-tsconfig branch March 9, 2023 09:11

sungik-choi mentioned this pull request Mar 9, 2023

chore(supports): add version, private and description value to package.json #1161

Merged

9 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Move common `tsconfig`, `eslintrc` into seperate packages #1114

Move common `tsconfig`, `eslintrc` into seperate packages #1114

Dogdriip commented Jan 30, 2023 •

edited

Loading

changeset-bot bot commented Jan 30, 2023 •

edited

Loading

codecov bot commented Jan 30, 2023 •

edited

Loading

github-actions bot commented Jan 30, 2023 •

edited

Loading

carlos-channel-io Feb 2, 2023

inhibitor1217 Feb 2, 2023

Dogdriip Feb 6, 2023

inhibitor1217 Feb 2, 2023

Dogdriip Feb 6, 2023

Dogdriip commented Mar 2, 2023 •

edited

Loading

sungik-choi commented Mar 6, 2023 •

edited

Loading

		@@ -1,7 +1,8 @@
		{
		"$schema": "https://json.schemastore.org/tsconfig",

Move common tsconfig, eslintrc into seperate packages #1114

Move common tsconfig, eslintrc into seperate packages #1114

Conversation

Dogdriip commented Jan 30, 2023 • edited Loading

Self Checklist

Related Issue

Summary

Details

Breaking change or not (Yes/No)

References

changeset-bot bot commented Jan 30, 2023 • edited Loading

⚠️ No Changeset found

codecov bot commented Jan 30, 2023 • edited Loading

Codecov Report

github-actions bot commented Jan 30, 2023 • edited Loading

Chromatic Report

carlos-channel-io Feb 2, 2023

Choose a reason for hiding this comment

inhibitor1217 Feb 2, 2023

Choose a reason for hiding this comment

Dogdriip Feb 6, 2023

Choose a reason for hiding this comment

inhibitor1217 Feb 2, 2023

Choose a reason for hiding this comment

Dogdriip Feb 6, 2023

Choose a reason for hiding this comment

Dogdriip commented Mar 2, 2023 • edited Loading

sungik-choi commented Mar 6, 2023 • edited Loading

Move common `tsconfig`, `eslintrc` into seperate packages #1114

Move common `tsconfig`, `eslintrc` into seperate packages #1114

Dogdriip commented Jan 30, 2023 •

edited

Loading

changeset-bot bot commented Jan 30, 2023 •

edited

Loading

codecov bot commented Jan 30, 2023 •

edited

Loading

github-actions bot commented Jan 30, 2023 •

edited

Loading

Dogdriip commented Mar 2, 2023 •

edited

Loading

sungik-choi commented Mar 6, 2023 •

edited

Loading