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

Jump to bottom

Define explicit dependencies and update configs #9

Merged
merged 39 commits into from
Mar 11, 2022
Merged

Define explicit dependencies and update configs #9

merged 39 commits into from
Mar 11, 2022

Conversation

jackw
Copy link
Collaborator

@jackw jackw commented Mar 1, 2022 •
edited by leventebalogh
Loading

This PR removes toolkit from the dependency tree in favour of explicitly declaring devDependencies within the scaffolded plugins package.json.

  • Remove @grafana/toolkit in place of declared devDependencies
  • Use TS for webpack config
  • Rewrite webpack config to use latest tooling (SWC)
  • Compile to ES6 for smaller plugin bundles
  • Introduce docker so plugin devs can easily dev against a running instance of Grafana
  • Make sure unit & integration testing works (Jest, React-testing-library)
  • Make sure e2e testing works (Cypress)
  • Add TS module definitions for non JS/TS imports
  • Update Readme with all the above
  • Test various plugins against the above webpack config changes (see plugin-examples repo)

I've tested loading a plugin compiled using these changes in Grafana and it all seems to function fine...

image

Fixes: #6

@jackw jackw added the enhancement New feature or request label Mar 1, 2022
@jackw jackw requested review from mckn and leventebalogh March 1, 2022 16:29
@jackw jackw self-assigned this Mar 1, 2022
@jackw jackw changed the title Define explicit dependencies and update webpack config Define explicit dependencies and update configs Mar 4, 2022
@leventebalogh leventebalogh mentioned this pull request Mar 4, 2022
Closed
@jackw jackw removed the request for review from leventebalogh March 9, 2022 08:31
mckn
mckn approved these changes Mar 10, 2022
View reviewed changes
Copy link
Collaborator

@mckn mckn left a comment

Choose a reason for hiding this comment

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

LGTM

jackw and others added 20 commits March 10, 2022 13:28
@jackw @leventebalogh
feat: introduce docker to dev inside an instance of grafana
b03e372
@jackw @leventebalogh
fix(simple-panel): import @emotion/css
be0f5e5
@jackw @leventebalogh
chore(common): remove toolkit in favour of explicit devDependencies
57b626a
@jackw @leventebalogh
refactor(webpack): use ts for config, replace babel with swc, use web…
0156fe0 
…pack5 features
@jackw @leventebalogh
refactor(common): update package.json webpack scripts
1bbf8c3
@jackw @leventebalogh
chore(common): prevent eslint from looking up the tree for other esli…
eadaae5 
…ntrc
@jackw @leventebalogh
chore(common): remove yarn.lock file in favour of using latest deps o…
20228f1 
…n scaffold
@jackw @leventebalogh
chore: speed up dev by preserving yarn.lock file
bd801fb
@jackw @leventebalogh
feat(plop): introduce if_eq plopHelper
332991c
@jackw @leventebalogh
feat(common): define app specific dependencies in package.json
244412b
@jackw @leventebalogh
feat(common): introduce swc/jest for frontend testing
7433e73
@jackw @leventebalogh
chore(webpack): update comment
13b4cb5
@jackw @leventebalogh
feat(jest): add dependency and update config
6dbc798
@leventebalogh
chore(NVM): add an .nvmrc
82c02c1
@leventebalogh
refactor(templates/app): move component files under separate folders
7c12a80
@leventebalogh
chore(jest): add a Jest setup file
05b8960
@leventebalogh
chore(npm): add @testing-library to the dev-dependencies
60971ed
@leventebalogh
feat: add basic tests to <App> and <AppConfig>
640faf6
@leventebalogh
chore(VS Code): stop allowing format-on-save for json files
61056b4
@leventebalogh
refactor: update import paths in module.ts
c0f498d
leventebalogh and others added 15 commits March 10, 2022 13:29
@leventebalogh
feat: add more tests for the <AppConfig> component
fd2d58f
@jackw @leventebalogh
feat(common): introduce typescript definitions for images and fonts
bb19242
@leventebalogh
chore(Git): ignore cypress generated files from Git
b2bc268
@leventebalogh
feat(Cypress): add a Cypress config
ed896c6
@leventebalogh
feat(NPM): add e2e commands§
f1cc66c
@leventebalogh
feat(NPM): add cypress as a dev dependency
8fef9d5
@leventebalogh
feat(E2E): add @grafana/e2eas a dev dependency
b8b9146
@leventebalogh
chore: remove cypress.json
24ccc64
@leventebalogh
chore(NPM): remove the NPM dependency cypress from the project
dd2d730
@leventebalogh
chore(NPM): add script for running the Grafana server
9490a8e
@leventebalogh
feat(E2E): add a basic smoke test
741ae89
@leventebalogh
fix(Prettier): fix linting errors
379a782
@leventebalogh
fix(Webpack): make yarn build work (the plugins array is quite strict)
895e1d2
@leventebalogh
chore(VSCode): remove VSCode config from version control
16a1efb
@leventebalogh
fix: add missing "org" parameter to the dev scripts
be90ee5
@leventebalogh leventebalogh marked this pull request as ready for review March 10, 2022 17:16
@leventebalogh leventebalogh merged commit ee7db42 into main Mar 11, 2022
@leventebalogh leventebalogh deleted the jackw/explicit-deps-webpack branch March 11, 2022 12:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mckn mckn mckn approved these changes

Assignees

@jackw jackw

Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Explicit dependencies
3 participants
@jackw @mckn @leventebalogh