Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(cli): change helper folder structure #240

Merged
merged 7 commits into from
Aug 4, 2023
Merged

chore(cli): change helper folder structure #240

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
8ee18b2
chore(cli): change helper folder structure
eunjae-lee Aug 1, 2023
ff658da
fix formatting issue
eunjae-lee Aug 1, 2023
f0c2de2
update .prettierignore
eunjae-lee Aug 1, 2023
8db177e
remove test code
eunjae-lee Aug 1, 2023
8c5a75c
fix lint
eunjae-lee Aug 1, 2023
e44ef4b
fix vue3 helper build
eunjae-lee Aug 1, 2023
71e5f80
move building helpers into the library
eunjae-lee Aug 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions .github/workflows/ci-library.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,10 @@ jobs:
- name: Check Types
run: yarn workspace @storyblok/field-plugin check:types
- name: Lint
run: yarn eslint packages/field-plugin
run: |
yarn eslint packages/field-plugin --ignore-pattern "packages/field-plugin/helpers/"
yarn workspaces foreach --include "helper-*" run lint
Comment on lines +27 to +28
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • line 27: ignore helpers from eslint
  • line 28: run eslint for helpers with their own configs

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why should they run separately?

Does this not solve the problem:

helper-vue3/.eslintrc.json

{
  "root": true,
  ...
}

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It didn't work. As far as I understand, the moment you run yarn eslint packages/field-plugin, it loads the root eslint config and apply it to all the files below. That root: true prevents your eslint process from "going up". So I had to separate them to make them work. Maybe I should just ignore the helpers in the root eslint config, so that I don't have to explicitly exclude them in the command line?

- name: Test
run: yarn workspace @storyblok/field-plugin test
- name: Build
run: yarn workspace @storyblok/field-plugin build

2 changes: 1 addition & 1 deletion .prettierignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
node_modules/
packages/*/dist/
packages/**/dist/
3 changes: 2 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@
],
"workspaces": [
"packages/*",
"packages/cli/templates/*"
"packages/cli/templates/*",
"packages/field-plugin/helpers/*"
],
"engines": {
"yarn": "^3.2.4"
Expand Down
1 change: 1 addition & 0 deletions packages/helper-react/.eslintrc.cjs → .../field-plugin/helpers/react/.eslintrc.cjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
module.exports = {
root: true,
env: { browser: true, es2020: true },
extends: [
'eslint:recommended',
Expand Down
2 changes: 1 addition & 1 deletion packages/helper-react/package.json → ...s/field-plugin/helpers/react/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"scripts": {
"dev": "vite",
"build": "tsc && vite build",
"lint": "eslint src --ext ts,tsx --report-unused-disable-directives --max-warnings 0 --resolve-plugins-relative-to ."
"lint": "eslint src --ext ts,tsx --report-unused-disable-directives --max-warnings 0"
},
"dependencies": {
"@storyblok/field-plugin": "workspace:*",
Expand Down
0 ...es/helper-react/src/FieldPluginContext.ts → ...n/helpers/react/src/FieldPluginContext.ts
View file
Open in desktop
File renamed without changes.
0 .../helper-react/src/FieldPluginProvider.tsx → ...helpers/react/src/FieldPluginProvider.tsx
View file
Open in desktop
File renamed without changes.
0 packages/helper-react/src/index.ts → ...s/field-plugin/helpers/react/src/index.ts
View file
Open in desktop
File renamed without changes.
0 packages/helper-react/src/useFieldPlugin.ts → ...lugin/helpers/react/src/useFieldPlugin.ts
View file
Open in desktop
File renamed without changes.
0 packages/helper-react/tsconfig.json → .../field-plugin/helpers/react/tsconfig.json
View file
Open in desktop
File renamed without changes.
0 packages/helper-react/tsconfig.node.json → ...d-plugin/helpers/react/tsconfig.node.json
View file
Open in desktop
File renamed without changes.
0 packages/helper-react/vite.config.ts → ...field-plugin/helpers/react/vite.config.ts
View file
Open in desktop
File renamed without changes.
0 packages/helper-vue2/.gitignore → ...ages/field-plugin/helpers/vue2/.gitignore
View file
Open in desktop
File renamed without changes.
0 packages/helper-vue2/README.md → packages/field-plugin/helpers/vue2/README.md
View file
Open in desktop
File renamed without changes.
0 packages/helper-vue2/package.json → ...es/field-plugin/helpers/vue2/package.json
View file
Open in desktop
File renamed without changes.
0 ...s/helper-vue2/src/FieldPluginProvider.vue → .../helpers/vue2/src/FieldPluginProvider.vue
View file
Open in desktop
File renamed without changes.
0 packages/helper-vue2/src/index.js → ...es/field-plugin/helpers/vue2/src/index.js
View file
Open in desktop
File renamed without changes.
0 packages/helper-vue2/vite.config.js → .../field-plugin/helpers/vue2/vite.config.js
View file
Open in desktop
File renamed without changes.
9 changes: 2 additions & 7 deletions packages/helper-vue3/.eslintrc.json → .../field-plugin/helpers/vue3/.eslintrc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,6 @@
"parser": "@typescript-eslint/parser",
"sourceType": "module"
},
"plugins": [
"prettier",
"@typescript-eslint",
"vue"
],
"rules": {
}
"plugins": ["prettier", "@typescript-eslint", "vue"],
"rules": {}
}
0 packages/helper-vue3/.gitignore → ...ages/field-plugin/helpers/vue3/.gitignore
View file
Open in desktop
File renamed without changes.
4 changes: 2 additions & 2 deletions packages/helper-vue3/package.json → ...es/field-plugin/helpers/vue3/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
"type": "module",
"scripts": {
"dev": "vite",
"build": "vue-tsc && vite build && mv dist/src/* dist/",
"lint": "eslint ."
"build": "vue-tsc && vite build",
"lint": "eslint src"
},
"dependencies": {
"@storyblok/field-plugin": "workspace:*",
Expand Down
2 changes: 1 addition & 1 deletion ...s/helper-vue3/src/FieldPluginProvider.vue → .../helpers/vue3/src/FieldPluginProvider.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import {
FieldPluginResponse,
FieldPluginData,
} from '@storyblok/field-plugin'
import { convertToRaw } from '../utils'
import { convertToRaw } from './utils'

const plugin = reactive<FieldPluginResponse>({
type: 'loading',
Expand Down
0 packages/helper-vue3/src/index.ts → ...es/field-plugin/helpers/vue3/src/index.ts
View file
Open in desktop
File renamed without changes.
0 packages/helper-vue3/src/useFieldPlugin.ts → ...plugin/helpers/vue3/src/useFieldPlugin.ts
View file
Open in desktop
File renamed without changes.
1 change: 1 addition & 0 deletions packages/helper-vue3/utils/convertToRaw.ts → ...in/helpers/vue3/src/utils/convertToRaw.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { toRaw, isProxy, isRef, unref } from 'vue'

// eslint-disable-next-line @typescript-eslint/no-explicit-any
export function convertToRaw(value: any): any {
let rawValue = value
if (isProxy(rawValue)) {
Expand Down
0 packages/helper-vue3/utils/index.ts → ...ld-plugin/helpers/vue3/src/utils/index.ts
View file
Open in desktop
File renamed without changes.
0 packages/helper-vue3/src/vite-env.d.ts → ...eld-plugin/helpers/vue3/src/vite-env.d.ts
View file
Open in desktop
File renamed without changes.
13 changes: 2 additions & 11 deletions packages/helper-vue3/tsconfig.json → ...s/field-plugin/helpers/vue3/tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,7 @@
"target": "ES2020",
"useDefineForClassFields": true,
"module": "ESNext",
"lib": [
"ES2020",
"DOM",
"DOM.Iterable"
],
"lib": ["ES2020", "DOM", "DOM.Iterable"],
"skipLibCheck": true,
/* Bundler mode */
"moduleResolution": "bundler",
Expand All @@ -22,12 +18,7 @@
"noUnusedParameters": true,
"noFallthroughCasesInSwitch": true
},
"include": [
"src/**/*.ts",
"src/**/*.d.ts",
"src/**/*.tsx",
"src/**/*.vue"
],
"include": ["src/**/*.ts", "src/**/*.d.ts", "src/**/*.tsx", "src/**/*.vue"],
"references": [
{
"path": "./tsconfig.node.json"
Expand Down
4 changes: 1 addition & 3 deletions packages/helper-vue3/tsconfig.node.json → ...ld-plugin/helpers/vue3/tsconfig.node.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,5 @@
"moduleResolution": "bundler",
"allowSyntheticDefaultImports": true
},
"include": [
"vite.config.ts"
]
"include": ["vite.config.ts"]
}
0 packages/helper-vue3/vite.config.ts → .../field-plugin/helpers/vue3/vite.config.ts
View file
Open in desktop
File renamed without changes.
6 changes: 3 additions & 3 deletions scripts/copy-helpers.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

mkdir ./packages/field-plugin/dist/{react,vue2,vue3}

cp -r ./packages/helper-react/dist/* ./packages/field-plugin/dist/react/
cp -r ./packages/helper-vue2/dist/* ./packages/field-plugin/dist/vue2/
cp -r ./packages/helper-vue3/dist/* ./packages/field-plugin/dist/vue3/
cp -r ./packages/field-plugin/helpers/react/dist/* ./packages/field-plugin/dist/react/
cp -r ./packages/field-plugin/helpers/vue2/dist/* ./packages/field-plugin/dist/vue2/
cp -r ./packages/field-plugin/helpers/vue3/dist/* ./packages/field-plugin/dist/vue3/

Loading